Do not read past the end of the buffer if an "f" layout font modifier

[mandoc.git] / apropos.1

diff --git a/apropos.1 b/apropos.1
index 2d84d6eab6bbb4f66a8aaebf6f8c9b749750bb51..e2075349f553b01f809a562935225081ccc7e6f5 100644 (file)
--- a/apropos.1
+++ b/apropos.1
@@ -1,6 +1,7 @@
-.\"    $Id: apropos.1,v 1.12 2011/11/29 10:59:19 kristaps Exp $
+.\"    $Id: apropos.1,v 1.36 2014/10/25 01:03:52 schwarze Exp $

 .\"
 .\"

-.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
+.\" Copyright (c) 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>

 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above


@@ -14,48 +15,161 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" 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 29 2011 $
+.Dd $Mdocdate: October 25 2014 $

 .Dt APROPOS 1
 .Os
 .Sh NAME
 .Dt APROPOS 1
 .Os
 .Sh NAME

-.Nm apropos
+.Nm apropos ,
+.Nm whatis

 .Nd search manual page databases
 .Sh SYNOPSIS
 .Nm
 .Nd search manual page databases
 .Sh SYNOPSIS
 .Nm

-.Op Fl M Ar manpath
-.Op Fl m Ar manpath
+.Op Fl acfhklVw
+.Op Fl C Ar file
+.Op Fl M Ar path
+.Op Fl m Ar path
+.Op Fl O Ar outkey

 .Op Fl S Ar arch
 .Op Fl s Ar section
 .Op Fl S Ar arch
 .Op Fl s Ar section

-.Ar expression...
+.Ar expression ...

 .Sh DESCRIPTION
 The
 .Sh DESCRIPTION
 The

-.Nm
-utility queries manual page databases generated by
-.Xr mandocdb 8 ,
-evaluating on
+.Nm apropos
+and
+.Nm whatis
+utilities query manual page databases generated by
+.Xr makewhatis 8 ,
+evaluating

 .Ar expression
 for each file in each database.
 .Ar expression
 for each file in each database.

-Its arguments are as follows:
+By default, they display the names, section numbers, and description lines
+of all matching manuals.
+.Pp
+By default,
+.Nm
+searches for
+.Xr makewhatis 8
+databases in the default paths stipulated by
+.Xr man 1
+and uses case-insensitive substring matching
+.Pq the Cm = No operator
+over manual names and descriptions
+.Pq the Li \&Nm No and Li \&Nd No macro keys .
+Multiple terms imply pairwise
+.Fl o .
+.Pp
+.Nm whatis
+is a synonym for
+.Nm
+.Fl f .
+.Pp
+The options are as follows:

 .Bl -tag -width Ds
 .Bl -tag -width Ds

-.It Fl M Ar manpath
+.It Fl a
+Instead of showing only the title lines, show the complete manual pages,
+just like
+.Xr man 1
+.Fl a
+would.
+If the standard output is a terminal device and
+.Fl c
+is not specified, use
+.Xr more 1
+to paginate them.
+In
+.Fl a
+mode, the options
+.Fl IKOTW
+described in the
+.Xr mandoc 1
+manual are also available.
+.It Fl C Ar file
+Specify an alternative configuration
+.Ar file
+in
+.Xr man.conf 5
+format.
+.It Fl c
+In
+.Fl a
+mode, copy the formatted manual pages to the standard output without using
+.Xr more 1
+to paginate them.
+.It Fl f
+Search for all words in
+.Ar expression
+in manual page names only.
+The search is case insensitive and matches whole words only.
+In this mode, macro keys, comparison operators, and logical operators
+are not available.
+This overrides any earlier
+.Fl k
+and
+.Fl l
+options.
+.It Fl h
+Instead of showing the title lines, show the SYNOPSIS sections, just like
+.Xr man 1
+.Fl h
+would.
+.It Fl k
+Support the full
+.Ar expression
+syntax.
+This overrides any earlier
+.Fl f
+and
+.Fl l
+options.
+It is the default for
+.Nm .
+.It Fl l
+An alias for
+.Xr mandoc 1
+.Fl a .
+This overrides any earlier
+.Fl f ,
+.Fl k ,
+and
+.Fl w
+options.
+.It Fl M Ar path

 Use the colon-separated path instead of the default list of paths
 searched for
 Use the colon-separated path instead of the default list of paths
 searched for

