]> git.cameronkatri.com Git - mandoc.git/blobdiff - man.options.1
Do not leak 64 bytes of heap memory every time a manual page calls
[mandoc.git] / man.options.1
index c885a3f0d1c7d971968ccfdc2ea678c6496e1e96..d8c790f4fa046689b98470b0d05ff77b7993c6c7 100644 (file)
@@ -1,4 +1,4 @@
-.\"    $Id: man.options.1,v 1.1 2017/02/02 02:17:31 schwarze Exp $
+.\"    $Id: man.options.1,v 1.7 2017/07/04 23:40:01 schwarze Exp $
 .\"
 .\" Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: February 2 2017 $
+.Dd $Mdocdate: July 4 2017 $
 .Dt MAN.OPTIONS 1
 .Os
 .Sh NAME
 .de Bx43
 .Bx 4.3 Pq June 1986 \\$1
 ..
-.de Bx44N1
-.Bx 4.3 Net/1 Pq March 3, 1989 \\$1
-..
-.de g102
-.No groff-1.02 Pq after March 1989, before June 1991 \\$1
+.\" option was present in groff-1.01 as contained in 4.3BSD-Net/2
+.\" and no mention of it could be found in the ChangeLog,
+.\" so it's probably older than groff-0.4, where the log started
+.de g04
+.No probably before groff-0.4 Pq before July 14, 1990 \\$1
 ..
 .de Eaton
 .No Eaton Pq before July 7, 1993; 1990/91? \\$1
 ..
-.\" man-1.6 was released on June 24, 2005.
-.de man16
-.No man-1.6 Pq not before 1993, not after 2005 \\$1
+.\" man-1.5e was released on July 11, 1998.
+.de man15e
+.No man-1.5e Pq not before 1993, not after 1998 \\$1
+..
+.\" man-1.5g was released on April 7, 1999.
+.de man15g
+.No man-1.5g Pq not before 1993, not after 1999 \\$1
 ..
-.\" first seen in the initial import of man-db into CVS
+.\" code first seen in the initial import of man-db into CVS ,
+.\" which was more or less debian man-db-2.3.17
+.\" Colin Watson's first release was 2.3.18 on May 14, 2001
+.\" no clue about it found in ChangeLog-2013,
+.\" so it was probably already present before man-db-2.2a4
 .de dbI
-.No man-db Pq before Apr 26, 2001; 1994/95? \\$1
+.No man-db probably before 2.2a4 Pq before Nov 8, 1994 \\$1
 ..
 .\"
 .\" --------------------------------------------------------------------
 .\"
-.Sh SYNOPSIS
-XXX
 .Sh DESCRIPTION
 This manual page lists option letters used in many different versions
 of the
@@ -136,17 +142,17 @@ ASCII output mode
 .At7
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .It Fl B
 use specified browser
 .br
 .Nm man :
-.man16
+.No man-1.6 Pq June 24, 2005
 .It Fl b
 print a backtrace with each warning or error message
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .Pp
 .Bq obsolete hardware
 report whether the phototypesetter is busy
@@ -158,13 +164,13 @@ alternate configuration file
 .br
 .Nm apropos , whatis :
 .Bx 4.4 Lite1 Pq April 22, 1994 ,
-.man16 ,
 .No man-db Pq Feb 22, 2003 ;
 .Ox , Nx
 .br
 .Nm man :
-.Nx 1.0 Pq Oct 26, 1994 ;
-.Ox ,
+.Nx 1.0 Pq Oct 26, 1994 ,
+.man15e ;
+.Ox
 .br
 .Nm mandb , catman , manpath :
 .No man-db Pq Feb 22, 2003
@@ -182,7 +188,7 @@ alternate configuration file
 enable compatibility mode
 .br
 .Nm groff :
-.Bx44N1
+.No before groff-0.5 Pq before August 3, 1990
 .It Fl c
 do not use a pager
 .br
@@ -193,21 +199,10 @@ do not use a pager
 .Nm apropos , whatis , mandoc :
 .Ox 5.7 Pq August 27, 2014
 .Pp
-disable terminal color output in
-.Xr grotty 1
-.br
-.Nm groff :
-.No groff-1.18.0 Pq Oct 4, 2001
-.Pp
-reformat source page even if cat page exists
-.br
-.Nm man :
-.man16
-.Pp
 process given catpath
 .br
 .Nm makewhatis :
