summaryrefslogtreecommitdiffstatshomepage
path: root/mandocdb.8
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2011-07-15 10:15:24 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2011-07-15 10:15:24 +0000
commit46a4999f476f21b9b4c1fb2ea2582c8ec43bec2d (patch)
tree4f9dfec46eec0423fb3564bb2c21fa83e4fc963e /mandocdb.8
parent57931f781129f601a18308a5fa95fd9f14915ac9 (diff)
downloadmandoc-46a4999f476f21b9b4c1fb2ea2582c8ec43bec2d.tar.gz
mandoc-46a4999f476f21b9b4c1fb2ea2582c8ec43bec2d.tar.zst
mandoc-46a4999f476f21b9b4c1fb2ea2582c8ec43bec2d.zip
First step of making mandocdb a true makewhatis/mandb replacement:
accept a set of directories on the command line ("manpaths") that are recursed for files. The databases are created in each manpath root. This temporarily removes OP_UPDATE and OP_DELETE functionality, which will be added back in.
Diffstat (limited to 'mandocdb.8')
-rw-r--r--mandocdb.855
1 files changed, 22 insertions, 33 deletions
diff --git a/mandocdb.8 b/mandocdb.8
index 84f3abe7..f22466be 100644
--- a/mandocdb.8
+++ b/mandocdb.8
@@ -1,4 +1,4 @@
-.\" $Id: mandocdb.8,v 1.1 2011/07/14 14:36:37 schwarze Exp $
+.\" $Id: mandocdb.8,v 1.2 2011/07/15 10:15:24 kristaps 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: July 14 2011 $
+.Dd $Mdocdate: July 15 2011 $
.Dt MANDOCDB 8
.Os
.Sh NAME
@@ -22,9 +22,7 @@
.Nd index UNIX manuals
.Sh SYNOPSIS
.Nm
-.Op Fl ruv
-.Op Fl d Ar dir
-.Ar
+.Ar dir...
.Sh DESCRIPTION
The
.Nm
@@ -33,42 +31,33 @@ utility extracts keywords from
manuals and indexes them for fast retrieval.
The arguments are as follows:
.Bl -tag -width Ds
-.It Fl d Ar dir
-The directory into which to write the keyword and index databases.
-.It Ar
-Read input from zero or more files in
+.It Ar dir...
+Recursively scan for
.Xr mdoc 7
-or
+and
.Xr man 7
.Ux
-manual format.
-.It Fl r
-Remove entries.
-This will remove the index and keyword references.
-If the record is not found, it is ignored.
-.It Fl u
-Update the record.
-This will first remove the record (as in
-.Fl r )
-then re-add it.
-.It Fl v
-Verbose output.
-If specified once, prints the name of each indexed file.
-If twice, prints keywords for each file.
-.El
-.Pp
-By default,
-.Nm
-constructs a new
+manual files in each
+.Ar dir
+directory.
.Sx Index Database
and
.Sx Keyword Database
-in the current working directory.
+files are installed in each
+.Ar dir
+directory.
Existing databases are truncated.
+.El
+.Pp
+By default,
+.Nm
+does nothing: the
+.Ar dir...
+invocation must be used.
.Pp
-If fatal parse errors are encountered, the offending file is printed to
-stderr, omitted from the index, and the parse continues with the next
-input file.
+If fatal parse errors are encountered while parsing, the offending file
+is printed to stderr, omitted from the index, and the parse continues
+with the next input file.
.Ss Index Database
The index database,
.Pa mandoc.index ,