=================================================================== RCS file: /cvs/mandoc/Attic/mandocdb.8,v retrieving revision 1.20 retrieving revision 1.25 diff -u -p -r1.20 -r1.25 --- mandoc/Attic/mandocdb.8 2013/10/01 20:56:18 1.20 +++ mandoc/Attic/mandocdb.8 2014/04/04 02:31:07 1.25 @@ -1,6 +1,7 @@ -.\" $Id: mandocdb.8,v 1.20 2013/10/01 20:56:18 schwarze Exp $ +.\" $Id: mandocdb.8,v 1.25 2014/04/04 02:31:07 schwarze Exp $ .\" .\" Copyright (c) 2011, 2012 Kristaps Dzonsons +.\" Copyright (c) 2011, 2012 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 @@ -14,7 +15,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: October 1 2013 $ +.Dd $Mdocdate: April 4 2014 $ .Dt MANDOCDB 8 .Os .Sh NAME @@ -22,20 +23,25 @@ .Nd index UNIX manuals .Sh SYNOPSIS .Nm -.Op Fl anvW +.Op Fl aDnpQ +.Op Fl T Cm utf8 .Op Fl C Ar file .Nm -.Op Fl anvW +.Op Fl aDnpQ +.Op Fl T Cm utf8 .Ar dir ... .Nm -.Op Fl nvW +.Op Fl DnpQ +.Op Fl T Cm utf8 .Fl d Ar dir .Op Ar .Nm -.Op Fl nvW +.Op Fl Dnp +.Op Fl T Cm utf8 .Fl u Ar dir .Op Ar .Nm +.Op Fl Q .Fl t Ar .Sh DESCRIPTION The @@ -46,7 +52,9 @@ manuals and indexes them in a database for fast retrie .Xr apropos 1 , .Xr whatis 1 , and -.Xr man 1 . +.Xr man 1 Ns 's +.Fl k +option. .Pp By default, .Nm @@ -86,14 +94,28 @@ Specify an alternative configuration in .Xr man.conf 5 format. +.It Fl D +Display all files added or removed to the index. +With a second +.Fl D , +also show all keyswords added for each file. .It Fl d Ar dir Merge (remove and re-add) .Ar to the database in .Ar dir . .It Fl n -Do not create or modify any database; -scan and parse only. +Do not create or modify any database; scan and parse only, +and print manual page names and descriptions to standard output. +.It Fl p +Print warnings about potential problems with manual pages +to the standard error output. +.It Fl Q +Quickly build reduced-size databases +by reading only the NAME sections of manuals. +The resulting databases will usually contain names and descriptions only. +.It Fl T Cm utf8 +Use UTF-8 encoding instead of ASCII for strings stored in the databases. .It Fl t Ar Check the given .Ar files @@ -102,7 +124,7 @@ Implies .Fl a , .Fl n , and -.Fl W . +.Fl p . All diagnostic messages are printed to the standard output; the standard error output is not used. .It Fl u Ar dir @@ -110,11 +132,6 @@ Remove .Ar from the database in .Ar dir . -.It Fl v -Display all files added or removed to the index. -.It Fl W -Print warnings about potential problems with manual pages -to the standard error output. .El .Pp If fatal parse errors are encountered while parsing, the offending file @@ -126,11 +143,30 @@ with the next input file. A database of manpages relative to the directory of the file. This file is portable across architectures and systems, so long as the manpage hierarchy it indexes does not change. -.It Pa mandoc.db~ -A temporary database used during scanning and parsing. +.It Pa /etc/man.conf +The default +.Xr man 1 +configuration file. .El .Sh EXIT STATUS -.Ex -std +The +.Nm +utility exits with one of the following values: +.Pp +.Bl -tag -width Ds -compact +.It 0 +No errors occurred. +.It 5 +Invalid command line arguments were specified. +No input files have been read. +.It 6 +An operating system error occurred, for example memory exhaustion or an +error accessing input files. +Such errors cause +.Nm +to exit at once, possibly in the middle of parsing or formatting a file. +The output databases are corrupt and should be removed. +.El .Sh SEE ALSO .Xr apropos 1 , .Xr man 1 , @@ -146,20 +182,24 @@ It was rewritten in for .Ox 2.7 and in C for -.Ox 5.1 . +.Ox 5.6 . .Pp The .Ar dir argument first appeared in .Nx 1.0 ; the options -.Fl dtu +.Fl dpt in .Ox 2.7 ; +the option +.Fl u +in +.Ox 3.4 ; and the options -.Fl aCvW +.Fl aCDnQT in -.Ox 5.1 . +.Ox 5.6 . .Sh AUTHORS .An -nosplit .An Bill Joy