Annotation of mandoc/makewhatis.8, Revision 1.4
1.4 ! schwarze 1: .\" $Id: makewhatis.8,v 1.3 2014/08/17 21:03:06 schwarze Exp $
1.1 schwarze 2: .\"
3: .\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
4: .\" Copyright (c) 2011, 2012 Ingo Schwarze <schwarze@openbsd.org>
5: .\"
6: .\" Permission to use, copy, modify, and distribute this software for any
7: .\" purpose with or without fee is hereby granted, provided that the above
8: .\" copyright notice and this permission notice appear in all copies.
9: .\"
10: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: .\"
1.4 ! schwarze 18: .Dd $Mdocdate: August 17 2014 $
1.1 schwarze 19: .Dt MAKEWHATIS 8
20: .Os
21: .Sh NAME
22: .Nm makewhatis
23: .Nd index UNIX manuals
24: .Sh SYNOPSIS
25: .Nm
26: .Op Fl aDnpQ
27: .Op Fl T Cm utf8
28: .Op Fl C Ar file
29: .Nm
30: .Op Fl aDnpQ
31: .Op Fl T Cm utf8
32: .Ar dir ...
33: .Nm
34: .Op Fl DnpQ
35: .Op Fl T Cm utf8
36: .Fl d Ar dir
37: .Op Ar
38: .Nm
39: .Op Fl Dnp
40: .Op Fl T Cm utf8
41: .Fl u Ar dir
42: .Op Ar
43: .Nm
1.2 schwarze 44: .Op Fl DQ
1.1 schwarze 45: .Fl t Ar
46: .Sh DESCRIPTION
47: The
48: .Nm
49: utility extracts keywords from
50: .Ux
51: manuals and indexes them in a database for fast retrieval by
52: .Xr apropos 1 ,
53: .Xr whatis 1 ,
54: and
55: .Xr man 1 Ns 's
56: .Fl k
57: option.
58: .Pp
59: By default,
60: .Nm
61: creates a database in each
62: .Ar dir
63: using the files
64: .Sm off
65: .Sy man Ar section Li /
66: .Op Ar arch Li /
67: .Ar title . section
68: .Sm on
69: and
70: .Sm off
71: .Sy cat Ar section Li /
72: .Op Ar arch Li /
73: .Ar title . Sy 0
74: .Sm on
75: in that directory.
76: Existing databases are replaced.
77: If
78: .Ar dir
79: is not provided,
80: .Nm
81: uses the default paths stipulated by
82: .Xr man.conf 5 .
83: .Pp
84: The arguments are as follows:
85: .Bl -tag -width "-C file"
86: .It Fl a
87: Use all directories and files found below
88: .Ar dir ... .
89: .It Fl C Ar file
90: Specify an alternative configuration
91: .Ar file
92: in
93: .Xr man.conf 5
94: format.
95: .It Fl D
96: Display all files added or removed to the index.
97: With a second
98: .Fl D ,
1.3 schwarze 99: also show all keywords added for each file.
1.1 schwarze 100: .It Fl d Ar dir
101: Merge (remove and re-add)
102: .Ar
103: to the database in
104: .Ar dir .
105: .It Fl n
106: Do not create or modify any database; scan and parse only,
107: and print manual page names and descriptions to standard output.
108: .It Fl p
109: Print warnings about potential problems with manual pages
110: to the standard error output.
111: .It Fl Q
112: Quickly build reduced-size databases
113: by reading only the NAME sections of manuals.
114: The resulting databases will usually contain names and descriptions only.
115: .It Fl T Cm utf8
116: Use UTF-8 encoding instead of ASCII for strings stored in the databases.
117: .It Fl t Ar
118: Check the given
119: .Ar files
120: for potential problems.
121: Implies
122: .Fl a ,
123: .Fl n ,
124: and
125: .Fl p .
126: All diagnostic messages are printed to the standard output;
127: the standard error output is not used.
128: .It Fl u Ar dir
129: Remove
130: .Ar
131: from the database in
132: .Ar dir .
133: .El
134: .Pp
135: If fatal parse errors are encountered while parsing, the offending file
136: is printed to stderr, omitted from the index, and the parse continues
137: with the next input file.
138: .Sh FILES
139: .Bl -tag -width Ds
140: .It Pa mandoc.db
141: A database of manpages relative to the directory of the file.
142: This file is portable across architectures and systems, so long as the
143: manpage hierarchy it indexes does not change.
144: .It Pa /etc/man.conf
145: The default
146: .Xr man 1
147: configuration file.
148: .El
149: .Sh EXIT STATUS
150: The
151: .Nm
152: utility exits with one of the following values:
153: .Pp
154: .Bl -tag -width Ds -compact
155: .It 0
156: No errors occurred.
157: .It 5
158: Invalid command line arguments were specified.
159: No input files have been read.
160: .It 6
161: An operating system error occurred, for example memory exhaustion or an
162: error accessing input files.
163: Such errors cause
164: .Nm
165: to exit at once, possibly in the middle of parsing or formatting a file.
166: The output databases are corrupt and should be removed.
167: .El
168: .Sh SEE ALSO
169: .Xr apropos 1 ,
170: .Xr man 1 ,
171: .Xr whatis 1 ,
172: .Xr man.conf 5
173: .Sh HISTORY
174: A
175: .Nm
176: utility first appeared in
177: .Bx 2 .
178: It was rewritten in
179: .Xr perl 1
180: for
181: .Ox 2.7
182: and in C for
183: .Ox 5.6 .
184: .Pp
185: The
186: .Ar dir
187: argument first appeared in
188: .Nx 1.0 ;
189: the options
190: .Fl dpt
191: in
192: .Ox 2.7 ;
193: the option
194: .Fl u
195: in
196: .Ox 3.4 ;
197: and the options
198: .Fl aCDnQT
199: in
200: .Ox 5.6 .
201: .Sh AUTHORS
202: .An -nosplit
203: .An Bill Joy
204: wrote the original
205: .Bx
206: .Nm
207: in February 1979,
208: .An Marc Espie
209: started the Perl version in 2000,
210: and the current version of
211: .Nm
212: was written by
213: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
214: and
215: .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to makewhatis.8 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc