Tue Mar 3 18:04:33 2015 UTC ()
mention that this replaces makewhatis(8)


(christos)
diff -r1.7 -r1.8 src/usr.sbin/makemandb/makemandb.8
cvs diff -r1.7 -r1.8 src/usr.sbin/makemandb/makemandb.8 (expand / switch to unified diff)

--- src/usr.sbin/makemandb/makemandb.8 2013/11/29 23:58:23 1.7
+++ src/usr.sbin/makemandb/makemandb.8 2015/03/03 18:04:33 1.8
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1.\" $NetBSD: makemandb.8,v 1.7 2013/11/29 23:58:23 wiz Exp $ 1.\" $NetBSD: makemandb.8,v 1.8 2015/03/03 18:04:33 christos Exp $
2.\" 2.\"
3.\" Copyright (c) 2011 Abhinav Upadhyay <er.abhinav.upadhyay@gmail.com> 3.\" Copyright (c) 2011 Abhinav Upadhyay <er.abhinav.upadhyay@gmail.com>
4.\" All rights reserved. 4.\" All rights reserved.
5.\" 5.\"
6.\" This code was developed as part of Google's Summer of Code 2011 program. 6.\" This code was developed as part of Google's Summer of Code 2011 program.
7.\" 7.\"
8.\" Redistribution and use in source and binary forms, with or without 8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions 9.\" modification, are permitted provided that the following conditions
10.\" are met: 10.\" are met:
11.\" 11.\"
12.\" 1. Redistributions of source code must retain the above copyright 12.\" 1. Redistributions of source code must retain the above copyright
13.\" notice, this list of conditions and the following disclaimer. 13.\" notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" 2. Redistributions in binary form must reproduce the above copyright
@@ -19,27 +19,27 @@ @@ -19,27 +19,27 @@
19.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 21.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 22.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 23.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, 24.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 25.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 26.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 27.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 28.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE. 30.\" SUCH DAMAGE.
31.\" 31.\"
32.Dd November 23, 2013 32.Dd March 3, 2015
33.Dt MAKEMANDB 8 33.Dt MAKEMANDB 8
34.Os 34.Os
35.Sh NAME 35.Sh NAME
36.Nm makemandb 36.Nm makemandb
37.Nd parse the manual pages and build a search index for 37.Nd parse the manual pages and build a search index for
38.Xr apropos 1 38.Xr apropos 1
39.Sh SYNOPSIS 39.Sh SYNOPSIS
40.Nm 40.Nm
41.Op Fl floQqv 41.Op Fl floQqv
42.Op Fl C Ar path 42.Op Fl C Ar path
43.Sh DESCRIPTION 43.Sh DESCRIPTION
44The 44The
45.Nm 45.Nm
@@ -73,27 +73,33 @@ Use this option to optimize the index fo @@ -73,27 +73,33 @@ Use this option to optimize the index fo
73to significantly reduce disk space usage. 73to significantly reduce disk space usage.
74This is a somewhat expensive operation. 74This is a somewhat expensive operation.
75.It Fl Q 75.It Fl Q
76Print only fatal error messages (i.e., when the database is left in 76Print only fatal error messages (i.e., when the database is left in
77an inconsistent state and needs manual intervention). 77an inconsistent state and needs manual intervention).
78.It Fl q 78.It Fl q
79Print only warnings and error messages but no status updates. 79Print only warnings and error messages but no status updates.
80.It Fl v 80.It Fl v
81Enable verbose output. 81Enable verbose output.
82This prints the name of every file being parsed 82This prints the name of every file being parsed
83and a summary at the end of the index update. 83and a summary at the end of the index update.
84.El 84.El
85.Pp 85.Pp
86.Nm . 86The index generated by
 87.Nm
 88is also used by the
 89.Xr whatis 1
 90program, replacing the old
 91.Dq makewhatis
 92program.
87.Ss DATABASE SCHEMA 93.Ss DATABASE SCHEMA
88The name of the FTS table is mandb and its schema is as follows: 94The name of the FTS table is mandb and its schema is as follows:
89.Bl -column -offset indent "Column Name" "Column Description" 95.Bl -column -offset indent "Column Name" "Column Description"
90.It Li section Ta The section number of the page 96.It Li section Ta The section number of the page
91.It Li name Ta The name of the page from the NAME section. 97.It Li name Ta The name of the page from the NAME section.
92.It Li name_desc Ta The one line description from the NAME section. 98.It Li name_desc Ta The one line description from the NAME section.
93.It Li desc Ta The DESCRIPTION section. 99.It Li desc Ta The DESCRIPTION section.
94.It Li lib Ta The LIBRARY section. 100.It Li lib Ta The LIBRARY section.
95.It Li return_vals Ta The RETURN VALUES section. 101.It Li return_vals Ta The RETURN VALUES section.
96.It Li env Ta The ENVIRONMENT section. 102.It Li env Ta The ENVIRONMENT section.
97.It Li files Ta The FILES section. 103.It Li files Ta The FILES section.
98.It Li exit_status Ta The EXIT STATUS section. 104.It Li exit_status Ta The EXIT STATUS section.
99.It Li diagnostics Ta The DIAGNOSTICS section. 105.It Li diagnostics Ta The DIAGNOSTICS section.