1.\" $NetBSD: man.1,v 1.6 1998/04/12 07:39:17 fair 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 BSD 4 39.Sh NAME 40.Nm man 41.Nd display the on-line manual pages 42.Sh SYNOPSIS 43.Nm 44.Op Fl achw 45.Op Fl C Ar file 46.Op Fl M Ar path 47.Op Fl m Ar path 48.Op Ar section 49.Ar name Ar ... 50.Sh DESCRIPTION 51The 52.Nm 53utility 54displays the 55.Bx 56manual pages entitled 57.Ar name . 58.Pp 59The options are as follows: 60.Bl -tag -width indent 61.It Fl a 62Display all of the manual pages for a specified 63.Ar section 64and 65.Ar name 66combination. 67(Normally, only the first manual page found is displayed.) 68.It Fl C 69Use the specified 70.Ar file 71instead of the default configuration file. 72This permits users to configure their own manual environment. 73See 74.Xr man.conf 5 75for a description of the contents of this file. 76.It Fl c 77Copy the manual page to the standard output instead of using 78.Xr more 1 79to paginate it. 80This is done by default if the standard output is not a terminal device. 81.It Fl h 82Display only the 83.Dq Tn SYNOPSIS 84lines of the requested manual pages. 85.It Fl M 86Override the list of standard directories which 87.Nm 88searches for manual pages. 89The supplied 90.Ar path 91must be a colon (``:'') separated list of directories. 92This search path may also be set using the environment variable 93.Ev MANPATH . 94The subdirectories to be searched, and their search order, 95is specified by the ``_subdir'' line in the 96.Nm 97configuration file. 98.It Fl m 99Augment the list of standard directories which 100.Nm 101searches for manual pages. 102The supplied 103.Ar path 104must be a colon (``:'') separated list of directories. 105These directories will be searched before the standard directories or 106the directories specified using the 107.Fl M 108option or the 109.Ev MANPATH 110environment variable. 111The subdirectories to be searched, and their search order, 112is specified by the ``_subdir'' line in the 113.Nm 114configuration file. 115.It Fl w 116List the pathnames of the manual pages which 117.Nm 118would display for the specified 119.Ar section 120and 121.Ar name 122combination. 123.El 124.Pp 125The optional 126.Ar section 127argument restricts the directories that 128.Nm 129will search. 130The 131.Nm 132configuration file (see 133.Xr man.conf 5 ) 134specifies the possible 135.Ar section 136values that are currently available. 137If only a single argument is specified or if the first argument is 138not a valid section, 139.Nm 140assumes that the argument is the name of a manual page to be displayed. 141.Sh ENVIRONMENT 142.Bl -tag -width MANPATHX 143.It Ev MACHINE 144As some manual pages are intended only for specific architectures, 145.Nm 146searches any subdirectories, 147with the same name as the current architecture, 148in every directory which it searches. 149Machine specific areas are checked before general areas. 150The current machine type may be overridden by setting the environment 151variable 152.Ev MACHINE 153to the name of a specific architecture. 154.It Ev MANPATH 155The standard search path used by 156.Nm 157may be overridden by specifying a path in the 158.Ev MANPATH 159environment 160variable. 161The format of the path is a colon (``:'') separated list of directories. 162The subdirectories to be searched as well as their search order 163is specified by the ``_subdir'' line in the 164.Nm 165configuration file. 166.It Ev PAGER 167Any value of the environment variable 168.Ev PAGER 169will be used instead of the standard pagination program, 170.Xr more 1 . 171.El 172.Sh FILES 173.Bl -tag -width /etc/man.conf -compact 174.It Pa /etc/man.conf 175default man configuration file. 176.El 177.Sh SEE ALSO 178.Xr apropos 1 , 179.Xr whatis 1 , 180.Xr whereis 1 , 181.Xr man.conf 5 , 182.Xr mdoc 7 , 183.Xr mdoc.samples 7 184.Sh BUGS 185The on-line manual pages are, by necessity, forgiving toward stupid 186display devices, causing a few manual pages to be not as nicely formatted 187as their typeset counterparts. 188.Sh HISTORY 189A 190.Nm 191command appeared in 192.At v6 . 193