Annotation of archangel/www/urls.html, revision 1.2

1.1       marnanel    1: <h1 class="page-header">The format of <acronym title="Reverse Gossip Transfer Protocol">RGTP</acronym> <acronym title="Universal Resource Locator">URL</acronym>s</h1>
                      2: 
                      3: <p><a href="/">Archangel</a> uses URLs whose scheme is <code>rgtp</code>. These are intended to conform to the guidelines laid down in <a href="http://www.cis.ohio-state.edu/cgi-bin/rfc/rfc1738.html">RFC 1738</a>. This document is an informal specification of the format.</p>
                      4: 
                      5: <p>In some cases, part of this specification is planned but not yet implemented. These are marked <b>(NYI:)</b>.</p>
                      6: 
                      7: <p><b>(NYI:)</b> The user name and password are supported; the password field is used to supply a shared secret. It must be a hex number with an even number of digits. If no shared secret, or an invalid one, is supplied, the program should either reuse a stored secret or prompt the user. If no username is supplied, the program should either reuse a stored name or prompt the user. If the name supplied matches the string "anonymous" exactly, any shared-secret is ignored and the program should attempt to log in without sending any sort of authentication.</p>
                      8: 
                      9: <p>The hostname must be given. It should be one of the following:</p>
                     10: <ul>
                     11: <li>a valid name within the DNS, though not necessarily a fully-qualified one (for example, <code>rgtp://rgtp-serv.groggs.group.cam.ac.uk</code>)</li>
                     12: <li>one of the following well-known names:
                     13: <table>
                     14: <tr><th>well-known name</th><th>resolves to DNS name</th></tr>
                     15: <tr><td><code>groggs</code></td><td><code>rgtp-serv.groggs.group.cam.ac.uk</code></td></tr>
                     16: </table>
                     17: </li>
1.2     ! marnanel   18: <li><b>(NYI:)</b> a single asterisk, in which case no username, password, port or url-path fields may be supplied. The program should supply a list of known servers to the user. (This is by analogy with <code>news:*</code>, RFC 1738 &#XA7;3.6.</li>
1.1       marnanel   19: 
                     20: <p>A port number may be specified. If it isn't given, it defaults to 1431, as allocated by IANA. The way port numbers work is independent of whether a well-known hostname is used.</p>
                     21: 
                     22: <p>The url-path is one of the following:</p>
                     23: <ul>
                     24: <li><b>(NYI:)</b> An empty string: equivalent to <code>index</code>.</li>
                     25: <li><code>index</code>: the user should be shown the index.</li>
                     26: <li>Any alphabetic character followed by any seven decimal characters: the user should be shown the item whose itemid is in the url-path, if it exists. If not, it's an error.</li>
                     27: <li><b>(NYI:)</b><code>motd</code>: the user should be shown the message of the day.</li>
                     28: <li><b>(NYI:)</b><code>editlog</code>: the user should be shown the editors' log.</li>
                     29: </ul>
                     30: 
                     31: 

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>