Since resetting of offsets works quite differently in man(7) and mdoc(7),

[mandoc.git] / apropos.1

diff --git a/apropos.1 b/apropos.1
index e17560394a570a5b150047d8a05c9b96740839b3..01d2a6bfa4f4c7e1b3b69bf6b3dd41a9d870fb4a 100644 (file)
--- a/apropos.1
+++ b/apropos.1
@@ -1,7 +1,7 @@
-.\"    $Id: apropos.1,v 1.32 2014/08/22 03:42:18 schwarze Exp $
+.\"    $Id: apropos.1,v 1.49 2018/11/22 12:33:52 schwarze Exp $

 .\"
 .\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
 .\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>

-.\" Copyright (c) 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2011,2012,2014,2017,2018 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


@@ -15,7 +15,7 @@
 .\" 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: August 22 2014 $
+.Dd $Mdocdate: November 22 2018 $

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


@@ -24,7 +24,7 @@
 .Nd search manual page databases
 .Sh SYNOPSIS
 .Nm
 .Nd search manual page databases
 .Sh SYNOPSIS
 .Nm

-.Op Fl acfkw
+.Op Fl afk

 .Op Fl C Ar file
 .Op Fl M Ar path
 .Op Fl m Ar path
 .Op Fl C Ar file
 .Op Fl M Ar path
 .Op Fl m Ar path


@@ -51,8 +51,7 @@ searches for
 .Xr makewhatis 8
 databases in the default paths stipulated by
 .Xr man 1
 .Xr makewhatis 8
 databases in the default paths stipulated by
 .Xr man 1

-and uses case-insensitive substring matching
-.Pq the Cm = No operator
+and uses case-insensitive extended regular expression matching

 over manual names and descriptions
 .Pq the Li \&Nm No and Li \&Nd No macro keys .
 Multiple terms imply pairwise
 over manual names and descriptions
 .Pq the Li \&Nm No and Li \&Nd No macro keys .
 Multiple terms imply pairwise


@@ -79,7 +78,7 @@ to paginate them.
 In
 .Fl a
 mode, the options
 In
 .Fl a
 mode, the options

-.Fl IOTW
+.Fl IKOTW

 described in the
 .Xr mandoc 1
 manual are also available.
 described in the
 .Xr mandoc 1
 manual are also available.


@@ -89,29 +88,17 @@ Specify an alternative configuration
 in
 .Xr man.conf 5
 format.
 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.
 .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.
+The search is case-insensitive and matches whole words only.

 In this mode, macro keys, comparison operators, and logical operators
 are not available.
 In this mode, macro keys, comparison operators, and logical operators
 are not available.

-This overrides any earlier
-.Fl k
-option.

 .It Fl k
 Support the full
 .Ar expression
 syntax.
 .It Fl k
 Support the full
 .Ar expression
 syntax.

-This overrides any earlier
-.Fl f
-option.

 It is the default for
 .Nm .
 .It Fl M Ar path
 It is the default for
 .Nm .
 .It Fl M Ar path


@@ -135,7 +122,7 @@ Restrict the search to pages for the specified
 .Xr machine 1
 architecture.
 .Ar arch
 .Xr machine 1
 architecture.
 .Ar arch

-is case insensitive.
+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 for all architectures are shown.
 .It Fl s Ar section
 Restrict the search to the specified section of the manual.


@@ -143,14 +130,16 @@ By default, pages from all sections are shown.
 See
 .Xr man 1
 for a listing of sections.
 See
 .Xr man 1
 for a listing of sections.

-.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
 .El
 .Pp

+The options
+.Fl chlw
+are also supported and are documented in
+.Xr man 1 .
+The options
+.Fl fkl
+are mutually exclusive and override each other.
+.Pp

 An
 .Ar expression
 consists of search terms joined by logical operators
 An
 .Ar expression
 consists of search terms joined by logical operators


@@ -191,7 +180,7 @@ This has syntax
 .Sm off
 .Oo
 .Op Ar key Op , Ar key ...
 .Sm off
 .Oo
 .Op Ar key Op , Ar key ...

