=================================================================== RCS file: /cvs/mandoc/Attic/mandocdb.8,v retrieving revision 1.18 retrieving revision 1.22 diff -u -p -r1.18 -r1.22 --- mandoc/Attic/mandocdb.8 2012/06/08 10:43:01 1.18 +++ mandoc/Attic/mandocdb.8 2014/04/03 15:24:32 1.22 @@ -1,6 +1,7 @@ -.\" $Id: mandocdb.8,v 1.18 2012/06/08 10:43:01 kristaps Exp $ +.\" $Id: mandocdb.8,v 1.22 2014/04/03 15:24:32 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: June 8 2012 $ +.Dd $Mdocdate: April 3 2014 $ .Dt MANDOCDB 8 .Os .Sh NAME @@ -22,20 +23,25 @@ .Nd index UNIX manuals .Sh SYNOPSIS .Nm -.Op Fl anvW +.Op Fl anQvW +.Op Fl T Cm utf8 .Op Fl C Ar file .Nm -.Op Fl anvW +.Op Fl anQvW +.Op Fl T Cm utf8 .Ar dir ... .Nm -.Op Fl nvW +.Op Fl nQvW +.Op Fl T Cm utf8 .Fl d Ar dir .Op Ar .Nm .Op Fl nvW +.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,6 +94,11 @@ 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 @@ -94,6 +107,12 @@ to the database in .It Fl n Do not create or modify any database; scan and parse only. +.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 @@ -122,26 +141,75 @@ is printed to stderr, omitted from the index, and the with the next input file. .Sh FILES .Bl -tag -width Ds -.It Pa mandocdb.db +.It Pa mandoc.db 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 mandocdb.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 , .Xr whatis 1 , .Xr man.conf 5 -.Sh AUTHORS +.Sh HISTORY +A +.Nm makewhatis +utility first appeared in +.Bx 2 . +It was rewritten in +.Xr perl 1 +for +.Ox 2.7 +and in C for +.Ox 5.6 . +.Pp The +.Ar dir +argument first appeared in +.Nx 1.0 ; +the options +.Fl dtu +in +.Ox 2.7 ; +and the options +.Fl aCnQTvW +in +.Ox 5.6 . +.Sh AUTHORS +.An -nosplit +.An Bill Joy +wrote the original +.Bx +.Nm makewhatis +in February 1979, +.An Marc Espie +started the Perl version in 2000, +and the current version of .Nm -utility was written by -.An Kristaps Dzonsons , -.Mt kristaps@bsd.lv , +was written by +.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv and -.An Ingo Schwarze , -.Mt schwarze@openbsd.org . +.An Ingo Schwarze Aq Mt schwarze@openbsd.org .