[BACK]Return to man.1 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/man.1, Revision 1.31

1.31    ! schwarze    1: .\"    $Id: man.1,v 1.30 2017/08/09 12:49:04 schwarze Exp $
1.1       schwarze    2: .\"
                      3: .\" Copyright (c) 1989, 1990, 1993
                      4: .\"    The Regents of the University of California.  All rights reserved.
1.2       schwarze    5: .\" Copyright (c) 2003, 2007, 2008, 2014 Jason McIntyre <jmc@openbsd.org>
1.22      schwarze    6: .\" Copyright (c) 2010, 2011, 2014-2017 Ingo Schwarze <schwarze@openbsd.org>
1.1       schwarze    7: .\"
                      8: .\" Redistribution and use in source and binary forms, with or without
                      9: .\" modification, are permitted provided that the following conditions
                     10: .\" are met:
                     11: .\" 1. Redistributions of source code must retain the above copyright
                     12: .\"    notice, this list of conditions and the following disclaimer.
                     13: .\" 2. Redistributions in binary form must reproduce the above copyright
                     14: .\"    notice, this list of conditions and the following disclaimer in the
                     15: .\"    documentation and/or other materials provided with the distribution.
                     16: .\" 3. Neither the name of the University nor the names of its contributors
                     17: .\"    may be used to endorse or promote products derived from this software
                     18: .\"    without specific prior written permission.
                     19: .\"
                     20: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     21: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     22: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     23: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     24: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     25: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     26: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     27: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     28: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     29: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     30: .\" SUCH DAMAGE.
                     31: .\"
                     32: .\"     @(#)man.1      8.2 (Berkeley) 1/2/94
                     33: .\"
1.31    ! schwarze   34: .Dd $Mdocdate: August 9 2017 $
1.1       schwarze   35: .Dt MAN 1
                     36: .Os
                     37: .Sh NAME
                     38: .Nm man
                     39: .Nd display manual pages
                     40: .Sh SYNOPSIS
                     41: .Nm man
1.13      schwarze   42: .Op Fl acfhklw
1.1       schwarze   43: .Op Fl C Ar file
                     44: .Op Fl M Ar path
                     45: .Op Fl m Ar path
                     46: .Op Fl S Ar subsection
1.28      schwarze   47: .Op Oo Fl s Oc Ar section
1.1       schwarze   48: .Ar name ...
                     49: .Sh DESCRIPTION
                     50: The
                     51: .Nm
                     52: utility
                     53: displays the
                     54: manual pages entitled
                     55: .Ar name .
                     56: Pages may be selected according to
                     57: a specific category
                     58: .Pq Ar section
                     59: or
                     60: machine architecture
                     61: .Pq Ar subsection .
                     62: .Pp
                     63: The options are as follows:
                     64: .Bl -tag -width Ds
                     65: .It Fl a
1.18      schwarze   66: Display all matching manual pages.
                     67: Normally, only the first page found is displayed.
1.1       schwarze   68: .It Fl C Ar file
                     69: Use the specified
                     70: .Ar file
                     71: instead of the default configuration file.
                     72: This permits users to configure their own manual environment.
                     73: See
                     74: .Xr man.conf 5
                     75: for a description of the contents of this file.
                     76: .It Fl c
                     77: Copy the manual page to the standard output instead of using
                     78: .Xr more 1
                     79: to paginate it.
                     80: This is done by default if the standard output is not a terminal device.
1.30      schwarze   81: .Pp
                     82: When using
                     83: .Fl c ,
                     84: most terminal devices are unable to show the markup.
                     85: To print the output of
                     86: .Nm
                     87: to the terminal with markup but without using a pager, pipe it to
                     88: .Xr ul 1 .
                     89: To remove the markup, pipe the output to
                     90: .Xr col 1
                     91: .Fl b
                     92: instead.
1.2       schwarze   93: .It Fl f
1.1       schwarze   94: A synonym for
                     95: .Xr whatis 1 .
1.2       schwarze   96: It searches for
                     97: .Ar name
                     98: in manual page names and displays the header lines from all matching pages.
                     99: The search is case insensitive and matches whole words only.
1.20      schwarze  100: .It Fl h
                    101: Display only the SYNOPSIS lines of the requested manual pages.
                    102: Implies
                    103: .Fl a
                    104: and
                    105: .Fl c .
1.2       schwarze  106: .It Fl k
1.1       schwarze  107: A synonym for
                    108: .Xr apropos 1 .
1.2       schwarze  109: Instead of
                    110: .Ar name ,
                    111: an expression can be provided using the syntax described in the
                    112: .Xr apropos 1
                    113: manual.
                    114: By default, it displays the header lines of all matching pages.
1.4       schwarze  115: .It Fl l
                    116: A synonym for
                    117: .Xr mandoc 1
                    118: .Fl a .
                    119: The
                    120: .Ar name
                    121: arguments are interpreted as filenames.
                    122: No search is done and
                    123: .Ar file ,
                    124: .Ar path ,
                    125: .Ar section ,
