Return to apropos.1 CVS log

Up to [local] / src / usr.bin / mandoc

Split the common code to be reused by other mandocdb clients,
for example the future man.cgi, out of apropos.c (which still
contains the apropos(1) main program, command line handling, and
the terminal output formatter) into apropos_db.{h,c} (which now
contains the database searching backend code).

While here,
* Drop the -e option; to search for exact strings, use REs.
* Drop the -r option (more changes related to this coming soon).
* Use the traditional -s and -S instead of inventing our own options.
* Drop the sort option (at least for now), it got in the way.

Written by kristaps@.

.\"	$Id: apropos.1,v 1.3 2011/11/13 09:58:21 schwarze 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 $Mdocdate: November 13 2011 $
.Dt APROPOS 1
.Os
.Sh NAME
.Nm apropos
.Nd search the manual page database
.Sh SYNOPSIS
.Nm
.Op Fl I
.Op Fl S Ar arch
.Op Fl s Ar section
.Op Fl t Ar types
.Ar pattern
.Sh DESCRIPTION
The
.Nm
utility queries the manual page database.
Its arguments are as follows:
.Bl -tag -width Ds
.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.
.It Fl I
Case-insensitive pattern matching.
.It Fl t Ar types
Consider only types of keyword match, where
.Ar types
is a comma-separated list consisting of the following:
.Ar name ,
manual names;
.Ar func ,
function names;
.Ar utility ,
utility names;
.Ar incl ,
include files;
.Ar var ,
variable names;
.Ar stand ,
standards ;
.Ar auth ,
authors;
.Ar conf ,
configuration strings;
.Ar desc ,
descriptive text;
.Ar xref ,
cross-references.
.Ar path ,
file pathnames;
.Ar env ,
environment variables; or
.Ar err ,
error codes.
Specifying
.Ar all
will search for all types.
.It Ar key
The search key.
.El
.Pp
By default,
.Nm
searches for pattern matches of
.Ar pattern
in manual names and descriptions
and displays results sorted by manual title.
Output is 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
.\" .Sh IMPLEMENTATION NOTES
.\" Not used in OpenBSD.
.\" .Sh RETURN VALUES
.\" For sections 2, 3, & 9 only.
.\" .Sh ENVIRONMENT
.\" For sections 1, 6, 7, & 8 only.
.\" .Sh FILES
.Sh EXIT STATUS
.Ex -std
.Sh EXAMPLES
Search for
.Qq optind
as a variable name in the library category:
.Pp
.Dl $ apropos \-tvar \-s 3 optind
.Pp
Search for all manuals referencing the term
.Qq POSIX
in any letter case:
.Pp
.Dl $ apropos \-tall \-I posix
.\" .Sh DIAGNOSTICS
.\" For sections 1, 4, 6, 7, & 8 only.
.\" .Sh ERRORS
.\" For sections 2, 3, & 9 only.
.Sh SEE ALSO
.Xr man 1 ,
.Xr mandoc 1 ,
.Xr re_format 7
.\" .Sh STANDARDS
.\" .Sh HISTORY
.Sh AUTHORS
The
.Nm
utility was written by
.An Kristaps Dzonsons ,
.Mt kristaps@bsd.lv .
.\" .Sh CAVEATS
.\" .Sh BUGS
.\" .Sh SECURITY CONSIDERATIONS
.\" Not used in OpenBSD.