Use mandoc.1's error codes (we use them internally).

[mandoc.git] / makewhatis.1

diff --git a/makewhatis.1 b/makewhatis.1
index c78027850e7317846e8a03a49fce452ad1d19ef3..aa0cf5b4cccbc6d12fa08466612d311b063323cb 100644 (file)
--- a/makewhatis.1
+++ b/makewhatis.1
@@ -1,4 +1,4 @@
-.\"    $Id: makewhatis.1,v 1.9 2011/07/01 12:02:44 kristaps Exp $
+.\"    $Id: makewhatis.1,v 1.12 2011/07/11 09:44:07 kristaps Exp $

 .\"
 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
 .\"
 .\" 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.
 .\"
 .\" 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 1 2011 $
+.Dd $Mdocdate: July 11 2011 $

 .Dt MAKEWHATIS 1
 .Os
 .Sh NAME
 .Dt MAKEWHATIS 1
 .Os
 .Sh NAME


@@ -122,6 +122,8 @@ If the link has no section, the period terminates the string.
 Path reference as given in the FILES section.
 .It Li 0x800
 Environment variable as given in the ENVIRONMENT section.
 Path reference as given in the FILES section.
 .It Li 0x800
 Environment variable as given in the ENVIRONMENT section.

+.It Li 0x1000
+Error codes as given in the ERRORS section.

 .El
 .Pp
 The last four bytes are a host-ordered record number within the
 .El
 .Pp
 The last four bytes are a host-ordered record number within the


@@ -138,19 +140,30 @@ A
 .Xr btree 3
 keyword database mapping keywords to a type and file reference in
 .Pa mandoc.index .
 .Xr btree 3
 keyword database mapping keywords to a type and file reference in
 .Pa mandoc.index .

-.It Pa mandoc.db~
-Working copy of
-.Pa mandoc.db .

 .It Pa mandoc.index
 A
 .Xr recno 3
 database of indexed file-names.
 .It Pa mandoc.index
 A
 .Xr recno 3
 database of indexed file-names.

-.It Pa mandoc.index~
-Working copy of
-.Pa mandoc.index .

 .El
 .Sh EXIT STATUS
 .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 mandoc 1
 .Sh AUTHORS
 .Sh SEE ALSO
 .Xr mandoc 1
 .Sh AUTHORS