aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mandocdb.8
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2011-12-12 02:00:49 +0000
committerIngo Schwarze <schwarze@openbsd.org>2011-12-12 02:00:49 +0000
commit6ca7be8f333b28c465a7b7d961bddcb31d59d72f (patch)
treee67531ef7f83c08f0c5eb984fa934e30675e4346 /mandocdb.8
parent424e4a7f6dd613adba96e61c70ed0ad508fc1d45 (diff)
downloadmandoc-6ca7be8f333b28c465a7b7d961bddcb31d59d72f.tar.gz
mandoc-6ca7be8f333b28c465a7b7d961bddcb31d59d72f.tar.zst
mandoc-6ca7be8f333b28c465a7b7d961bddcb31d59d72f.zip
implement -C (alternative config file) for apropos(1) and mandocdb(8),
including various tweaks to the whatis(8) manual; ok kristaps@
Diffstat (limited to 'mandocdb.8')
-rw-r--r--mandocdb.828
1 files changed, 22 insertions, 6 deletions
diff --git a/mandocdb.8 b/mandocdb.8
index e8e84ec8..0469c13b 100644
--- a/mandocdb.8
+++ b/mandocdb.8
@@ -1,4 +1,4 @@
-.\" $Id: mandocdb.8,v 1.11 2011/12/02 00:21:56 kristaps Exp $
+.\" $Id: mandocdb.8,v 1.12 2011/12/12 02:00:49 schwarze Exp $
.\"
.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: December 2 2011 $
+.Dd $Mdocdate: December 12 2011 $
.Dt MANDOCDB 8
.Os
.Sh NAME
@@ -23,7 +23,10 @@
.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
@@ -69,10 +72,16 @@ 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
+in
+.Xr man.conf 5
+format.
.It Fl d Ar dir
Merge (remove and re-add)
.Ar
@@ -141,7 +150,7 @@ length plus one) mapping to a 12-byte binary field consisting of the
64-bit keyword type and 32-bit source
.Sx Index Database
record number, both in network-byte order.
-The typet bit-mask consists of the following
+The type bit-mask consists of the following
values mapping into
.Xr mdoc 7
macro identifiers:
@@ -208,6 +217,10 @@ keyword database mapping keywords to a type and file reference in
A
.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
@@ -249,9 +262,12 @@ This usually indicates database corruption or invalid command-line
arguments.
.El
.Sh SEE ALSO
+.Xr apropos 1 ,
.Xr man 1 ,
+.Xr whatis 1 ,
.Xr btree 3 ,
-.Xr recno 3
+.Xr recno 3 ,
+.Xr man.conf 5
.Sh AUTHORS
The
.Nm