version 1.2, 2014/04/25 12:13:15 |
version 1.7, 2022/03/16 23:26:14 |
|
|
.\" $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> |
.\" Copyright (c) 2011, 2012, 2014, 2017 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 52 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 Ns 's |
.Xr man 1 . |
.Fl k |
|
option. |
|
.Pp |
.Pp |
By default, |
By default, |
.Nm |
.Nm |
|
|
.Sm on |
.Sm on |
in that directory. |
in that directory. |
Existing databases are replaced. |
Existing databases are replaced. |
|
If a directory contains no manual pages, no database is created in that |
|
directory. |
If |
If |
.Ar dir |
.Ar dir |
is not provided, |
is not provided, |
.Nm |
.Nm |
uses the default paths stipulated by |
uses the default paths stipulated by |
.Xr manpath 1 , |
|
or |
|
.Xr man.conf 5 . |
.Xr man.conf 5 . |
.Pp |
.Pp |
The arguments are as follows: |
The arguments are as follows: |
|
|
Display all files added or removed to the index. |
Display all files added or removed to the index. |
With a second |
With a second |
.Fl D , |
.Fl D , |
also show all keyswords added for each file. |
also show all keywords 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 |
|
|
.Ar |
.Ar |
from the database in |
from the database in |
.Ar dir . |
.Ar dir . |
|
If that causes the database to become empty, also delete the database file. |
.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 |
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. |
|
.Sh ENVIRONMENT |
|
.Bl -tag -width MANPATH |
|
.It Ev MANPATH |
|
A colon-separated list of directories to create databases in. |
|
Ignored if a |
|
.Ar dir |
|
argument or the |
|
.Fl t |
|
option is specified. |
|
.El |
.Sh FILES |
.Sh FILES |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Pa mandoc.db |
.It Pa mandoc.db |