version 1.9, 2014/12/18 21:11:46 |
version 1.17, 2016/07/01 20:24:04 |
|
|
.\" 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 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2010, 2011, 2014, 2015 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 |
|
|
.Nd display manual pages |
.Nd display manual pages |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm man |
.Nm man |
.Op Fl acfhklVw |
.Op Fl acfhklw |
.Op Fl C Ar file |
.Op Fl C Ar file |
.Op Fl I Cm os Ns = Ns Ar name |
.Op Fl I Cm os Ns = Ns Ar name |
.Op Fl K Ar encoding |
.Op Fl K Ar encoding |
Line 106 Override the default operating system |
|
Line 106 Override the default operating system |
|
for the |
for the |
.Xr mdoc 7 |
.Xr mdoc 7 |
.Ic \&Os |
.Ic \&Os |
|
and for the |
|
.Xr man 7 |
|
.Ic \&TH |
macro. |
macro. |
.It Fl h |
.It Fl h |
Display only the SYNOPSIS lines of the requested manual pages. |
Display only the SYNOPSIS lines of the requested manual pages. |
|
|
separated list of directories. |
separated list of directories. |
This search path may also be set using the environment variable |
This search path may also be set using the environment variable |
.Ev MANPATH . |
.Ev MANPATH . |
The subdirectories to be searched, and their search order, |
|
are specified by the |
|
.Dq _subdir |
|
line in the |
|
.Nm |
|
configuration file. |
|
.It Fl m Ar path |
.It Fl m Ar path |
Augment the list of standard directories which |
Augment the list of standard directories which |
.Nm |
.Nm |
Line 191 the directories specified using the |
|
Line 188 the directories specified using the |
|
option or the |
option or the |
.Ev MANPATH |
.Ev MANPATH |
environment variable. |
environment variable. |
The subdirectories to be searched, and their search order, |
|
are specified by the |
|
.Dq _subdir |
|
line in the |
|
.Nm |
|
configuration file. |
|
.It Fl O Ar option Ns = Ns Ar value |
.It Fl O Ar option Ns = Ns Ar value |
Comma-separated output options. |
Comma-separated output options. |
For each output format, the available options are described in the |
For each output format, the available options are described in the |
Line 218 architecture whilst using another. |
|
Line 209 architecture whilst using another. |
|
This option overrides the |
This option overrides the |
.Ev MACHINE |
.Ev MACHINE |
environment variable. |
environment variable. |
.It Xo |
.It Oo Fl s Oc Ar section |
.Op Fl s |
Only select manuals from the specified |
.Ar section |
.Ar section . |
.Xc |
|
Restricts the directories that |
|
.Nm |
|
will search to a specific section. |
|
The currently available sections are: |
The currently available sections are: |
.Pp |
.Pp |
.Bl -tag -width "localXXX" -offset indent -compact |
.Bl -tag -width "localXXX" -offset indent -compact |
Line 234 General commands |
|
Line 221 General commands |
|
.It 2 |
.It 2 |
System calls and error numbers. |
System calls and error numbers. |
.It 3 |
.It 3 |
Libraries. |
Library functions. |
.It 3f |
|
Fortran programmer's reference guide. |
|
.It 3p |
.It 3p |
.Xr perl 1 |
.Xr perl 1 |
programmer's reference guide. |
programmer's reference guide. |
|
|
.It 6 |
.It 6 |
Games. |
Games. |
.It 7 |
.It 7 |
Miscellaneous. |
Miscellaneous information. |
.It 8 |
.It 8 |
System maintenance and operation commands. |
System maintenance and operation commands. |
.It 9 |
.It 9 |
Kernel internals. |
Kernel internals. |
.It X11 |
|
An alias for X11R6. |
|
.It X11R6 |
|
X Window System. |
|
.It local |
|
Pages located in |
|
.Pa /usr/local . |
|
.It n |
|
Tcl/Tk commands. |
|
.El |
.El |
.Pp |
|
The |
|
.Nm |
|
configuration file, |
|
.Xr man.conf 5 , |
|
specifies the possible |
|
.Ar section |
|
values, and their search order. |
|
Additional sections may be specified. |
|
.It Fl T Ar output |
.It Fl T Ar output |
Select the output format. |
Select the output format. |
The default is |
The default is |
|
|
are described in the |
are described in the |
.Xr mandoc 1 |
.Xr mandoc 1 |
manual. |
manual. |
.It Fl V |
|
Print version and exit. |
|
.It Fl W Ar level |
.It Fl W Ar level |
Specify the minimum message |
Specify the minimum message |
.Ar level |
.Ar level |
|
|
.Cm warning , |
.Cm warning , |
.Cm error , |
.Cm error , |
or |
or |
.Cm fatal . |
.Cm unsupp ; |
The default is |
|
.Cm fatal ; |
|
.Cm all |
.Cm all |
is an alias for |
is an alias for |
.Cm warning . |
.Cm warning . |
|
By default, |
|
.Nm |
|
is silent. |
See the |
See the |
.Xr mandoc 1 |
.Xr mandoc 1 |
manual for details. |
manual for details. |
Line 358 Any non-empty value of the environment variable |
|
Line 324 Any non-empty value of the environment variable |
|
.Ev MANPAGER |
.Ev MANPAGER |
will be used instead of the standard pagination program, |
will be used instead of the standard pagination program, |
.Xr more 1 . |
.Xr more 1 . |
|
If |
|
.Xr less 1 |
|
is used, the interactive |
|
.Ic :t |
|
command can be used to go to the definitions of various terms, for |
|
example command line options, command modifiers, internal commands, |
|
and environment variables. |
.It Ev MANPATH |
.It Ev MANPATH |
The standard search path used by |
The standard search path used by |
.Nm |
.Nm |
|
|
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. |
The subdirectories to be searched, as well as their search order, |
|
are specified by the |
|
.Dq _subdir |
|
line in the |
|
.Nm |
|
configuration file. |
|
.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, |
.Pa /usr/bin/more Fl s |
.Xr more 1 |
|
.Fl s |
will be used. |
will be used. |
.El |
.El |
.Sh FILES |
.Sh FILES |
Line 412 utility is compliant with the |
|
Line 380 utility is compliant with the |
|
specification. |
specification. |
.Pp |
.Pp |
The flags |
The flags |
.Op Fl aCcfhIKlMmOSsTVWw , |
.Op Fl aCcfhIKlMmOSsTWw , |
as well as the environment variables |
as well as the environment variables |
.Ev MACHINE , |
.Ev MACHINE , |
.Ev MANPAGER , |
.Ev MANPAGER , |