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