mandoc/mandocdb.8 - diff

Return to mandocdb.8 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/mandocdb.8 between version 1.14 and 1.17.2.2

version 1.14, 2011/12/16 12:06:35

version 1.17.2.2, 2014/03/17 09:04:52

Line 1

.\" $Id$

.\"

.\" Permission to use, copy, modify, and distribute this software for any

.\" purpose with or without fee is hereby granted, provided that the above

Line 22

Line 23

.Nd index UNIX manuals

.Sh SYNOPSIS

.Nm

.Op Fl av

.Op Fl avW

.Op Fl C Ar file

.Nm

.Op Fl av

.Op Fl avW

.Ar dir ...

.Nm

.Op Fl v

.Op Fl vW

.Fl d Ar dir

.Op Ar

.Nm

.Op Fl v

.Op Fl vW

.Fl u Ar dir

.Op Ar

.Nm

.Fl t Ar

.Sh DESCRIPTION

The

.Nm

Line 44 manuals and indexes them in a

Line 47 manuals and indexes them in a

.Sx Keyword Database

and

.Sx Index Database

for fast retrieval.

for fast retrieval by

.Xr apropos 1 ,

.Xr whatis 1 ,

and

.Xr man 1 Ns 's

.Fl k

option.

.Pp

By default,

.Nm

Line 62 and

Line 71 and

.Op Ar arch Li /

.Ar title . Sy 0

.Sm on

in that directory;

in that directory.

existing databases are truncated.

Existing databases are replaced.

.Ar dir

is not provided,

.Nm

uses the default paths stipulated by

.Xr man 1 .

.Xr manpath 1 ,

.Xr man.conf 5 .

.Pp

The arguments are as follows:

.Bl -tag -width "-C file"

Line 88 Merge (remove and re-add)

Line 99 Merge (remove and re-add)

to the database in

.Ar dir

without truncating it.

.It Fl t Ar

Check the given

.Ar files

for potential problems.

No databases are modified.

Implies

.Fl a

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

Line 96 from the database in

Line 118 from the database in

without truncating it.

.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

Line 143 The keyword database,

Line 168 The keyword database,

is a

.Xr btree 3

database of NUL-terminated keywords (record length is non-zero string

length plus one) mapping to a 12-byte binary field consisting of the

length plus one) mapping to a 16-byte binary field consisting of the

64-bit keyword type and 32-bit source

64-bit keyword type and the 64-bit

.Sx Index Database

record number, both in network-byte order.

.Pp

The type bit-mask consists of the following

values mapping into

.Xr mdoc 7

Line 192 macro identifiers:

Line 218 macro identifiers:

.It Li 0x0000001000000000ULL Ta \&Vt

.It Li 0x0000002000000000ULL Ta \&Xr

.El

.Pp

The last four bytes are a host-ordered record number within the

.Sx Index Database .

.Sh IMPLEMENTATION NOTES

The time to construct a new database pair grows linearly with the

number of keywords in the input files.

Line 236 error accessing input files.

Line 259 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 .

The output databases are corrupt and should be removed.

.El

.Sh DIAGNOSTICS

If the following errors occur, the

Line 265 arguments.

Line 288 arguments.

.Xr btree 3 ,

.Xr recno 3 ,

.Xr man.conf 5

.Sh AUTHORS

.Sh HISTORY

.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.1 .

.Pp

The

.Ar dir

argument first appeared in

.Nx 1.0 ;

the options

.Fl dtu

.Ox 2.7 ;

and the options

.Fl aCvW

.Ox 5.1 .

.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

was written by

.An Kristaps Dzonsons ,

.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv

.Mt kristaps@bsd.lv .

and

.An Ingo Schwarze Aq Mt schwarze@openbsd.org .

CVSweb