-.Xr mandocdb 8
+.Xr makewhatis 8

 databases.
 Invalid paths, or paths without manual databases, are ignored.
 databases.
 Invalid paths, or paths without manual databases, are ignored.

-.It Fl m Ar manpath
+.It Fl m Ar path

 Prepend the colon-separated paths to the list of paths searched
 for
 Prepend the colon-separated paths to the list of paths searched
 for

-.Xr mandocdb 8
+.Xr makewhatis 8

 databases.
 Invalid paths, or paths without manual databases, are ignored.
 databases.
 Invalid paths, or paths without manual databases, are ignored.

+.It Fl O Ar outkey
+Show the values associated with the key
+.Ar outkey
+instead of the manual descriptions.

 .It Fl S Ar arch
 .It Fl S Ar arch

-Search only for a particular architecture.
-.It Fl s Ar cat
-Search only for a manual section.
+Restrict the search to pages for the specified
+.Xr machine 1
+architecture.
+.Ar arch
+is case insensitive.
+By default, pages for all architectures are shown.
+.It Fl s Ar section
+Restrict the search to the specified section of the manual.
+By default, pages from all sections are shown.

 See
 .Xr man 1
 See
 .Xr man 1

-for a listing of manual sections.
+for a listing of sections.
+.It Fl V
+Print version and exit.
+.It Fl w
+Instead of showing title lines, show the pathnames of the matching
+manual pages, just like
+.Xr man 1
+.Fl w
+would.

 .El
 .Pp
 An
 .El
 .Pp
 An


@@ -82,34 +196,40 @@ True if both
 and
 .Ar expr2
 are true (logical
 and
 .Ar expr2
 are true (logical

-.Qq and ) .
+.Sq and ) .

 .It Ar expr1 Oo Fl o Oc Ar expr2
 True if
 .Ar expr1
 and/or
 .Ar expr2
 evaluate to true (logical
 .It Ar expr1 Oo Fl o Oc Ar expr2
 True if
 .Ar expr1
 and/or
 .Ar expr2
 evaluate to true (logical

-.Qq or ) .
+.Sq or ) .

 .It Ar term
 True if
 .Ar term
 is satisfied.
 This has syntax
 .It Ar term
 True if
 .Ar term
 is satisfied.
 This has syntax

-.Li [key[,key]*(=~)]?val ,
-where operand
-.Cm key
+.Sm off
+.Oo
+.Op Ar key Op , Ar key ...
+.Pq Cm = | ~
+.Oc
+.Ar val ,
+.Sm on
+where
+.Ar key

 is an
 .Xr mdoc 7
 macro to query and
 is an
 .Xr mdoc 7
 macro to query and

-.Cm val
+.Ar val

 is its value.
 See
 .Sx Macro Keys
 for a list of available keys.
 Operator
 is its value.
 See
 .Sx Macro Keys
 for a list of available keys.
 Operator

-.Li \&=
+.Cm =

 evaluates a substring, while
 evaluates a substring, while

-.Li \&~
+.Cm ~

 evaluates a regular expression.
 .It Fl i Ar term
 If
 evaluates a regular expression.
 .It Fl i Ar term
 If


@@ -119,46 +239,33 @@ is evaluated case-insensitively.
 Has no effect on substring terms.
 .El
 .Pp
 Has no effect on substring terms.
 .El
 .Pp

