xref: /minix3/usr.bin/man/man.1 (revision 0a6a1f1d05b60e214de2f05a7310ddd1f0e590e7)
1*0a6a1f1dSLionel Sambuc.\"	$NetBSD: man.1,v 1.28 2014/08/14 15:44:47 apb Exp $
20c3983b2SBen Gras.\"
30c3983b2SBen Gras.\" Copyright (c) 1989, 1990, 1993
40c3983b2SBen Gras.\"	The Regents of the University of California.  All rights reserved.
50c3983b2SBen Gras.\"
60c3983b2SBen Gras.\" Redistribution and use in source and binary forms, with or without
70c3983b2SBen Gras.\" modification, are permitted provided that the following conditions
80c3983b2SBen Gras.\" are met:
90c3983b2SBen Gras.\" 1. Redistributions of source code must retain the above copyright
100c3983b2SBen Gras.\"    notice, this list of conditions and the following disclaimer.
110c3983b2SBen Gras.\" 2. Redistributions in binary form must reproduce the above copyright
120c3983b2SBen Gras.\"    notice, this list of conditions and the following disclaimer in the
130c3983b2SBen Gras.\"    documentation and/or other materials provided with the distribution.
140c3983b2SBen Gras.\" 3. Neither the name of the University nor the names of its contributors
150c3983b2SBen Gras.\"    may be used to endorse or promote products derived from this software
160c3983b2SBen Gras.\"    without specific prior written permission.
170c3983b2SBen Gras.\"
180c3983b2SBen Gras.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
190c3983b2SBen Gras.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
200c3983b2SBen Gras.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
210c3983b2SBen Gras.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
220c3983b2SBen Gras.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
230c3983b2SBen Gras.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
240c3983b2SBen Gras.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
250c3983b2SBen Gras.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
260c3983b2SBen Gras.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
270c3983b2SBen Gras.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
280c3983b2SBen Gras.\" SUCH DAMAGE.
290c3983b2SBen Gras.\"
300c3983b2SBen Gras.\"     @(#)man.1	8.2 (Berkeley) 1/2/94
310c3983b2SBen Gras.\"
32*0a6a1f1dSLionel Sambuc.Dd August 14, 2014
330c3983b2SBen Gras.Dt MAN 1
340c3983b2SBen Gras.Os
350c3983b2SBen Gras.Sh NAME
360c3983b2SBen Gras.Nm man
370c3983b2SBen Gras.Nd display the on-line manual pages
380c3983b2SBen Gras.Pq aka Dq Em man pages
390c3983b2SBen Gras.Sh SYNOPSIS
400c3983b2SBen Gras.Nm
410c3983b2SBen Gras.Oo Fl acw Ns \&| Ns Fl h Oc
420c3983b2SBen Gras.Op Fl C Ar file
430c3983b2SBen Gras.Op Fl M Ar path
440c3983b2SBen Gras.Op Fl m Ar path
450c3983b2SBen Gras.Op Fl S Ar srch
460c3983b2SBen Gras.Oo
470c3983b2SBen Gras.Op Fl s
480c3983b2SBen Gras.Ar section
490c3983b2SBen Gras.Oc
500c3983b2SBen Gras.Ar name Ar ...
510c3983b2SBen Gras.Nm
52b9a6a72bSLionel Sambuc.Fl k
530c3983b2SBen Gras.Op Fl C Ar file
540c3983b2SBen Gras.Op Fl M Ar path
550c3983b2SBen Gras.Op Fl m Ar path
560c3983b2SBen Gras.Ar keyword Ar ...
57b9a6a72bSLionel Sambuc.Nm
58b9a6a72bSLionel Sambuc.Fl p
590c3983b2SBen Gras.Sh DESCRIPTION
600c3983b2SBen GrasThe
610c3983b2SBen Gras.Nm
620c3983b2SBen Grasutility displays the manual pages named on the command line.
630c3983b2SBen GrasIts options are as follows:
640c3983b2SBen Gras.Bl -tag -width indent
650c3983b2SBen Gras.It Fl a
660c3983b2SBen GrasDisplay all of the man pages for a specified
670c3983b2SBen Gras.Ar section
680c3983b2SBen Grasand
690c3983b2SBen Gras.Ar name
700c3983b2SBen Grascombination.
710c3983b2SBen Gras(Normally, only the first man page found is displayed.)
720c3983b2SBen Gras.It Fl C
730c3983b2SBen GrasUse the specified
740c3983b2SBen Gras.Ar file
750c3983b2SBen Grasinstead of the default configuration file.
760c3983b2SBen GrasThis permits users to configure their own man environment.
770c3983b2SBen GrasSee
780c3983b2SBen Gras.Xr man.conf 5
790c3983b2SBen Grasfor a description of the contents of this file.
800c3983b2SBen Gras.It Fl c
810c3983b2SBen GrasCopy the man page to the standard output instead of using
820c3983b2SBen Gras.Xr more 1
830c3983b2SBen Grasto paginate it.
840c3983b2SBen GrasThis is done by default if the standard output is not a terminal device.
850c3983b2SBen Gras.It Fl h
860c3983b2SBen GrasDisplay only the
870c3983b2SBen Gras.Dq Tn SYNOPSIS
880c3983b2SBen Graslines of the requested man pages.
890c3983b2SBen GrasFor commands, this is typically the command line usage information.
900c3983b2SBen GrasFor library functions, this usually contains the required include
910c3983b2SBen Grasfiles and function prototypes.
920c3983b2SBen Gras.It Fl k
930c3983b2SBen GrasDisplay the header lines for any man pages matching
940c3983b2SBen Gras.Ar keyword Ns Pq s ,
950c3983b2SBen Grasin the same manner as
960c3983b2SBen Gras.Xr apropos 1 .
970c3983b2SBen Gras.It Fl M
980c3983b2SBen GrasOverride the list of standard directories which
990c3983b2SBen Gras.Nm
1000c3983b2SBen Grassearches for man pages.
1010c3983b2SBen GrasThe supplied
1020c3983b2SBen Gras.Ar path
1030c3983b2SBen Grasmust be a colon
1040c3983b2SBen Gras.Pq Dq \&:
1050c3983b2SBen Grasseparated list of directories.
1060c3983b2SBen GrasThis search path may also be set using the environment variable
1070c3983b2SBen Gras.Ev MANPATH .
1080c3983b2SBen GrasThe subdirectories to be searched, and their search order,
1090c3983b2SBen Grasis specified by the
1100c3983b2SBen Gras.Dq _subdir
1110c3983b2SBen Grasline in the
1120c3983b2SBen Gras.Nm
1130c3983b2SBen Grasconfiguration file.
1140c3983b2SBen Gras.It Fl m
1150c3983b2SBen GrasAugment the list of standard directories which
1160c3983b2SBen Gras.Nm
1170c3983b2SBen Grassearches for man pages.
1180c3983b2SBen GrasThe supplied
1190c3983b2SBen Gras.Ar path
1200c3983b2SBen Grasmust be a colon
1210c3983b2SBen Gras.Pq Dq \&:
1220c3983b2SBen Grasseparated list of directories.
1230c3983b2SBen GrasThese directories will be searched before the standard directories or
1240c3983b2SBen Grasthe directories specified using the
1250c3983b2SBen Gras.Fl M
1260c3983b2SBen Grasoption or the
1270c3983b2SBen Gras.Ev MANPATH
1280c3983b2SBen Grasenvironment variable.
1290c3983b2SBen GrasThe subdirectories to be searched, and their search order,
1300c3983b2SBen Grasis specified by the
1310c3983b2SBen Gras.Dq _subdir
1320c3983b2SBen Grasline in the
1330c3983b2SBen Gras.Nm
1340c3983b2SBen Grasconfiguration file.
135b9a6a72bSLionel Sambuc.It Fl p
136b9a6a72bSLionel SambucPrint the search path for the manual pages.
1370c3983b2SBen Gras.It Fl s
1380c3983b2SBen GrasRestrict the directories that
1390c3983b2SBen Gras.Nm
1400c3983b2SBen Graswill search to the specified section.
1410c3983b2SBen GrasThe
1420c3983b2SBen Gras.Nm
1430c3983b2SBen Grasconfiguration file (see
1440c3983b2SBen Gras.Xr man.conf 5 )
1450c3983b2SBen Grasspecifies the possible
1460c3983b2SBen Gras.Ar section
1470c3983b2SBen Grasvalues that are currently available.
1480c3983b2SBen Gras.It Fl S
1490c3983b2SBen GrasDisplay only man pages that have the specified string in the directory
1500c3983b2SBen Graspart of their filenames.
1510c3983b2SBen GrasThis allows the man page search process criteria to be
1520c3983b2SBen Grasnarrowed without having to change the MANPATH or
1530c3983b2SBen Gras.Dq _default
1540c3983b2SBen Grasvariables.
1550c3983b2SBen Gras.It Fl w
1560c3983b2SBen GrasList the pathnames of the man pages which
1570c3983b2SBen Gras.Nm
1580c3983b2SBen Graswould display for the specified
1590c3983b2SBen Gras.Ar section
1600c3983b2SBen Grasand
1610c3983b2SBen Gras.Ar name
1620c3983b2SBen Grascombination.
1630c3983b2SBen Gras.El
1640c3983b2SBen Gras.Pp
1650c3983b2SBen GrasIf the
1660c3983b2SBen Gras.Ql Fl s
1670c3983b2SBen Grasoption is not specified,
1680c3983b2SBen Grasthere is more than one argument,
1690c3983b2SBen Grasthe
1700c3983b2SBen Gras.Ql Fl k
1710c3983b2SBen Grasoption is not used, and the first argument is a valid section, then that
1720c3983b2SBen Grasargument will be used as if specified by the
1730c3983b2SBen Gras.Ql Fl s
1740c3983b2SBen Grasoption.
1750c3983b2SBen Gras.Pp
1760c3983b2SBen GrasIf
1770c3983b2SBen Gras.Ar name
178*0a6a1f1dSLionel Sambucis given with a full path (beginning with
179*0a6a1f1dSLionel Sambuc.Ql Pa \&/ )
180*0a6a1f1dSLionel Sambucor a relative path that begins with
181*0a6a1f1dSLionel Sambuc.Ql Pa .\&/
182*0a6a1f1dSLionel Sambucor
183*0a6a1f1dSLionel Sambuc.Ql Pa .\&./ ,
184*0a6a1f1dSLionel Sambucthen
1850c3983b2SBen Gras.Nm
1860c3983b2SBen Grasinterprets it as a file specification, so that you can do
1870c3983b2SBen Gras.Nm
1880c3983b2SBen Gras.Cm ./foo.5
1890c3983b2SBen Grasor even
1900c3983b2SBen Gras.Nm
1910c3983b2SBen Gras.Cm /cd/foo/bar.1.gz .
192*0a6a1f1dSLionel SambucIf
193*0a6a1f1dSLionel Sambuc.Ar name
194*0a6a1f1dSLionel Sambuccontains
195*0a6a1f1dSLionel Sambuc.Ql Pa /
196*0a6a1f1dSLionel Sambucbut does not match one of the above cases, then the
197*0a6a1f1dSLionel Sambucsearch path is used; this allows you to request
198*0a6a1f1dSLionel Sambucmachine-specific man pages, such as
199*0a6a1f1dSLionel Sambuc.Nm Cm vax/boot .
2000c3983b2SBen Gras.Sh ENVIRONMENT
2010c3983b2SBen Gras.Bl -tag -width MANPATHX
2020c3983b2SBen Gras.It Ev MACHINE
2030c3983b2SBen GrasAs some man pages are intended only for specific architectures,
2040c3983b2SBen Gras.Nm
2050c3983b2SBen Grassearches any subdirectories,
2060c3983b2SBen Graswith the same name as the current architecture,
2070c3983b2SBen Grasin every directory which it searches.
2080c3983b2SBen GrasMachine specific areas are checked before general areas.
2090c3983b2SBen GrasThe current machine type may be overridden by setting the environment
2100c3983b2SBen Grasvariable
2110c3983b2SBen Gras.Ev MACHINE
2120c3983b2SBen Grasto the name of a specific architecture.
213*0a6a1f1dSLionel SambucMachine-specific man pages may also be requested by
214*0a6a1f1dSLionel Sambucprepending the relevant subdirectory name to the page name,
215*0a6a1f1dSLionel Sambucseparated by
216*0a6a1f1dSLionel Sambuc.Ql Pa \&/ .
2170c3983b2SBen Gras.It Ev MANPATH
2180c3983b2SBen GrasThe standard search path used by
2190c3983b2SBen Gras.Nm
2200c3983b2SBen Grasmay be overridden by specifying a path in the
2210c3983b2SBen Gras.Ev MANPATH
22284d9c625SLionel Sambucenvironment variable.
2230c3983b2SBen GrasThe format of the path is a colon
2240c3983b2SBen Gras.Pq Dq \&:
2250c3983b2SBen Grasseparated list of directories.
2260c3983b2SBen GrasThe subdirectories to be searched as well as their search order
2270c3983b2SBen Grasis specified by the
2280c3983b2SBen Gras.Dq _subdir
2290c3983b2SBen Grasline in the
2300c3983b2SBen Gras.Nm
2310c3983b2SBen Grasconfiguration file.
2320c3983b2SBen Gras.It Ev PAGER
2330c3983b2SBen GrasThe pagination command used for writing the output.
2340c3983b2SBen GrasIf the
2350c3983b2SBen Gras.Ev PAGER
2360c3983b2SBen Grasenvironment variable is null or not set, the standard pagination program
2370c3983b2SBen Gras.Xr more 1
2380c3983b2SBen Graswill be used.
2390c3983b2SBen Gras.El
2400c3983b2SBen Gras.Sh FILES
2410c3983b2SBen Gras.Bl -hang -width /etc/man.conf -compact
2420c3983b2SBen Gras.It Pa /etc/man.conf
2430c3983b2SBen Grasdefault man configuration file.
2440c3983b2SBen Gras.El
2450c3983b2SBen Gras.Sh SEE ALSO
2460c3983b2SBen Gras.Xr apropos 1 ,
2470c3983b2SBen Gras.Xr whatis 1 ,
2480c3983b2SBen Gras.Xr whereis 1 ,
2490c3983b2SBen Gras.Xr man.conf 5 ,
2500c3983b2SBen Gras.Xr mdoc 7 ,
2510c3983b2SBen Gras.Xr mdoc.samples 7
2520c3983b2SBen Gras.Sh STANDARDS
2530c3983b2SBen Gras.Nm
2540c3983b2SBen Grasconforms to
2550c3983b2SBen Gras.St -xcu5 .
2560c3983b2SBen Gras.\"and is expected to conform to
2570c3983b2SBen Gras.\".St -p1003.2-?? .
2580c3983b2SBen Gras.Sh BUGS
2590c3983b2SBen GrasThe on-line man pages are, by necessity, forgiving toward stupid
2600c3983b2SBen Grasdisplay devices, causing a few man pages to be not as nicely formatted
2610c3983b2SBen Grasas their typeset counterparts.
262