-.Pq Cm = | ~
+.Pq Cm = | \(ti

 .Oc
 .Ar val ,
 .Sm on
 .Oc
 .Ar val ,
 .Sm on


@@ -208,8 +197,8 @@ for a list of available keys.
 Operator
 .Cm =
 evaluates a substring, while
 Operator
 .Cm =
 evaluates a substring, while

-.Cm ~
-evaluates a regular expression.
+.Cm \(ti
+evaluates a case-sensitive extended regular expression.

 .It Fl i Ar term
 If
 .Ar term
 .It Fl i Ar term
 If
 .Ar term


@@ -218,7 +207,12 @@ is evaluated case-insensitively.
 Has no effect on substring terms.
 .El
 .Pp
 Has no effect on substring terms.
 .El
 .Pp

-Results are sorted by manual sections and names, with output formatted as
+Results are sorted first according to the section number in ascending
+numerical order, then by the page name in ascending
+.Xr ascii 7
+alphabetical order, case-insensitive.
+.Pp
+Each output line is formatted as

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


@@ -317,25 +311,66 @@ Text production:
 .It Li \&Ox Ta Ox No version reference
 .It Li \&Dx Ta Dx No version reference
 .El
 .It Li \&Ox Ta Ox No version reference
 .It Li \&Dx Ta Dx No version reference
 .El

+.Pp
+In general, macro keys are supposed to yield complete results without
+expecting the user to consider actual macro usage.
+For example, results include:
+.Pp
+.Bl -tag -width 3n -offset 3n -compact
+.It Li \&Fa
+function arguments appearing on
+.Ic \&Fn
+lines
+.It Li \&Fn
+function names marked up with
+.Ic \&Fo
+macros
+.It Li \&In
+include file names marked up with
+.Ic \&Fd
+macros
+.It Li \&Vt
+types appearing as function return types and
+.It \&
+types appearing in function arguments in the SYNOPSIS
+.El

 .Sh ENVIRONMENT
 .Sh ENVIRONMENT

-.Bl -tag -width MANPATH
+.Bl -tag -width MANPAGER
+.It Ev MANPAGER
+Any non-empty value of the environment variable
+.Ev MANPAGER
+is used instead of the standard pagination program,
+.Xr more 1 ;
+see
+.Xr man 1
+for details.
+Only used if
+.Fl a
+or
+.Fl l
+is specified.

 .It Ev MANPATH
 .It Ev MANPATH

-The standard search path used by
+A colon-separated list of directories to search for manual pages; see

 .Xr man 1
 .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.
+for details.

 Overridden by
 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.
+.Fl M ,
+ignored if
+.Fl l
+is specified.
+.It Ev PAGER
+Specifies the pagination program to use when
+.Ev MANPAGER
+is not defined.
+If neither PAGER nor MANPAGER is defined,
+.Xr more 1
+.Fl s
+is used.
+Only used if
+.Fl a
+or
+.Fl l
+is specified.

 .El
 .Sh FILES
 .Bl -tag -width "/etc/man.conf" -compact
 .El
 .Sh FILES
 .Bl -tag -width "/etc/man.conf" -compact


@@ -355,7 +390,7 @@ Search for
 .Qq .cf
 as a substring of manual names and descriptions:
 .Pp
 .Qq .cf
 as a substring of manual names and descriptions:
 .Pp

-.Dl $ apropos .cf
+.Dl $ apropos =.cf

 .Pp
 Include matches for
 .Qq .cnf
 .Pp
 Include matches for
 .Qq .cnf


@@ -363,11 +398,11 @@ and
 .Qq .conf
 as well:
 .Pp
 .Qq .conf
 as well:
 .Pp

-.Dl $ apropos .cf .cnf .conf
+.Dl $ apropos =.cf =.cnf =.conf

 .Pp
 .Pp

-Search in names and descriptions using a regular expression:
+Search in names and descriptions using a case-sensitive regular expression:

 .Pp
 .Pp

-.Dl $ apropos '~set.?[ug]id'
+.Dl $ apropos \(aq\(tiset.?[ug]id\(aq

 .Pp
 Search for manuals in the library section mentioning both the
 .Qq optind
 .Pp
 Search for manuals in the library section mentioning both the
 .Qq optind


@@ -378,24 +413,42 @@ variables:
 .Dl $ apropos \-s 3 Va=optind \-a Va=optarg
 .Pp
 Do exactly the same as calling
 .Dl $ apropos \-s 3 Va=optind \-a Va=optarg
 .Pp
 Do exactly the same as calling

-.Xr whatis 1
+.Nm whatis

 with the argument
 .Qq ssh :
 .Pp
 with the argument
 .Qq ssh :
 .Pp

-.Dl $ apropos \-\- \-i 'Nm~[[:<:]]ssh[[:>:]]'
+.Dl $ apropos \-\- \-i \(aqNm\(ti[[:<:]]ssh[[:>:]]\(aq

 .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)
 .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 $
+.Li -a arch\(ti^( Ns Ar arch Ns Li |any)$
+.Li -a sec\(ti^ Ns Ar section Ns Li $

 .Ed
 .Sh SEE ALSO
 .Xr man 1 ,
 .Xr re_format 7 ,
 .Xr makewhatis 8
 .Ed
 .Sh SEE ALSO
 .Xr man 1 ,
 .Xr re_format 7 ,
 .Xr makewhatis 8

+.Sh STANDARDS
+The
+.Nm
+utility is compliant with the
+.St -p1003.1-2008
+specification of
+.Xr man 1
+.Fl k .
+.Pp
+All options, the
+.Nm whatis
+command, support for logical operators, macro keys,
+substring matching, sorting of results, the environment variables
+.Ev MANPAGER
+and
+.Ev MANPATH ,
+the database format, and the configuration file
+are extensions to that specification.

 .Sh HISTORY
 Part of the functionality of
 .Nm whatis
 .Sh HISTORY
 Part of the functionality of
 .Nm whatis


@@ -436,6 +489,10 @@ and in
 .Ox 5.6
 for
 .Nm whatis .
 .Ox 5.6
 for
 .Nm whatis .

+The options
+.Fl acfhIKklOTWw
+appeared in
+.Ox 5.7 .

 .Sh AUTHORS
 .An -nosplit
 .An Bill Joy
 .Sh AUTHORS
 .An -nosplit
 .An Bill Joy