-By default,
-.Nm
-searches for
-.Xr mandocdb 8
-databases in the default paths stipulated by
-.Xr man 1 ,
-parses terms as case-sensitive regular expressions
-.Pq the Li \&~ operator
-over manual names and descriptions
-.Pq the Li \&Nm No and Li \&Nd No macro keys .
-Multiple terms imply pairwise
-.Fl o .
-Results are sorted by manual title, with output formatted as
+Results are sorted by manual sections and names, with output formatted as

 .Pp
 .Pp

-.D1 title(sec) \- description
+.D1 name[, name...](sec) \- description

 .Pp
 Where
 .Pp
 Where

-.Qq title
-is the manual's title (note multiple manual names may exist for one
-title),
-.Qq sec
+.Dq name
+is the manual's name,
+.Dq sec

 is the manual section, and
 is the manual section, and

-.Qq description
+.Dq description

 is the manual's short description.
 If an architecture is specified for the manual, it is displayed as
 .Pp
 is the manual's short description.
 If an architecture is specified for the manual, it is displayed as
 .Pp

-.D1 title(cat/arch) \- description
+.D1 name(sec/arch) \- description

 .Pp
 Resulting manuals may be accessed as
 .Pp
 .Pp
 Resulting manuals may be accessed as
 .Pp

-.Dl $ man \-s sec title
+.Dl $ man \-s sec name

 .Pp
 If an architecture is specified in the output, use
 .Pp
 .Pp
 If an architecture is specified in the output, use
 .Pp

-.Dl $ man \-s sec \-S arch title
+.Dl $ man \-s sec \-S arch name

 .Ss Macro Keys
 Queries evaluate over a subset of
 .Xr mdoc 7
 macros indexed by
 .Ss Macro Keys
 Queries evaluate over a subset of
 .Xr mdoc 7
 macros indexed by

-.Xr mandocdb 8 .
+.Xr makewhatis 8 .

 In addition to the macro keys listed below, the special key
 .Cm any
 may be used to match any available macro key.
 In addition to the macro keys listed below, the special key
 .Cm any
 may be used to match any available macro key.


@@ -167,6 +274,8 @@ Names and description:
 .Bl -column "xLix" description -offset indent -compact
 .It Li \&Nm Ta manual name
 .It Li \&Nd Ta one-line manual description
 .Bl -column "xLix" description -offset indent -compact
 .It Li \&Nm Ta manual name
 .It Li \&Nd Ta one-line manual description

+.It Li arch Ta machine architecture (case-insensitive)
+.It Li sec  Ta manual section number

 .El
 .Pp
 Sections and cross references:
 .El
 .Pp
 Sections and cross references:


@@ -230,48 +339,148 @@ Text production:
 .It Li \&Dx Ta Dx No version reference
 .El
 .Sh ENVIRONMENT
 .It Li \&Dx Ta Dx No version reference
 .El
 .Sh ENVIRONMENT

-.Bl -tag -width Ds
+.Bl -tag -width MANPAGER
+.It Ev MANPAGER
+Any non-empty value of the environment variable
+.Ev MANPAGER
+will be used instead of the standard pagination program,
+.Xr more 1 .

 .It Ev MANPATH
 .It Ev MANPATH

-Colon-separated paths overriding the default list of paths searched for
-manual databases.
+The standard search path used by
+.Xr man 1
+may be changed by specifying a path in the
+.Ev MANPATH
+environment variable.

 Invalid paths, or paths without manual databases, are ignored.
 Overridden by
 .Fl M .
 Invalid paths, or paths without manual databases, are ignored.
 Overridden by
 .Fl M .

