summaryrefslogtreecommitdiffstats
path: root/makewhatis.1
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2011-07-11 21:56:06 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2011-07-11 21:56:06 +0000
commitb893dc28f5e041ed6abe50ad792ae5d85f32cd74 (patch)
tree9474d13e611e1ad853b3dc728932db6219879384 /makewhatis.1
parentf37ec6d0eca54e78591941710bf176d838010944 (diff)
downloadmandoc-b893dc28f5e041ed6abe50ad792ae5d85f32cd74.tar.gz
Fairly straightforward patch adding basic update (-u) and remove (-r)
functionality to makewhatis. This is somewhat expensive (requiring the index file to be trawled multiple times), but it's a good start.
Diffstat (limited to 'makewhatis.1')
-rw-r--r--makewhatis.122
1 files changed, 20 insertions, 2 deletions
diff --git a/makewhatis.1 b/makewhatis.1
index 68332858..116a6f51 100644
--- a/makewhatis.1
+++ b/makewhatis.1
@@ -22,7 +22,7 @@
.Nd index UNIX manuals
.Sh SYNOPSIS
.Nm
-.Op Fl v
+.Op Fl ruv
.Op Fl d Ar dir
.Ar
.Sh DESCRIPTION
@@ -42,6 +42,15 @@ or
.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.
@@ -50,11 +59,12 @@ If twice, prints keywords for each file.
.Pp
By default,
.Nm
-constructs the
+constructs a new
.Sx Index Database
and
.Sx Keyword Database
in the current working directory.
+Existing databases are truncated.
.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
@@ -133,6 +143,14 @@ 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.
+However, removing or updating entries with
+.Fl r
+or
+.Fl u ,
+respectively, grows as a multiple of the index length and input size.
.Sh FILES
.Bl -tag -width Ds
.It Pa mandoc.db