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.8 and 1.12

version 1.8, 2011/11/28 01:37:34

version 1.12, 2011/12/12 02:00:49

Line 23

.Sh SYNOPSIS

.Nm

.Op Fl av

.Op Ar dir ...

.Op Fl C Ar file

.Nm

.Op Fl av

.Ar dir ...

.Nm

.Op Fl v

.Fl d Ar dir

.Op Ar

Line 69 uses the default paths stipulated by

Line 72 uses the default paths stipulated by

.Xr man 1 .

.Pp

The arguments are as follows:

.Bl -tag -width Ds

.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

.Xr man.conf 5

format.

.It Fl d Ar dir

Merge (remove and re-add)

.Ar

Line 86 from the database in

Line 95 from the database in

.Ar dir

without truncating it.

.It Fl v

Verbose operation.

Display all files added or removed to the index.

Use once to display all files added or removed and twice for keywords as

well.

.El

.Pp

If fatal parse errors are encountered while parsing, the offending file

Line 108 the string

Line 115 the string

.Cm man ,

.Cm cat

to indicate the file type,

to indicate the file type

.Po

file in

.Xr mdoc 7 ,

.Xr man 7 ,

and post-formatted, respectively

.Pc ,

.It

the filename,

.It

Line 133 The keyword database,

Line 146 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 8-byte binary field consisting of the

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

keyword type and source

64-bit keyword type and 32-bit source

.Sx Index Database

record number.

record number, both in network-byte order.

The type, a 32-bit bit-mask in host order, consists of the following

The type bit-mask consists of the following

fields:

values mapping into

.Xr mdoc 7

macro identifiers:

.Pp

.Bl -tag -width Ds -offset indent -compact

.Bl -column "x0x0000000000000001ULLx" "xLix" -offset indent -compact

.It Li 0x01

.It Li 0x0000000000000001ULL Ta \&An

The name of a manual page as given in the NAME section.

.It Li 0x0000000000000002ULL Ta \&Ar

.It Li 0x02

.It Li 0x0000000000000004ULL Ta \&At

A function prototype name as given in the SYNOPSIS section.

.It Li 0x0000000000000008ULL Ta \&Bsx

.It Li 0x04

.It Li 0x0000000000000010ULL Ta \&Bx

A utility name as given in the SYNOPSIS section.

.It Li 0x0000000000000020ULL Ta \&Cd

.It Li 0x08

.It Li 0x0000000000000040ULL Ta \&Cm

An include file as given in the SYNOPSIS section.

.It Li 0x0000000000000080ULL Ta \&Dv

.It Li 0x10

.It Li 0x0000000000000100ULL Ta \&Dx

A variable name as given in the SYNOPSIS section.

.It Li 0x0000000000000200ULL Ta \&Em

.It Li 0x20

.It Li 0x0000000000000400ULL Ta \&Er

A standard as given in the STANDARDS section.

.It Li 0x0000000000000800ULL Ta \&Ev

.It Li 0x40

.It Li 0x0000000000001000ULL Ta \&Fa

An author as given in the AUTHORS section.

.It Li 0x0000000000002000ULL Ta \&Fl

.It Li 0x80

.It Li 0x0000000000004000ULL Ta \&Fn

A configuration as given in the SYNOPSIS section.

.It Li 0x0000000000008000ULL Ta \&Ft

.It Li 0x100

.It Li 0x0000000000010000ULL Ta \&Fx

Free-form descriptive text as given in the NAME section.

.It Li 0x0000000000020000ULL Ta \&Ic

.It Li 0x200

.It Li 0x0000000000040000ULL Ta \&In

Cross-links between manuals.

.It Li 0x0000000000080000ULL Ta \&Lb

Listed as the link name, then a period, then the link section.

.It Li 0x0000000000100000ULL Ta \&Li

If the link has no section, the period terminates the string.

.It Li 0x0000000000200000ULL Ta \&Lk

.It Li 0x400

.It Li 0x0000000000400000ULL Ta \&Ms

Path reference as given in the FILES section.

.It Li 0x0000000000800000ULL Ta \&Mt

.It Li 0x800

.It Li 0x0000000001000000ULL Ta \&Nd

Environment variable as given in the ENVIRONMENT section.

.It Li 0x0000000002000000ULL Ta \&Nm

.It Li 0x1000

.It Li 0x0000000004000000ULL Ta \&Nx

Error codes as given in the ERRORS section.

.It Li 0x0000000008000000ULL Ta \&Ox

.It Li 0x0000000010000000ULL Ta \&Pa

.It Li 0x0000000020000000ULL Ta \&Rs

.It Li 0x0000000040000000ULL Ta \&Sh

.It Li 0x0000000080000000ULL Ta \&Ss

.It Li 0x0000000100000000ULL Ta \&St

.It Li 0x0000000200000000ULL Ta \&Sy

.It Li 0x0000000400000000ULL Ta \&Tn

.It Li 0x0000000800000000ULL Ta \&Va

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

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

Line 197 keyword database mapping keywords to a type and file r

Line 217 keyword database mapping keywords to a type and file r

.Xr recno 3

database of indexed file-names.

.It Pa /etc/man.conf

The default

.Xr man 1

configuration file.

.El

.Sh EXIT STATUS

The

Line 217 Such errors cause

Line 241 Such errors cause

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 DIAGNOSTICS

If the following errors occur, the

.Nm

databases should be rebuilt.

.Bl -diag

.It "%s: Corrupt database"

The keyword database file indicated by

.Pa %s

is unreadable.

.It "%s: Corrupt index"

The index database file indicated by

.Pa %s

is unreadable.

.It "%s: Path too long"

The file

.Pa %s

is too long.

This usually indicates database corruption or invalid command-line

arguments.

.El

.Sh SEE ALSO

.Xr apropos 1 ,

.Xr man 1 ,

.Xr mandoc 1 ,

.Xr whatis 1 ,

.Xr btree 3 ,

.Xr recno 3

.Xr recno 3 ,

.Xr man.conf 5

.Sh AUTHORS

The

.Nm

CVSweb