1.\" $NetBSD: man.1,v 1.14 2001/12/01 16:43:19 wiz Exp $ 2.\" 3.\" Copyright (c) 1989, 1990, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)man.1 8.2 (Berkeley) 1/2/94 35.\" 36.Dd January 2, 1994 37.Dt MAN 1 38.Os 39.Sh NAME 40.Nm man 41.Nd display the on-line manual pages 42.Pq aka Dq Em man pages 43.Sh SYNOPSIS 44.Nm "" 45.Oo Fl acw Ns \&| Ns Fl h Oc 46.Op Fl C Ar file 47.Op Fl M Ar path 48.Op Fl m Ar path 49.Op Fl S Ar srch 50.Oo 51.Op Fl s 52.Ar section 53.Oc 54.Ar name Ar ... 55.Nm "" 56.Op Fl k 57.Op Fl C Ar file 58.Op Fl M Ar path 59.Op Fl m Ar path 60.Ar keyword Ar ... 61.Sh DESCRIPTION 62The 63.Nm 64utility 65displays the 66.Bx 67man pages entitled 68.Ar name . 69.Pp 70The options are as follows: 71.Bl -tag -width indent 72.It Fl a 73Display all of the man pages for a specified 74.Ar section 75and 76.Ar name 77combination. 78(Normally, only the first man page found is displayed.) 79.It Fl C 80Use the specified 81.Ar file 82instead of the default configuration file. 83This permits users to configure their own man environment. 84See 85.Xr man.conf 5 86for a description of the contents of this file. 87.It Fl c 88Copy the man page to the standard output instead of using 89.Xr more 1 90to paginate it. 91This is done by default if the standard output is not a terminal device. 92.It Fl h 93Display only the 94.Dq Tn SYNOPSIS 95lines of the requested man pages, 96in the same manner as 97.Xr whatis 1 . 98.It Fl k 99Display the header lines for any man pages matching 100.Ar keyword Ns Pq s , 101in the same manner as 102.Xr apropos 1 . 103.It Fl M 104Override the list of standard directories which 105.Nm 106searches for man pages. 107The supplied 108.Ar path 109must be a colon (``:'') separated list of directories. 110This search path may also be set using the environment variable 111.Ev MANPATH . 112The subdirectories to be searched, and their search order, 113is specified by the ``_subdir'' line in the 114.Nm 115configuration file. 116.It Fl m 117Augment the list of standard directories which 118.Nm 119searches for man pages. 120The supplied 121.Ar path 122must be a colon (``:'') separated list of directories. 123These directories will be searched before the standard directories or 124the directories specified using the 125.Fl M 126option or the 127.Ev MANPATH 128environment variable. 129The subdirectories to be searched, and their search order, 130is specified by the ``_subdir'' line in the 131.Nm 132configuration file. 133.It Fl s 134Restrict the directories that 135.Nm 136will search. The 137.Nm 138configuration file (see 139.Xr man.conf 5 ) 140specifies the possible 141.Ar section 142values that are currently available. 143.It Fl S 144Display only man pages that have the specified string in their 145filenames. This allows the man page search process criteria to be 146narrowed without having to change the MANPATH or ``_default'' 147variables. 148.It Fl w 149List the pathnames of the man pages which 150.Nm 151would display for the specified 152.Ar section 153and 154.Ar name 155combination. 156.El 157.Pp 158If the 159.Ql Fl s 160option is not specified, 161there is more than one argument, 162the 163.Ql Fl k 164option is not used and the first argument is a valid section, that 165argument will be used as if specified by the 166.Ql Fl s 167option. 168.Sh ENVIRONMENT 169.Bl -tag -width MANPATHX 170.It Ev MACHINE 171As some man pages are intended only for specific architectures, 172.Nm 173searches any subdirectories, 174with the same name as the current architecture, 175in every directory which it searches. 176Machine specific areas are checked before general areas. 177The current machine type may be overridden by setting the environment 178variable 179.Ev MACHINE 180to the name of a specific architecture. 181.It Ev MANPATH 182The standard search path used by 183.Nm 184may be overridden by specifying a path in the 185.Ev MANPATH 186environment 187variable. 188The format of the path is a colon (``:'') separated list of directories. 189The subdirectories to be searched as well as their search order 190is specified by the ``_subdir'' line in the 191.Nm 192configuration file. 193.It Ev PAGER 194The pagination command used for writing the output. 195If the 196.Ev PAGER 197environment variable is null or not set, the standard pagination program 198.Xr more 1 199will be used. 200.El 201.Sh FILES 202.Bl -hang -width /etc/man.conf -compact 203.It Pa /etc/man.conf 204default man configuration file. 205.It Pa /usr/{share,X11R6,pkg,local}/man/whatis.db 206standard whatis/apropos database search path, 207set in 208.Pa /etc/man.conf Ns . 209.El 210.Sh SEE ALSO 211.Xr apropos 1 , 212.Xr whatis 1 , 213.Xr whereis 1 , 214.Xr man.conf 5 , 215.Xr mdoc 7 , 216.Xr mdoc.samples 7 217.Sh STANDARDS 218.Nm "" 219conforms to 220.St -xcu5 . 221.\"and is expected to conform to 222.\".St -p1003.2-?? . 223.Sh BUGS 224The on-line man pages are, by necessity, forgiving toward stupid 225display devices, causing a few man pages to be not as nicely formatted 226as their typeset counterparts. 227