version 1.19, 2016/11/08 17:05:29 |
version 1.25, 2017/03/22 13:31:49 |
|
|
.\" 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, 2015 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2010, 2011, 2014-2017 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 |
Line 96 This overrides any earlier |
|
Line 96 This overrides any earlier |
|
and |
and |
.Fl l |
.Fl l |
options. |
options. |
|
.It Fl h |
|
Display only the SYNOPSIS lines of the requested manual pages. |
|
Implies |
|
.Fl a |
|
and |
|
.Fl c . |
.It Fl I Cm os Ns = Ns Ar name |
.It Fl I Cm os Ns = Ns Ar name |
Override the default operating system |
Override the default operating system |
.Ar name |
.Ar name |
|
|
.Xr man 7 |
.Xr man 7 |
.Ic \&TH |
.Ic \&TH |
macro. |
macro. |
.It Fl h |
|
Display only the SYNOPSIS lines of the requested manual pages. |
|
Implies |
|
.Fl a |
|
and |
|
.Fl c . |
|
.It Fl K Ar encoding |
.It Fl K Ar encoding |
Specify the input encoding. |
Specify the input encoding. |
The supported |
The supported |
Line 190 For each output format, the available options are desc |
|
Line 190 For each output format, the available options are desc |
|
.Xr mandoc 1 |
.Xr mandoc 1 |
manual. |
manual. |
.It Fl S Ar subsection |
.It Fl S Ar subsection |
Restricts the directories that |
Only show pages for the specified |
.Nm |
|
will search to those of a specific |
|
.Xr machine 1 |
.Xr machine 1 |
architecture. |
architecture. |
.Ar subsection |
.Ar subsection |
Line 234 System maintenance and operation commands. |
|
Line 232 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 T Ar output |
.It Fl T Ar output |
Select the output format. |
Select the output format. |
The default is |
The default is |
|
|
.Xr mandoc 1 |
.Xr mandoc 1 |
manual for details. |
manual for details. |
.It Fl w |
.It Fl w |
List the pathnames of the manual pages which |
List the pathnames of all matching manual pages instead of displaying |
.Nm |
any of them. |
would display for the specified |
|
.Ar section |
|
and |
|
.Ar name |
|
combination. |
|
.El |
.El |
.Pp |
.Pp |
Guidelines for writing |
Guidelines for writing |
|
|
.Pa cat1/foo.0 |
.Pa cat1/foo.0 |
and |
and |
.Pa man1/foo.1 , |
.Pa man1/foo.1 , |
exist in the same directory, and at least one of them is selected, |
exist in the same directory, only the unformatted version is used. |
only the newer one is used. |
|
However, if both the |
|
.Fl a |
|
and the |
|
.Fl w |
|
options are specified, both file names are printed. |
|
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
.Bl -tag -width MANPATHX |
.Bl -tag -width MANPATHX |
.It Ev MACHINE |
.It Ev MACHINE |
Line 318 is case insensitive. |
|
Line 309 is case insensitive. |
|
.It Ev MANPAGER |
.It Ev MANPAGER |
Any non-empty value of the environment variable |
Any non-empty value of the environment variable |
.Ev MANPAGER |
.Ev MANPAGER |
will be used instead of the standard pagination program, |
is used instead of the standard pagination program, |
.Xr more 1 . |
.Xr more 1 . |
If |
If |
.Xr less 1 |
.Xr less 1 |
Line 342 information about the term last searched for with |
|
Line 333 information about the term last searched for with |
|
.It Ev MANPATH |
.It Ev MANPATH |
The standard search path used by |
The standard search path used by |
.Nm |
.Nm |
may be overridden by specifying a path in the |
may be changed by specifying a path in the |
.Ev MANPATH |
.Ev MANPATH |
environment |
environment variable. |
variable. |
|
The format of the path 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, or paths without manual databases, are ignored. |
|
Overridden by |
|
.Fl M , |
|
ignored if |
|
.Fl l |
|
is specified. |
|
.Pp |
|
If |
|
.Ev MANPATH |
|
begins with a colon, it is appended to the default list; |
|
if it ends with a colon, it is prepended to the default list; |
|
or if it contains two adjacent colons, |
|
the standard search 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 |
|
|
If neither PAGER nor MANPAGER is defined, |
If neither PAGER nor MANPAGER is defined, |
.Xr more 1 |
.Xr more 1 |
.Fl s |
.Fl s |
will be 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 |
Line 365 default man configuration file |
|
Line 375 default man configuration file |
|
.El |
.El |
.Sh EXIT STATUS |
.Sh EXIT STATUS |
.Ex -std man |
.Ex -std man |
|
See |
|
.Xr mandoc 1 |
|
for details. |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr apropos 1 , |
.Xr apropos 1 , |
.Xr intro 1 , |
.Xr intro 1 , |
.Xr whatis 1 , |
|
.Xr whereis 1 , |
.Xr whereis 1 , |
.Xr intro 2 , |
.Xr intro 2 , |
.Xr intro 3 , |
.Xr intro 3 , |
|
|
.Fl C |
.Fl C |
in |
in |
.Nx 1.0 ; |
.Nx 1.0 ; |
and |
|
.Fl s |
.Fl s |
and |
and |
.Fl S |
.Fl S |
in |
in |
.Ox 2.3 . |
.Ox 2.3 ; |
|
and |
|
.Fl I , |
|
.Fl K , |
|
.Fl l , |
|
.Fl O , |
|
and |
|
.Fl W |
|
in |
|
.Ox 5.7 . |
|
The |
|
.Fl T |
|
option first appeared in |
|
.At III |
|
and was also added in |
|
.Ox 5.7 . |