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

Annotation of mandoc/man.options.1, Revision 1.2

1.2     ! schwarze    1: .\"    $Id: man.options.1,v 1.1 2017/02/02 02:17:31 schwarze Exp $
1.1       schwarze    2: .\"
                      3: .\" Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org>
                      4: .\"
                      5: .\" Permission to use, copy, modify, and distribute this software for any
                      6: .\" purpose with or without fee is hereby granted, provided that the above
                      7: .\" copyright notice and this permission notice appear in all copies.
                      8: .\"
                      9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     16: .\"
1.2     ! schwarze   17: .Dd $Mdocdate: February 2 2017 $
1.1       schwarze   18: .Dt MAN.OPTIONS 1
                     19: .Os
                     20: .Sh NAME
                     21: .Nm man.options
                     22: .Nd assignment of option letters in manual page utilities
                     23: .\"
                     24: .\" Sources that occur repeatedly.
                     25: .\" Only use if the precise implementation time is unknown.
                     26: .\"
                     27: .de PWB
                     28: .No PWB/UNIX 1.0 Pq July 1, 1977 \\$1
                     29: ..
                     30: .de At7
                     31: .At v7 Pq January 1979 \\$1
                     32: ..
                     33: .de At3
                     34: .At III Pq June 1980 \\$1
                     35: ..
                     36: .de Bx4
                     37: .Bx 4 Pq November 16, 1980 \\$1
                     38: ..
                     39: .de At5
                     40: .At V Pq January 1983 \\$1
                     41: ..
                     42: .de Bx43
                     43: .Bx 4.3 Pq June 1986 \\$1
                     44: ..
                     45: .de Bx44N1
                     46: .Bx 4.3 Net/1 Pq March 3, 1989 \\$1
                     47: ..
                     48: .de g102
                     49: .No groff-1.02 Pq after March 1989, before June 1991 \\$1
                     50: ..
                     51: .de Eaton
                     52: .No Eaton Pq before July 7, 1993; 1990/91? \\$1
                     53: ..
                     54: .\" man-1.6 was released on June 24, 2005.
                     55: .de man16
                     56: .No man-1.6 Pq not before 1993, not after 2005 \\$1
                     57: ..
                     58: .\" first seen in the initial import of man-db into CVS
                     59: .de dbI
                     60: .No man-db Pq before Apr 26, 2001; 1994/95? \\$1
                     61: ..
                     62: .\"
                     63: .\" --------------------------------------------------------------------
                     64: .\"
                     65: .Sh DESCRIPTION
                     66: This manual page lists option letters used in many different versions
                     67: of the
                     68: .Nm man ,
                     69: .Nm apropos ,
                     70: .Nm whatis ,
                     71: .Nm mandoc ,
                     72: .Nm makewhatis ,
                     73: .Nm mandb ,
                     74: .Nm makemandb ,
                     75: .Nm catman ,
                     76: and
                     77: .Nm manpath
                     78: utilities.
                     79: Option letters used by
                     80: .Nm groff ,
                     81: .Nm nroff ,
                     82: .Nm troff ,
                     83: and
                     84: .Nm roff
                     85: are also included because beginning with
                     86: .At v7 ,
                     87: many versions of
                     88: .Xr man 1
                     89: pass on unrecognized options to these programs.
                     90: .Pp
                     91: For each option letter, information is first grouped into paragraphs,
                     92: each paragraph describing similar functionality and starting with
                     93: one line briefly summarizing that functionality.
                     94: .Pp
                     95: For each program using the letter for that functionality, one line
                     96: is provided, giving the name of the program, a colon, the system
                     97: where this letter first appeared for this functionality in this
                     98: program, optionally a comma and a list of other system versions
                     99: introducing the same, a semicolon, and a list of current systems
                    100: supporting it.
                    101: If a system appears before the semicolon, it is not repeated
                    102: afterwards.
                    103: .Pp
                    104: Entries are sorted by historical precedence, except that obsolete
                    105: options are moved to the end.
                    106: Dates are commit dates where known, and release dates otherwise.
                    107: .Bl -tag -width 3n
                    108: .It Fl a
                    109: display all matching manual pages
                    110: .br
                    111: .Nm man :
                    112: .Bx 4.3 Tahoe Pq June 1988 ,
                    113: .Eaton ;
                    114: .Ox , Fx , Nx , No man-db , man-1.6 , illumos , Solaris 9-11
                    115: .br
                    116: .Nm apropos , whatis , mandoc :
                    117: .Ox 5.7 Pq August 27, 2014
                    118: .Pp
                    119: only display items that match all keywords
                    120: .br
                    121: .Nm apropos :
                    122: .No man-db Pq Aug 29, 2007
                    123: .Pp
                    124: use all directories and files for
                    125: .Xr mandoc.db 5
                    126: .br
                    127: .Nm makewhatis :
                    128: .Ox 5.6 Pq April 18, 2014
                    129: .Pp
                    130: .Bq superseded by Fl T Cm ascii
                    131: ASCII output mode
                    132: .br
                    133: .Nm troff :
                    134: .At7
                    135: .br
                    136: .Nm groff :
                    137: .Bx44N1
                    138: .It Fl B
                    139: use specified browser
                    140: .br
                    141: .Nm man :
                    142: .man16
                    143: .It Fl b
                    144: print a backtrace with each warning or error message
                    145: .br
                    146: .Nm groff :
                    147: .Bx44N1
                    148: .Pp
                    149: .Bq obsolete hardware
                    150: report whether the phototypesetter is busy
                    151: .br
                    152: .Nm troff :
                    153: .At7
                    154: .It Fl C
                    155: alternate configuration file
                    156: .br
                    157: .Nm apropos , whatis :
                    158: .Bx 4.4 Lite1 Pq April 22, 1994 ,
                    159: .man16 ,
                    160: .No man-db Pq Feb 22, 2003 ;
                    161: .Ox , Nx
                    162: .br
                    163: .Nm man :
                    164: .Nx 1.0 Pq Oct 26, 1994 ;
