Delete two preprocessor constants that are no longer used.

[mandoc.git] / apropos.1

diff --git a/apropos.1 b/apropos.1
index e31900bb0c46669d3399828e50456f9effaf3f93..10ba3c6a454d9014f4c2139b6cd7c87c5e809d2d 100644 (file)
--- a/apropos.1
+++ b/apropos.1
@@ -1,4 +1,4 @@
-.\"    $Id: apropos.1,v 1.30 2014/08/21 01:52:59 schwarze Exp $
+.\"    $Id: apropos.1,v 1.39 2015/04/03 08:46:17 schwarze Exp $

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


@@ -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 21 2014 $
+.Dd $Mdocdate: April 3 2015 $

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


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

+.Op Fl acfhklw

 .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


@@ -56,17 +57,82 @@ over manual names and descriptions
 .Pq the Li \&Nm No and Li \&Nd No macro keys .
 Multiple terms imply pairwise
 .Fl o .
 .Pq the Li \&Nm No and Li \&Nd No macro keys .
 Multiple terms imply pairwise
 .Fl o .

+.Pp

 .Nm whatis
 .Nm whatis

-maps terms only to case-sensitive manual names.
+is a synonym for
+.Nm
+.Fl f .

 .Pp
 .Pp

-Its arguments are as follows:
+The options are as follows:

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

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


@@ -96,6 +162,12 @@ 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
 An
 .El
 .Pp
 An


@@ -138,7 +210,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


@@ -155,7 +227,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


@@ -165,11 +237,6 @@ is evaluated case-insensitively.
 Has no effect on substring terms.
 .El
 .Pp
 Has no effect on substring terms.
 .El
 .Pp

-.Nm whatis
-considers an
-.Ar expression
-to consist of an opaque keyword.
-.Pp

 Results are sorted by manual sections and names, with output formatted as
 .Pp
 .D1 name[, name...](sec) \- description
 Results are sorted by manual sections and names, with output formatted as
 .Pp
 .D1 name[, name...](sec) \- description


@@ -270,7 +337,12 @@ 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 MANPATH
+.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
 The standard search path used by
 .Xr man 1
 .It Ev MANPATH
 The standard search path used by
 .Xr man 1


@@ -288,6 +360,14 @@ 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.
 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,
+.Xr more 1
+.Fl s
+will be used.

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


@@ -319,7 +399,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


@@ -334,15 +414,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 ,