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

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

version 1.2, 2011/07/15 10:15:24 version 1.19, 2013/07/13 19:41:16
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"  .\"
 .\" 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 22 
 .Nd index UNIX manuals  .Nd index UNIX manuals
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm  .Nm
 .Ar dir...  .Op Fl anvW
   .Op Fl C Ar file
   .Nm
   .Op Fl anvW
   .Ar dir ...
   .Nm
   .Op Fl nvW
   .Fl d Ar dir
   .Op Ar
   .Nm
   .Op Fl nvW
   .Fl u Ar dir
   .Op Ar
   .Nm
   .Fl t Ar
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 utility extracts keywords from  utility extracts keywords from
 .Ux  .Ux
 manuals and indexes them for fast retrieval.  manuals and indexes them in a database for fast retrieval by
 The arguments are as follows:  .Xr apropos 1 ,
 .Bl -tag -width Ds  .Xr whatis 1 ,
 .It Ar dir...  
 Recursively scan for  
 .Xr mdoc 7  
 and  and
 .Xr man 7  .Xr man 1 .
 .Ux  .Pp
 manual files in each  By default,
   .Nm
   creates a database in each
 .Ar dir  .Ar dir
 directory.  using the files
 .Sx Index Database  .Sm off
   .Sy man Ar section Li /
   .Op Ar arch Li /
   .Ar title . section
   .Sm on
 and  and
 .Sx Keyword Database  .Sm off
 files are installed in each  .Sy cat Ar section Li /
   .Op Ar arch Li /
   .Ar title . Sy 0
   .Sm on
   in that directory.
   Existing databases are replaced.
   If
 .Ar dir  .Ar dir
 directory.  is not provided,
 Existing databases are truncated.  
 .El  
 .Pp  
 By default,  
 .Nm  .Nm
 does nothing: the  uses the default paths stipulated by
 .Ar dir...  .Xr manpath 1 ,
 invocation must be used.  or
   .Xr man.conf 5 .
 .Pp  .Pp
   The arguments are as follows:
   .Bl -tag -width "-C file"
   .It Fl a
   Use all directories and files found below
   .Ar dir ... .
   .It Fl C Ar file
   Specify an alternative configuration
   .Ar file
   in
   .Xr man.conf 5
   format.
   .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.
   .It Fl t Ar
   Check the given
   .Ar files
   for potential problems.
   Implies
   .Fl a ,
   .Fl n ,
   and
   .Fl W .
   All diagnostic messages are printed to the standard output;
   the standard error output is not used.
   .It Fl u Ar dir
   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  If fatal parse errors are encountered while parsing, the offending file
 is printed to stderr, omitted from the index, and the parse continues  is printed to stderr, omitted from the index, and the parse continues
 with the next input file.  with the next input file.
 .Ss Index Database  
 The index database,  
 .Pa mandoc.index ,  
 is a  
 .Xr recno 3  
 database with record values consisting of  
 .Pp  
 .Bl -enum -compact  
 .It  
 a nil-terminated filename,  
 .It  
 a nil-terminated manual section,  
 .It  
 a nil-terminated manual title,  
 .It  
 a nil-terminated architecture  
 .Pq this is not often available  
 .It  
 and a nil-terminated description.  
 .El  
 .Pp  
 Both the manual section and description may be zero-length.  
 Entries are sequentially-numbered, but the filenames are unordered.  
 .Ss Keyword Database  
 The keyword database,  
 .Pa mandoc.db ,  
 is a  
 .Xr btree 3  
 database of nil-terminated keywords (record length is non-zero string  
 length plus one) mapping to a 8-byte binary field consisting of the  
 keyword type and source  
 .Sx Index Database  
 record number.  
 The type, a 32-bit bit-mask in host order, consists of the following  
 fields:  
 .Pp  
 .Bl -tag -width Ds -offset indent -compact  
 .It Li 0x01  
 The name of a manual page as given in the NAME section.  
 .It Li 0x02  
 A function prototype name as given in the SYNOPSIS section.  
 .It Li 0x04  
 A utility name as given in the SYNOPSIS section.  
 .It Li 0x08  
 An include file as given in the SYNOPSIS section.  
 .It Li 0x10  
 A variable name as given in the SYNOPSIS section.  
 .It Li 0x20  
 A standard as given in the STANDARDS section.  
 .It Li 0x40  
 An author as given in the AUTHORS section.  
 .It Li 0x80  
 A configuration as given in the SYNOPSIS section.  
 .It Li 0x100  
 Free-form descriptive text as given in the NAME section.  
 .It Li 0x200  
 Cross-links between manuals.  
 Listed as the link name, then a period, then the link section.  
 If the link has no section, the period terminates the string.  
 .It Li 0x400  
 Path reference as given in the FILES section.  
 .It Li 0x800  
 Environment variable as given in the ENVIRONMENT section.  
 .It Li 0x1000  
 Error codes as given in the ERRORS section.  
 .El  
 .Pp  
 The last four bytes are a host-ordered record number within the  
 .Sx Index Database .  
 .Pp  
 The  
 .Nm  
 utility is  
 .Ud  
 .Sh IMPLEMENTATION NOTES  
 The time to construct a new database pair grows linearly with the  
 number of keywords in the input.  
 However, removing or updating entries with  
 .Fl r  
 or  
 .Fl u ,  
 respectively, grows as a multiple of the index length and input size.  
 .Sh FILES  .Sh FILES
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Pa mandoc.db  .It Pa mandocdb.db
 A  A database of manpages relative to the directory of the file.
 .Xr btree 3  This file is portable across architectures and systems, so long as the
 keyword database mapping keywords to a type and file reference in  manpage hierarchy it indexes does not change.
 .Pa mandoc.index .  .It Pa mandocdb.db~
 .It Pa mandoc.index  A temporary database used during scanning and parsing.
 A  
 .Xr recno 3  
 database of indexed file-names.  
 .El  .El
 .Sh EXIT STATUS  .Sh EXIT STATUS
 The  .Ex -std
 .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 mandoc 1  .Xr apropos 1 ,
   .Xr man 1 ,
   .Xr whatis 1 ,
   .Xr man.conf 5
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  utility was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .  .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv ,
   and
   .An Ingo Schwarze Aq Mt schwarze@openbsd.org .

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

CVSweb