-.man16
+.Pq not before 1992, not after 1995
 .Pp
 recreate databases from scratch
 .br
@@ -225,6 +220,17 @@ internal option for use by
 .Nm man :
 .dbI
 .Pp
+reformat source page even if cat page exists
+.br
+.Nm man :
+.man15e
+.Pp
+disable terminal color output in
+.Xr grotty 1
+.br
+.Nm groff :
+.No groff-1.18.0 Pq Oct 4, 2001
+.Pp
 recreate nroff versions from SGML sources
 .br
 .Nm catman :
@@ -238,17 +244,17 @@ postprocess with
 .At3 ,
 .At5
 .It Fl D
-print debugging info in addition to manual page
-.br
-.Nm man :
-.man16
-.Pp
 reset whatever was set with
 .Ev MANOPT
 .br
 .Nm man :
 .dbI
 .Pp
+print debugging info in addition to manual page
+.br
+.Nm man :
+.man15e
+.Pp
 set default input encoding for
 .Xr preconv 1
 .br
@@ -264,7 +270,7 @@ display all files added to
 define a user-defined string
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .Pp
 print debugging information
 .br
@@ -299,7 +305,7 @@ interpret arguments as file names
 inhibit all error messages
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .Pp
 select output encoding
 .br
@@ -313,22 +319,22 @@ preprocess with
 .At7
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .Pp
 adjust text to left and right margins
 .br
 .Nm nroff :
 .At7
 .Pp
-restrict search by section extension
-.br
-.Nm man :
-.dbI
-.Pp
 use exact matching
 .br
 .Nm apropos , whatis :
 .dbI
+.Pp
+restrict search by section extension
+.br
+.Nm man :
+.No man-db-2.3.5 Pq April 21, 1995
 .It Fl F
 use alternate font directory
 .br
@@ -336,14 +342,14 @@ use alternate font directory
 .Bx 4.2 Pq September 1983
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .Pp
 preformat only, do not display
 .br
 .Nm man :
-.man16
+.No man-1.5g Pq April 7, 1999
 .Pp
-force searchings dirs, do not use index (default)
+force searching dirs, do not use index (default)
 .br
 .Nm man :
 .No illumos , Solaris 9-11
@@ -366,7 +372,7 @@ mode
 set the default font family
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .Pp
 force formatting even if cat page is newer
 .br
@@ -403,7 +409,7 @@ preprocess with
 produce a global manpath
 .br
 .Nm manpath :
-.dbI
+.No man-db-2.2a7 Pq Nov 16, 1994
 .Pp
 preprocess with
 .Xr grn 1
@@ -426,22 +432,22 @@ output to a DASI 300 terminal in 12-pitch mode
 read hyphenation patterns from the given file
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .Pp
-use program to render HTML files as text
+produce HTML output
 .br
 .Nm man :
-.man16
+.No man-db-1.3.12 to 1.3.17 Pq not before 1996, not after 2001
 .Pp
-produce HTML output
+use program to render HTML files as text
 .br
 .Nm man :
-.dbI
+.No man-1.6 Pq June 24, 2005
 .It Fl h
 print a help message and exit
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .br
 .Nm man :
 .Eaton ;
@@ -499,7 +505,7 @@ read standard input after the input files are exhausted
 .At7
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .Pp
 ignore case when matching manual page names
 .br
@@ -526,8 +532,8 @@ preprocess with
 source code full text search
 .br
 .Nm man :
-.man16 ;
-.No man-db Pq June 28, 2009 ,
+.man15e ,
+.No man-db Pq June 28, 2009 ;
 .No Solaris 11
 .Pp
 input encoding
@@ -569,18 +575,18 @@ display on a Tektronix 4014 terminal
 pass argument to the spooler
 .br
 .Nm groff :
-.Bx44N1
-.Pp
-print list of locales
-.br
-.Nm manpath :
-.Fx Pq Nov 23, 1999
+.No groff-0.6 Pq Sep 14, 1990
 .Pp
 use alternate
 .Xr locale 1
 .br
 .Nm man , apropos , whatis :
-.dbI
+.No before man-db-2.2a13 Pq before Dec 15, 1994
+.Pp
+print list of locales
+.br
+.Nm manpath :
+.Fx Pq Nov 23, 1999
 .Pp
 use
 .Xr locale 1
@@ -592,12 +598,12 @@ specified in the environment
 spool the output
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .Pp
 interpret arguments as file names
 .br
 .Nm man :
