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