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

wrapped long source lines

This commit is contained in:
Michael Kerrisk 2007-06-02 05:43:56 +00:00
parent 8427b6a4f2
commit 6116ff440b
1 changed files with 29 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
man7/uri.7
View File

@ -81,7 +81,8 @@ the resource ceases to exist or becomes unavailable.
.PP .PP
URIs are the standard way to name hypertext link destinations URIs are the standard way to name hypertext link destinations
for tools such as web browsers. for tools such as web browsers.
The string "http://www.kernelnotes.org" is a URL (and thus it's a URI). The string "http://www.kernelnotes.org" is a URL (and thus it
is also a URI).
Many people use the term URL loosely as a synonym for URI Many people use the term URL loosely as a synonym for URI
(though technically URLs are a subset of URIs). (though technically URLs are a subset of URIs).
.PP .PP
@ -164,7 +165,8 @@ are embedded in SGML/XML documents (including HTML), the ampersand
(&) has to be rewritten as &. (&) has to be rewritten as &.
Note that not all queries use this format; larger forms Note that not all queries use this format; larger forms
may be too long to store as a URI, so they use a different may be too long to store as a URI, so they use a different
interaction mechanism (called POST) which does not include the data in the URI. interaction mechanism (called POST) which does
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)" .SS "ftp \- File Transfer Protocol (FTP)"
@ -282,8 +284,8 @@ An example of this scheme is <file:///etc/passwd>.
.RI man: command-name ( section ) .RI man: command-name ( section )
.PP .PP
This refers to local online manual (man) reference pages. This refers to local online manual (man) reference pages.
The command name can optionally be followed by a parenthesis and section number; The command name can optionally be followed by a
see parenthesis and section number; see
.BR man (7) .BR man (7)
for more information on the meaning of the section numbers. 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)
@ -299,7 +301,8 @@ An example is <man:ls(1)>.
.RI info:( virtual-filename ) nodename .RI info:( virtual-filename ) nodename
.PP .PP
This scheme refers to online info reference pages (generated from This scheme refers to online info reference pages (generated from
texinfo files), a documentation format used by programs such as the GNU tools. texinfo files),
a documentation format used by programs such as the GNU tools.
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.
As of this writing, GNOME and KDE differ in their URI syntax As of this writing, GNOME and KDE differ in their URI syntax
@ -318,8 +321,8 @@ Examples of the KDE format are <info:(gcc)> and <info:(gcc)G++ and GCC>.
.SS "whatis \- Documentation search" .SS "whatis \- Documentation search"
.RI whatis: string .RI whatis: string
.PP .PP
This scheme searches the database of short (one-line) descriptions of commands This scheme searches the database of short (one-line) descriptions of
and returns a list of descriptions containing that string. commands and returns a list of descriptions containing that string.
Only complete word matches are returned. Only complete word matches are returned.
See See
.BR whatis (1). .BR whatis (1).
@ -389,7 +392,7 @@ a comma-separated list of type=value
pairs, where the =value portion may be omitted for options not pairs, where the =value portion may be omitted for options not
requiring it. requiring it.
An extension prefixed with a '!' is critical An extension prefixed with a '!' is critical
(must be supported to be valid), otherwise it's non-critical (optional). (must be supported to be valid), otherwise it is non-critical (optional).
.PP .PP
LDAP queries are easiest to explain by example. LDAP queries are easiest to explain by example.
Here's a query that asks ldap.itd.umich.edu for information about Here's a query that asks ldap.itd.umich.edu for information about
@ -553,9 +556,10 @@ use the standard format as described here.
.UE .UE
.SH NOTES .SH NOTES
Any tool accepting URIs (e.g., a web browser) on a Linux system should Any tool accepting URIs (e.g., a web browser) on a Linux system should
be able to handle (directly or indirectly) all of the schemes described here, be able to handle (directly or indirectly) all of the
including the man: and info: schemes. schemes described here, including the man: and info: schemes.
Handling them by invoking some other program is fine and in fact encouraged. Handling them by invoking some other program is
fine and in fact encouraged.
.PP .PP
Technically the fragment isn't part of the URI. Technically the fragment isn't part of the URI.
.PP .PP
@ -568,8 +572,8 @@ Texinfo files use the format @uref{\fIuri\fP}.
Man and mdoc have the recently-added UR macro, or just include the Man and mdoc have the recently-added UR macro, or just include the
URI in the text (viewers should be able to detect :// as part of a URI). URI in the text (viewers should be able to detect :// as part of a URI).
.PP .PP
The GNOME and KDE desktop environments currently vary in the URIs they accept, The GNOME and KDE desktop environments currently vary in the URIs
in particular in their respective help browsers. they accept, in particular in their respective help browsers.
To list man pages, GNOME uses <toc:man> while KDE uses <man:(index)>, and To list man pages, GNOME uses <toc:man> while KDE uses <man:(index)>, and
to list info pages, GNOME uses <toc:info> while KDE uses <info:(dir)> to list info pages, GNOME uses <toc:info> while KDE uses <info:(dir)>
(the author of this man page prefers the KDE approach here, though a more (the author of this man page prefers the KDE approach here, though a more
@ -582,8 +586,8 @@ GNOME prefers the ghelp scheme to store and find documentation.
Neither browser handles file: references to directories at the time Neither browser handles file: references to directories at the time
of this writing, making it difficult to refer to an entire directory with of this writing, making it difficult to refer to an entire directory with
a browsable URI. a browsable URI.
As noted above, these environments differ in how they handle the info: scheme, As noted above, these environments differ in how they handle the
probably the most important variation. info: scheme, probably the most important variation.
It is expected that GNOME and KDE It is expected that GNOME and KDE
will converge to common URI formats, and a future will converge to common URI formats, and a future
version of this man page will describe the converged result. version of this man page will describe the converged result.
@ -640,15 +644,16 @@ References of the form
<file:///usr/doc/ZZZ> don't work because different distributions and <file:///usr/doc/ZZZ> don't work because different distributions and
local installation requirements may place the files in different local installation requirements may place the files in different
directories directories
(it may be in /usr/doc, or /usr/local/doc, or /usr/share, or somewhere else). (it may be in /usr/doc, or /usr/local/doc, or /usr/share,
or somewhere else).
Also, the directory ZZZ usually changes when a version changes Also, the directory ZZZ usually changes when a version changes
(though filename globbing could partially overcome this). (though filename globbing could partially overcome this).
Finally, using the file: scheme doesn't easily support people who dynamically Finally, using the file: scheme doesn't easily support people
load documentation from the Internet (instead of loading the files who dynamically load documentation from the Internet (instead of
onto a local filesystem). loading the files onto a local filesystem).
A future URI scheme may be added (e.g., "userdoc:") to permit A future URI scheme may be added (e.g., "userdoc:") to permit
programs to include cross-references to more detailed documentation without programs to include cross-references to more detailed documentation
having to know the exact location of that documentation. without having to know the exact location of that documentation.
Alternatively, a future version of the filesystem specification may Alternatively, a future version of the filesystem specification may
specify file locations sufficiently so that the file: scheme will specify file locations sufficiently so that the file: scheme will
be able to locate documentation. be able to locate documentation.
@ -658,9 +663,9 @@ or implement links using URIs.
.PP .PP
Many programs can't handle all of these different URI formats; there Many programs can't handle all of these different URI formats; there
should be a standard mechanism to load an arbitrary URI that automatically should be a standard mechanism to load an arbitrary URI that automatically
detects the users' environment (e.g., text or graphics, desktop environment, detects the users' environment (e.g., text or graphics,
local user preferences, and currently-executing tools) and invokes the desktop environment, local user preferences, and currently-executing
right tool for any URI. tools) and invokes the right tool for any URI.
.\" .SH AUTHOR .\" .SH AUTHOR
.\" David A. Wheeler (dwheeler@dwheeler.com) wrote this man page. .\" David A. Wheeler (dwheeler@dwheeler.com) wrote this man page.
.SH "SEE ALSO" .SH "SEE ALSO"