-.dbI ,
+.No before man-2.2a7 Pq before Nov 16, 1994 ,
 .Ox 5.7 Pq Aug 30, 2014
 .br
 .Nm apropos , whatis , mandoc :
@@ -632,7 +638,7 @@ override manual page search path
 .br
 .Nm apropos , whatis :
 .Bx43 ,
-.dbI ;
+.No before man-db-2.2a14 Pq before Dec 16, 1994 ;
 .Ox , No illumos
 .br
 .Nm catman :
@@ -646,7 +652,7 @@ override manual page search path
 prepend to macro file search path
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .Pp
 do not show the context of the match
 .br
@@ -659,7 +665,7 @@ specify input macro language
 .At7
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .br
 .Nm mandoc :
 .Ox 4.8 Pq April 6, 2009
@@ -700,7 +706,7 @@ do not allow newlines between
 delimiters
 .br
 .Nm groff :
-.Bx44N1
+.No groff-1.01 Pq Feb 21, 1991
 .It Fl n
 specify a page number for the first page
 .br
@@ -708,7 +714,7 @@ specify a page number for the first page
 .At7
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .Pp
 .Xr nroff 1
 output mode
@@ -755,7 +761,7 @@ select pages by numbers
 .At7
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .Pp
 force use of non-localized manual pages
 .br
@@ -770,7 +776,7 @@ optimize index for speed and disk space
 pass argument to postprocessor
 .br
 .Nm groff :
-.Bx44N1
+.No groff-0.6 Pq Sep 14, 1990
 .Pp
 use specified pager
 .br
@@ -787,7 +793,7 @@ preprocess with
 .Xr pic 1
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .Pp
 use the given list of preprocessors
 .br
@@ -864,7 +870,7 @@ postprocess with
 .Xr refer 1
 .br
 .Nm groff :
-.g102
+.No groff-1.02 Pq June 2, 1991
 .Pp
 recode to the specified encoding
 .br
@@ -877,24 +883,24 @@ set number register
 .At7
 .br
 .Nm groff :
-.Bx44N1
+.g04
+.Pp
+scan for and remove junk files
+.br
+.Nm catman :
+.Fx Pq March 31, 1995
 .Pp
 set
 .Xr less 1
 prompt
 .br
 .Nm man :
-.dbI
+.No man-db-2.3.5 Pq April 21, 1995
 .Pp
 use regular expression matching
 .br
 .Nm apropos , whatis :
-.dbI
-.Pp
-scan for and remove junk files
-.br
-.Nm catman :
-.Fx Pq March 31, 1995
+.No man-db-2.3.5 Pq April 21, 1995
 .Pp
 turn off formatting
 .br
@@ -937,7 +943,7 @@ preprocess with
 .Xr soelim 1
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .Pp
 silent mode, do not echo commands
 .br
@@ -946,6 +952,9 @@ silent mode, do not echo commands
 .Pp
 restrict section
 .br
+.Nm makewhatis :
+.man15g
+.br
 .Nm man :
 .Ox 2.3 Pq March 9, 1998 ,
 .Nx Pq June 12, 2000 ;
@@ -953,20 +962,17 @@ restrict section
 .br
 .Nm apropos :
 .No man-db Pq Nov 16, 2003 ,
-.Ox 4.5 Pq Dec 24, 2008 ;
-.Nx Pq May 8, 2009 ,
+.Ox 4.5 Pq Dec 24, 2008 ,
+.Nx Pq May 8, 2009 ;
 .No illumos
 .br
 .Nm whatis :
-.Ox 5.6 Pq April 18, 2014 ,
 .No man-db Pq Nov 16, 2003 ,
+.Ox 5.6 Pq April 18, 2014 ;
 .No illumos
 .br
 .Nm mandoc :
 .Ox 5.7 Pq August 27, 2014
-.br
-.Nm makewhatis :
-.man16
 .Pp
 do not look for stray cats
 .br
@@ -1011,7 +1017,7 @@ select terminal output format
 .Ox 5.7 Pq August 27, 2014
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .br
 .Nm mandoc :
 .Ox 4.8 Pq April 6, 2009
@@ -1050,12 +1056,12 @@ preprocess with
 .Xr tbl 7
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .Pp
 check manual pages in the hierarchy
 .br
 .Nm mandb :
