aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mandocdb.8
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2014-03-17 08:34:00 +0000
committerIngo Schwarze <schwarze@openbsd.org>2014-03-17 08:34:00 +0000
commite90e8d2dcc01489e5fa59b798ff003273b5ca134 (patch)
tree0221b23c8b0f59c3422a29b8812720c6ee378fca /mandocdb.8
parentd3bd41e2ad7a545b43f34ce05e2f98126c843584 (diff)
downloadmandoc-e90e8d2dcc01489e5fa59b798ff003273b5ca134.tar.gz
mandoc-e90e8d2dcc01489e5fa59b798ff003273b5ca134.tar.zst
mandoc-e90e8d2dcc01489e5fa59b798ff003273b5ca134.zip
minor sync to OpenBSD
Diffstat (limited to 'mandocdb.8')
-rw-r--r--mandocdb.834
1 files changed, 28 insertions, 6 deletions
diff --git a/mandocdb.8 b/mandocdb.8
index 1bb6547b..52e412a8 100644
--- a/mandocdb.8
+++ b/mandocdb.8
@@ -1,6 +1,7 @@
-.\" $Id: mandocdb.8,v 1.20 2013/10/01 20:56:18 schwarze Exp $
+.\" $Id: mandocdb.8,v 1.21 2014/03/17 08:34:00 schwarze Exp $
.\"
.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
+.\" Copyright (c) 2011, 2012 Ingo Schwarze <schwarze@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
@@ -14,7 +15,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: October 1 2013 $
+.Dd $Mdocdate: March 17 2014 $
.Dt MANDOCDB 8
.Os
.Sh NAME
@@ -46,7 +47,9 @@ manuals and indexes them in a database for fast retrieval by
.Xr apropos 1 ,
.Xr whatis 1 ,
and
-.Xr man 1 .
+.Xr man 1 Ns 's
+.Fl k
+option.
.Pp
By default,
.Nm
@@ -126,11 +129,30 @@ with the next input file.
A database of manpages relative to the directory of the file.
This file is portable across architectures and systems, so long as the
manpage hierarchy it indexes does not change.
-.It Pa mandoc.db~
-A temporary database used during scanning and parsing.
+.It Pa /etc/man.conf
+The default
+.Xr man 1
+configuration file.
.El
.Sh EXIT STATUS
-.Ex -std
+The
+.Nm
+utility exits with one of the following values:
+.Pp
+.Bl -tag -width Ds -compact
+.It 0
+No errors occurred.
+.It 5
+Invalid command line arguments were specified.
+No input files have been read.
+.It 6
+An operating system error occurred, for example memory exhaustion or an
+error accessing input files.
+Such errors cause
+.Nm
+to exit at once, possibly in the middle of parsing or formatting a file.
+The output databases are corrupt and should be removed.
+.El
.Sh SEE ALSO
.Xr apropos 1 ,
.Xr man 1 ,