implement the tbl(7) "allbox" option;

[mandoc.git] / apropos.1

diff --git a/apropos.1 b/apropos.1
index 50b250d05685164cc2c66640e69bbe2220e822ba..cb101ad5ef5202c5e4be85faed1d070a3bb97834 100644 (file)
--- a/apropos.1
+++ b/apropos.1
@@ -1,7 +1,7 @@
-.\"    $Id: apropos.1,v 1.35 2014/09/03 05:22:45 schwarze Exp $
+.\"    $Id: apropos.1,v 1.45 2017/03/27 18:51:36 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 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: September 3 2014 $
+.Dd $Mdocdate: March 27 2017 $

 .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 acfhklVw
+.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


@@ -79,7 +79,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,12 +89,6 @@ 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
 .It Fl f
 Search for all words in
 .Ar expression


@@ -102,37 +96,12 @@ 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.
 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.
 .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


@@ -162,16 +131,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 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
 .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


@@ -212,7 +181,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


@@ -229,7 +198,7 @@ for a list of available keys.
 Operator
 .Cm =
 evaluates a substring, while
 Operator
 .Cm =
 evaluates a substring, while

-.Cm ~
+.Cm \(ti

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


@@ -239,7 +208,28 @@ 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 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
+.Xr ascii 7
+alphabetical order, case-insensitive.
+.El
+.Pp
+Each output line is formatted as

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


@@ -343,32 +333,38 @@ Text production:
 .It Ev MANPAGER
 Any non-empty value of the environment variable
 .Ev 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 .
+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,
 .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.
+.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


@@ -400,7 +396,7 @@ as well:
 .Pp
 Search in names and descriptions using a regular expression:
 .Pp
 .Pp
 Search in names and descriptions using a regular expression:
 .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


@@ -415,15 +411,15 @@ Do exactly the same as calling
 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 ,
 .Ed
 .Sh SEE ALSO
 .Xr man 1 ,


@@ -469,6 +465,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