1.2     ! schwarze  165: .Ox
1.1       schwarze  166: .br
                    167: .Nm mandb , catman , manpath :
                    168: .No man-db Pq Feb 22, 2003
                    169: .br
                    170: .Nm makemandb :
                    171: .Nx Pq Feb 7, 2012
                    172: .br
                    173: .Nm makewhatis :
                    174: .Ox 5.6 Pq April 18, 2014
                    175: .br
                    176: .Nm mandoc :
                    177: .Ox 5.7 Pq August 27, 2014
                    178: .Pp
                    179: .Bq obsolete
                    180: enable compatibility mode
                    181: .br
                    182: .Nm groff :
                    183: .Bx44N1
                    184: .It Fl c
                    185: do not use a pager
                    186: .br
                    187: .Nm man :
                    188: .Bx 4.3 Reno Pq June 1990 ;
                    189: .Ox , Nx
                    190: .br
                    191: .Nm apropos , whatis , mandoc :
                    192: .Ox 5.7 Pq August 27, 2014
                    193: .Pp
                    194: disable terminal color output in
                    195: .Xr grotty 1
                    196: .br
                    197: .Nm groff :
                    198: .No groff-1.18.0 Pq Oct 4, 2001
                    199: .Pp
                    200: reformat source page even if cat page exists
                    201: .br
                    202: .Nm man :
                    203: .man16
                    204: .Pp
                    205: process given catpath
                    206: .br
                    207: .Nm makewhatis :
                    208: .man16
                    209: .Pp
                    210: recreate databases from scratch
                    211: .br
                    212: .Nm mandb :
                    213: .dbI
                    214: .Pp
                    215: produce a catpath as opposed to a manpath
                    216: .br
                    217: .Nm manpath :
                    218: .dbI
                    219: .Pp
                    220: internal option for use by
                    221: .Xr catman 1
                    222: .br
                    223: .Nm man :
                    224: .dbI
                    225: .Pp
                    226: recreate nroff versions from SGML sources
                    227: .br
                    228: .Nm catman :
                    229: .No Solaris 9-11
                    230: .Pp
                    231: .Bq obsolete
                    232: postprocess with
                    233: .Xr col 1
                    234: .br
                    235: .Nm man :
                    236: .At3 ,
                    237: .At5
                    238: .It Fl D
                    239: print debugging info in addition to manual page
                    240: .br
                    241: .Nm man :
                    242: .man16
                    243: .Pp
                    244: reset whatever was set with
                    245: .Ev MANOPT
                    246: .br
                    247: .Nm man :
                    248: .dbI
                    249: .Pp
                    250: set default input encoding for
                    251: .Xr preconv 1
                    252: .br
                    253: .Nm groff :
                    254: .No groff-1.20 Pq August 20, 2008
                    255: .Pp
                    256: display all files added to
                    257: .Xr mandoc.db 5
                    258: .br
                    259: .Nm makewhatis :
                    260: .Ox 5.6 Pq April 18, 2014
                    261: .It Fl d
                    262: define a user-defined string
                    263: .br
                    264: .Nm groff :
                    265: .Bx44N1
                    266: .Pp
                    267: print debugging information
                    268: .br
                    269: .Nm man :
                    270: .Eaton ;
                    271: .Fx , No man-db , man-1.6 , illumos , Solaris 9-11
                    272: .br
                    273: .Nm manpath :
                    274: .Eaton ;
                    275: .Fx , No man-db
                    276: .br
                    277: .Nm apropos , whatis :
                    278: .dbI ;
                    279: .Fx
                    280: .br
                    281: .Nm mandb , catman :
                    282: .dbI
                    283: .Pp
                    284: remove and re-add a file to
                    285: .Xr mandoc.db 5
                    286: .br
                    287: .Nm makewhatis :
                    288: .Ox 2.7 Pq Feb 3, 2000
                    289: .Pp
                    290: .Bq superseded by Fl l
                    291: interpret arguments as file names
                    292: .br
                    293: .Nm man :
                    294: .At3 ,
                    295: .At5
                    296: .It Fl E
                    297: inhibit all error messages
                    298: .br
                    299: .Nm groff :
                    300: .Bx44N1
                    301: .Pp
                    302: select output encoding
                    303: .br
                    304: .Nm man :
                    305: .No man-db Pq Dec 23, 2001
                    306: .It Fl e
                    307: preprocess with
                    308: .Xr eqn 7
                    309: .br
                    310: .Nm man :
                    311: .At7
                    312: .br
                    313: .Nm groff :
                    314: .Bx44N1
                    315: .Pp
                    316: adjust text to left and right margins
                    317: .br
                    318: .Nm nroff :
                    319: .At7
                    320: .Pp
                    321: restrict search by section extension
                    322: .br
                    323: .Nm man :
                    324: .dbI
                    325: .Pp
                    326: use exact matching
                    327: .br
                    328: .Nm apropos , whatis :
                    329: .dbI
                    330: .It Fl F
                    331: use alternate font directory
                    332: .br
                    333: .Nm troff :
                    334: .Bx 4.2 Pq September 1983
                    335: .br
                    336: .Nm groff :
                    337: .Bx44N1
                    338: .Pp
                    339: preformat only, do not display
                    340: .br
                    341: .Nm man :
                    342: .man16
                    343: .Pp
                    344: force searchings dirs, do not use index (default)
                    345: .br
                    346: .Nm man :
                    347: .No illumos , Solaris 9-11
                    348: .It Fl f
                    349: .Xr whatis 1
                    350: mode
                    351: .br
                    352: .Nm man :
                    353: .Bx4 ,
                    354: .Eaton ;
                    355: .Ox , Fx , No man-db , man-1.6
                    356: .br
                    357: .Nm apropos , whatis :
                    358: .No man-db Pq Dec 2, 2010 ,
                    359: .Ox 5.7 Pq August 27, 2014
                    360: .br
                    361: .Nm mandoc :
                    362: .Ox 5.7 Pq August 27, 2014
                    363: .Pp
                    364: set the default font family
                    365: .br
                    366: .Nm groff :
                    367: .Bx44N1
                    368: .Pp
                    369: force formatting even if cat page is newer
                    370: .br
                    371: .Nm catman :
                    372: .Fx Pq March 15, 1995
                    373: .Pp
                    374: update only the entries for the given file
                    375: .br
                    376: .Nm mandb :
                    377: .No man-db Pq Feb 21, 2003
                    378: .Pp
                    379: force rebuilding the database from scratch
                    380: .br
                    381: .Nm makemandb :
                    382: .Nx Pq Feb 7, 2012
                    383: .Pp
                    384: locate manual page related to given file name
                    385: .br
                    386: .Nm man :
                    387: .No illumos , Solaris 9-11
                    388: .Pp
                    389: .Bq obsolete hardware
                    390: do not feed out paper nor stop phototypesetter
                    391: .br
                    392: .Nm troff :
                    393: .At7
                    394: .It Fl G
                    395: preprocess with
                    396: .Xr grap 1
                    397: .br
                    398: .Nm groff :
                    399: .No groff-1.16 Pq May 1, 2000
                    400: .It Fl g
                    401: produce a global manpath
                    402: .br
                    403: .Nm manpath :
                    404: .dbI
                    405: .Pp
                    406: preprocess with
                    407: .Xr grn 1
                    408: .br
                    409: .Nm groff :
                    410: .No groff-1.16 Pq Feb 20, 2000
                    411: .Pp
                    412: .Bq obsolete hardware
                    413: output to a GCOS phototypesetter
                    414: .br
                    415: .Nm troff :
                    416: .At7
                    417: .Pp
                    418: .Bq obsolete hardware
                    419: output to a DASI 300 terminal in 12-pitch mode
                    420: .br
                    421: .Nm man :
                    422: .PWB
                    423: .It Fl H
                    424: read hyphenation patterns from the given file
                    425: .br
                    426: .Nm groff :
                    427: .Bx44N1
                    428: .Pp
                    429: use program to render HTML files as text
                    430: .br
                    431: .Nm man :
                    432: .man16
                    433: .Pp
                    434: produce HTML output
                    435: .br
                    436: .Nm man :
                    437: .dbI
                    438: .It Fl h
                    439: print a help message and exit
                    440: .br
                    441: .Nm groff :
                    442: .Bx44N1
                    443: .br
                    444: .Nm man :
                    445: .Eaton ;
                    446: .Fx , No man-db , man-1.6
                    447: .br
                    448: .Nm manpath :
                    449: .Eaton ;
                    450: .Fx , No man-db
                    451: .br
                    452: .Nm apropos , whatis , mandb , catman :
                    453: .dbI
                    454: .Pp
                    455: display the SYNOPSIS lines only
                    456: .br
                    457: .Nm man :
                    458: .Bx 4.3 Net/2 Pq August 20, 1991 ;
                    459: .Ox , Nx
                    460: .br
                    461: .Nm apropos , whatis , mandoc :
                    462: .Ox 5.7 Pq Sep 3, 2014
                    463: .Pp
                    464: turn on HTML formatting
                    465: .br
                    466: .Nm apropos :
                    467: .Nx Pq Apr 2, 2013
                    468: .Pp
                    469: .Bq obsolete
                    470: replace spaces by tabs in the output
                    471: .br
                    472: .Nm roff , nroff :
                    473: .At7
                    474: .It Fl I
                    475: input file search path for
                    476: .Xr soelim 1
                    477: .br
                    478: .Nm groff :
                    479: .No groff-1.12 Pq Sep 11, 1999
                    480: .Pp
                    481: respect case when matching manual page names
                    482: .br
                    483: .Nm man , catman :
                    484: .No man-db Pq Apr 21, 2002
                    485: .Pp
                    486: input options, in particular default operating system name
                    487: .br
                    488: .Nm mandoc :
                    489: .Ox 5.2 Pq May 24, 2012
                    490: .br
                    491: .Nm man , apropos , whatis :
                    492: .Ox 5.7 Pq August 27, 2014
                    493: .It Fl i
                    494: read standard input after the input files are exhausted
                    495: .br
                    496: .Nm nroff , troff :
                    497: .At7
                    498: .br
                    499: .Nm groff :
                    500: .Bx44N1
                    501: .Pp
                    502: ignore case when matching manual page names
                    503: .br
                    504: .Nm man , catman :
                    505: .No man-db Pq Apr 21, 2002
                    506: .Pp
                    507: turn on terminal escape code formatting
                    508: .br
                    509: .Nm apropos :
                    510: .Nx Pq March 29, 2013
                    511: .It Fl J
                    512: preprocess with
                    513: .Xr gideal 1
                    514: .br
                    515: .Nm groff :
                    516: .No groff-1.22.3 Pq June 17, 2014
                    517: .It Fl j
                    518: preprocess with
                    519: .Xr chem 1
                    520: .br
                    521: .Nm groff :
                    522: .No groff-1.22 Pq Jan 22, 2011
                    523: .It Fl K
                    524: source code full text search
                    525: .br
                    526: .Nm man :
                    527: .man16 ;
                    528: .No man-db Pq June 28, 2009 ,
                    529: .No Solaris 11
                    530: .Pp
                    531: input encoding
                    532: .br
                    533: .Nm groff :
                    534: .No groff-1.20 Pq Dec 31, 2005
                    535: .br
                    536: .Nm man , apropos , whatis , mandoc :
                    537: .Ox 5.7 Pq Oct 30, 2014
                    538: .It Fl k
                    539: .Xr apropos 1
                    540: mode
                    541: .br
                    542: .Nm man :
                    543: .Bx4 ,
                    544: .Eaton ;
                    545: .No POSIX , Ox , Fx , Nx , No man-db , man-1.6 , illumos , Solaris 9-11
                    546: .br
                    547: .Nm apropos , whatis , mandoc :
                    548: .Ox 5.7 Pq August 27, 2014
                    549: .Pp
                    550: ignore formatting errors
                    551: .br
                    552: .Nm catman :
                    553: .Nx Pq April 26, 1994
                    554: .Pp
                    555: preprocess with
                    556: .Xr preconv 1
                    557: .br
                    558: .Nm groff :
                    559: .No groff-1.20 Pq Dec 31, 2005
                    560: .Pp
                    561: .Bq obsolete hardware
                    562: display on a Tektronix 4014 terminal
                    563: .br
                    564: .Nm man :
                    565: .At7
                    566: .It Fl L
                    567: pass argument to the spooler
                    568: .br
                    569: .Nm groff :
                    570: .Bx44N1
                    571: .Pp
                    572: print list of locales
                    573: .br
                    574: .Nm manpath :
                    575: .Fx Pq Nov 23, 1999
                    576: .Pp
                    577: use alternate
                    578: .Xr locale 1
                    579: .br
                    580: .Nm man , apropos , whatis :
                    581: .dbI
                    582: .Pp
                    583: use
                    584: .Xr locale 1
                    585: specified in the environment
                    586: .br
                    587: .Nm catman :
                    588: .Fx Pq May 18, 2002
                    589: .It Fl l
                    590: spool the output
                    591: .br
                    592: .Nm groff :
                    593: .Bx44N1
                    594: .Pp
                    595: interpret arguments as file names
                    596: .br
                    597: .Nm man :
                    598: .dbI ,
                    599: .Ox 5.7 Pq Aug 30, 2014
                    600: .br
                    601: .Nm apropos , whatis , mandoc :
                    602: .Ox 5.7 Pq Aug 30, 2014
                    603: .Pp
                    604: do not trim output to the terminal width
                    605: .br
                    606: .Nm apropos , whatis :
                    607: .No man-db Pq Aug 19, 2007
                    608: .Pp
                    609: only parse NAME sections
                    610: .br
                    611: .Nm makemandb :
                    612: .Nx Pq Feb 7, 2012
                    613: .Pp
                    614: legacy mode: search Nm,Nd, no context or formatting
                    615: .br
                    616: .Nm apropos :
                    617: .Nx Pq March 29, 2013
                    618: .Pp
                    619: list all manual pages matching name within the search path
                    620: .br
                    621: .Nm man :
                    622: .No illumos , Solaris 9-11
                    623: .It Fl M
                    624: override manual page search path
                    625: .br
                    626: .Nm man :
                    627: .Bx43 ,
                    628: .Eaton ;
                    629: .Ox , Fx , Nx , No man-db , man-1.6 , illumos , Solaris 9-11
                    630: .br
                    631: .Nm apropos , whatis :
                    632: .Bx43 ,
                    633: .dbI ;
                    634: .Ox , No illumos
                    635: .br
                    636: .Nm catman :
                    637: .dbI ;
                    638: .Nx Pq July 27, 1993 ,
                    639: .No Solaris 9-11
                    640: .br
                    641: .Nm mandoc :
                    642: .Ox 5.7 Pq August 27, 2014
                    643: .Pp
                    644: prepend to macro file search path
                    645: .br
                    646: .Nm groff :
                    647: .Bx44N1
                    648: .Pp
                    649: do not show the context of the match
                    650: .br
                    651: .Nm apropos :
                    652: .Nx Pq May 22, 2016
                    653: .It Fl m
                    654: specify input macro language
                    655: .br
                    656: .Nm nroff , troff :
                    657: .At7
                    658: .br
                    659: .Nm groff :
                    660: .Bx44N1
                    661: .br
                    662: .Nm mandoc :
                    663: .Ox 4.8 Pq April 6, 2009
                    664: .Pp
                    665: augment manual page search path
                    666: .br
                    667: .Nm man , apropos , whatis :
                    668: .Bx 4.3 Reno Pq June 1990 ;
                    669: .Ox , Nx
                    670: .br
                    671: .Nm catman :
                    672: .Nx Pq Apr 4, 1999
                    673: .br
                    674: .Nm mandoc :
                    675: .Ox 5.7 Pq August 27, 2014
                    676: .Pp
                    677: override operating system
                    678: .br
                    679: .Nm man :
                    680: .Eaton ;
                    681: .No man-db , man-1.6
                    682: .br
                    683: .Nm apropos , whatis , manpath :
                    684: .dbI
                    685: .Pp
                    686: override architecture
                    687: .br
                    688: .Nm man :
                    689: .Fx Pq Jan 11, 2002
                    690: .Pp
                    691: show the context of the match
                    692: .br
                    693: .Nm apropos :
                    694: .Nx Pq May 22, 2016
                    695: .It Fl N
                    696: do not allow newlines between
                    697: .Xr eqn 7
                    698: delimiters
                    699: .br
                    700: .Nm groff :
                    701: .Bx44N1
                    702: .It Fl n
                    703: specify a page number for the first page
                    704: .br
                    705: .Nm troff :
                    706: .At7
                    707: .br
                    708: .Nm groff :
                    709: .Bx44N1
                    710: .Pp
                    711: .Xr nroff 1
                    712: output mode
                    713: .br
                    714: .Nm man :
                    715: .At7
                    716: .Pp
                    717: do not create the
                    718: .Xr whatis 1
                    719: database
                    720: .br
                    721: .Nm catman :
                    722: .Nx Pq July 27, 1993
                    723: .Pp
                    724: print commands instead of executing them
                    725: .br
                    726: .Nm catman :
                    727: .Fx Pq May 18, 2002 ,
                    728: .No Solaris 9-11
                    729: .Pp
                    730: limit the number of results
                    731: .br
                    732: .Nm apropos :
                    733: .Nx Pq Feb 7, 2012
                    734: .Pp
                    735: dry run simulating
                    736: .Xr mandoc.db 5
                    737: creation
                    738: .br
                    739: .Nm makewhatis :
                    740: .Ox 5.6 Pq April 18, 2014
                    741: .It Fl O
                    742: output options
                    743: .br
                    744: .Nm mandoc :
                    745: .Ox 4.8 Pq Oct 27, 2009
                    746: .br
                    747: .Nm man , apropos , whatis :
                    748: .Ox 5.7 Pq August 27, 2014
                    749: .It Fl o
                    750: select pages by numbers
                    751: .br
                    752: .Nm nroff , troff :
                    753: .At7
                    754: .br
                    755: .Nm groff :
                    756: .Bx44N1
                    757: .Pp
                    758: force use of non-localized manual pages
                    759: .br
                    760: .Nm man :
                    761: .Fx Pq June 7, 1999
                    762: .Pp
                    763: optimize index for speed and disk space
                    764: .br
                    765: .Nm makemandb :
                    766: .Nx Pq Feb 7, 2012
                    767: .It Fl P
                    768: pass argument to postprocessor
                    769: .br
                    770: .Nm groff :
                    771: .Bx44N1
                    772: .Pp
                    773: use specified pager
                    774: .br
                    775: .Nm man :
                    776: .Eaton ;
                    777: .Fx , No man-db , man-1.6
                    778: .Pp
                    779: turn on pager formatting
                    780: .br
                    781: .Nm apropos :
                    782: .Nx Pq Apr 2, 2013
                    783: .It Fl p
                    784: preprocess with
                    785: .Xr pic 1
                    786: .br
                    787: .Nm groff :
                    788: .Bx44N1
                    789: .Pp
                    790: use the given list of preprocessors
                    791: .br
                    792: .Nm man :
                    793: .Eaton ;
                    794: .Fx , No man-db , man-1.6
                    795: .Pp
                    796: dry run, display commands instead of executing them
                    797: .br
                    798: .Nm catman :
                    799: .Nx Pq July 27, 1993 ,
                    800: .Fx Pq March 15, 1995 to May 18, 2002 ,
                    801: .No Solaris 9-11
                    802: .Pp
                    803: print warnings when building
                    804: .Xr mandoc.db 5
                    805: .br
                    806: .Nm makewhatis :
                    807: .Ox 2.7 Pq April 23, 2000
                    808: .Pp
                    809: do not look for deleted manual pages
                    810: .br
                    811: .Nm mandb :
                    812: .No man-db Pq June 28, 2001
                    813: .Pp
                    814: print the search path for manual pages
                    815: .br
                    816: .Nm man :
                    817: .Nx Pq June 14 , 2011
                    818: .Pp
                    819: turn on pager formatting and pipe through pager
                    820: .br
                    821: .Nm apropos :
                    822: .Nx Pq Feb 7, 2012
                    823: .Pp
                    824: .Bq obsolete hardware
                    825: set phototypesetter point size
                    826: .br
                    827: .Nm troff :
                    828: .At7
                    829: .It Fl Q
                    830: print only fatal error messages
                    831: .br
                    832: .Nm makemandb :
                    833: .Nx Pq Aug 29, 2012
                    834: .Pp
                    835: quick mode of
                    836: .Xr mandoc.db 5
                    837: creation
                    838: .br
                    839: .Nm makewhatis :
                    840: .Ox 5.6 Pq April 18, 2014
                    841: .It Fl q
                    842: invoke the simultaneous input-output mode of the .rd request
                    843: .br
                    844: .Nm nroff , troff :
                    845: .At7
                    846: .Pp
                    847: issue no warnings
                    848: .br
                    849: .Nm manpath :
                    850: .Eaton ;
                    851: .Fx , No man-db
                    852: .br
                    853: .Nm mandb :
                    854: .dbI
                    855: .Pp
                    856: print only warnings and errors, no status updates
                    857: .br
                    858: .Nm makemandb :
                    859: .Nx Pq Aug 29, 2012
                    860: .It Fl R
                    861: postprocess with
                    862: .Xr refer 1
                    863: .br
                    864: .Nm groff :
                    865: .g102
                    866: .Pp
                    867: recode to the specified encoding
                    868: .br
                    869: .Nm man :
                    870: .No man-db Pq Dec 31, 2007
                    871: .It Fl r
                    872: set number register
                    873: .br
                    874: .Nm nroff , troff :
                    875: .At7
                    876: .br
                    877: .Nm groff :
                    878: .Bx44N1
                    879: .Pp
                    880: set
                    881: .Xr less 1
                    882: prompt
                    883: .br
                    884: .Nm man :
                    885: .dbI
                    886: .Pp
                    887: use regular expression matching
                    888: .br
                    889: .Nm apropos , whatis :
                    890: .dbI
                    891: .Pp
                    892: scan for and remove junk files
                    893: .br
                    894: .Nm catman :
                    895: .Fx Pq March 31, 1995
                    896: .Pp
                    897: turn off formatting
                    898: .br
                    899: .Nm apropos :
                    900: .Nx Pq Feb 10, 2013
                    901: .Pp
                    902: check for formatting errors, do not display
                    903: .br
                    904: .Nm man :
                    905: .No illumos , Solaris 9-11
                    906: .It Fl S
                    907: manual section search list
                    908: .br
                    909: .Nm man :
                    910: .Eaton ;
                    911: .Fx , No man-db , man-1.6
                    912: .Pp
                    913: safer mode
                    914: .br
                    915: .Nm groff :
                    916: .No groff-1.10 Pq May 17, 1994
                    917: .Pp
                    918: restrict architecture
                    919: .br
                    920: .Nm man :
                    921: .Ox 2.3 Pq March 9, 1998 ,
                    922: .Nx Pq May 27, 2000
                    923: .br
                    924: .Nm apropos :
                    925: .Ox 4.5 Pq Dec 24, 2008 ,
                    926: .Nx Pq May 8, 2009
                    927: .br
                    928: .Nm whatis :
                    929: .Ox 5.6 Pq April 18, 2014
                    930: .br
                    931: .Nm mandoc :
                    932: .Ox 5.7 Pq August 27, 2014
                    933: .It Fl s
                    934: preprocess with
                    935: .Xr soelim 1
                    936: .br
                    937: .Nm groff :
                    938: .Bx44N1
                    939: .Pp
                    940: silent mode, do not echo commands
                    941: .br
                    942: .Nm catman :
                    943: .Nx Pq April 26, 1994
                    944: .Pp
                    945: restrict section
                    946: .br
                    947: .Nm man :
                    948: .Ox 2.3 Pq March 9, 1998 ,
                    949: .Nx Pq June 12, 2000 ;
                    950: .No illumos , Solaris 9-11
                    951: .br
                    952: .Nm apropos :
                    953: .No man-db Pq Nov 16, 2003 ,
