Convert to mdoc format.
Submitted by: Sandro Sigala <sandro@cat.local.net> as part of PR# 2134
This commit is contained in:
Mike Pritchard
+71
-66
@@ -12,16 +12,29 @@
|
|||||||
.\" The University of Texas at Austin
|
.\" The University of Texas at Austin
|
||||||
.\" Austin, Texas 78712
|
.\" Austin, Texas 78712
|
||||||
.\"
|
.\"
|
||||||
.TH man 1 "Jan 5, 1991"
|
.Dd Jan 5, 1991
|
||||||
.LO 1
|
.Dt MAN 1
|
||||||
.SH NAME
|
.Sh NAME
|
||||||
man \- format and display the on-line manual pages
|
.Nm man
|
||||||
.SH SYNOPSIS
|
.Nd format and display the on-line manual pages
|
||||||
man [\-adfhktw] [\-m system] [\-p string] [\-M path] [\-P pager]
|
.Sh SYNOPSIS
|
||||||
[\-S list] [section] name ...
|
.Nm man
|
||||||
.SH DESCRIPTION
|
.Op Fl adfhktw
|
||||||
man formats and displays the on-line manual pages. This version knows
|
.Op Fl m Ar system
|
||||||
about the MANPATH and PAGER environment variables, so you can have
|
.Op Fl p Ar string
|
||||||
|
.Op Fl M Ar path
|
||||||
|
.Op Fl P Ar pager
|
||||||
|
.Op Fl S Ar list
|
||||||
|
.Op Ar section
|
||||||
|
.Ar name ...
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
.Nm Man
|
||||||
|
formats and displays the on-line manual pages. This version knows
|
||||||
|
about the
|
||||||
|
.Ev MANPATH
|
||||||
|
and
|
||||||
|
.Ev PAGER
|
||||||
|
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. If section is specified, man
|
like to display the formatted pages. If section is specified, man
|
||||||
only looks in that section of the manual. You may also specify the
|
only looks in that section of the manual. You may also specify the
|
||||||
@@ -30,105 +43,97 @@ run on the source files via command line options or environment
|
|||||||
variables. If enabled by the system administrator, formatted man
|
variables. 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 `%compress%' command to save
|
||||||
space.
|
space.
|
||||||
.SH OPTIONS
|
.Pp
|
||||||
.TP
|
The options are as follows:
|
||||||
.B \-\^M " path"
|
.Bl -tag -width Fl
|
||||||
|
.It Fl M Ar path
|
||||||
Specify an alternate manpath. By default, man uses
|
Specify an alternate manpath. By default, man uses
|
||||||
.B manpath
|
.Nm manpath
|
||||||
to determine the path to search. This option overrides the
|
to determine the path to search. This option overrides the
|
||||||
.B MANPATH
|
.Ev MANPATH
|
||||||
environment variable.
|
environment variable.
|
||||||
.TP
|
.It Fl P Ar pager
|
||||||
.B \-\^P " pager"
|
|
||||||
Specify which pager to use. By default, man uses
|
Specify which pager to use. By default, man uses
|
||||||
.B %pager%,
|
.Nm %pager% ,
|
||||||
This option overrides the
|
This option overrides the
|
||||||
.B PAGER
|
.Ev PAGER
|
||||||
environment variable.
|
environment variable.
|
||||||
.TP
|
.It Fl S Ar list
|
||||||
.B \-\^S " list"
|
|
||||||
List is a colon separated list of manual sections to search.
|
List is a colon separated list of manual sections to search.
|
||||||
This option overrides the
|
This option overrides the
|
||||||
.B MANSECT
|
.Ev MANSECT
|
||||||
environment variable.
|
environment variable.
|
||||||
.TP
|
.It Fl a
|
||||||
.B \-\^a
|
|
||||||
By default, man will exit after displaying the first manual page it
|
By default, man will exit after displaying the first manual page it
|
||||||
finds. Using this option forces man to display all the manual pages
|
finds. Using this option forces man to display all the manual pages
|
||||||
that match
|
that match
|
||||||
.B name,
|
.Ar name ,
|
||||||
not just the first.
|
not just the first.
|
||||||
.TP
|
.It Fl d
|
||||||
.B \-\^d
|
|
||||||
Don't actually display the man pages, but do print gobs of debugging
|
Don't actually display the man pages, but do print gobs of debugging
|
||||||
information.
|
information.
|
||||||
.TP
|
.It Fl f
|
||||||
.B \-\^f
|
|
||||||
Equivalent to
|
Equivalent to
|
||||||
.B whatis.
|
.Nm whatis .
|
||||||
.TP
|
.It Fl h
|
||||||
.B \-\^h
|
|
||||||
Print a one line help message and exit.
|
Print a one line help message and exit.
|
||||||
.TP
|
.It Fl k
|
||||||
.B \-\^k
|
|
||||||
Equivalent to
|
Equivalent to
|
||||||
.B apropos.
|
.Nm apropos .
|
||||||
.TP
|
.It Fl m Ar system
|
||||||
.B \-\^m " system"
|
|
||||||
Specify an alternate set of man pages to search based on the system
|
Specify an alternate set of man pages to search based on the system
|
||||||
name given.
|
name given.
|
||||||
.TP
|
.It Fl p Ar string
|
||||||
.B \-\^p " string"
|
|
||||||
Specify the sequence of preprocessors to run before nroff or troff.
|
Specify the sequence of preprocessors to run before nroff or troff.
|
||||||
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).
|
eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r).
|
||||||
This option overrides the
|
This option overrides the
|
||||||
.B MANROFFSEQ
|
.Ev MANROFFSEQ
|
||||||
environment variable.
|
environment variable.
|
||||||
.TP
|
.It Fl t
|
||||||
.B \-\^t
|
|
||||||
Use
|
Use
|
||||||
.B %troff%
|
.Nm %troff%
|
||||||
to format the manual page, passing the output to
|
to format the manual page, passing the output to stdout.
|
||||||
.B stdout.
|
|
||||||
The output from
|
The output from
|
||||||
.B %troff%
|
.Nm %troff%
|
||||||
may need to be passed through some filter or another before being
|
may need to be passed through some filter or another before being
|
||||||
printed.
|
printed.
|
||||||
.TP
|
.It Fl w
|
||||||
.B \-\^w
|
|
||||||
Don't actually display the man pages, but do print the location(s) of
|
Don't actually display the man pages, but do print the location(s) of
|
||||||
the files that would be formatted or displayed.
|
the files that would be formatted or displayed.
|
||||||
.SH ENVIRONMENT
|
.El
|
||||||
.TP \w'MANROFFSEQ\ \ 'u
|
.Sh ENVIRONMENT
|
||||||
.B MANPATH
|
.Bl -tag -width MANROFFSEQ -compact
|
||||||
|
.It Ev MANPATH
|
||||||
If
|
If
|
||||||
.B MANPATH
|
.Ev MANPATH
|
||||||
is set, its value is used as the path to search for manual pages.
|
is set, its value is used as the path to search for manual pages.
|
||||||
.TP
|
.It Ev MANROFFSEQ
|
||||||
.B MANROFFSEQ
|
|
||||||
If
|
If
|
||||||
.B 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. By default, pages are passed through
|
before running nroff or troff. By default, pages are passed through
|
||||||
the table preprocessor before nroff.
|
the table preprocessor before nroff.
|
||||||
.TP
|
.It Ev MANSEC
|
||||||
.B MANSEC
|
|
||||||
If
|
If
|
||||||
.B MANSEC
|
.Ev MANSEC
|
||||||
is set, its value is used to determine which manual sections to search.
|
is set, its value is used to determine which manual sections to search.
|
||||||
.TP
|
.It Ev PAGER
|
||||||
.B PAGER
|
|
||||||
If
|
If
|
||||||
.B PAGER
|
.Ev PAGER
|
||||||
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. By default,
|
the man page. By default,
|
||||||
.B %pager%
|
.Nm %pager%
|
||||||
is used.
|
is used.
|
||||||
.SH "SEE ALSO"
|
.El
|
||||||
apropos(1), whatis(1), manpath(1), more(1), groff(1).
|
.Sh SEE ALSO
|
||||||
.SH BUGS
|
.Xr apropos 1 ,
|
||||||
|
.Xr whatis 1 ,
|
||||||
|
.Xr manpath 1 ,
|
||||||
|
.Xr more 1 ,
|
||||||
|
.Xr groff 1
|
||||||
|
.Sh BUGS
|
||||||
The
|
The
|
||||||
.B \-t
|
.Fl t
|
||||||
option only works if a troff-like program is installed.
|
option only works if a troff-like program is installed.
|
||||||
|
|||||||
@@ -12,45 +12,57 @@
|
|||||||
.\" The University of Texas at Austin
|
.\" The University of Texas at Austin
|
||||||
.\" Austin, Texas 78712
|
.\" Austin, Texas 78712
|
||||||
.\"
|
.\"
|
||||||
.TH manpath 1 "Jan 5, 1991"
|
.Dd Jan 5, 1991
|
||||||
.LO 1
|
.Dt MANPATH 1
|
||||||
.SH NAME
|
.Os
|
||||||
manpath \- determine user's search path for man pages
|
.Sh NAME
|
||||||
.SH SYNOPSIS
|
.Nm manpath
|
||||||
manpath [\-q]
|
.Nd determine user's search path for man pages
|
||||||
.SH DESCRIPTION
|
.Sh SYNOPSIS
|
||||||
manpath tries to determine the user's manpath from a set of system
|
.Nm
|
||||||
|
.Op Fl q
|
||||||
|
.Sh DESCRIPTION
|
||||||
|
.Nm manpath
|
||||||
|
tries to determine the user's manpath from a set of system
|
||||||
defaults and the user's
|
defaults and the user's
|
||||||
.B PATH ,
|
.Ev PATH ,
|
||||||
echoing the result to the standard output. Warnings and errors are
|
echoing the result to the standard output. Warnings and errors are
|
||||||
written to the standard error.
|
written to the standard error.
|
||||||
If a directory in the user's path is not listed in the manpath.config
|
If a directory in the user's path is not listed in the manpath.config
|
||||||
file, manpath looks for the subdirectories man or MAN. If they exist,
|
file, manpath looks for the subdirectories man or MAN. If they exist,
|
||||||
they are added to the search path.
|
they are added to the search path.
|
||||||
.PP
|
.Pp
|
||||||
manpath is used by
|
.Nm
|
||||||
.B man
|
manpath
|
||||||
|
is used by
|
||||||
|
.Nm man
|
||||||
to determine the search path, so user's normally don't need to set the
|
to determine the search path, so user's normally don't need to set the
|
||||||
.B MANPATH
|
.Ev MANPATH
|
||||||
environment variable directly.
|
environment variable directly.
|
||||||
.SH OPTIONS
|
.Pp
|
||||||
.TP
|
The options are as follows:
|
||||||
.B \-\^q
|
.Bl -tag -width Ds
|
||||||
|
.It Fl q
|
||||||
Operate quietly. Only echo the final manpath.
|
Operate quietly. Only echo the final manpath.
|
||||||
.SH ENVIRONMENT
|
.El
|
||||||
.TP \w'MANPATH\ \ 'u
|
.Sh ENVIRONMENT
|
||||||
.B MANPATH
|
.Bl -tag -width MANPATH -compact
|
||||||
|
.It Ev MANPATH
|
||||||
If
|
If
|
||||||
.B MANPATH
|
.Ev MANPATH
|
||||||
is set,
|
is set,
|
||||||
.B manpath
|
.Nm manpath
|
||||||
echoes its value on the standard output and issues a warning on the
|
echoes its value on the standard output and issues a warning on the
|
||||||
standard error.
|
standard error.
|
||||||
.SH FILES
|
.El
|
||||||
.TP \w'%manpath_config_file%'u+2n
|
.Sh FILES
|
||||||
.BI %manpath_config_file%
|
.Bl -tag -width %manpath_config_file% -compact
|
||||||
|
.It Pa %manpath_config_file%
|
||||||
System configuration file.
|
System configuration file.
|
||||||
.SH "SEE ALSO"
|
.El
|
||||||
apropos(1), whatis(1), man(1).
|
.Sh SEE ALSO
|
||||||
.SH BUGS
|
.Xr apropos 1 ,
|
||||||
|
.Xr whatis 1 ,
|
||||||
|
.Xr man 1
|
||||||
|
.Sh BUGS
|
||||||
None known.
|
None known.
|
||||||
|
|||||||
Reference in New Issue
Block a user