xref: /csrg-svn/usr.bin/man/man.1 (revision 62102)
1*62102Sbostic.\" Copyright (c) 1989, 1990, 1993
2*62102Sbostic.\"	The Regents of the University of California.  All rights reserved.
319207Smckusick.\"
448283Sbostic.\" %sccs.include.redist.roff%
519207Smckusick.\"
6*62102Sbostic.\"     @(#)man.1	8.1 (Berkeley) 06/06/93
748283Sbostic.\"
848838Scael.Dd
948838Scael.Dt MAN 1
1048838Scael.Os BSD 4
1148838Scael.Sh NAME
1248838Scael.Nm man
1348838Scael.Nd display the on-line manual pages
1448838Scael.Sh SYNOPSIS
1548838Scael.Nm man
1648838Scael.Op Fl achw
1748838Scael.Op Fl M Ar path
1848838Scael.Op Fl m Ar path
1948838Scael.Op Ar section
2048838Scael.Ar name Ar ...
2148838Scael.Sh DESCRIPTION
2248838ScaelThe
2348838Scael.Nm man
2448838Scaelutility
2548838Scaeldisplays the
2648838Scael.Bx
2748838Scaelmanual pages entitled
2848838Scael.Ar name .
2948838Scael.Pp
3040390SbosticThe options are as follows:
3148838Scael.Bl -tag -width indent
3248838Scael.It Fl a
3340390SbosticDisplay all of the manual pages for a specified
3448838Scael.Ar section
3542402Sbosticand
3648838Scael.Ar name
3742402Sbosticcombination.
3840390Sbostic(Normally, only the first manual page found is displayed.)
3948838Scael.It Fl c
4040390SbosticCopy the manual page to the standard output instead of using
4148838Scael.Xr more 1
4240390Sbosticto paginate it.
4340390SbosticThis is done by default if the standard output is not a terminal device.
4448838Scael.It Fl h
4548838ScaelDisplay only the
4648838Scael.Dq Tn SYNOPSIS
4748838Scaellines of the requested manual pages.
4848838Scael.It Fl M
4942402SbosticOverride the list of standard directories which
5048838Scael.Nm man
5140390Sbosticsearches for manual pages.
5240390SbosticThe supplied
5348838Scael.Ar path
5440390Sbosticmust be a colon (``:'') separated list of directories.
5543726ScaelThis search path may also be set using the environment variable
5648838Scael.Ev MANPATH .
5744418StrentThe subdirectories to be searched as well as their search order
5844418Strentis specified by the ``_subdir'' line in the
5948838Scael.Nm man
6044418Strentconfiguration file.
6148838Scael.It Fl m
6242402SbosticAugment the list of standard directories which
6348838Scael.Nm man
6440390Sbosticsearches for manual pages.
6540390SbosticThe supplied
6648838Scael.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
7048838Scael.Fl M
7140390Sbosticoption or the
7248838Scael.Ev MANPATH
7343726Scaelenvironment variable.
7448838Scael.It Fl w
7542402SbosticList the pathnames of the manual pages which
7648838Scael.Nm man
7740390Sbosticwould display for the specified
7848838Scael.Ar section
7942402Sbosticand
8048838Scael.Ar name
8142402Sbosticcombination.
8248838Scael.El
8348838Scael.Pp
8442402SbosticThe optional
8548838Scael.Ar section
8642402Sbosticrestricts the directories that
8748838Scael.Nm man
8842402Sbosticwill search.
8942402SbosticThe
9048838Scael.Nm man
9142402Sbosticconfiguration file (see
9248838Scael.Xr man_conf 5 )
9342402Sbosticspecifies the possible
9448838Scael.Ar section
9542402Sbosticvalues that are currently available.
9642402SbosticIf only a single argument is specified or if the first argument is
9742402Sbosticnot a valid section,
9848838Scael.Nm man
9942402Sbosticassumes that the argument is the name of a manual page to be displayed.
10048838Scael.Sh ENVIRONMENT
10148838Scael.Bl -tag -width MANPATHX
10248838Scael.It Ev MACHINE
10340390SbosticAs some manual pages are intended only for use on certain architectures,
10448838Scael.Nm man
10542402Sbosticsearches certain directories applicable to the current machine.
10648838ScaelMan's
10740390Sbosticdetermination of the current machine type may be overridden by setting
10848838Scaelthe environment variable
10948838Scael.Ev MACHINE
11048838Scaelto the name of an architecture (see
11148838Scael.Xr machine 1 ) .
11240390SbosticMachine specific areas are checked before general areas.
11348838Scael.It Ev MANPATH
11440390SbosticThe standard search path used by
11548838Scael.Nm man
11648838Scaelmay be overridden by specifying a path in the
11748838Scael.Ev MANPATH
11848838Scaelenvironment
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
12348838Scael.Nm man
12444418Strentconfiguration file.
12548838Scael.It Ev PAGER
12643726ScaelAny value of the environment variable
12748838Scael.Ev PAGER
12840390Sbosticwill be used instead of the standard pagination program
12948838Scael.Xr more 1 .
13048838Scael.El
13148838Scael.Sh FILES
13248838Scael.Bl -tag -width /etc/man.conf -compact
13348838Scael.It Pa /etc/man.conf
13448838Scaelman configuration file (see
13548838Scael.Xr man_conf 5 )
13648838Scael.El
13748838Scael.Sh SEE ALSO
13848838Scael.Xr apropos 1 ,
13948838Scael.Xr machine 1 ,
14048838Scael.Xr whatis 1 ,
14148838Scael.Xr whereis 1 ,
14248838Scael.Xr man_conf 5
14348838Scael.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.
14748838Scael.Sh HISTORY
14848838ScaelA
14948838Scael.Nm
15048838Scaelcommand appeared in
15148838Scael.At v6 .
152