Enable generation of the desired delim/basic output with groff(1).

[mandoc.git] / apropos.1

diff --git a/apropos.1 b/apropos.1
index e0aa37a7e58bb39fceb7f56305efd474c5516c6c..01d2a6bfa4f4c7e1b3b69bf6b3dd41a9d870fb4a 100644 (file)
--- a/apropos.1
+++ b/apropos.1
@@ -1,7 +1,7 @@
-.\"    $Id: apropos.1,v 1.42 2017/03/18 19:51:19 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, 2017 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: March 18 2017 $
+.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 acfhklw
+.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


@@ -89,50 +88,19 @@ 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
-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.
 .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 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
 .It Fl M Ar path
 Use the colon-separated path instead of the default list of paths
 searched for


@@ -154,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.


@@ -162,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


@@ -228,7 +198,7 @@ Operator
 .Cm =
 evaluates a substring, while
 .Cm \(ti
 .Cm =
 evaluates a substring, while
 .Cm \(ti

-evaluates a regular expression.
+evaluates a case-sensitive extended regular expression.

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


@@ -237,26 +207,10 @@ is evaluated case-insensitively.
 Has no effect on substring terms.
 .El
 .Pp
 Has no effect on substring terms.
 .El
 .Pp

-Results are sorted according to the following criteria:
-.Bl -enum
-.It
-The manpath directory tree the page is found in, according to the
-order specified with
-.Fl M ,
-.Fl m ,
-the
-.Ev MANPATH
-environment variable, the
-.Xr man.conf 5
-configuration file, or the default documented in
-.Xr man.conf 5 .
-.It
-The section number in ascending numerical order.
-.It
-The page name in ascending
+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.
 .Xr ascii 7
 alphabetical order, case-insensitive.

-.El

 .Pp
 Each output line is formatted as
 .Pp
 .Pp
 Each output line is formatted as
 .Pp


@@ -357,6 +311,29 @@ 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
 .Bl -tag -width MANPAGER
 .It Ev MANPAGER
 .Sh ENVIRONMENT
 .Bl -tag -width MANPAGER
 .It Ev MANPAGER


@@ -413,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


@@ -421,9 +398,9 @@ 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
 .Dl $ apropos \(aq\(tiset.?[ug]id\(aq
 .Pp
 .Pp
 .Dl $ apropos \(aq\(tiset.?[ug]id\(aq
 .Pp


@@ -436,7 +413,7 @@ 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


@@ -454,6 +431,24 @@ The following two invocations are equivalent:
 .Xr man 1 ,
 .Xr re_format 7 ,
 .Xr makewhatis 8
 .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