LDP
/
man-pages
mirror of https://github.com/mkerrisk/man-pages
0
1
Fork 0
Code Releases Activity

Reformat headings

This commit is contained in:
Michael Kerrisk 2007-06-15 20:06:35 +00:00
parent 1ce284ecb0
commit 446a4bc839
1 changed files with 45 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
man7/uri.7
View File

@ -105,7 +105,7 @@ devicename colons with the vertical bar ("|") in URIs, so "C:" becomes "C|".
A fragment identifier, if included, refers to a particular named portion A fragment identifier, if included, refers to a particular named portion
(fragment) of a resource; text after a '#' identifies the fragment. (fragment) of a resource; text after a '#' identifies the fragment.
A URI beginning with '#' refers to that fragment in the current resource. A URI beginning with '#' refers to that fragment in the current resource.
.SH USAGE .SS Usage
There are many different URI schemes, each with specific There are many different URI schemes, each with specific
additional rules and meanings, but they are intentionally made to be additional rules and meanings, but they are intentionally made to be
as similar as possible. as similar as possible.
@ -136,7 +136,9 @@ Here are some of the most common schemes in use on Unix-like systems
that are understood by many tools. that are understood by many tools.
Note that many tools using URIs also have internal schemes or specialized Note that many tools using URIs also have internal schemes or specialized
schemes; see those tools' documentation for information on those schemes. schemes; see those tools' documentation for information on those schemes.
.SS "http \- Web (HTTP) server" .PP
.B "http \- Web (HTTP) server"
.PP
.RI http:// ip_server / path .RI http:// ip_server / path
.br .br
.RI http:// ip_server / path ? query .RI http:// ip_server / path ? query
@ -169,7 +171,9 @@ interaction mechanism (called POST) which does
not include the data in the URI. not include the data in the URI.
See the Common Gateway Interface specification at See the Common Gateway Interface specification at
<http://www.w3.org/CGI> for more information. <http://www.w3.org/CGI> for more information.
.SS "ftp \- File Transfer Protocol (FTP)" .PP
.B "ftp \- File Transfer Protocol (FTP)"
.PP
.RI ftp:// ip_server / path .RI ftp:// ip_server / path
.PP .PP
This is a URL accessing a file through the file transfer protocol (FTP). This is a URL accessing a file through the file transfer protocol (FTP).
@ -179,7 +183,9 @@ in that case many clients provide as the password the requestor's
Internet email address. Internet email address.
An example is An example is
<ftp://ftp.is.co.za/rfc/rfc1808.txt>. <ftp://ftp.is.co.za/rfc/rfc1808.txt>.
.SS "gopher \- Gopher server" .PP
.B "gopher \- Gopher server"
.PP
.RI gopher:// ip_server / "gophertype selector" .RI gopher:// ip_server / "gophertype selector"
.br .br
.RI gopher:// ip_server / "gophertype selector" %09 search .RI gopher:// ip_server / "gophertype selector" %09 search
@ -202,7 +208,9 @@ In the Gopher protocol,
Gopher selector strings are a sequence of octets which may contain Gopher selector strings are a sequence of octets which may contain
any octets except 09 hexadecimal (US-ASCII HT or tab), 0A hexadecimal any octets except 09 hexadecimal (US-ASCII HT or tab), 0A hexadecimal
(US-ASCII character LF), and 0D (US-ASCII character CR). (US-ASCII character LF), and 0D (US-ASCII character CR).
.SS "mailto \- Email address" .PP
.B "mailto \- Email address"
.PP
.RI mailto: email-address .RI mailto: email-address
.PP .PP
This is an email address, usually of the form This is an email address, usually of the form
@ -212,7 +220,9 @@ See
for more information on the correct format of an email address. for more information on the correct format of an email address.
Note that any % character must be rewritten as %25. Note that any % character must be rewritten as %25.
An example is <mailto:dwheeler@dwheeler.com>. An example is <mailto:dwheeler@dwheeler.com>.
.SS "news \- Newsgroup or News message" .PP
.B "news \- Newsgroup or News message"
.PP
.RI news: newsgroup-name .RI news: newsgroup-name
.br .br
.RI news: message-id .RI news: message-id
@ -236,7 +246,9 @@ and ">"; it takes the form
.IR unique @ full_domain_name . .IR unique @ full_domain_name .
A message identifier may be distinguished from a news group name by the A message identifier may be distinguished from a news group name by the
presence of the "@" character. presence of the "@" character.
.SS "telnet \- Telnet login" .PP
.B "telnet \- Telnet login"
.PP
.RI telnet:// ip_server / .RI telnet:// ip_server /
.PP .PP
The Telnet URL scheme is used to designate interactive text services that The Telnet URL scheme is used to designate interactive text services that
@ -244,7 +256,9 @@ may be accessed by the Telnet protocol.
The final "/" character may be omitted. The final "/" character may be omitted.
The default port is 23. The default port is 23.
An example is <telnet://melvyl.ucop.edu/>. An example is <telnet://melvyl.ucop.edu/>.
.SS "file \- Normal file" .PP
.B "file \- Normal file"
.PP
.RI file:// ip_server / path_segments .RI file:// ip_server / path_segments
.br .br
.RI file: path_segments .RI file: path_segments
@ -279,7 +293,9 @@ Note that if you really mean to say "start from the current location," don't
specify the scheme at all; use a relative address like <../test.txt>, specify the scheme at all; use a relative address like <../test.txt>,
which has the side-effect of being scheme-independent. which has the side-effect of being scheme-independent.
An example of this scheme is <file:///etc/passwd>. An example of this scheme is <file:///etc/passwd>.
.SS "man \- Man page documentation" .PP
.B "man \- Man page documentation"
.PP
.RI man: command-name .RI man: command-name
.br .br
.RI man: command-name ( section ) .RI man: command-name ( section )
@ -292,7 +308,9 @@ for more information on the meaning of the section numbers.
This URI scheme is unique to Unix-like systems (such as Linux) This URI scheme is unique to Unix-like systems (such as Linux)
and is not currently registered by the IETF. and is not currently registered by the IETF.
An example is <man:ls(1)>. An example is <man:ls(1)>.
.SS "info \- Info page documentation" .PP
.B "info \- Info page documentation"
.PP
.RI info: virtual-filename .RI info: virtual-filename
.br .br
.RI info: virtual-filename # nodename .RI info: virtual-filename # nodename
@ -319,7 +337,9 @@ In both GNOME and KDE, if the form without the nodename is used the
nodename is assumed to be "Top". nodename is assumed to be "Top".
Examples of the GNOME format are <info:gcc> and <info:gcc#G++_and_GCC>. Examples of the GNOME format are <info:gcc> and <info:gcc#G++_and_GCC>.
Examples of the KDE format are <info:(gcc)> and <info:(gcc)G++ and GCC>. Examples of the KDE format are <info:(gcc)> and <info:(gcc)G++ and GCC>.
.SS "whatis \- Documentation search" .PP
.B "whatis \- Documentation search"
.PP
.RI whatis: string .RI whatis: string
.PP .PP
This scheme searches the database of short (one-line) descriptions of This scheme searches the database of short (one-line) descriptions of
@ -329,12 +349,16 @@ See
.BR whatis (1). .BR whatis (1).
This URI scheme is unique to Unix-like systems (such as Linux) This URI scheme is unique to Unix-like systems (such as Linux)
and is not currently registered by the IETF. and is not currently registered by the IETF.
.SS "ghelp \- GNOME help documentation" .PP
.B "ghelp \- GNOME help documentation"
.PP
.RI ghelp: name-of-application .RI ghelp: name-of-application
.PP .PP
This loads GNOME help for the given application. This loads GNOME help for the given application.
Note that not much documentation currently exists in this format. Note that not much documentation currently exists in this format.
.SS "ldap \- Lightweight Directory Access Protocol" .PP
.B "ldap \- Lightweight Directory Access Protocol"
.PP
.RI ldap:// hostport .RI ldap:// hostport
.br .br
.RI ldap:// hostport / .RI ldap:// hostport /
@ -415,7 +439,9 @@ with common name (cn) "Babs Jensen" at University of Michigan, request:
.nf .nf
ldap://host.com:6666/o=University%20of%20Michigan,c=US??sub?(cn=Babs%20Jensen) ldap://host.com:6666/o=University%20of%20Michigan,c=US??sub?(cn=Babs%20Jensen)
.fi .fi
.SS "wais \- Wide Area Information Servers" .PP
.B "wais \- Wide Area Information Servers"
.PP
.RI wais:// hostport / database .RI wais:// hostport / database
.br .br
.RI wais:// hostport / database ? search .RI wais:// hostport / database ? search
@ -440,7 +466,9 @@ database to be retrieved.
is the WAIS designation of the type of the object and is the WAIS designation of the type of the object and
.I wpath .I wpath
is the WAIS document-id. is the WAIS document-id.
.SS "other schemes" .PP
.B "other schemes"
.PP
There are many other URI schemes. There are many other URI schemes.
Most tools that accept URIs support a set of internal URIs Most tools that accept URIs support a set of internal URIs
(e.g., Mozilla has the about: scheme for internal information, (e.g., Mozilla has the about: scheme for internal information,
@ -454,7 +482,7 @@ URNs are to be supported by the urn: scheme, with a hierarchical name space
(e.g., urn:ietf:... would identify IETF documents); at this time (e.g., urn:ietf:... would identify IETF documents); at this time
URNs are not widely implemented. URNs are not widely implemented.
Not all tools support all schemes. Not all tools support all schemes.
.SH "CHARACTER ENCODING" .SS "Character Encoding"
.PP .PP
URIs use a limited number of characters so that they can be URIs use a limited number of characters so that they can be
typed in and used in a variety of situations. typed in and used in a variety of situations.
@ -504,7 +532,7 @@ translate the character sequences into UTF-8 (IETF RFC\ 2279) \(em see
.IP 2. .IP 2.
use the URI escaping mechanism, that is, use the URI escaping mechanism, that is,
use the %HH encoding for unsafe octets. use the %HH encoding for unsafe octets.
.SH "WRITING A URI" .SS "Writing a URI"
When written, URIs should be placed inside double quotes When written, URIs should be placed inside double quotes
(e.g., "http://www.kernelnotes.org"), (e.g., "http://www.kernelnotes.org"),
enclosed in angle brackets (e.g., <http://lwn.net>), enclosed in angle brackets (e.g., <http://lwn.net>),