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