Markup revision.
This commit is contained in:
parent
0e3b49a9c1
commit
bdaa38dc41
@ -31,7 +31,9 @@
|
|||||||
.Op Ar section
|
.Op Ar section
|
||||||
.Ar name ...
|
.Ar name ...
|
||||||
.Sh DESCRIPTION
|
.Sh DESCRIPTION
|
||||||
.Nm Man
|
The
|
||||||
|
.Nm
|
||||||
|
utility
|
||||||
formats and displays the on-line manual pages.
|
formats and displays the on-line manual pages.
|
||||||
This version knows
|
This version knows
|
||||||
about the
|
about the
|
||||||
@ -41,7 +43,9 @@ and
|
|||||||
environment variables, so you can have
|
environment variables, so you can have
|
||||||
your own set(s) of personal man pages and choose whatever program you
|
your own set(s) of personal man pages and choose whatever program you
|
||||||
like to display the formatted pages.
|
like to display the formatted pages.
|
||||||
If section is specified,
|
If
|
||||||
|
.Ar section
|
||||||
|
is specified,
|
||||||
.Nm
|
.Nm
|
||||||
only looks in that section of the manual.
|
only looks in that section of the manual.
|
||||||
You may also specify the
|
You may also specify the
|
||||||
@ -49,11 +53,12 @@ order to search the sections for entries and which preprocessors to
|
|||||||
run on the source files via command line options or environment
|
run on the source files via command line options or environment
|
||||||
variables.
|
variables.
|
||||||
If enabled by the system administrator, formatted man
|
If enabled by the system administrator, formatted man
|
||||||
pages will also be compressed with the `%compress%' command to save
|
pages will also be compressed with the
|
||||||
space.
|
.Dq Li "%compress%"
|
||||||
|
command to save space.
|
||||||
.Pp
|
.Pp
|
||||||
The options are as follows:
|
The options are as follows:
|
||||||
.Bl -tag -width Fl
|
.Bl -tag -width ".Fl P Ar pager"
|
||||||
.It Fl M Ar path
|
.It Fl M Ar path
|
||||||
Specify an alternate manpath.
|
Specify an alternate manpath.
|
||||||
By default,
|
By default,
|
||||||
@ -72,7 +77,7 @@ Specify which pager to use.
|
|||||||
By default,
|
By default,
|
||||||
.Nm
|
.Nm
|
||||||
uses
|
uses
|
||||||
.Nm %pager% .
|
.Dq Li "%pager%" .
|
||||||
This option overrides the
|
This option overrides the
|
||||||
.Ev PAGER
|
.Ev PAGER
|
||||||
environment variable.
|
environment variable.
|
||||||
@ -172,8 +177,8 @@ will search in the following subdirectories, in the order of precedence:
|
|||||||
.Sm on
|
.Sm on
|
||||||
.El
|
.El
|
||||||
.Pp
|
.Pp
|
||||||
For example, for
|
For example, for the
|
||||||
.Dq de_DE.ISO8859-1
|
.Dq Li de_DE.ISO8859-1
|
||||||
locale,
|
locale,
|
||||||
.Nm
|
.Nm
|
||||||
will search in the following subdirectories of the
|
will search in the following subdirectories of the
|
||||||
@ -195,10 +200,18 @@ it will be looked up in the default
|
|||||||
.Pa /usr/share/man
|
.Pa /usr/share/man
|
||||||
directory.
|
directory.
|
||||||
.It Fl p Ar string
|
.It Fl p Ar string
|
||||||
Specify the sequence of preprocessors to run before nroff or troff.
|
Specify the sequence of preprocessors to run before
|
||||||
|
.Xr nroff 1
|
||||||
|
or
|
||||||
|
.Xr troff 1 .
|
||||||
Not all installations will have a full set of preprocessors.
|
Not all installations will have a full set of preprocessors.
|
||||||
Some of the preprocessors and the letters used to designate them are:
|
Some of the preprocessors and the letters used to designate them are:
|
||||||
eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r).
|
.Nm eqn Pq e ,
|
||||||
|
.Nm grap Pq g ,
|
||||||
|
.Nm pic Pq p ,
|
||||||
|
.Nm tbl Pq t ,
|
||||||
|
.Nm vgrind Pq v ,
|
||||||
|
.Nm refer Pq r .
|
||||||
This option overrides the
|
This option overrides the
|
||||||
.Ev MANROFFSEQ
|
.Ev MANROFFSEQ
|
||||||
environment variable.
|
environment variable.
|
||||||
@ -245,9 +258,15 @@ is set, its value is used as the path to search for manual pages.
|
|||||||
If
|
If
|
||||||
.Ev MANROFFSEQ
|
.Ev MANROFFSEQ
|
||||||
is set, its value is used to determine the set of preprocessors run
|
is set, its value is used to determine the set of preprocessors run
|
||||||
before running nroff or troff.
|
before running
|
||||||
|
.Xr nroff 1
|
||||||
|
or
|
||||||
|
.Xr troff 1 .
|
||||||
By default, pages are passed through
|
By default, pages are passed through
|
||||||
the table preprocessor before nroff.
|
the table preprocessor
|
||||||
|
.Pq Xr tbl 1
|
||||||
|
before
|
||||||
|
.Xr nroff 1 .
|
||||||
.It Ev MANSECT
|
.It Ev MANSECT
|
||||||
If
|
If
|
||||||
.Ev MANSECT
|
.Ev MANSECT
|
||||||
@ -258,22 +277,23 @@ If
|
|||||||
is set, its value is used as the name of the program to use to display
|
is set, its value is used as the name of the program to use to display
|
||||||
the man page.
|
the man page.
|
||||||
By default,
|
By default,
|
||||||
.Nm %pager%
|
.Dq Li "%pager%"
|
||||||
is used.
|
is used.
|
||||||
.El
|
.El
|
||||||
.Sh EXAMPLES
|
.Sh EXAMPLES
|
||||||
.Pp
|
.Pp
|
||||||
Normally, to look at the relevant manpage information for getopt,
|
Normally, to look at the relevant manpage information for
|
||||||
|
.Dq Li getopt ,
|
||||||
one would use:
|
one would use:
|
||||||
.Pp
|
.Pp
|
||||||
.Dl man getopt
|
.Dl "man getopt"
|
||||||
.Pp
|
.Pp
|
||||||
However, when referring to a specific section of the manual,
|
However, when referring to a specific section of the manual,
|
||||||
such as
|
such as
|
||||||
.Xr getopt 3 ,
|
.Xr getopt 3 ,
|
||||||
one would use:
|
one would use:
|
||||||
.Pp
|
.Pp
|
||||||
.Dl man 3 getopt
|
.Dl "man 3 getopt"
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr apropos 1 ,
|
.Xr apropos 1 ,
|
||||||
.Xr groff 1 ,
|
.Xr groff 1 ,
|
||||||
|
Loading…
Reference in New Issue
Block a user