usr.bin/man/man.1

   1 .\"     $NetBSD: man.1,v 1.21 2009/10/07 08:30:31 cegger 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. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)man.1       8.2 (Berkeley) 1/2/94
  31 .\"
  32 .Dd October 6, 2009
  33 .Dt MAN 1
  34 .Os
  35 .Sh NAME
  36 .Nm man
  37 .Nd display the on-line manual pages
  38 .Pq aka Dq Em man pages
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Oo Fl acw Ns \&| Ns Fl h Oc
  42 .Op Fl C Ar file
  43 .Op Fl M Ar path
  44 .Op Fl m Ar path
  45 .Op Fl S Ar srch
  46 .Oo
  47 .Op Fl s
  48 .Ar section
  49 .Oc
  50 .Ar name Ar ...
  51 .Nm
  52 .Op Fl k
  53 .Op Fl C Ar file
  54 .Op Fl M Ar path
  55 .Op Fl m Ar path
  56 .Ar keyword Ar ...
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 utility displays the manual pages named on the command line.
  61 Its options are as follows:
  62 .Bl -tag -width indent
  63 .It Fl a
  64 Display all of the man pages for a specified
  65 .Ar section
  66 and
  67 .Ar name
  68 combination.
  69 (Normally, only the first man 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 man 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 man 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 man pages.
  87 For commands, this is typically the command line usage information.
  88 For library functions, this usually contains the required include
  89 files and function prototypes.
  90 .It Fl k
  91 Display the header lines for any man pages matching
  92 .Ar keyword Ns Pq s ,
  93 in the same manner as
  94 .Xr apropos 1 .
  95 .It Fl M
  96 Override the list of standard directories which
  97 .Nm
  98 searches for man pages.
  99 The supplied
 100 .Ar path
 101 must be a colon
 102 .Pq Dq \&:
 103 separated list of directories.
 104 This search path may also be set using the environment variable
 105 .Ev MANPATH .
 106 The subdirectories to be searched, and their search order,
 107 is specified by the
 108 .Dq _subdir
 109 line in the
 110 .Nm
 111 configuration file.
 112 .It Fl m
 113 Augment the list of standard directories which
 114 .Nm
 115 searches for man pages.
 116 The supplied
 117 .Ar path
 118 must be a colon
 119 .Pq Dq \&:
 120 separated list of directories.
 121 These directories will be searched before the standard directories or
 122 the directories specified using the
 123 .Fl M
 124 option or the
 125 .Ev MANPATH
 126 environment variable.
 127 The subdirectories to be searched, and their search order,
 128 is specified by the
 129 .Dq _subdir
 130 line in the
 131 .Nm
 132 configuration file.
 133 .It Fl s
 134 Restrict the directories that
 135 .Nm
 136 will search to the specified section.
 137 The
 138 .Nm
 139 configuration file (see
 140 .Xr man.conf 5 )
 141 specifies the possible
 142 .Ar section
 143 values that are currently available.
 144 .It Fl S
 145 Display only man pages that have the specified string in the directory
 146 part of their filenames.
 147 This allows the man page search process criteria to be
 148 narrowed without having to change the MANPATH or
 149 .Dq _default
 150 variables.
 151 .It Fl w
 152 List the pathnames of the man pages which
 153 .Nm
 154 would display for the specified
 155 .Ar section
 156 and
 157 .Ar name
 158 combination.
 159 .El
 160 .Pp
 161 If the
 162 .Ql Fl s
 163 option is not specified,
 164 there is more than one argument,
 165 the
 166 .Ql Fl k
 167 option is not used, and the first argument is a valid section, then that
 168 argument will be used as if specified by the
 169 .Ql Fl s
 170 option.
 171 .Pp
 172 If
 173 .Ar name
 174 is given with a full or relative path then
 175 .Nm
 176 interprets it as a file specification, so that you can do
 177 .Nm
 178 .Cm ./foo.5
 179 or even
 180 .Nm
 181 .Cm /cd/foo/bar.1.gz .
 182 .Sh ENVIRONMENT
 183 .Bl -tag -width MANPATHX
 184 .It Ev MACHINE
 185 As some man pages are intended only for specific architectures,
 186 .Nm
 187 searches any subdirectories,
 188 with the same name as the current architecture,
 189 in every directory which it searches.
 190 Machine specific areas are checked before general areas.
 191 The current machine type may be overridden by setting the environment
 192 variable
 193 .Ev MACHINE
 194 to the name of a specific architecture.
 195 .It Ev MANPATH
 196 The standard search path used by
 197 .Nm
 198 may be overridden by specifying a path in the
 199 .Ev MANPATH
 200 environment
 201 variable.
 202 The format of the path is a colon
 203 .Pq Dq \&:
 204 separated list of directories.
 205 The subdirectories to be searched as well as their search order
 206 is specified by the
 207 .Dq _subdir
 208 line in the
 209 .Nm
 210 configuration file.
 211 .It Ev PAGER
 212 The pagination command used for writing the output.
 213 If the
 214 .Ev PAGER
 215 environment variable is null or not set, the standard pagination program
 216 .Xr more 1
 217 will be used.
 218 .El
 219 .Sh FILES
 220 .Bl -hang -width /etc/man.conf -compact
 221 .It Pa /etc/man.conf
 222 default man configuration file.
 223 .It Pa /usr/{share,X11R6,pkg,local}/man/whatis.db
 224 standard whatis/apropos database search path,
 225 set in
 226 .Pa /etc/man.conf .
 227 .El
 228 .Sh SEE ALSO
 229 .Xr apropos 1 ,
 230 .Xr whatis 1 ,
 231 .Xr whereis 1 ,
 232 .Xr man.conf 5 ,
 233 .Xr mdoc 7 ,
 234 .Xr mdoc.samples 7
 235 .Sh STANDARDS
 236 .Nm
 237 conforms to
 238 .St -xcu5 .
 239 .\"and is expected to conform to
 240 .\".St -p1003.2-?? .
 241 .Sh BUGS
 242 The on-line man pages are, by necessity, forgiving toward stupid
 243 display devices, causing a few man pages to be not as nicely formatted
 244 as their typeset counterparts.