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