1.27      schwarze  126: .Ar subsection ,
1.4       schwarze  127: and
1.27      schwarze  128: .Fl w
1.4       schwarze  129: are ignored.
1.1       schwarze  130: .It Fl M Ar path
                    131: Override the list of standard directories which
                    132: .Nm
                    133: searches for manual pages.
                    134: The supplied
                    135: .Ar path
                    136: must be a colon
                    137: .Pq Ql \&:
                    138: separated list of directories.
                    139: This search path may also be set using the environment variable
                    140: .Ev MANPATH .
                    141: .It Fl m Ar path
                    142: Augment the list of standard directories which
                    143: .Nm
                    144: searches for manual pages.
                    145: The supplied
                    146: .Ar path
                    147: must be a colon
                    148: .Pq Ql \&:
                    149: separated list of directories.
                    150: These directories will be searched before the standard directories or
                    151: the directories specified using the
                    152: .Fl M
                    153: option or the
                    154: .Ev MANPATH
                    155: environment variable.
                    156: .It Fl S Ar subsection
1.25      schwarze  157: Only show pages for the specified
1.1       schwarze  158: .Xr machine 1
                    159: architecture.
                    160: .Ar subsection
                    161: is case insensitive.
                    162: .Pp
                    163: By default manual pages for all architectures are installed.
                    164: Therefore this option can be used to view pages for one
                    165: architecture whilst using another.
                    166: .Pp
                    167: This option overrides the
                    168: .Ev MACHINE
                    169: environment variable.
1.17      schwarze  170: .It Oo Fl s Oc Ar section
                    171: Only select manuals from the specified
                    172: .Ar section .
1.1       schwarze  173: The currently available sections are:
                    174: .Pp
                    175: .Bl -tag -width "localXXX" -offset indent -compact
                    176: .It 1
                    177: General commands
                    178: .Pq tools and utilities .
                    179: .It 2
                    180: System calls and error numbers.
                    181: .It 3
1.17      schwarze  182: Library functions.
1.1       schwarze  183: .It 3p
                    184: .Xr perl 1
                    185: programmer's reference guide.
                    186: .It 4
                    187: Device drivers.
                    188: .It 5
                    189: File formats.
                    190: .It 6
                    191: Games.
                    192: .It 7
1.17      schwarze  193: Miscellaneous information.
1.1       schwarze  194: .It 8
                    195: System maintenance and operation commands.
                    196: .It 9
                    197: Kernel internals.
                    198: .El
1.22      schwarze  199: .Pp
                    200: If not specified and a match is found in more than one section,
                    201: the first match is selected from the following list:
                    202: 1, 8, 6, 2, 3, 5, 7, 4, 9, 3p.
1.1       schwarze  203: .It Fl w
1.25      schwarze  204: List the pathnames of all matching manual pages instead of displaying
                    205: any of them.
1.1       schwarze  206: .El
1.26      schwarze  207: .Pp
                    208: The options
                    209: .Fl IKOTW
                    210: are also supported and are documented in
                    211: .Xr mandoc 1 .
1.27      schwarze  212: The options
                    213: .Fl fkl
                    214: are mutually exclusive and override each other.
1.1       schwarze  215: .Pp
1.2       schwarze  216: Guidelines for writing
1.1       schwarze  217: man pages can be found in
                    218: .Xr mdoc 7 .
                    219: .Pp
                    220: If both a formatted and an unformatted version of the same manual page,
                    221: for example
                    222: .Pa cat1/foo.0
                    223: and
                    224: .Pa man1/foo.1 ,
1.24      schwarze  225: exist in the same directory, only the unformatted version is used.
1.1       schwarze  226: .Sh ENVIRONMENT
                    227: .Bl -tag -width MANPATHX
                    228: .It Ev MACHINE
                    229: As some manual pages are intended only for specific architectures,
                    230: .Nm
                    231: searches any subdirectories,
                    232: with the same name as the current architecture,
                    233: in every directory which it searches.
                    234: Machine specific areas are checked before general areas.
                    235: The current machine type may be overridden by setting the environment
                    236: variable
                    237: .Ev MACHINE
                    238: to the name of a specific architecture,
                    239: or with the
                    240: .Fl S
                    241: option.
                    242: .Ev MACHINE
                    243: is case insensitive.
                    244: .It Ev MANPAGER
                    245: Any non-empty value of the environment variable
                    246: .Ev MANPAGER
1.23      schwarze  247: is used instead of the standard pagination program,
1.1       schwarze  248: .Xr more 1 .
1.15      schwarze  249: If
                    250: .Xr less 1
                    251: is used, the interactive
                    252: .Ic :t
                    253: command can be used to go to the definitions of various terms, for
                    254: example command line options, command modifiers, internal commands,
