]> git.cameronkatri.com Git - mandoc.git/blobdiff - mandocdb.8
When the -n or -t flag is given to makewhatis(8),
[mandoc.git] / mandocdb.8
index 52e412a8f295687d807d3644980716a3518a3c3a..6cbd5ee291744b7815af04e3cdfeb2c2302dd47b 100644 (file)
@@ -1,4 +1,4 @@
-.\"    $Id: mandocdb.8,v 1.21 2014/03/17 08:34:00 schwarze Exp $
+.\"    $Id: mandocdb.8,v 1.25 2014/04/04 02:31:07 schwarze Exp $
 .\"
 .\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2011, 2012 Ingo Schwarze <schwarze@openbsd.org>
@@ -15,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: March 17 2014 $
+.Dd $Mdocdate: April 4 2014 $
 .Dt MANDOCDB 8
 .Os
 .Sh NAME
 .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
@@ -89,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
@@ -105,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
@@ -113,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
@@ -168,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