version 1.1, 2014/08/21 00:42:38 |
version 1.16, 2015/09/21 09:59:02 |
|
|
.\" $OpenBSD$ |
.\" $Id$ |
.\" |
.\" |
.\" 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) 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 achw |
.Op Fl acfhklw |
.Op Fl C Ar file |
.Op Fl C Ar file |
|
.Op Fl I Cm os Ns = Ns Ar name |
|
.Op Fl K Ar encoding |
.Op Fl M Ar path |
.Op Fl M Ar path |
.Op Fl m Ar path |
.Op Fl m Ar path |
|
.Op Fl O Ar option Ns = Ns Ar value |
.Op Fl S Ar subsection |
.Op Fl S Ar subsection |
.Op Fl s Ar section |
.Op Fl s Ar section |
|
.Op Fl T Ar output |
|
.Op Fl W Ar level |
.Op Ar section |
.Op Ar section |
.Ar name ... |
.Ar name ... |
.Nm man |
|
.Fl f Ar command ... |
|
.Nm man |
|
.Fl k Ar keyword ... |
|
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
utility |
utility |
displays the |
displays the |
.Bx |
|
manual pages entitled |
manual pages entitled |
.Ar name . |
.Ar name . |
Pages may be selected according to |
Pages may be selected according to |
Line 86 Copy the manual page to the standard output instead of |
|
Line 88 Copy the manual page to the standard output instead of |
|
.Xr more 1 |
.Xr more 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. |
.It Fl f Ar command |
.It Fl f |
A synonym for |
A synonym for |
.Xr whatis 1 . |
.Xr whatis 1 . |
It looks up a given command and |
It searches for |
gives the header line from the manual page. |
.Ar name |
.Ar command |
in manual page names and displays the header lines from all matching pages. |
is case insensitive. |
The search is case insensitive and matches whole words only. |
|
This overrides any earlier |
|
.Fl k |
|
and |
|
.Fl l |
|
options. |
|
.It Fl I Cm os Ns = Ns Ar name |
|
Override the default operating system |
|
.Ar name |
|
for the |
|
.Xr mdoc 7 |
|
.Ic \&Os |
|
and for the |
|
.Xr man 7 |
|
.Ic \&TH |
|
macro. |
.It Fl h |
.It Fl h |
Display only the |
Display only the SYNOPSIS lines of the requested manual pages. |
.Dq SYNOPSIS |
Implies |
lines of the requested manual pages. |
.Fl a |
.It Fl k Ar keyword |
and |
|
.Fl c . |
|
.It Fl K Ar encoding |
|
Specify the input encoding. |
|
The supported |
|
.Ar encoding |
|
arguments are |
|
.Cm us-ascii , |
|
.Cm iso-8859-1 , |
|
and |
|
.Cm utf-8 . |
|
By default, the encoding is automatically detected as described in the |
|
.Xr mandoc 1 |
|
manual. |
|
.It Fl k |
A synonym for |
A synonym for |
.Xr apropos 1 . |
.Xr apropos 1 . |
It shows which manual pages contain instances of any of the given |
Instead of |
keywords in their title line. |
.Ar name , |
.Ar keyword |
an expression can be provided using the syntax described in the |
is case insensitive. |
.Xr apropos 1 |
.Pp |
manual. |
For instance, |
By default, it displays the header lines of all matching pages. |
to list all man pages which contain |
This overrides any earlier |
.Dq mount |
.Fl f |
in the |
and |
.Dq NAME |
.Fl l |
line of the man page: |
options. |
.Pp |
.It Fl l |
.Dl $ man -k mount |
A synonym for |
.Pp |
.Xr mandoc 1 |
Which would produce a list much like this: |
.Fl a . |
.Bd -literal |
The |
amd (8) \(en automatically mount file systems |
.Ar name |
amq (8) \(en automounter query tool |
arguments are interpreted as filenames. |
domountroothooks (9) \(en run all mountroot hooks |
No search is done and |
exports (5) \(en define remote mount points for NFS mount requests |
.Ar file , |
getfsstat (2) \(en get list of all mounted file systems |
.Ar path , |
getmntinfo (3) \(en get information about mounted file systems |
.Ar section , |
mount (8) \(en mount file systems |
and |
mount, unmount (2) \(en mount or dismount a filesystem |
.Ar subsection |
mount_cd9660 (8) \(en mount an ISO-9660 filesystem |
are ignored. |
mount_ext2fs (8) \(en mount an ext2fs file system |
This overrides any earlier |
mount_ffs (8) \(en mount a Berkeley Fast File System |
.Fl f , |
mount_msdos (8) \(en mount an MS-DOS file system |
.Fl k , |
mount_nfs (8) \(en mount NFS file systems |
and |
mount_ntfs (8) \(en mount an NTFS file system |
.Fl w |
mount_procfs (8) \(en mount the process file system |
options. |
mount_udf (8) \(en mount a UDF filesystem |
|
mount_vnd, vnconfig (8) \(en configure vnode disks |
|
mountd (8) \(en service remote NFS mount requests |
|
\&... |
|
.Ed |
|
.It Fl M Ar path |
.It Fl M Ar path |
Override the list of standard directories which |
Override the list of standard directories which |
.Nm |
.Nm |
|
|
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 168 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, |
.It Fl O Ar option Ns = Ns Ar value |
are specified by the |
Comma-separated output options. |
.Dq _subdir |
For each output format, the available options are described in the |
line in the |
.Xr mandoc 1 |
.Nm |
manual. |
configuration file. |
|
.It Fl S Ar subsection |
.It Fl S Ar subsection |
Restricts the directories that |
Restricts the directories that |
.Nm |
.Nm |
Line 243 specifies the possible |
|
Line 262 specifies the possible |
|
.Ar section |
.Ar section |
values, and their search order. |
values, and their search order. |
Additional sections may be specified. |
Additional sections may be specified. |
|
.It Fl T Ar output |
|
Select the output format. |
|
The default is |
|
.Cm locale . |
|
The other output modes |
|
.Cm ascii , |
|
.Cm html , |
|
.Cm lint , |
|
.Cm man , |
|
.Cm pdf , |
|
.Cm ps , |
|
.Cm tree , |
|
and |
|
.Cm utf8 |
|
are described in the |
|
.Xr mandoc 1 |
|
manual. |
|
.It Fl W Ar level |
|
Specify the minimum message |
|
.Ar level |
|
to be reported on the standard error output and to affect the exit status. |
|
The |
|
.Ar level |
|
can be |
|
.Cm warning , |
|
.Cm error , |
|
or |
|
.Cm unsupp ; |
|
.Cm all |
|
is an alias for |
|
.Cm warning . |
|
By default, |
|
.Nm |
|
is silent. |
|
See the |
|
.Xr mandoc 1 |
|
manual for details. |
.It Fl w |
.It Fl w |
List the pathnames of the manual pages which |
List the pathnames of the manual pages which |
.Nm |
.Nm |
|
|
combination. |
combination. |
.El |
.El |
.Pp |
.Pp |
Guidelines for |
Guidelines for writing |
.Ox |
|
man pages can be found in |
man pages can be found in |
.Xr mdoc 7 . |
.Xr mdoc 7 . |
.Pp |
.Pp |
Line 293 Any non-empty value of the environment variable |
|
Line 348 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 347 utility is compliant with the |
|
Line 404 utility is compliant with the |
|
specification. |
specification. |
.Pp |
.Pp |
The flags |
The flags |
.Op Fl aCcfhMmSsw , |
.Op Fl aCcfhIKlMmOSsTWw , |
as well as the environment variables |
as well as the environment variables |
.Ev MACHINE , |
.Ev MACHINE , |
.Ev MANPAGER , |
.Ev MANPAGER , |