148283Sbostic.\" Copyright (c) 1989, 1990 The Regents of the University of California. 248283Sbostic.\" All rights reserved. 319207Smckusick.\" 448283Sbostic.\" %sccs.include.redist.roff% 519207Smckusick.\" 6*48838Scael.\" @(#)man.1 6.14 (Berkeley) 04/29/91 748283Sbostic.\" 8*48838Scael.Dd 9*48838Scael.Dt MAN 1 10*48838Scael.Os BSD 4 11*48838Scael.Sh NAME 12*48838Scael.Nm man 13*48838Scael.Nd display the on-line manual pages 14*48838Scael.Sh SYNOPSIS 15*48838Scael.Nm man 16*48838Scael.Op Fl achw 17*48838Scael.Op Fl M Ar path 18*48838Scael.Op Fl m Ar path 19*48838Scael.Op Ar section 20*48838Scael.Ar name Ar ... 21*48838Scael.Sh DESCRIPTION 22*48838ScaelThe 23*48838Scael.Nm man 24*48838Scaelutility 25*48838Scaeldisplays the 26*48838Scael.Bx 27*48838Scaelmanual pages entitled 28*48838Scael.Ar name . 29*48838Scael.Pp 3040390SbosticThe options are as follows: 31*48838Scael.Bl -tag -width indent 32*48838Scael.It Fl a 3340390SbosticDisplay all of the manual pages for a specified 34*48838Scael.Ar section 3542402Sbosticand 36*48838Scael.Ar name 3742402Sbosticcombination. 3840390Sbostic(Normally, only the first manual page found is displayed.) 39*48838Scael.It Fl c 4040390SbosticCopy the manual page to the standard output instead of using 41*48838Scael.Xr more 1 4240390Sbosticto paginate it. 4340390SbosticThis is done by default if the standard output is not a terminal device. 44*48838Scael.It Fl h 45*48838ScaelDisplay only the 46*48838Scael.Dq Tn SYNOPSIS 47*48838Scaellines of the requested manual pages. 48*48838Scael.It Fl M 4942402SbosticOverride the list of standard directories which 50*48838Scael.Nm man 5140390Sbosticsearches for manual pages. 5240390SbosticThe supplied 53*48838Scael.Ar path 5440390Sbosticmust be a colon (``:'') separated list of directories. 5543726ScaelThis search path may also be set using the environment variable 56*48838Scael.Ev MANPATH . 5744418StrentThe subdirectories to be searched as well as their search order 5844418Strentis specified by the ``_subdir'' line in the 59*48838Scael.Nm man 6044418Strentconfiguration file. 61*48838Scael.It Fl m 6242402SbosticAugment the list of standard directories which 63*48838Scael.Nm man 6440390Sbosticsearches for manual pages. 6540390SbosticThe supplied 66*48838Scael.Ar path 6740390Sbosticmust be a colon (``:'') separated list of directories. 6840390SbosticThese directories will be searched before the standard directories or 6942402Sbosticthe directories specified using the 70*48838Scael.Fl M 7140390Sbosticoption or the 72*48838Scael.Ev MANPATH 7343726Scaelenvironment variable. 74*48838Scael.It Fl w 7542402SbosticList the pathnames of the manual pages which 76*48838Scael.Nm man 7740390Sbosticwould display for the specified 78*48838Scael.Ar section 7942402Sbosticand 80*48838Scael.Ar name 8142402Sbosticcombination. 82*48838Scael.El 83*48838Scael.Pp 8442402SbosticThe optional 85*48838Scael.Ar section 8642402Sbosticrestricts the directories that 87*48838Scael.Nm man 8842402Sbosticwill search. 8942402SbosticThe 90*48838Scael.Nm man 9142402Sbosticconfiguration file (see 92*48838Scael.Xr man_conf 5 ) 9342402Sbosticspecifies the possible 94*48838Scael.Ar section 9542402Sbosticvalues that are currently available. 9642402SbosticIf only a single argument is specified or if the first argument is 9742402Sbosticnot a valid section, 98*48838Scael.Nm man 9942402Sbosticassumes that the argument is the name of a manual page to be displayed. 100*48838Scael.Sh ENVIRONMENT 101*48838Scael.Bl -tag -width MANPATHX 102*48838Scael.It Ev MACHINE 10340390SbosticAs some manual pages are intended only for use on certain architectures, 104*48838Scael.Nm man 10542402Sbosticsearches certain directories applicable to the current machine. 106*48838ScaelMan's 10740390Sbosticdetermination of the current machine type may be overridden by setting 108*48838Scaelthe environment variable 109*48838Scael.Ev MACHINE 110*48838Scaelto the name of an architecture (see 111*48838Scael.Xr machine 1 ) . 11240390SbosticMachine specific areas are checked before general areas. 113*48838Scael.It Ev MANPATH 11440390SbosticThe standard search path used by 115*48838Scael.Nm man 116*48838Scaelmay be overridden by specifying a path in the 117*48838Scael.Ev MANPATH 118*48838Scaelenvironment 11942402Sbosticvariable. 12040390SbosticThe format of the path is a colon (``:'') separated list of directories. 12144418StrentThe subdirectories to be searched as well as their search order 12244418Strentis specified by the ``_subdir'' line in the 123*48838Scael.Nm man 12444418Strentconfiguration file. 125*48838Scael.It Ev PAGER 12643726ScaelAny value of the environment variable 127*48838Scael.Ev PAGER 12840390Sbosticwill be used instead of the standard pagination program 129*48838Scael.Xr more 1 . 130*48838Scael.El 131*48838Scael.Sh FILES 132*48838Scael.Bl -tag -width /etc/man.conf -compact 133*48838Scael.It Pa /etc/man.conf 134*48838Scaelman configuration file (see 135*48838Scael.Xr man_conf 5 ) 136*48838Scael.El 137*48838Scael.Sh SEE ALSO 138*48838Scael.Xr apropos 1 , 139*48838Scael.Xr machine 1 , 140*48838Scael.Xr whatis 1 , 141*48838Scael.Xr whereis 1 , 142*48838Scael.Xr man_conf 5 143*48838Scael.Sh BUGS 14440390SbosticThe on-line manual pages are, by necessity, forgiving toward stupid 14540390Sbosticdisplay devices, causing some manual pages to not be as good as their 14640390Sbostictypeset counterparts. 147*48838Scael.Sh HISTORY 148*48838ScaelA 149*48838Scael.Nm 150*48838Scaelcommand appeared in 151*48838Scael.At v6 . 152