[BACK]Return to mandocdb.8 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/mandocdb.8 between version 1.20 and 1.24

version 1.20, 2013/10/01 20:56:18 version 1.24, 2014/04/03 16:27:28
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
   .\" Copyright (c) 2011, 2012 Ingo Schwarze <schwarze@openbsd.org>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above  .\" purpose with or without fee is hereby granted, provided that the above
Line 22 
Line 23 
 .Nd index UNIX manuals  .Nd index UNIX manuals
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm  .Nm
 .Op Fl anvW  .Op Fl aDnpQ
   .Op Fl T Cm utf8
 .Op Fl C Ar file  .Op Fl C Ar file
 .Nm  .Nm
 .Op Fl anvW  .Op Fl aDnpQ
   .Op Fl T Cm utf8
 .Ar dir ...  .Ar dir ...
 .Nm  .Nm
 .Op Fl nvW  .Op Fl DnpQ
   .Op Fl T Cm utf8
 .Fl d Ar dir  .Fl d Ar dir
 .Op Ar  .Op Ar
 .Nm  .Nm
 .Op Fl nvW  .Op Fl Dnp
   .Op Fl T Cm utf8
 .Fl u Ar dir  .Fl u Ar dir
 .Op Ar  .Op Ar
 .Nm  .Nm
   .Op Fl Q
 .Fl t Ar  .Fl t Ar
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
Line 46  manuals and indexes them in a database for fast retrie
Line 52  manuals and indexes them in a database for fast retrie
 .Xr apropos 1 ,  .Xr apropos 1 ,
 .Xr whatis 1 ,  .Xr whatis 1 ,
 and  and
 .Xr man 1 .  .Xr man 1 Ns 's
   .Fl k
   option.
 .Pp  .Pp
 By default,  By default,
 .Nm  .Nm
Line 86  Specify an alternative configuration
Line 94  Specify an alternative configuration
 in  in
 .Xr man.conf 5  .Xr man.conf 5
 format.  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  .It Fl d Ar dir
 Merge (remove and re-add)  Merge (remove and re-add)
 .Ar  .Ar
Line 94  to the database in
Line 107  to the database in
 .It Fl n  .It Fl n
 Do not create or modify any database;  Do not create or modify any database;
 scan and parse only.  scan and parse only.
   .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  .It Fl t Ar
 Check the given  Check the given
 .Ar files  .Ar files
Line 102  Implies
Line 124  Implies
 .Fl a ,  .Fl a ,
 .Fl n ,  .Fl n ,
 and  and
 .Fl W .  .Fl p .
 All diagnostic messages are printed to the standard output;  All diagnostic messages are printed to the standard output;
 the standard error output is not used.  the standard error output is not used.
 .It Fl u Ar dir  .It Fl u Ar dir
Line 110  Remove
Line 132  Remove
 .Ar  .Ar
 from the database in  from the database in
 .Ar dir .  .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  .El
 .Pp  .Pp
 If fatal parse errors are encountered while parsing, the offending file  If fatal parse errors are encountered while parsing, the offending file
Line 126  with the next input file.
Line 143  with the next input file.
 A database of manpages relative to the directory of the file.  A database of manpages relative to the directory of the file.
 This file is portable across architectures and systems, so long as the  This file is portable across architectures and systems, so long as the
 manpage hierarchy it indexes does not change.  manpage hierarchy it indexes does not change.
 .It Pa mandoc.db~  .It Pa /etc/man.conf
 A temporary database used during scanning and parsing.  The default
   .Xr man 1
   configuration file.
 .El  .El
 .Sh EXIT STATUS  .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  .Sh SEE ALSO
 .Xr apropos 1 ,  .Xr apropos 1 ,
 .Xr man 1 ,  .Xr man 1 ,
Line 146  It was rewritten in
Line 182  It was rewritten in
 for  for
 .Ox 2.7  .Ox 2.7
 and in C for  and in C for
 .Ox 5.1 .  .Ox 5.6 .
 .Pp  .Pp
 The  The
 .Ar dir  .Ar dir
 argument first appeared in  argument first appeared in
 .Nx 1.0 ;  .Nx 1.0 ;
 the options  the options
 .Fl dtu  .Fl dpt
 in  in
 .Ox 2.7 ;  .Ox 2.7 ;
   the option
   .Fl u
   in
   .Ox 3.4 ;
 and the options  and the options
 .Fl aCvW  .Fl aCDnQT
 in  in
 .Ox 5.1 .  .Ox 5.6 .
 .Sh AUTHORS  .Sh AUTHORS
 .An -nosplit  .An -nosplit
 .An Bill Joy  .An Bill Joy

Legend:
Removed from v.1.20  
changed lines
  Added in v.1.24

CVSweb