end of sentence detection after .ME and .UE, useful for some GNU manuals

[mandoc.git] / apropos.1

diff --git a/apropos.1 b/apropos.1
index e0aa37a7e58bb39fceb7f56305efd474c5516c6c..c0895a87e4c32fd135ff059ea0b3bb5b839a87b7 100644 (file)
--- a/apropos.1
+++ b/apropos.1
@@ -1,4 +1,4 @@
-.\"    $Id: apropos.1,v 1.42 2017/03/18 19:51:19 schwarze Exp $
+.\"    $Id: apropos.1,v 1.47 2018/02/23 18:54:02 schwarze Exp $

 .\"
 .\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2011, 2012, 2014, 2017 Ingo Schwarze <schwarze@openbsd.org>
 .\"
 .\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2011, 2012, 2014, 2017 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: March 18 2017 $
+.Dd $Mdocdate: February 23 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


@@ -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,14 +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 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


@@ -357,6 +328,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
+fuction 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


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