-.dbI
+.No man-db-1.3.12 to 1.3.17 Pq not before 1996, not after 2001
 .Pp
 check files for problems related to
 .Xr mandoc.db 5
@@ -1071,18 +1077,18 @@ unsafe mode
 update database
 .br
 .Nm makewhatis :
-.man16
-.Pp
-update database cache (requires suid)
-.br
-.Nm man :
-.dbI
+.Pq not before 1992, not after 1995
 .Pp
 create user databases only
 .br
 .Nm mandb :
 .dbI
 .Pp
+update database cache (requires suid)
+.br
+.Nm man :
+.No before man-db-2.2a10 Pq before Dec 6, 1994
+.Pp
 remove files from
 .Xr mandoc.db 5
 .br
@@ -1092,7 +1098,7 @@ remove files from
 print the pipeline on stdout instead of executing it
 .br
 .Nm groff :
-.Bx44N1
+.No groff-0.6 Pq Sep 2, 1990
 .Pp
 print version information
 .br
@@ -1102,7 +1108,7 @@ print version information
 print version number
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .Pp
 verbose mode
 .br
@@ -1110,7 +1116,7 @@ verbose mode
 .Fx Pq March 15, 1995
 .br
 .Nm makewhatis :
-.man16
+.man15g
 .br
 .Nm apropos , whatis :
 .No man-db Pq Dec 29, 2002
@@ -1129,12 +1135,12 @@ produce output on the Versatec printer
 disable the named warning
 .br
 .Nm groff :
-.Bx44N1
+.No groff-0.5 Pq August 14, 1990
 .Pp
 list pathnames without additional information
 .br
 .Nm man :
-.man16
+.man15e
 .Pp
 list pathnames of cat files
 .br
@@ -1164,7 +1170,7 @@ list pathnames
 enable the named warning
 .br
 .Nm groff :
-.Bx44N1
+.No groff-0.5 Pq August 14, 1990
 .Pp
 only create the
 .Xr whatis 1
@@ -1174,15 +1180,15 @@ database
 .Nx Pq July 27, 1993 ,
 .No Solaris 9-11
 .Pp
-use manpath obtained from man --path
-.br
-.Nm makewhatis :
-.man16
-.Pp
 use wildcard matching
 .br
 .Nm apropos , whatis :
-.dbI
+.No man-db-2.3.5 Pq April 21, 1995
+.Pp
+use manpath obtained from man --path
+.br
+.Nm makewhatis :
+.man15g
 .Pp
 update the
 .Xr whatis 1
@@ -1215,27 +1221,27 @@ use the non-compacted version of the macros
 do not run preprocessors
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .br
 .Nm man :
-.dbI
+.No man-db-2.2a5 Pq Nov 10, 1994
 .It Fl z
 suppress formatted output from
 .Xr troff 1 ,
 print only error messages
 .br
 .Nm groff :
-.Bx44N1
+.g04
 .It Fl 7
 ASCII output mode
 .br
 .Nm man :
-.dbI
+.No man-db-2.3.5 Pq April 21, 1995
 .It Fl \&?
 print a help message and exit
 .br
 .Nm groff :
-.g102
+.g04
 .br
 .Nm man , manpath :
 .Eaton ;
@@ -1291,15 +1297,34 @@ the Unix Archive of the Unix Heritage Society
 .It
 the CSRG Archive CD-ROMs
 .It
-the FreeBSD SVN repository
+the
+.Fx
+SVN repository
+.It
+the
+.Ox
+CVS repository
+.It
+the
+.Nx
+CVS repository
+.It
+the GNU roff (groff) git repository
+.It
+the 4.3BSD-Net/2 groff CHANGES file (Oct 1990 to March 1991)
+.It
+the 4.3BSD-Net/2 groff ChangeLog file (July 1990 to March 1991)
+.It
+the man-db CVS and git repositories (since April 2001)
 .It
-the OpenBSD CVS repository
+the man-db NEWS file (April 1995 to Dec 2016)
 .It
-the NetBSD CVS repository
+the man-db ChangeLog-2013 file (Nov 1994 to Dec 2013)
 .It
-the man-db CVS and git repositories
+release tarballs man-1.5g (July 1998) to man-1.5p (Jan 2005),
+man-1.6 (June 2005), and man-1.6a to man-1.6g (Dec 2010)
 .It
-the final man-1.6 release tarball
+a makewhatis release tarball without version number from 1995
 .It
 the illumos manual pages on the WWW
 .It