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

Diff for /mandoc/Attic/mandocdb.8 between version 1.19 and 1.23

version 1.19, 2013/07/13 19:41:16 version 1.23, 2014/04/03 15:37:19
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 aDnQW
   .Op Fl T Cm utf8
 .Op Fl C Ar file  .Op Fl C Ar file
 .Nm  .Nm
 .Op Fl anvW  .Op Fl aDnQW
   .Op Fl T Cm utf8
 .Ar dir ...  .Ar dir ...
 .Nm  .Nm
 .Op Fl nvW  .Op Fl DnQW
   .Op Fl T Cm utf8
 .Fl d Ar dir  .Fl d Ar dir
 .Op Ar  .Op Ar
 .Nm  .Nm
 .Op Fl nvW  .Op Fl DnW
   .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 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 110  Remove
Line 129  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  .It Fl W
 Print warnings about potential problems with manual pages  Print warnings about potential problems with manual pages
 to the standard error output.  to the standard error output.
Line 122  is printed to stderr, omitted from the index, and the 
Line 139  is printed to stderr, omitted from the index, and the 
 with the next input file.  with the next input file.
 .Sh FILES  .Sh FILES
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Pa mandocdb.db  .It Pa mandoc.db
 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 mandocdb.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 ,
 .Xr whatis 1 ,  .Xr whatis 1 ,
 .Xr man.conf 5  .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  The
   .Ar dir
   argument first appeared in
   .Nx 1.0 ;
   the options
   .Fl dtu
   in
   .Ox 2.7 ;
   and the options
   .Fl aCDnQTW
   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  .Nm
 utility was written by  was written by
 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv ,  .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
 and  and
 .An Ingo Schwarze Aq Mt schwarze@openbsd.org .  .An Ingo Schwarze Aq Mt schwarze@openbsd.org .

Legend:
Removed from v.1.19  
changed lines
  Added in v.1.23

CVSweb