+If
+.Ev MANPATH
+begins with a colon, it is appended to the default list;
+if it ends with a colon, it is prepended to the default list;
+or if it contains two adjacent colons,
+the standard search path is inserted between the colons.
+If none of these conditions are met, it overrides the
+standard search path.
+.It Ev PAGER
+Specifies the pagination program to use when
+.Ev MANPAGER
+is not defined.
+If neither PAGER nor MANPAGER is defined,
+.Pa /usr/bin/more Fl s
+will be used.
+.El
+.Sh FILES
+.Bl -tag -width "/etc/man.conf" -compact
+.It Pa mandoc.db
+name of the
+.Xr makewhatis 8
+keyword database
+.It Pa /etc/man.conf
+default
+.Xr man 1
+configuration file

 .El
 .Sh EXIT STATUS
 .Ex -std
 .Sh EXAMPLES
 Search for
 .El
 .Sh EXIT STATUS
 .Ex -std
 .Sh EXAMPLES
 Search for

-.Qq mdoc
-as a substring and regular expression
-within each manual name and description:
+.Qq .cf
+as a substring of manual names and descriptions:

 .Pp
 .Pp

-.Dl $ apropos mdoc
-.Dl $ apropos ~^mdoc$
+.Dl $ apropos .cf

 .Pp
 Include matches for
 .Pp
 Include matches for

-.Qq roff
+.Qq .cnf

 and
 and

-.Qq man
-for the regular expression case:
+.Qq .conf
+as well:

 .Pp
 .Pp

-.Dl $ apropos ~^mdoc$ roff man
-.Dl $ apropos ~^mdoc$ \-o roff \-o man
+.Dl $ apropos .cf .cnf .conf

 .Pp
 .Pp

-Search for
+Search in names and descriptions using a regular expression:
+.Pp
+.Dl $ apropos '~set.?[ug]id'
+.Pp
+Search for manuals in the library section mentioning both the

 .Qq optind
 .Qq optind

-and
+and the

 .Qq optarg
 .Qq optarg

-as variable names in the library category:
+variables:
+.Pp
+.Dl $ apropos \-s 3 Va=optind \-a Va=optarg
+.Pp
+Do exactly the same as calling
+.Xr whatis 1
+with the argument
+.Qq ssh :

 .Pp
 .Pp

-.Dl $ apropos \-s 3 Va~^optind \-a Va~^optarg$
+.Dl $ apropos \-\- \-i 'Nm~[[:<:]]ssh[[:>:]]'
+.Pp
+The following two invocations are equivalent:
+.Pp
+.D1 Li $ apropos -S Ar arch Li -s Ar section expression
+.Bd -ragged -offset indent
+.Li $ apropos \e( Ar expression Li \e)
+.Li -a arch~^( Ns Ar arch Ns Li |any)$
+.Li -a sec~^ Ns Ar section Ns Li $
+.Ed

 .Sh SEE ALSO
 .Xr man 1 ,
 .Xr re_format 7 ,
 .Sh SEE ALSO
 .Xr man 1 ,
 .Xr re_format 7 ,

-.Xr mandocdb 8
-.Sh AUTHORS
+.Xr makewhatis 8
+.Sh HISTORY
+Part of the functionality of
+.Nm whatis
+was already provided by the former
+.Nm manwhere
+utility in
+.Bx 1 .

 The
 .Nm
 The
 .Nm

-utility was written by
-.An Kristaps Dzonsons ,
-.Mt kristaps@bsd.lv .
+and
+.Nm whatis
+utilities first appeared in
+.Bx 2 .
+They were rewritten from scratch for
+.Ox 5.6 .
+.Pp
+The
+.Fl M
+option and the
+.Ev MANPATH
+variable first appeared in
+.Bx 4.3 ;
+.Fl m
+in
+.Bx 4.3 Reno ;
+.Fl C
+in
+.Bx 4.4 Lite1 ;
+and
+.Fl S
+and
+.Fl s
+in
+.Ox 4.5
+for
+.Nm
+and in
+.Ox 5.6
+for
+.Nm whatis .
+.Sh AUTHORS
+.An -nosplit
+.An Bill Joy
+wrote
+.Nm manwhere
+in 1977 and the original
+.Bx
+.Nm
+and
+.Nm whatis
+in February 1979.
+The current version was written by
+.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
+and
+.An Ingo Schwarze Aq Mt schwarze@openbsd.org .