version 1.31, 2017/08/11 15:10:26 |
version 1.41, 2022/08/04 11:32:23 |
|
|
.\" Copyright (c) 1989, 1990, 1993 |
.\" Copyright (c) 1989, 1990, 1993 |
.\" The Regents of the University of California. All rights reserved. |
.\" The Regents of the University of California. All rights reserved. |
.\" Copyright (c) 2003, 2007, 2008, 2014 Jason McIntyre <jmc@openbsd.org> |
.\" Copyright (c) 2003, 2007, 2008, 2014 Jason McIntyre <jmc@openbsd.org> |
.\" Copyright (c) 2010, 2011, 2014-2017 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2010, 2011, 2014-2020 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" Redistribution and use in source and binary forms, with or without |
.\" Redistribution and use in source and binary forms, with or without |
.\" modification, are permitted provided that the following conditions |
.\" modification, are permitted provided that the following conditions |
|
|
.Nm |
.Nm |
utility |
utility |
displays the |
displays the |
manual pages entitled |
manual page entitled |
.Ar name . |
.Ar name . |
Pages may be selected according to |
Pages may be selected according to |
a specific category |
a specific category |
Line 64 The options are as follows: |
|
Line 64 The options are as follows: |
|
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl a |
.It Fl a |
Display all matching manual pages. |
Display all matching manual pages. |
Normally, only the first page found is displayed. |
|
.It Fl C Ar file |
.It Fl C Ar file |
Use the specified |
Use the specified |
.Ar file |
.Ar file |
|
|
for a description of the contents of this file. |
for a description of the contents of this file. |
.It Fl c |
.It Fl c |
Copy the manual page to the standard output instead of using |
Copy the manual page to the standard output instead of using |
.Xr more 1 |
.Xr less 1 |
to paginate it. |
to paginate it. |
This is done by default if the standard output is not a terminal device. |
This is done by default if the standard output is not a terminal device. |
.Pp |
.Pp |
|
|
By default, it displays the header lines of all matching pages. |
By default, it displays the header lines of all matching pages. |
.It Fl l |
.It Fl l |
A synonym for |
A synonym for |
.Xr mandoc 1 |
.Xr mandoc 1 . |
.Fl a . |
|
The |
The |
.Ar name |
.Ar name |
arguments are interpreted as filenames. |
arguments are interpreted as filenames. |
Line 127 No search is done and |
|
Line 125 No search is done and |
|
and |
and |
.Fl w |
.Fl w |
are ignored. |
are ignored. |
|
This option implies |
|
.Fl a . |
.It Fl M Ar path |
.It Fl M Ar path |
Override the list of standard directories which |
Override the list of directories to search for manual pages. |
.Nm |
|
searches for manual pages. |
|
The supplied |
The supplied |
.Ar path |
.Ar path |
must be a colon |
must be a colon |
.Pq Ql \&: |
.Pq Ql \&: |
separated list of directories. |
separated list of directories. |
This search path may also be set using the environment variable |
This option also overrides the environment variable |
.Ev MANPATH . |
.Ev MANPATH |
|
and any directories specified in the |
|
.Xr man.conf 5 |
|
file. |
.It Fl m Ar path |
.It Fl m Ar path |
Augment the list of standard directories which |
Augment the list of directories to search for manual pages. |
.Nm |
|
searches for manual pages. |
|
The supplied |
The supplied |
.Ar path |
.Ar path |
must be a colon |
must be a colon |
.Pq Ql \&: |
.Pq Ql \&: |
separated list of directories. |
separated list of directories. |
These directories will be searched before the standard directories or |
These directories will be searched before those specified using the |
the directories specified using the |
|
.Fl M |
.Fl M |
option or the |
option, the |
.Ev MANPATH |
.Ev MANPATH |
environment variable. |
environment variable, the |
|
.Xr man.conf 5 |
|
file, or the default directories. |
.It Fl S Ar subsection |
.It Fl S Ar subsection |
Only show pages for the specified |
Only show pages for the specified |
.Xr machine 1 |
.Xr machine 1 |
Line 167 architecture whilst using another. |
|
Line 167 architecture whilst using another. |
|
This option overrides the |
This option overrides the |
.Ev MACHINE |
.Ev MACHINE |
environment variable. |
environment variable. |
|
.Tg s |
.It Oo Fl s Oc Ar section |
.It Oo Fl s Oc Ar section |
Only select manuals from the specified |
Only select manuals from the specified |
.Ar section . |
.Ar section . |
Line 196 System maintenance and operation commands. |
|
Line 197 System maintenance and operation commands. |
|
.It 9 |
.It 9 |
Kernel internals. |
Kernel internals. |
.El |
.El |
.Pp |
|
If not specified and a match is found in more than one section, |
|
the first match is selected from the following list: |
|
1, 8, 6, 2, 3, 5, 7, 4, 9, 3p. |
|
.It Fl w |
.It Fl w |
List the pathnames of all matching manual pages instead of displaying |
List the pathnames of all matching manual pages instead of displaying |
any of them. |
any of them. |
|
If no |
|
.Ar name |
|
is given, list the directories that would be searched. |
.El |
.El |
.Pp |
.Pp |
The options |
The options |
|
|
.Fl fkl |
.Fl fkl |
are mutually exclusive and override each other. |
are mutually exclusive and override each other. |
.Pp |
.Pp |
Guidelines for writing |
The search starts with the |
man pages can be found in |
.Fl m |
.Xr mdoc 7 . |
argument if provided, then continues with the |
|
.Fl M |
|
argument, the |
|
.Ev MANPATH |
|
variable, the |
|
.Ic manpath |
|
entries in the |
|
.Xr man.conf 5 |
|
file, or with |
|
.Pa /usr/share/man : Ns Pa /usr/X11R6/man : Ns Pa /usr/local/man |
|
by default. |
|
Within each of these, directories are searched in the order provided. |
|
Within each directory, the search proceeds according to the following |
|
list of sections: 1, 8, 6, 2, 3, 5, 7, 4, 9, 3p. |
|
The first match found is shown. |
.Pp |
.Pp |
|
The |
|
.Xr mandoc.db 5 |
|
database is used for looking up manual page entries. |
|
In cases where the database is absent, outdated, or corrupt, |
|
.Nm |
|
falls back to looking for files called |
|
.Ar name . Ns Ar section . |
If both a formatted and an unformatted version of the same manual page, |
If both a formatted and an unformatted version of the same manual page, |
for example |
for example |
.Pa cat1/foo.0 |
.Pa cat1/foo.0 |
and |
and |
.Pa man1/foo.1 , |
.Pa man1/foo.1 , |
exist in the same directory, only the unformatted version is used. |
exist in the same directory, only the unformatted version is used. |
|
The database is kept up to date with |
|
.Xr makewhatis 8 , |
|
which is run by the |
|
.Xr weekly 8 |
|
maintenance script. |
|
.Pp |
|
Guidelines for writing |
|
man pages can be found in |
|
.Xr mdoc 7 . |
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
.Bl -tag -width MANPATHX |
.Bl -tag -width MANPATHX |
.It Ev MACHINE |
.It Ev MACHINE |
Line 245 is case insensitive. |
|
Line 275 is case insensitive. |
|
Any non-empty value of the environment variable |
Any non-empty value of the environment variable |
.Ev MANPAGER |
.Ev MANPAGER |
is used instead of the standard pagination program, |
is used instead of the standard pagination program, |
.Xr more 1 . |
.Xr less 1 . |
If |
If |
.Xr less 1 |
.Xr less 1 |
is used, the interactive |
is used, the interactive |
|
|
can be used to move to the next and to the previous place providing |
can be used to move to the next and to the previous place providing |
information about the term last searched for with |
information about the term last searched for with |
.Ic :t . |
.Ic :t . |
|
The |
|
.Fl O Cm tag Ns Op = Ns Ar term |
|
option documented in the |
|
.Xr mandoc 1 |
|
manual opens a manual page at the definition of a specific |
|
.Ar term |
|
rather than at the beginning. |
.It Ev MANPATH |
.It Ev MANPATH |
The standard search path used by |
Override the standard search path which is either specified in |
.Nm |
.Xr man.conf 5 |
may be changed by specifying a path in the |
or the default path. |
|
The format of |
.Ev MANPATH |
.Ev MANPATH |
environment variable. |
is a colon |
The format of the path is a colon |
|
.Pq Ql \&: |
.Pq Ql \&: |
separated list of directories. |
separated list of directories. |
Invalid paths are ignored. |
Invalid directories are ignored. |
Overridden by |
Overridden by |
.Fl M , |
.Fl M , |
ignored if |
ignored if |
|
|
.Pp |
.Pp |
If |
If |
.Ev MANPATH |
.Ev MANPATH |
begins with a colon, it is appended to the default list; |
begins with a colon, it is appended to the standard path; |
if it ends with a colon, it is prepended to the default list; |
if it ends with a colon, it is prepended to the standard path; |
or if it contains two adjacent colons, |
or if it contains two adjacent colons, |
the standard search path is inserted between the colons. |
the standard path is inserted between the colons. |
If none of these conditions are met, it overrides the |
|
standard search path. |
|
.It Ev PAGER |
.It Ev PAGER |
Specifies the pagination program to use when |
Specifies the pagination program to use when |
.Ev MANPAGER |
.Ev MANPAGER |
is not defined. |
is not defined. |
If neither PAGER nor MANPAGER is defined, |
If neither PAGER nor MANPAGER is defined, |
.Xr more 1 |
.Xr less 1 |
.Fl s |
|
is used. |
is used. |
Only used if |
|
.Fl a |
|
or |
|
.Fl l |
|
is specified. |
|
.El |
.El |
.Sh FILES |
.Sh FILES |
.Bl -tag -width /etc/man.conf -compact |
.Bl -tag -width /etc/man.conf -compact |
.It Pa /etc/man.conf |
.It Pa /etc/man.conf |
default man configuration file |
default |
|
.Nm |
|
configuration file |
.El |
.El |
.Sh EXIT STATUS |
.Sh EXIT STATUS |
.Ex -std man |
.Ex -std man |
Line 350 are extensions to that specification. |
|
Line 381 are extensions to that specification. |
|
A |
A |
.Nm |
.Nm |
command first appeared in |
command first appeared in |
.At v3 . |
.At v2 . |
.Pp |
.Pp |
The |
The |
.Fl w |
.Fl w |
Line 360 option first appeared in |
|
Line 391 option first appeared in |
|
and |
and |
.Fl k |
.Fl k |
in |
in |
.Bx 4 ; |
.Pa /usr/usb/man |
|
in |
|
.Bx 4.0 ; |
.Fl M |
.Fl M |
in |
in |
.Bx 4.3 ; |
.Bx 4.3 ; |