1 .\"
   2 .\" This file and its contents are supplied under the terms of the
   3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
   4 .\" You may only use this file in accordance with the terms of version
   5 .\" 1.0 of the CDDL.
   6 .\"
   7 .\" A full copy of the text of the CDDL should have accompanied this
   8 .\" source.  A copy of the CDDL is also available via the Internet at
   9 .\" http://www.illumos.org/license/CDDL.
  10 .\"
  11 .\"
  12 .\" Copyright 2012 Nexenta Systems, Inc. All rights reserved.
  13 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
  14 .\"
  15 .Dd October 18, 2012
  16 .Dt MAN 1
  17 .Os
  18 .Sh NAME
  19 .Nm man
  20 .Nd find and display reference manual pages
  21 .Sh SYNOPSIS
  22 .Nm
  23 .Op Fl alptw
  24 .Op Fl M Ar manpath
  25 .Op Fl s Ar mansect
  26 .Ar page ...
  27 .Nm
  28 .Op Fl s Ar mansect
  29 .Fl f
  30 .Ar keyword ...
  31 .Nm
  32 .Op Fl s Ar mansect
  33 .Fl k
  34 .Ar keyword ...
  35 .Sh DESCRIPTION
  36 The
  37 .Nm
  38 utility finds and displays reference manual pages.
  39 .Pp
  40 Options that
  41 .Nm
  42 understands:
  43 .Bl -tag -width indent
  44 .It Fl M Ar manpath
  45 Forces a specific colon separated manual path instead of the default
  46 search path.
  47 Overrides the
  48 .Ev MANPATH
  49 environment variable.
  50 .It Fl a
  51 Display all manual pages instead of just the first found for each
  52 .Ar page
  53 argument.
  54 .It Fl f
  55 Emulate
  56 .Xr whatis 1 .
  57 .It Fl k
  58 Emulate
  59 .Xr apropos 1 .
  60 .It Fl l
  61 Display the location of the manual page instead of the contents of
  62 the manual page.
  63 .It Fl p
  64 Output current path used for searching.
  65 .It Fl s Ar mansect
  66 Restrict manual sections searched to the specified colon delimited list.
  67 .It Fl t
  68 Send the content formatted as PostScript to the default printer.
  69 .It Fl w
  70 Create
  71 .Nm whatis
  72 databases used by
  73 .Xr apropos 1
  74 and
  75 .Xr whatis 1 .
  76 .El
  77 .Sh ENVIRONMENT
  78 The following environment variables affect the execution of
  79 .Nm :
  80 .Bl -tag -width ".Ev MANPATH"
  81 .It Ev LC_ALL , LC_CTYPE , LANG
  82 Used to find locale-specific manual pages.
  83 .It Ev MANPATH
  84 Used to find the location of the manual files.
  85 Corresponds to the
  86 .Fl M
  87 option.
  88 .It Ev MANWIDTH
  89 Defines the width of output. If set to
  90 .Dq Li tty ,
  91 and output is to a terminal, full width of terminal is used.
  92 .It Ev PAGER
  93 Program used to display files. If unset,
  94 .Dq Li "less -ins"
  95 is used.
  96 .It Ev PATH
  97 Used to find location of manual files if
  98 .Ev MANPATH
  99 and
 100 .Fl M
 101 are not specified.
 102 .El
 103 .Sh FILES
 104 .Bl -tag -width indent -compact
 105 .It Pa man.cf
 106 Per-manpath configuration settings.  The file is formatted as follows:
 107 .Bd -literal -offset indent
 108 MANSECT=\fIsection\fR[,\fIsection\fR]...
 109 .Ed
 110 .Pp
 111 Each section consists of a section in the reference manual.  The file
 112 may also contain comment blank lines or lines consisting of comments, where
 113 the first character in the line is `#'.  Both blank lines and comment lines are
 114 ignored.
 115 .El
 116 .Sh CODE SET INDEPENDENCE
 117 Enabled.
 118 .Sh INTERFACE STABILITY
 119 The
 120 .Nm
 121 utility is
 122 .Nm Standard ,
 123 as is the
 124 .Fl k
 125 option. The other options are
 126 .Nm Committed .
 127 .Sh SEE ALSO
 128 .Xr apropos 1 ,
 129 .Xr intro 1 ,
 130 .Xr mandoc 1 ,
 131 .Xr whatis 1 ,
 132 .Xr man 5 ,
 133 .Xr mdoc 5 ,
 134 .Xr standards 5
 135 .Sh NOTES
 136 Some pages may contain information which cannot be properly displayed on
 137 all terminals.  In such cases, some information may be lost.