head 1.1; branch 1.1.1; access; symbols netbsd-8-3-RELEASE:1.1.1.2 netbsd-9-4-RELEASE:1.1.1.4 netbsd-10-0-RELEASE:1.1.1.4 netbsd-10-0-RC6:1.1.1.4 netbsd-10-0-RC5:1.1.1.4 netbsd-10-0-RC4:1.1.1.4 netbsd-10-0-RC3:1.1.1.4 netbsd-10-0-RC2:1.1.1.4 netbsd-10-0-RC1:1.1.1.4 netbsd-10:1.1.1.4.0.10 netbsd-10-base:1.1.1.4 netbsd-9-3-RELEASE:1.1.1.4 cjep_sun2x-base1:1.1.1.4 cjep_sun2x:1.1.1.4.0.8 cjep_sun2x-base:1.1.1.4 cjep_staticlib_x-base1:1.1.1.4 netbsd-9-2-RELEASE:1.1.1.4 cjep_staticlib_x:1.1.1.4.0.6 cjep_staticlib_x-base:1.1.1.4 netbsd-9-1-RELEASE:1.1.1.4 phil-wifi-20200421:1.1.1.4 phil-wifi-20200411:1.1.1.4 is-mlppp:1.1.1.4.0.4 is-mlppp-base:1.1.1.4 phil-wifi-20200406:1.1.1.4 netbsd-8-2-RELEASE:1.1.1.2 netbsd-9-0-RELEASE:1.1.1.4 netbsd-9-0-RC2:1.1.1.4 netbsd-9-0-RC1:1.1.1.4 phil-wifi-20191119:1.1.1.4 netbsd-9:1.1.1.4.0.2 netbsd-9-base:1.1.1.4 phil-wifi-20190609:1.1.1.4 netbsd-8-1-RELEASE:1.1.1.2 netbsd-8-1-RC1:1.1.1.2 mdocml-1-14-5:1.1.1.4 pgoyette-compat-merge-20190127:1.1.1.2.10.1 pgoyette-compat-20190127:1.1.1.3 pgoyette-compat-20190118:1.1.1.3 pgoyette-compat-1226:1.1.1.3 pgoyette-compat-1126:1.1.1.3 pgoyette-compat-1020:1.1.1.3 pgoyette-compat-0930:1.1.1.3 pgoyette-compat-0906:1.1.1.3 mdocml-1-14-4:1.1.1.3 pgoyette-compat-0728:1.1.1.2 netbsd-8-0-RELEASE:1.1.1.2 phil-wifi:1.1.1.2.0.12 phil-wifi-base:1.1.1.2 pgoyette-compat-0625:1.1.1.2 netbsd-8-0-RC2:1.1.1.2 pgoyette-compat-0521:1.1.1.2 pgoyette-compat-0502:1.1.1.2 pgoyette-compat-0422:1.1.1.2 netbsd-8-0-RC1:1.1.1.2 pgoyette-compat-0415:1.1.1.2 pgoyette-compat-0407:1.1.1.2 pgoyette-compat-0330:1.1.1.2 pgoyette-compat-0322:1.1.1.2 pgoyette-compat-0315:1.1.1.2 pgoyette-compat:1.1.1.2.0.10 pgoyette-compat-base:1.1.1.2 matt-nb8-mediatek:1.1.1.2.0.8 matt-nb8-mediatek-base:1.1.1.2 perseant-stdc-iso10646:1.1.1.2.0.6 perseant-stdc-iso10646-base:1.1.1.2 netbsd-8:1.1.1.2.0.4 netbsd-8-base:1.1.1.2 prg-localcount2-base3:1.1.1.2 prg-localcount2-base2:1.1.1.2 prg-localcount2-base1:1.1.1.2 prg-localcount2:1.1.1.2.0.2 prg-localcount2-base:1.1.1.2 pgoyette-localcount-20170426:1.1.1.2 bouyer-socketcan-base1:1.1.1.2 pgoyette-localcount-20170320:1.1.1.2 mdocml-1-14-1:1.1.1.2 bouyer-socketcan:1.1.1.1.0.4 bouyer-socketcan-base:1.1.1.1 pgoyette-localcount-20170107:1.1.1.1 pgoyette-localcount-20161104:1.1.1.1 localcount-20160914:1.1.1.1 pgoyette-localcount-20160806:1.1.1.1 pgoyette-localcount:1.1.1.1.0.2 pgoyette-localcount-20160726:1.1.1.1 mdocml-1-13-4:1.1.1.1 KRISTAPS:1.1.1; locks; strict; comment @.\" @; 1.1 date 2016.07.15.14.25.56; author christos; state Exp; branches 1.1.1.1; next ; commitid 1Uhv267ohfbwrqez; 1.1.1.1 date 2016.07.15.14.25.56; author christos; state Exp; branches 1.1.1.1.2.1 1.1.1.1.4.1; next 1.1.1.2; commitid 1Uhv267ohfbwrqez; 1.1.1.2 date 2017.03.18.15.06.51; author christos; state Exp; branches 1.1.1.2.10.1 1.1.1.2.12.1; next 1.1.1.3; commitid kAn9hvVDJyLiL2Kz; 1.1.1.3 date 2018.08.14.08.41.03; author christos; state Exp; branches; next 1.1.1.4; commitid GxOyTdy7PtUv64OA; 1.1.1.4 date 2019.03.10.22.28.58; author christos; state Exp; branches; next ; commitid OY2rN8xVGWKe0SeB; 1.1.1.1.2.1 date 2016.07.15.14.25.56; author pgoyette; state dead; branches; next 1.1.1.1.2.2; commitid x7TlcOjghfjvqMfz; 1.1.1.1.2.2 date 2016.07.26.03.24.14; author pgoyette; state Exp; branches; next 1.1.1.1.2.3; commitid x7TlcOjghfjvqMfz; 1.1.1.1.2.3 date 2017.03.20.06.56.03; author pgoyette; state Exp; branches; next ; commitid jjw7cAwgyKq7RfKz; 1.1.1.1.4.1 date 2017.04.21.16.52.02; author bouyer; state Exp; branches; next ; commitid dUG7nkTKALCadqOz; 1.1.1.2.10.1 date 2018.09.06.06.51.48; author pgoyette; state Exp; branches; next ; commitid HCi1bXD317XIK0RA; 1.1.1.2.12.1 date 2019.06.10.21.51.09; author christos; state Exp; branches; next ; commitid jtc8rnCzWiEEHGqB; desc @@ 1.1 log @Initial revision @ text @.\" Id: man.conf.5,v 1.3 2015/03/27 21:33:20 schwarze Exp .\" .\" Copyright (c) 2015 Ingo Schwarze .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. .\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" .Dd March 27, 2015 .Dt MAN.CONF 5 .Os .Sh NAME .Nm man.conf .Nd configuration file for man .Sh DESCRIPTION This is the configuration file for the .Xr man 1 , .Xr apropos 1 , and .Xr makewhatis 8 utilities. Its presence, and all directives, are optional. .Pp This file is an ASCII text file. Leading whitespace on lines, lines starting with .Sq # , and blank lines are ignored. Words are separated by whitespace. The first word on each line is the name of a configuration directive. .Pp The following directives are supported: .Bl -tag -width Ds .It Ic manpath Ar path Override the default search .Ar path for .Xr man 1 , .Xr apropos 1 , and .Xr makewhatis 8 . It can be used multiple times to specify multiple paths, with the order determining the manual page search order. .Pp Each path is a tree containing subdirectories whose names consist of the strings .Sq man and/or .Sq cat followed by the names of sections, usually single digits. The former are supposed to contain unformatted manual pages in .Xr mdoc 7 and/or .Xr man 7 format; file names should end with the name of the section preceded by a dot. The latter should contain preformatted manual pages; file names should end with .Ql .0 . .Pp Creating a .Xr mandoc.db 5 database with .Xr makewhatis 8 in each directory configured with .Ic manpath is recommended and necessary for .Xr apropos 1 to work, but not strictly required for .Xr man 1 . .It Ic output Ar option Op Ar value Configure the default value of an output option. These directives are overridden by the .Fl O command line options of the same names. For details, see the .Xr mandoc 1 manual. .Pp .Bl -column fragment integer "ascii, utf8" -compact .It Ar option Ta Ar value Ta used by Fl T Ta purpose .It Ta Ta Ta .It Ic fragment Ta none Ta Cm html Ta print only body .It Ic includes Ta string Ta Cm html Ta path to header files .It Ic indent Ta integer Ta Cm ascii , utf8 Ta left margin .It Ic man Ta string Ta Cm html Ta path for Xr links .It Ic paper Ta string Ta Cm ps , pdf Ta paper size .It Ic style Ta string Ta Cm html Ta CSS file .It Ic width Ta integer Ta Cm ascii , utf8 Ta right margin .El .It Ic _whatdb Ar path Ns Cm /whatis.db This directive provides the same functionality as .Ic manpath , but using a historic and misleading syntax. It is kept for backward compatibility for now, but will eventually be removed. .El .Sh FILES .Pa /etc/man.conf .Sh EXAMPLES The following configuration file reproduces the defaults: installing it is equivalent to not having a .Nm file at all. .Bd -literal -offset indent manpath /usr/share/man manpath /usr/X11R6/man manpath /usr/local/man .Ed .Sh SEE ALSO .Xr apropos 1 , .Xr man 1 , .Xr makewhatis 8 .Sh HISTORY A relatively complicated .Nm file format first appeared in .Bx 4.3 Reno . For .Ox 5.8 , it was redesigned from scratch, aiming for simplicity. .Sh AUTHORS .An Ingo Schwarze Aq Mt schwarze@@openbsd.org @ 1.1.1.1 log @Changes in version 1.13.4, released on July 14, 2016 --- MAJOR NEW FEATURES --- * man.conf(5): Design and implement a simpler configuration file format. * man(1): Leverage less(1) -T and :t in a way resembling ctags(1) to jump to the definitions of various terms inside manual pages. * soelim(1): New implementation by Baptiste Daroussin. * privilege limitation: Use OpenBSD pledge(2) or OS X sandbox_init(3) when available. * man.cgi(8): Support short URIs like http://man.openbsd.org/mdoc . * mandoc.css: Use one unified stylesheet rather than three different ones. --- MAJOR FUNCTIONALLY RELEVANT BUGFIXES --- * mdoc(7): Fix multiple aspects of SYNOPSIS .Nm formatting. * man(1): Fix process group handling, avoiding unclean shutdowns. --- PORTABILITY IMPROVEMENTS --- * Correctly use the ohash(3) compatibility implementation even when building without SQLite support. * Add compat glue for building on Solaris 9 and 10. * Let ./configure select a supported RE syntax for word boundaries. * Support LDFLAGS, to be used for example for hardening options. * Avoid mixing putchar(3) and putwchar(3) on the same file descriptor, it resulted in output corruption on some platforms. * Avoid reusing va_lists, use va_copy(3) for better portability. * Do not hardcode the path to the more(1) program. --- MINOR NEW FEATURES --- * roff(7): Implement \n(.$ (number of macro arguments). * roff(7): Fully implement \z (do not advance cursor). * roff(7): Implement the `r' conditional (register exists). * roff(7): Implement \\$* (interpolate all arguments). * roff(7): Parse and ignore \, and \/ (italic corrections). * When there is no -m, no -M, no MANPATH and no /etc/man.conf, fall back to /usr/share/man:/usr/X11R6/man:/usr/local/man. * man(1): Give manuals in purely numerical sections priority over manuals of the same name in sections with an alphabetical suffix. * man.cgi(8): Support "header.html" and "footer.html". * man.cgi(8): Set the "autofocus" attribute on the query text box. * man.cgi(8): Simplify the search form, drop two useless buttons. * man.cgi(8): Delete the pseudo-manpath "mandoc", assume that apropos(1) and man.cgi(8) are installed in the default manpath. --- RELIABILITY BUGFIXES --- * mdoc(7): Avoid a use after free and an assertion failure when nodes are deleted during validation. * mdoc(7): Avoid a NULL pointer access when .Bd has no arguments. * mdoc(7): Avoid a NULL pointer access triggered by mismatching end macros. * mdoc(7): Avoid an assertion when .Fo has no argument. * mdoc(7): Avoid an assertion when .Ta occurs in .Bl -column. * mdoc(7): Avoid an assertion when a body gets broken and has a tail. * roff(7): Avoid an assertion caused by blanks inside \o. * roff(7): Make .so links to gziped manuals work without mandoc.db(5). * tbl(7): Avoid a use after free when the last line of a layout is empty. * eqn(7): Avoid an infinite loop caused by recursive "define". * makewhatis(8): Avoid a segfault caused by unusual directory structures. * Fix handling of leading, trailing, and double colons in MANPATH and -m. --- MINOR BUGFIXES --- * mdoc(7): Put arguments to end macros of broken partial explicit blocks inside the breaking block. * mdoc(7): Let .Dv force normal font. * mdoc(7): Make trailing whitespace significant in .Bl -tag widths. * mdoc(7): Fix macro interpretation around tabs in .Bl -column. * man(7): Use the default width for .RS without arguments. * man(7): On a new RS nesting level, the saved width starts from the default width, not from the saved width of the previous level. * man(7): Allow .PD in next-line scope. * man(7): Improve handling of empty .HP. * man(7): Improve formatting of .br and .sp inside .HP. * man(7): Do not mistreat empty arguments to font alternating macros as vertical spacing requests. * man(7): Allow fill mode changes in tagged paragraph next-line scope. * man(7): Fix minor bugs in block rewinding and simplify the related code. * man(7): Add missing line breaks before subsection headers. * man(7): Give section and subsection headers hanging indentation. * man(7): Make trailing whitespace significant in .TP widths. * roff(7): Don't allow breaking the output line after hyphens that immediately follow escape sequences. * roff(7): Ignore blank characters at the beginning of conditional blocks. * roff(7): Escape breakable hyphens only after handling input line traps. * roff(7): Reject \[uD800] to \[uDFFF] (surrogates) in the parser. * tbl(7): Allow more than one data field after T} on the same input line. * terminal output: Apply bold and italic to non-ASCII Unicode codepoints. * terminal output: Improve rounding rules for horizontal scaling widths. * HTML output: Render ASCII_NBRSP as " ", not "-". * man(1): Do not match the first part of a name if it continues with a dot. * man(1): Keep working even if the current directory is unusable. * man(1): Better error message when $PAGER is invalid. * makewhatis(8): Improve handling of .Va and .Vt macros. * apropos(1): Print "nothing appropriate" to stderr when appropriate. * apropos(1): Abort with a useful error message when elementary database operations like preparing queries or binding variables fail. --- STRUCTURAL CHANGES, no functional change --- * mdoc(7) and man(7): Unified data structures struct roff_node etc. * mdoc(7) and man(7): Unified node handling library in roff.c. * mdoc(7) and man(7): Seperate validation phase from parsing. * roff(7): Major character table cleanup. * Link with libz rather than forking gunzip(1). --- THANKS TO --- * Baptiste Daroussin (FreeBSD) for the new soelim(1) and for release testing. * Anthony Bentley (OpenBSD) for unifying mandoc.css, two nice patches for man.cgi(8), some documentation patches, some bug reports, and various useful discussions. * Todd Miller (OpenBSD) for lots of help with process group and signal handling, a few patches, some bug reports and some useful discussions. * Jonathan Gray (OpenBSD) for yet more testing with afl(1) again resulting in more than half a dozen important bug reports. * Svyatoslav Mishyn (Crux Linux) for some patches, several bug reports, and extensive release testing. * Christian Neukirchen (void Linux) for a number of compatibility patches and suggestions and several bug reports. * Christos Zoulas (NetBSD) for a bug fix patch and some useful suggestions for cleanup. * Florian Obser (OpenBSD) for a bugfix patch and some bug reports. * Sevan Janiyan for help with Solaris compatibility and release testing on many platforms. * Jan Holzhueter and OpenCSW in general for help with Solaris compatibility, and for providing me with a Solaris 9/10/11 testing environment. * Michael McConville (OpenBSD) for some simple cleanup patches. * Thomas Klausner (NetBSD) for some bug reports and release testing. * Christian Weisgerber, Dmitrij Czarkoff, Igor Sobrado, Ken Westerback, Marc Espie, Mike Belopuhov, Rafael Neves, Ted Unangst, Tim van der Molen, Theo Buehler, Theo de Raadt (OpenBSD), Kurt Jaeger, Dag Erling Smoergrav (FreeBSD), Joerg Sonnenberger (NetBSD), Carsten Kunze (Heirloom troff), Daniel Levai, Fabian Raetz, Jan Stary, Jean-Yves Migeon, Lorenzo Beretta, Markus Waldeck, Maxim Belooussov, Michael Reed, Peter Bray, and Serguey Parkhomovsky for bug reports and feature suggestions. * Alexander Hall, Andrew Fresh, Antoine Jacoutot, Doug Hogan, Jason McIntyre, Jasper Lievisse Adriaanse, Kent Spillner, Nicholas Marriott, Peter Hessler, Sebastien Marie, Stefan Sperling, and Theo de Raadt (OpenBSD) for helpful discussions and feedback. @ text @@ 1.1.1.1.4.1 log @Sync with HEAD @ text @d1 1 a1 1 .\" Id: man.conf.5,v 1.4 2016/12/28 22:52:17 schwarze Exp d17 1 a17 1 .Dd December 28, 2016 d94 1 a94 1 .It Ic man Ta string Ta Cm html Ta path for \&Xr links @ 1.1.1.2 log @ Changes in version 1.14.1, released on February 21, 2017 --- MAJOR NEW FEATURES --- * apropos(1): Reimplement complete semantic search functionality without the dependency on SQLite3, using only POSIX APIs. This comes with a completely new mandoc.db(5) file format. * man(1): Support more than one tag entry for the same search term, plus some minor improvements to the less(1) :t support. * -Thtml: Use real macro names for CSS classes. Systematic cleanup of and many improvements to mandoc.css. * -Thtml: Produce human readable HTML code by using indentation and better line breaks. Improve various HTML elements, and trim several useless ones. * New catman(8) utility, still somewhat experimental. * Now includes a portable version of the OpenBSD mandoc regression suite, see regress/regress.pl.1 for details. --- REMOVED FUNCTIONALITY --- * Operating systems that don't provide mmap(3) are no longer supported. * Drop support for manpath(1). Even if your system has manpath(1), it is simpler to use MANPATH_DEFAULT in configure.local for operating system defaults, man.conf(5) for machine-specific modifications, and ${MANPATH}, -m, and -M for user preferences than to bother with the complexity of manpath(1). * makewhatis(8) -p: No longer warn about missing MLINKS since these are no longer needed for anything. --- MINOR NEW FEATURES --- * mdoc(7): Warn about invalid punctuation and content below NAME. * mdoc(7): Warn about .Xr lacking the second argument (section). * mdoc(7): Warn about violations of the rule "new sentence, new line". * roff(7): Warn about trailing whitespace at the end of comments. * mdoc(7): Improve rendering of double quotes. * mdoc(7): Always do text production in the validator, never in the formatters. Cleaner, simpler, shorter, helps NetBSD apropos(1) and also makes -Ttree output more useful. * -Ttree: Show metadata and some additional node flags. New -Onoval output option to show the unvalidated tree. --- RELIABILITY BUGFIXES --- * man(1): Make "man -l" work with standard input from a pipe or file, as long as standard output is a terminal. * man(7): Fix out of bounds read access if a text node immediately preceded the first .SH header. * mdoc(7): Fix out of bounds read access for .Bl without a type but with a width. * mdoc(7): Fix out of bounds read access for .Bl -column starting with a tab character instead of a child .It macro. * mdoc(7): Fix syntax tree corruption leading to segfaults caused by stray block end macros in nested blocks of mismatching type. * man(1): Fix NULL dereference when the first of multiple pages shown was preformatted. * mdoc(7): Fix syntax tree corruption leading to NULL dereference caused by partial implicit macros inside .Bl -column table cells. * mdoc(7): Fix syntax tree corruption leading to NULL dereference for macro sequences like .Bl .Bl .It Bo .El .It. * mdoc(7): Fix syntax tree corruption leading to NULL dereference caused by .Ta following a nested .Bl -column breaking another block. * mdoc(7): Fix syntax tree corruption sometimes leading to NULL dereference caused by indirectly broken .Nd or .Nm blocks. * mdoc(7) -Thtml: Fix a NULL dereference for .Bl -column with 0 columns. * mdoc(7): Fix NULL dereference in some specific cases of a block-end macro calling another block-end macro. * mdoc(7): Fix NULL dereference if the only child of the head of the first .Sh was an empty in-line macro. * eqn(7): Fix NULL dereference in the terminal formatter for empty matrices and empty square roots. * mdoc(7): Fix an assertion failure for a .Bd without a type that breaks another block. * mdoc(7): Fix an assertion failure that happened for some .Bl -column lists containing a column width of "-4n", "-3n", or "-2n". * mdoc(7): Fix an assertion failure caused by .Bl -column without .It but containing eqn(7) or tbl(7) code. * roff(7): Fix an assertion failure caused by \z\[u00FF] with -Tps/-Tpdf. * roff(7): Fix an assertion failures caused by whitespace inside \o'' (overstrike) sequences. * -Thtml: Fix an assertion failure caused by -Oman or -Oincludes of excessive length. --- PORTABILITY IMPROVEMENTS --- * man(1): Do not mix stdio narrow and wide stream orientation on stdout, which could cause output corruption on glibc. * mandoc(1): Autodetect a suitable locale for -Tutf8 mode. * ./configure: Autodetect whether PATH_MAX and O_DIRECTORY are defined. * ./configure: Autodetect if nanosleep(3) needs -lrt. * ./configure: Provide an ${LN} configuration variable. * ./configure: Put compiler arguments that may contain -l at the end. --- MINOR BUGFIXES --- * mdoc(7): Fix SYNOPSIS output if the first child of .Nm is a macro. * mdoc(7) -Thtml: Improve formatting of .Bl -tag with short tags. * man(7) -Thtml: Preserve whitespace in .nf (nofill) mode. * mandoc(1): Error out on invalid output options on the command line. --- STRUCTURAL CHANGES, no functional change --- * Redesign part of the mandoc_html(3) interfaces, making them much easier to use and reducing the amount of code by a few hundred lines. --- THANKS TO --- * Michael Stapelberg (Debian) for designing the new mandocd(8) and parts of the new catman(8), for release testing, and for a number of patches and bug reports. * Baptiste Daroussin (FreeBSD) for profiling the new makewhatis(8) implementation and suggesting an algorithmic improvement which more than doubled performance, and for a few bug reports. * Ed Maste (FreeBSD) for an important patch improving reproducibility of builds in makewhatis(8), and for a few bug reports. * Theo Buehler (OpenBSD) for almost twenty important bug reports, most of them found by systematic afl(1) fuzzing. * Benny Lofgren, David Dahlberg, and in particular Vadim Zhukov for crucial help in getting .Bl -tag CSS formatting fixed. * Svyatoslav Mishyn (Crux Linux) for an initial version of the patch to autodetect a suitable locale for -Tutf8 mode and for release testing. * Jason McIntyre (OpenBSD) for multiple useful discussions and a number of bug reports. * Sevan Janiyan (NetBSD) for extensive release testing and multiple bug reports. * Thomas Klausner and Christos Zoulas (NetBSD), Yuri Pankov (illumos), and Leah Neukirchen (Void Linux) for release testing and bug reports. * Ulrich Spoerlein (FreeBSD) for release testing. * Alexander Bluhm, Andrew Fresh, Antoine Jacoutot, Antony Bentley, Christian Weisgerber, Jonathan Gray, Marc Espie, Martijn van Duren, Stuart Henderson, Ted Unangst, Theo de Raadt (OpenBSD), Abhinav Upadhyay, Kamil Rytarowski (NetBSD), Aaron M. Ucko, Bdale Garbee, Reiner Herrmann, Shane Kerr (Debian), Daniel Sabogal (Alpine Linux), Carsten Kunze (Heirloom roff), Kristaps Dzonsons (bsd.lv), Anton Lindqvist, Jan Stary, Jeremy A. Mates, Mark Patruck, Pavan Maddamsetti, Sean Levy , and Tiago Silva for bug reports. * Brent Cook, Marc Espie, Philip Guenther, Todd Miller (OpenBSD) and Markus Waldeck for useful discussions. * And as usual, OpenCSW for providing me with a Solaris 9/10/11 testing environment. @ text @d1 1 a1 1 .\" Id: man.conf.5,v 1.4 2016/12/28 22:52:17 schwarze Exp d17 1 a17 1 .Dd December 28, 2016 d94 1 a94 1 .It Ic man Ta string Ta Cm html Ta path for \&Xr links @ 1.1.1.2.12.1 log @Sync with HEAD @ text @d1 1 a1 1 .\" Id: man.conf.5,v 1.6 2018/10/02 14:56:47 schwarze Exp d3 1 a3 1 .\" Copyright (c) 2015, 2017 Ingo Schwarze d17 1 a17 1 .Dd October 2, 2018 d77 2 a78 6 to work, and also for .Xr man 1 on operating systems like .Ox that install each manual page with only one file name in the file system, even if it documents multiple utilities or functions. a96 1 .It Ic toc Ta none Ta Cm html Ta print table of contents @ 1.1.1.2.10.1 log @Sync with HEAD Resolve a couple of conflicts (result of the uimin/uimax changes) @ text @d1 1 a1 1 .\" Id: man.conf.5,v 1.5 2017/08/22 18:17:52 schwarze Exp d17 1 a17 1 .Dd August 22, 2017 d77 2 a78 6 to work, and also for .Xr man 1 on operating systems like .Ox that install each manual page with only one file name in the file system, even if it documents multiple utilities or functions. @ 1.1.1.3 log @Import 1.14.4 This file lists the most important changes in the mandoc.bsd.lv distribution. Changes in version 1.14.4, released on August 8, 2018 --- MAJOR NEW FEATURES --- * In ASCII output, render mathematical symbols and greek letters as transliterations conveying the characters' meanings rather than trying to imitate their shape. Consequently, such characters can now be used in portable manual pages. All the same, please limit their use to contexts where they really matter, for example when showing complicated mathematical formulae. * First steps towards better support for small screens in HTML output (responsive design): avoid most style= attributes, in particular all hard-coded indentations and column widths, and provide a better mandoc.css style sheet with a @@media query, using em units throughout, and avoiding redundancy in selectors. * Better HTML output with some more fitting HTML elements, eliminating needless class= attributes, and avoiding various HTML syntax errors (element nesting, URL-fragment syntax, duplicate id= attributes). --- MINOR NEW FEATURES --- * When a man(1) argument contains a slash, imply -l like in man-db. * Use TIOCGWINSZ to reduce the default -Owidth and -Oindent during interactive use on terminals narrower than 79 columns. * Generated PostScript files are now more than 50% smaller. * Terminal rendering of eqn(7) is improved in several respects. * Simplified and nicer output from the mdoc(7) .Lk macro, formatting all links in-line, even long ones. * roff(7) \n+ and \n- numerical register auto-increment and -decrement * roff(7) .nr optional third argument (auto-increment step size) * Autodetect in ./configure whether the compiler can use -W and -static, allowing to build on Solaris 10 and 11 without any configure.local. --- RELIABILITY BUGFIXES --- * Only activate UTF-8 output when the user really selected UTF-8, not some other multibyte character encoding. * Prevent excessive .ll arguments from generating infinite output. * Fix out of bounds accesses to parse buffers that could happen when using renamed or user defined macros after roff(7) conditionals. * Avoid an assertion failure in certain .Bl -column lists. * Avoid a NULL pointer access on deroff() failure after '.SS ""'. * Fix a segfault that could be triggered by two invalid .Dt macros. * Fix two syntax errors in generated PDF files. * Properly state the page size in generated PostScript files. * Close a memory leak caused by missing gzclose(3). * Fix misformatting of man(7) documents lacking .SH macros in PostScript and PDF output. * And many minor bugfixes. --- THANKS TO --- * Marc Espie (OpenBSD) for implementing the size reduction of PostScript files, one additional patch for code simplification, and two bug reports. * Theo Buehler (OpenBSD) for a bugfix patch, and Theo de Raadt (OpenBSD) for checking it. * John Gardner for more than a dozen suggestions regarding HTML output. * Mike Williams for teaching me how to use %%DocumentMedia and setpagedevice in PostScript files. * Werner Lemberg (groff) for feedback on mdoc(7) language changes. * Colin Watson (man-db) for feedback on man-db semantics. * Jason McIntyre (OpenBSD) for lots of feedback and suggestions on diagnostic messages and on the documentation. * Thomas Klausner (NetBSD) for suggesting two new style messages and one new feature, for two bug reports, and for release testing. * Leah Neukirchen (Void Linux) for suggesting a new style message, five bug reports, and release testing. * Anthony Bentley (OpenBSD) for reporting multiple bugs and missing features. * Paul Irofti (OpenBSD) and Nate Bargmann for suggesting new features. * Michael Stapelberg (Debian) for bug reports and release testing. * Christian Weisgerber, Jonathan Gray, Stuart Henderson, Ted Unangst (OpenBSD), Takeshi Nakayama (NetBSD), Anton Lazarov, Jakub Klinkovsky, Jan Stary, Jesper Wallin, Will Backmam, and Wolfgang Mueller for bug reports. * Sevan Janiyan (NetBSD) for additions to lib.in. * George Brown for suggesting code simplifications. * David Coppa, Igor Sobrado (OpenBSD), and Alexander Kuleshov for documentation improvements. * Laura Morales and Raf Czlonka for questions resulting in better documentation. * Yuri Pankov (illumos) for release testing. Changes in version 1.14.3, released on August 5, 2017 --- BUG FIXES --- * man(7): Do not crash with out-of-bounds read access to a constant array if .sp or a blank line immediately precedes .SS or .SH. * mdoc(7): Do not crash with out-of-bounds read access to a constant array if .sp or a blank line precede the first .Sh macro. * tbl(7): Ignore explicitly specified negative column widths rather than wrapping around to huge numbers and risking memory exhaustion. * man(1): No longer use names that only occur in the SYNOPSIS section. Gets rid of some surprising behaviour and bogus warnings. --- THANKS TO --- Leah Neukirchen (Void Linux), Markus Waldeck (Debian), Peter Bui (nd.edu), and Yuri Pankov (illumos) for bug reports. Changes in version 1.14.2, released on July 28, 2017 --- MAJOR NEW FEATURES --- * New mdoc(7) -Tmarkdown output mode. * For -Thtml, implement internal hyperlinks pointing to authoritative definitions of various syntax elements, similar to the ctags(1)-like less(1) :t internal searching in terminal mode. * Provide a superset of the functionality of the former mdoclint(1) utility and a new -Wstyle message level with several new messages, including validity checking of .Xr cross references. * tbl(7): Implement automatic line breaking inside individual table cells, and several other formatting improvements. * eqn(7): Complete rewrite of the lexer, resulting in several bugfixes. * Continue parser unification, in particular allowing generation of syntax tree nodes on the roff(7) level, allowing implementation of many additional roff requests. --- REMOVED FUNCTIONALITY --- * Delete the manpage(1) utility. It was never enabled in any release. * Delete the -Txhtml command line option. It has been an obsolete alias for the -Thtml output mode for more than two years. --- MINOR NEW FEATURES --- * -Tlint now puts parser messages on stdout instead of stderr, making commands like "man -l -Tlint *.1" useful. * mdoc(7): Various .Lk formatting improvements. * mdoc(7) -Thtml: Better CSS for .Bl lists. * man(7): Implement the .MT/.ME block macro (mailto hyperlink). * man(7): Implement the .DT macro (restore default tab positions). * man(7): Improved support for manuals generated with reStructuredText by partial support for the \n[an-margin] number register. * man(7) -Thtml: Support deep linking to .SH and .SS headers. * tbl(7): Implement the "allbox" table option. * tbl(7): Implement the column spacing and the 'w' (minimum column width) layout modifiers. * tbl(7): Significant improvements of the manual page. * eqn(7): Much improved font selection, including recognition of well-known function names, and a few other formatting improvements. * eqn(7) -Thtml: Use and in addition to . * roff(7): Implement the .ce (centering), .mc (margin character), .rj (right justify), .ta (define tab stops), .ti (temporary indent), .als (macro alias), .ec and .eo (escape character control), .po (page offset), and .rn (macro rename) requests. * roff(7) .am: Implement appending to mdoc(7) and man(7) macros. * roff(7): implement the \h (horizontol motion), \l (horizontal line drawing), and \p (break output line) escape sequences, and also several additional character escape sequences. * roff(7): Implement the 'd' conditional (macro or string defined). * man.cgi(8) now uses pledge(2), too. * regress.pl(1): simpler user interface, better summary output, simpler code, and no more recursion. --- THANKS TO --- * Anthony Bentley (OpenBSD) for the implementation of .MT/.ME, reports of many bugs and missing features, and suggestions for a number of feature and documentation improvements. * Sebastien Marie (OpenBSD) for two source code patches and for some useful discussions. * Florian Obser (OpenBSD) for a bugfix patch and a bug report. * Jonathan Gray (OpenBSD) for several bug reports from afl(1) and several more from static analysis tools. * Theo Buehler (OpenBSD) for several bug reports, most from afl(1). * Jason McIntyre (OpenBSD) for many useful discussions about a wide variety of topics, lots of continuous testing, a number of bug reports, and some suggestions for messages and documentation. * Thomas Klausner (NetBSD) for lots of help while migrating mdoclint(1) functionality to mandoc -Tlint, for suggesting several useful new messages, and for release testing. * Reyk Floeter (OpenBSD) and Vsevolod Stakhov (FreeBSD) for suggesting a markdown output mode. * Thomas Guettler for suggesting -Thtml internal hyperlinks. * Yuri Pankov (Illumos) for inspiring new warning messages and for extensive release testing. * Anton Lindqvist and TJ Townsend (both OpenBSD) and Jan Stary for multiple bug reports. * Leah Neukirchen (Void Linux) for bug reports and release testing. * Michael Stapelberg (Debian) for suggesting feature improvements and for release testing. * Martin Natano and Theo de Raadt (both OpenBSD), Andreas Voegele, Gabriel Guzman, Gonzalo Tornaria, Markus Waldeck, and Raf Czlonka for bug reports. * Antoine Jacoutot (OpenBSD) and Steffen Nurpmeso for suggesting feature improvements. * Dag-Erling Smoergrav (FreeBSD) for inspiring new warning messages. * Ted Unangst and Marc Espie (OpenBSD) for providing useful ideas. * Svyatoslav Mishyn (Crux Linux) for release testing. * Carsten Kunze (Heirloom roff) for help keeping mandoc and groff compatible and for committing some of my patches to groff. @ text @d1 1 a1 1 .\" Id: man.conf.5,v 1.5 2017/08/22 18:17:52 schwarze Exp d17 1 a17 1 .Dd August 22, 2017 d77 2 a78 6 to work, and also for .Xr man 1 on operating systems like .Ox that install each manual page with only one file name in the file system, even if it documents multiple utilities or functions. @ 1.1.1.4 log @Changes in version 1.14.5, released on March 10, 2019 --- MAJOR NEW FEATURES --- * apropos(1): improve POSIX compliance by accepting case-insensitive extended regular expressions by default * new -O tag[=term] output option (open a page at the definition of a term) * tbl(7) -T html: spanning and horizontal and vertical alignment of cells * tbl(7) -T html: draw lines on the edges of table cells * tbl(7) -T utf8: render lines with the Unicode box drawing characters * mandoc is now able to handle the manual pages of the groff package. --- MINOR NEW FEATURES --- * -T html: new option -O toc (table of contents) * -T html: second argument to -O man to support local and remote links * mdoc(7) .Bd -centered now fills the text contained in it * man-ext .SY and .YS macros (synopsis block) * man-ext .TQ macro (tagged paragraph without vertical space before it) * tbl(7) \& explicit alignment indicator * roff(7) .shift, .while, and .return requests * roff(7) .char request (output glyph definition) * roff(7) .nop request (no operation) * roff(7) .ft request: handle the CB, CI, and CR fonts * roff(7) .if c conditional (character available) * roff(7) \\$@@ escape sequence (insert all macro arguments, quoted) * roff(7) \*(.T predefined string (interpolate output device name) * roff(7) \[charNNN] escape sequence (for printable ASCII characters) * roff(7) \# escape sequence (line continuation with comment) --- HTML OUTPUT SYNTAX CORRECTIONS --- * Render .br and \p as
, not as an empty
. * Render .Pp and .PP as