1.19      schwarze  255: environment variables, function names, preprocessor macros,
                    256: .Xr errno 2
                    257: values, and some other emphasized words.
                    258: Some terms may have defining text at more than one place.
                    259: In that case, the
                    260: .Xr less 1
                    261: interactive commands
                    262: .Ic t
                    263: and
                    264: .Ic T
                    265: can be used to move to the next and to the previous place providing
                    266: information about the term last searched for with
                    267: .Ic :t .
1.1       schwarze  268: .It Ev MANPATH
                    269: The standard search path used by
                    270: .Nm
1.23      schwarze  271: may be changed by specifying a path in the
1.1       schwarze  272: .Ev MANPATH
1.23      schwarze  273: environment variable.
1.1       schwarze  274: The format of the path is a colon
                    275: .Pq Ql \&:
                    276: separated list of directories.
1.29      schwarze  277: Invalid paths are ignored.
1.23      schwarze  278: Overridden by
                    279: .Fl M ,
                    280: ignored if
                    281: .Fl l
                    282: is specified.
                    283: .Pp
                    284: If
                    285: .Ev MANPATH
                    286: begins with a colon, it is appended to the default list;
                    287: if it ends with a colon, it is prepended to the default list;
                    288: or if it contains two adjacent colons,
                    289: the standard search path is inserted between the colons.
                    290: If none of these conditions are met, it overrides the
                    291: standard search path.
1.1       schwarze  292: .It Ev PAGER
                    293: Specifies the pagination program to use when
                    294: .Ev MANPAGER
                    295: is not defined.
                    296: If neither PAGER nor MANPAGER is defined,
1.14      schwarze  297: .Xr more 1
                    298: .Fl s
1.23      schwarze  299: is used.
                    300: Only used if
                    301: .Fl a
                    302: or
                    303: .Fl l
                    304: is specified.
1.1       schwarze  305: .El
                    306: .Sh FILES
                    307: .Bl -tag -width /etc/man.conf -compact
                    308: .It Pa /etc/man.conf
                    309: default man configuration file
                    310: .El
                    311: .Sh EXIT STATUS
                    312: .Ex -std man
1.25      schwarze  313: See
                    314: .Xr mandoc 1
                    315: for details.
1.31    ! schwarze  316: .Sh EXAMPLES
        !           317: Format a page for pasting extracts into an email message \(em
        !           318: avoid printing any UTF-8 characters, reduce the width to ease
        !           319: quoting in replies, and remove markup:
        !           320: .Pp
        !           321: .Dl $ man -T ascii -O width=65 pledge | col -b
        !           322: .Pp
        !           323: Read a typeset page in a PDF viewer:
        !           324: .Pp
        !           325: .Dl $ MANPAGER=mupdf man -T pdf lpd
1.1       schwarze  326: .Sh SEE ALSO
                    327: .Xr apropos 1 ,
1.30      schwarze  328: .Xr col 1 ,
                    329: .Xr mandoc 1 ,
                    330: .Xr ul 1 ,
1.1       schwarze  331: .Xr whereis 1 ,
                    332: .Xr man.conf 5 ,
1.30      schwarze  333: .Xr mdoc 7
1.1       schwarze  334: .Sh STANDARDS
                    335: The
                    336: .Nm
                    337: utility is compliant with the
                    338: .St -p1003.1-2008
                    339: specification.
                    340: .Pp
                    341: The flags
1.13      schwarze  342: .Op Fl aCcfhIKlMmOSsTWw ,
1.1       schwarze  343: as well as the environment variables
                    344: .Ev MACHINE ,
                    345: .Ev MANPAGER ,
                    346: and
                    347: .Ev MANPATH ,
                    348: are extensions to that specification.
                    349: .Sh HISTORY
                    350: A
                    351: .Nm
                    352: command first appeared in
                    353: .At v3 .
                    354: .Pp
                    355: The
                    356: .Fl w
                    357: option first appeared in
                    358: .At v7 ;
                    359: .Fl f
                    360: and
                    361: .Fl k
                    362: in
                    363: .Bx 4 ;
                    364: .Fl M
                    365: in
                    366: .Bx 4.3 ;
                    367: .Fl a
                    368: in
                    369: .Bx 4.3 Tahoe ;
                    370: .Fl c
                    371: and
                    372: .Fl m
                    373: in
                    374: .Bx 4.3 Reno ;
                    375: .Fl h
                    376: in
                    377: .Bx 4.3 Net/2 ;
                    378: .Fl C
                    379: in
                    380: .Nx 1.0 ;
                    381: .Fl s
                    382: and
                    383: .Fl S
                    384: in
1.21      schwarze  385: .Ox 2.3 ;
                    386: and
                    387: .Fl I ,
                    388: .Fl K ,
                    389: .Fl l ,
                    390: .Fl O ,
                    391: and
                    392: .Fl W
                    393: in
                    394: .Ox 5.7 .
                    395: The
                    396: .Fl T
                    397: option first appeared in
                    398: .At III
                    399: and was also added in
                    400: .Ox 5.7 .

CVSweb