1.2     ! schwarze  954: .Ox 4.5 Pq Dec 24, 2008 ,
        !           955: .Nx Pq May 8, 2009 ;
1.1       schwarze  956: .No illumos
                    957: .br
                    958: .Nm whatis :
                    959: .Ox 5.6 Pq April 18, 2014 ,
                    960: .No man-db Pq Nov 16, 2003 ,
                    961: .No illumos
                    962: .br
                    963: .Nm mandoc :
                    964: .Ox 5.7 Pq August 27, 2014
                    965: .br
                    966: .Nm makewhatis :
                    967: .man16
                    968: .Pp
                    969: do not look for stray cats
                    970: .br
                    971: .Nm mandb :
                    972: .dbI
                    973: .Pp
                    974: .Bq SysV compat, recommends Fl S
                    975: manual section search list
                    976: .br
                    977: .Nm man :
                    978: .No man-db Pq Jan 1, 2008
                    979: .Pp
                    980: .Bq superseded by Fl h
                    981: display the SYNOPSIS lines only
                    982: .br
                    983: .Nm man :
                    984: .PWB
                    985: .Pp
                    986: .Bq obsolete hardware
                    987: pause before each page for paper manipulation
                    988: .br
                    989: .Nm roff :
                    990: .At7
                    991: .Pp
                    992: .Bq obsolete hardware
                    993: .Xr troff 1
                    994: output mode, small format
                    995: .br
                    996: .Nm man :
                    997: .At3 ,
                    998: .At5
                    999: .It Fl T
                   1000: select terminal output format
                   1001: .br
                   1002: .Nm nroff :
                   1003: .At7
                   1004: .br
                   1005: .Nm man :
                   1006: .At3 ,
                   1007: .At5 ,
                   1008: .dbI ,
                   1009: .Ox 5.7 Pq August 27, 2014
                   1010: .br
                   1011: .Nm groff :
                   1012: .Bx44N1
                   1013: .br
                   1014: .Nm mandoc :
                   1015: .Ox 4.8 Pq April 6, 2009
                   1016: .br
                   1017: .Nm apropos , whatis :
                   1018: .Ox 5.7 Pq August 27, 2014
                   1019: .Pp
                   1020: use UTF-8 for
                   1021: .Xr mandoc.db 5
                   1022: .br
                   1023: .Nm makewhatis :
                   1024: .Ox 5.6 Pq April 18, 2014
                   1025: .Pp
                   1026: .Bq superseded by Fl m
                   1027: use other macro package
                   1028: .br
                   1029: .Nm man , catman :
                   1030: .No Solaris 9-11
                   1031: .It Fl t
                   1032: .Xr troff 1
                   1033: output mode
                   1034: .br
                   1035: .Nm man :
                   1036: .PWB ,
                   1037: .At7 ,
                   1038: .Bx 2 Pq May 10, 1979 ,
                   1039: .At3 ,
                   1040: .At5 ,
                   1041: .Eaton ;
                   1042: .Fx , No man-db , man-1.6 , illumos , Solaris 9-11
                   1043: .br
                   1044: .Nm catman :
                   1045: .No Solaris 9-11
                   1046: .Pp
                   1047: preprocess with
                   1048: .Xr tbl 7
                   1049: .br
                   1050: .Nm groff :
                   1051: .Bx44N1
                   1052: .Pp
                   1053: check manual pages in the hierarchy
                   1054: .br
                   1055: .Nm mandb :
                   1056: .dbI
                   1057: .Pp
                   1058: check files for problems related to
                   1059: .Xr mandoc.db 5
                   1060: .br
                   1061: .Nm makewhatis :
                   1062: .Ox 2.7 Pq April 23, 2000
                   1063: .It Fl U
                   1064: unsafe mode
                   1065: .br
                   1066: .Nm groff :
                   1067: .No groff-1.12 Pq Dec 13, 1999
                   1068: .It Fl u
                   1069: update database
                   1070: .br
                   1071: .Nm makewhatis :
                   1072: .man16
                   1073: .Pp
                   1074: update database cache (requires suid)
                   1075: .br
                   1076: .Nm man :
                   1077: .dbI
                   1078: .Pp
                   1079: create user databases only
                   1080: .br
                   1081: .Nm mandb :
                   1082: .dbI
                   1083: .Pp
                   1084: remove files from
                   1085: .Xr mandoc.db 5
                   1086: .br
                   1087: .Nm makewhatis :
                   1088: .Ox 3.4 Pq July 9, 2003
                   1089: .It Fl V
                   1090: print the pipeline on stdout instead of executing it
                   1091: .br
                   1092: .Nm groff :
                   1093: .Bx44N1
                   1094: .Pp
                   1095: print version information
                   1096: .br
                   1097: .Nm man , apropos , whatis , mandb , catman , manpath :
                   1098: .dbI
                   1099: .It Fl v
                   1100: print version number
                   1101: .br
                   1102: .Nm groff :
                   1103: .Bx44N1
                   1104: .Pp
                   1105: verbose mode
                   1106: .br
                   1107: .Nm catman :
                   1108: .Fx Pq March 15, 1995
                   1109: .br
                   1110: .Nm makewhatis :
                   1111: .man16
                   1112: .br
                   1113: .Nm apropos , whatis :
                   1114: .No man-db Pq Dec 29, 2002
                   1115: .Pp
                   1116: print the name of every parsed file
                   1117: .br
                   1118: .Nm makemandb :
                   1119: .Nx Pq Feb 7, 2012
                   1120: .Pp
                   1121: .Bq obsolete hardware
                   1122: produce output on the Versatec printer
                   1123: .br
                   1124: .Nm man :
                   1125: .PWB
                   1126: .It Fl W
                   1127: disable the named warning
                   1128: .br
                   1129: .Nm groff :
                   1130: .Bx44N1
                   1131: .Pp
                   1132: list pathnames without additional information
                   1133: .br
                   1134: .Nm man :
                   1135: .man16
                   1136: .Pp
                   1137: list pathnames of cat files
                   1138: .br
                   1139: .Nm man :
                   1140: .No man-db Pq Aug 13, 2002
                   1141: .Pp
                   1142: minimum message level to display
                   1143: .br
                   1144: .Nm mandoc :
                   1145: .Ox 4.8 Pq April 6, 2009
                   1146: .br
                   1147: .Nm man , apropos , whatis :
                   1148: .Ox 5.7 Pq August 27, 2014
                   1149: .It Fl w
                   1150: list pathnames
                   1151: .br
                   1152: .Nm man :
                   1153: .At7 ,
                   1154: .At3 ,
                   1155: .At5 ,
                   1156: .Eaton ;
                   1157: .Ox , Fx , Nx , No man-db , man-1.6
                   1158: .br
                   1159: .Nm apropos , whatis , mandoc :
                   1160: .Ox 5.7 Pq August 27, 2014
                   1161: .Pp
                   1162: enable the named warning
                   1163: .br
                   1164: .Nm groff :
                   1165: .Bx44N1
                   1166: .Pp
                   1167: only create the
                   1168: .Xr whatis 1
                   1169: database
                   1170: .br
                   1171: .Nm catman :
                   1172: .Nx Pq July 27, 1993 ,
                   1173: .No Solaris 9-11
                   1174: .Pp
                   1175: use manpath obtained from man --path
                   1176: .br
                   1177: .Nm makewhatis :
                   1178: .man16
                   1179: .Pp
                   1180: use wildcard matching
                   1181: .br
                   1182: .Nm apropos , whatis :
                   1183: .dbI
                   1184: .Pp
                   1185: update the
                   1186: .Xr whatis 1
                   1187: database
                   1188: .br
                   1189: .Nm man :
                   1190: .No illumos
                   1191: .Pp
                   1192: .Bq obsolete hardware
                   1193: wait until the phototypesetter is available
                   1194: .br
                   1195: .Nm troff :
                   1196: .At7
                   1197: .It Fl X
                   1198: display with
                   1199: .Xr gxditview 1
                   1200: .br
                   1201: .Nm groff :
                   1202: .No groff-1.06 Pq Sep 1, 1992
                   1203: .br
                   1204: .Nm man :
                   1205: .dbI
                   1206: .It Fl y
                   1207: use the non-compacted version of the macros
                   1208: .br
                   1209: .Nm man :
                   1210: .At3 ,
                   1211: .At5
                   1212: .It Fl Z
                   1213: do not run preprocessors
                   1214: .br
                   1215: .Nm groff :
                   1216: .Bx44N1
                   1217: .br
                   1218: .Nm man :
                   1219: .dbI
                   1220: .It Fl z
                   1221: suppress formatted output from
                   1222: .Xr troff 1 ,
                   1223: print only error messages
                   1224: .br
                   1225: .Nm groff :
                   1226: .Bx44N1
                   1227: .It Fl 7
                   1228: ASCII output mode
                   1229: .br
                   1230: .Nm man :
                   1231: .dbI
                   1232: .It Fl \&?
                   1233: print a help message and exit
                   1234: .br
                   1235: .Nm groff :
                   1236: .g102
                   1237: .br
                   1238: .Nm man , manpath :
                   1239: .Eaton ;
                   1240: .Fx , No man-db
                   1241: .br
                   1242: .Nm apropos , whatis , mandb , catman :
                   1243: .dbI
                   1244: .El
                   1245: .Pp
                   1246: Multi-letter options:
                   1247: .Bl -tag -width Ds
                   1248: .It Fl hp
                   1249: .Bq obsolete hardware
                   1250: output to a Hewlett Packard terminal
                   1251: .br
                   1252: .Nm man :
                   1253: .PWB
                   1254: .It Fl 12
                   1255: .Bq obsolete hardware
                   1256: use 12-pitch for certain terminals
                   1257: .br
                   1258: .Nm man :
                   1259: .At3 ,
                   1260: .At5
                   1261: .It Fl 450
                   1262: .Bq obsolete hardware
                   1263: output to a DASI 450 terminal
                   1264: .br
                   1265: .Nm man :
                   1266: .PWB
                   1267: .El
                   1268: .Pp
                   1269: In
                   1270: .At v3 ,
                   1271: .Xr man 1
                   1272: had no options.
                   1273: .br
                   1274: The syntax was:
                   1275: .Sy man Ar name Op Ar section
                   1276: .Pp
                   1277: In
                   1278: .At v4 ,
                   1279: .br
                   1280: the syntax changed to:
                   1281: .Sy man Oo Ar section Oc Op Ar name ...
                   1282: .Sh AUTHORS
                   1283: This information was assembled by
                   1284: .An Ingo Schwarze Aq Mt schwarze@openbsd.org
                   1285: using
                   1286: .Bl -bullet -compact
                   1287: .It
                   1288: the Unix Archive of the Unix Heritage Society
                   1289: .It
                   1290: the CSRG Archive CD-ROMs
                   1291: .It
                   1292: the FreeBSD SVN repository
                   1293: .It
                   1294: the OpenBSD CVS repository
                   1295: .It
                   1296: the NetBSD CVS repository
                   1297: .It
                   1298: the man-db CVS and git repositories
                   1299: .It
                   1300: the final man-1.6 release tarball
                   1301: .It
                   1302: the illumos manual pages on the WWW
                   1303: .It
                   1304: and Solaris 11, SunOS 5.10, and SunOS 5.9 machines at opencsw.org.
                   1305: .El

CVSweb