and automatically close it when needed. * Stop writing empty list elements for non-compact .Bl -tag lists. * Do not put

inside if .UR or .MT contain .PP. * Implement tooltips purely in CSS rather than abusing title= attributes. --- MINOR FUNCTIONAL IMPROVEMENTS --- * many improvements to the handling of fill and no-fill mode * tbl(7): better column widths in the presence of horizontal spans * several minor improvements to escape sequence handling * several minor improvements to manual font handling * portability: autodetect need for _GNU_SOURCE or _OPENBSD_SOURCE * portability: autodetect whether less(1) supports the -T option * large numbers of bugfixes of diverse kinds --- STRUCTURAL IMPROVEMENTS --- * Disentangle eqn(7) and tbl(7) from other parser header files, and clean up some parser data structures. * Substantially simplify error and warning message infrastructure. --- THANKS TO --- * John Gardner for crucial help implementing tooltips in CSS. * Alexander Bluhm, Raphael Graf, Ted Unangst (OpenBSD) and Daniel Sabogal (Alpine Linux) for patches. * Anthony Bentley and Jason McIntyre (OpenBSD) for documentation patches, suggesting new features, bug reports, and useful discussions. * Kyle Evans and Baptiste Daroussin (FreeBSD) for minor patches. * Pali Rohar for suggesting multiple new features and for reporting several bugs and missing features. * Klemens Nanni (OpenBSD) for suggesting multiple new features. * Kristaps Dzonsons (bsd.lv), Marc Espie (OpenBSD), Adam Kalisz, and Laura Morales for suggesting new features. * Wolfram Schneider and Yuri Pankov (FreeBSD) for reporting missing features. * Edward Tomasz Napierala (FreeBSD) for suggesting a feature improvement. * Thomas Klausner (NetBSD) and Sevan Janiyan (SmartOS) for bug reports and release testing. * Bryan Steele, Janne Johansson, Kurt Mosiejczuk, Mike Belopuhov, Theo Buehler, Todd Miller (OpenBSD), Andreas Gustafsson, Christos Zoulas, Robert Elz (NetBSD), Kurt Jaeger (FreeBSD), Fabio Scotoni, Kelvin Sherlock, Mark Harris, Orestis Ioannou, Raf Czlonka, and Sean Farrell for bug reports. * Ulrich Spoerlein (FreeBSD), Leah Neukirchen (Void Linux), Matej Cepl (openSUSE), and Jan Stary (MacOS X) for release testing. * Brian Callahan and Stuart Henderson (OpenBSD) for help with the OpenBSD groff port. * Bertrand Garrigues, Branden Robinson, Ralph Corderoy, and Werner Lemberg (GNU troff) for checking groff patches. * Scott Cheloha, Theo de Raadt (OpenBSD) and Natanael Copa (Alpine Linux) for useful discussions. @ text @d1 1 a1 1 .\" Id: man.conf.5,v 1.6 2018/10/02 14:56:47 schwarze Exp d3 1 a3 1 .\" Copyright (c) 2015, 2017 Ingo Schwarze d17 1 a17 1 .Dd October 2, 2018 a100 1 .It Ic toc Ta none Ta Cm html Ta print table of contents @ 1.1.1.1.2.1 log @file man.conf.5 was added on branch pgoyette-localcount on 2016-07-26 03:24:14 +0000 @ text @d1 131 @ 1.1.1.1.2.2 log @Sync with HEAD @ text @a0 131 .\" Id: man.conf.5,v 1.3 2015/03/27 21:33:20 schwarze Exp .\" .\" Copyright (c) 2015 Ingo Schwarze .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. .\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" .Dd March 27, 2015 .Dt MAN.CONF 5 .Os .Sh NAME .Nm man.conf .Nd configuration file for man .Sh DESCRIPTION This is the configuration file for the .Xr man 1 , .Xr apropos 1 , and .Xr makewhatis 8 utilities. Its presence, and all directives, are optional. .Pp This file is an ASCII text file. Leading whitespace on lines, lines starting with .Sq # , and blank lines are ignored. Words are separated by whitespace. The first word on each line is the name of a configuration directive. .Pp The following directives are supported: .Bl -tag -width Ds .It Ic manpath Ar path Override the default search .Ar path for .Xr man 1 , .Xr apropos 1 , and .Xr makewhatis 8 . It can be used multiple times to specify multiple paths, with the order determining the manual page search order. .Pp Each path is a tree containing subdirectories whose names consist of the strings .Sq man and/or .Sq cat followed by the names of sections, usually single digits. The former are supposed to contain unformatted manual pages in .Xr mdoc 7 and/or .Xr man 7 format; file names should end with the name of the section preceded by a dot. The latter should contain preformatted manual pages; file names should end with .Ql .0 . .Pp Creating a .Xr mandoc.db 5 database with .Xr makewhatis 8 in each directory configured with .Ic manpath is recommended and necessary for .Xr apropos 1 to work, but not strictly required for .Xr man 1 . .It Ic output Ar option Op Ar value Configure the default value of an output option. These directives are overridden by the .Fl O command line options of the same names. For details, see the .Xr mandoc 1 manual. .Pp .Bl -column fragment integer "ascii, utf8" -compact .It Ar option Ta Ar value Ta used by Fl T Ta purpose .It Ta Ta Ta .It Ic fragment Ta none Ta Cm html Ta print only body .It Ic includes Ta string Ta Cm html Ta path to header files .It Ic indent Ta integer Ta Cm ascii , utf8 Ta left margin .It Ic man Ta string Ta Cm html Ta path for Xr links .It Ic paper Ta string Ta Cm ps , pdf Ta paper size .It Ic style Ta string Ta Cm html Ta CSS file .It Ic width Ta integer Ta Cm ascii , utf8 Ta right margin .El .It Ic _whatdb Ar path Ns Cm /whatis.db This directive provides the same functionality as .Ic manpath , but using a historic and misleading syntax. It is kept for backward compatibility for now, but will eventually be removed. .El .Sh FILES .Pa /etc/man.conf .Sh EXAMPLES The following configuration file reproduces the defaults: installing it is equivalent to not having a .Nm file at all. .Bd -literal -offset indent manpath /usr/share/man manpath /usr/X11R6/man manpath /usr/local/man .Ed .Sh SEE ALSO .Xr apropos 1 , .Xr man 1 , .Xr makewhatis 8 .Sh HISTORY A relatively complicated .Nm file format first appeared in .Bx 4.3 Reno . For .Ox 5.8 , it was redesigned from scratch, aiming for simplicity. .Sh AUTHORS .An Ingo Schwarze Aq Mt schwarze@@openbsd.org @ 1.1.1.1.2.3 log @Sync with HEAD @ text @d1 1 a1 1 .\" Id: man.conf.5,v 1.4 2016/12/28 22:52:17 schwarze Exp d17 1 a17 1 .Dd December 28, 2016 d94 1 a94 1 .It Ic man Ta string Ta Cm html Ta path for \&Xr links @