172 lines
3.9 KiB
Groff
172 lines
3.9 KiB
Groff
.\" $Vendor-Id: whatis.1,v 1.7 2011/12/25 19:35:44 kristaps Exp $
|
|
.\"
|
|
.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
|
|
.\"
|
|
.\" Permission to use, copy, modify, and distribute this software for any
|
|
.\" purpose with or without fee is hereby granted, provided that the above
|
|
.\" copyright notice and this permission notice appear in all copies.
|
|
.\"
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
.\"
|
|
.Dd December 25, 2011
|
|
.Dt WHATIS 1
|
|
.Os
|
|
.Sh NAME
|
|
.Nm whatis
|
|
.Nd search for manual pages by page names
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl C Ar file
|
|
.Op Fl M Ar manpath
|
|
.Op Fl m Ar manpath
|
|
.Op Fl S Ar arch
|
|
.Op Fl s Ar section
|
|
.Ar name ...
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
utility searches databases generated by
|
|
.Xr mandocdb 8
|
|
for manuals containing the word
|
|
.Ar name
|
|
in their page name, ignoring case.
|
|
It returns the header lines from all matching pages.
|
|
You can then use the
|
|
.Xr man 1
|
|
command to get more information.
|
|
.Pp
|
|
By default,
|
|
.Nm
|
|
searches for
|
|
.Xr mandocdb 8
|
|
databases in the default paths stipulated by
|
|
.Xr man 1 .
|
|
.Pp
|
|
The options are as follows:
|
|
.Bl -tag -width Ds
|
|
.It Fl C Ar file
|
|
Specify an alternative configuration
|
|
.Ar file
|
|
in
|
|
.Xr man.conf 5
|
|
format.
|
|
.It Fl M Ar manpath
|
|
Use the colon-separated
|
|
.Ar manpath
|
|
instead of the default list of paths searched for
|
|
.Xr mandocdb 8
|
|
databases.
|
|
Invalid paths, or paths without manual databases, are ignored.
|
|
.It Fl m Ar manpath
|
|
Prepend the colon-separated
|
|
.Ar manpath
|
|
to the list of paths searched for
|
|
.Xr mandocdb 8
|
|
databases.
|
|
Invalid paths, or paths without manual databases, are ignored.
|
|
.It Fl S Ar arch
|
|
Search only for a particular architecture.
|
|
.It Fl s Ar cat
|
|
Search only for a manual section.
|
|
See
|
|
.Xr man 1
|
|
for a listing of manual sections.
|
|
.El
|
|
.Pp
|
|
Results are sorted by manual title, with output formatted as
|
|
.Pp
|
|
.D1 title(sec) \- description
|
|
.Pp
|
|
Where
|
|
.Qq title
|
|
is the manual's title (note multiple manual names may exist for one
|
|
title),
|
|
.Qq sec
|
|
is the manual section, and
|
|
.Qq description
|
|
is the manual's short description.
|
|
If an architecture is specified for the manual, it is displayed as
|
|
.Pp
|
|
.D1 title(cat/arch) \- description
|
|
.Pp
|
|
Resulting manuals may be accessed as
|
|
.Pp
|
|
.Dl $ man \-s sec title
|
|
.Pp
|
|
If an architecture is specified in the output, use
|
|
.Pp
|
|
.Dl $ man \-s sec \-S arch title
|
|
.Pp
|
|
.Nm
|
|
is identical to running
|
|
.Xr apropos 1
|
|
as follows:
|
|
.Pp
|
|
.Dl $ apropos -- -i 'Nm~[[:<:]]term[[:>:]]'
|
|
.Sh ENVIRONMENT
|
|
.Bl -tag -width Ds
|
|
.It Ev MANPATH
|
|
Colon-separated paths modifying the default list of paths searched for
|
|
manual databases.
|
|
Invalid paths, or paths without manual databases, are ignored.
|
|
Overridden by
|
|
.Fl M .
|
|
If
|
|
.Ev MANPATH
|
|
begins with a
|
|
.Sq \&: ,
|
|
it is appended to the default list;
|
|
else if it ends with
|
|
.Sq \&: ,
|
|
it is prepended to the default list; else if it contains
|
|
.Sq \&:: ,
|
|
the default list is inserted between the colons.
|
|
If none of these conditions are met, it overrides the default list.
|
|
.El
|
|
.Sh FILES
|
|
.Bl -tag -width "/etc/man.conf" -compact
|
|
.It Pa whatis.db
|
|
name of the
|
|
.Xr mandocdb 8
|
|
keyword database
|
|
.It Pa whatis.index
|
|
name of the
|
|
.Xr mandocdb 8
|
|
filename database
|
|
.It Pa /etc/man.conf
|
|
default
|
|
.Xr man 1
|
|
configuration file
|
|
.El
|
|
.Sh EXIT STATUS
|
|
.Ex -std
|
|
.Sh SEE ALSO
|
|
.Xr apropos 1 ,
|
|
.Xr man 1 ,
|
|
.Xr man.conf 5 ,
|
|
.Xr mandocdb 8
|
|
.Sh HISTORY
|
|
The
|
|
.Nm
|
|
utility first appeared in
|
|
.Bx 2 .
|
|
It was rewritten from scratch as part of the
|
|
.Xr mandocdb 8
|
|
project for
|
|
.Ox 5.1 .
|
|
.Sh AUTHORS
|
|
.An -nosplit
|
|
.An Bill Joy
|
|
wrote the original
|
|
.Bx
|
|
.Nm
|
|
in 1979.
|
|
The current version was written by
|
|
.An Kristaps Dzonsons ,
|
|
.Mt kristaps@bsd.lv .
|