1 .\" $Id: whatis.1,v 1.9 2012/03/25 00:48:47 kristaps Exp $
3 .\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 .Dd $Mdocdate: March 25 2012 $
22 .Nd search for manual pages by page names
34 utility searches databases generated by
36 for manuals containing the word
38 in their page name, ignoring case.
44 databases in the default paths stipulated by
46 If standard output is a TTY, a result may be selected from a list and
47 its manual displayed with the pager.
49 The options are as follows:
52 Specify an alternative configuration
58 Use the colon-separated
60 instead of the default list of paths searched for
63 Invalid paths, or paths without manual databases, are ignored.
65 Prepend the colon-separated
67 to the list of paths searched for
70 Invalid paths, or paths without manual databases, are ignored.
72 Search only for a particular architecture.
74 Search only for a manual section.
77 for a listing of manual sections.
80 Results are sorted by manual title, with output formatted as
82 .D1 title(sec) \- description
86 is the manual's title (note multiple manual names may exist for one
89 is the manual section, and
91 is the manual's short description.
92 If an architecture is specified for the manual, it is displayed as
94 .D1 title(cat/arch) \- description
96 If on a TTY, results are prefixed with a numeric identifier.
98 .D1 [index] title(cat) \- description
100 One may choose a manual be entering the index at the prompt.
101 Valid choices are displayed using
107 Source pages are formatted with
109 preformatted pages with
113 is identical to running
117 .Dl $ apropos -- -i 'Nm~[[:<:]]term[[:>:]]'
121 Default pager for manuals.
122 If this is unset, falls back to
125 The second choice for a manual pager.
126 If this is unset, use
129 Colon-separated paths modifying the default list of paths searched for
131 Invalid paths, or paths without manual databases, are ignored.
138 it is appended to the default list;
141 it is prepended to the default list; else if it contains
143 the default list is inserted between the colons.
144 If none of these conditions are met, it overrides the default list.
147 .Bl -tag -width "/etc/man.conf" -compact
171 utility first appeared in
173 It was rewritten from scratch as part of the
184 The current version was written by
185 .An Kristaps Dzonsons ,
186 .Mt kristaps@bsd.lv .