aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mandocdb.8
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2011-12-25 13:08:12 +0000
committerIngo Schwarze <schwarze@openbsd.org>2011-12-25 13:08:12 +0000
commit1282796854ba0d64d77baf61f72081d5c1e45a8c (patch)
tree1b3c541ce58e7a28cf553607f1f6474480aa7c5a /mandocdb.8
parent586d9c5122c9adb8da1eac27d93045e4851ccf60 (diff)
downloadmandoc-1282796854ba0d64d77baf61f72081d5c1e45a8c.tar.gz
mandoc-1282796854ba0d64d77baf61f72081d5c1e45a8c.tar.zst
mandoc-1282796854ba0d64d77baf61f72081d5c1e45a8c.zip
Implement test mode (makewhatis -t), required for pkg_create(8).
Always do all consistency checks; when any one fails, decide whether to print a message, or skip the file, or both, or none. While here, do some cleanup as well: * Bail out on conflicting options. * Do not crash with -a if there are plain files in the root dir. * Collect some related variables into structs. Feedback and 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 38b928fd..270bab92 100644
--- a/mandocdb.8
+++ b/mandocdb.8
@@ -1,4 +1,4 @@
-.\" $Id: mandocdb.8,v 1.14 2011/12/16 12:06:35 kristaps Exp $
+.\" $Id: mandocdb.8,v 1.15 2011/12/25 13:08:12 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 16 2011 $
+.Dd $Mdocdate: December 25 2011 $
.Dt MANDOCDB 8
.Os
.Sh NAME
@@ -22,19 +22,21 @@
.Nd index UNIX manuals
.Sh SYNOPSIS
.Nm
-.Op Fl av
+.Op Fl avW
.Op Fl C Ar file
.Nm
-.Op Fl av
+.Op Fl avW
.Ar dir ...
.Nm
-.Op Fl v
+.Op Fl vW
.Fl d Ar dir
.Op Ar
.Nm
-.Op Fl v
+.Op Fl vW
.Fl u Ar dir
.Op Ar
+.Nm
+.Fl t Ar
.Sh DESCRIPTION
The
.Nm
@@ -88,6 +90,17 @@ Merge (remove and re-add)
to the database in
.Ar dir
without truncating it.
+.It Fl t Ar
+Check the given
+.Ar files
+for potential problems.
+No databases are modified.
+Implies
+.Fl a
+and
+.Fl W .
+All diagnostic messages are printed to the standard output;
+the standard error output is not used.
.It Fl u Ar dir
Remove
.Ar
@@ -96,6 +109,9 @@ from the database in
without truncating it.
.It Fl v
Display all files added or removed to the index.
+.It Fl W
+Print warnings about potential problems with manual pages
+to the standard error output.
.El
.Pp
If fatal parse errors are encountered while parsing, the offending file