aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/whatis.1
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2011-12-12 02:00:49 +0000
committerIngo Schwarze <schwarze@openbsd.org>2011-12-12 02:00:49 +0000
commit6ca7be8f333b28c465a7b7d961bddcb31d59d72f (patch)
treee67531ef7f83c08f0c5eb984fa934e30675e4346 /whatis.1
parent424e4a7f6dd613adba96e61c70ed0ad508fc1d45 (diff)
downloadmandoc-6ca7be8f333b28c465a7b7d961bddcb31d59d72f.tar.gz
mandoc-6ca7be8f333b28c465a7b7d961bddcb31d59d72f.tar.zst
mandoc-6ca7be8f333b28c465a7b7d961bddcb31d59d72f.zip
implement -C (alternative config file) for apropos(1) and mandocdb(8),
including various tweaks to the whatis(8) manual; ok kristaps@
Diffstat (limited to 'whatis.1')
-rw-r--r--whatis.175
1 files changed, 59 insertions, 16 deletions
diff --git a/whatis.1 b/whatis.1
index c927ef8c..8ade7f45 100644
--- a/whatis.1
+++ b/whatis.1
@@ -1,4 +1,4 @@
-.\" $Id: whatis.1,v 1.3 2011/11/29 10:59:19 kristaps Exp $
+.\" $Id: whatis.1,v 1.4 2011/12/12 02:00:49 schwarze Exp $
.\"
.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\"
@@ -14,37 +14,52 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: November 29 2011 $
+.Dd $Mdocdate: December 12 2011 $
.Dt WHATIS 1
.Os
.Sh NAME
.Nm whatis
-.Nd search manual page databases
+.Nd search for manual pages by page names
.Sh SYNOPSIS
.Nm
+.Op Fl C Ar file
.Op Fl M Ar manpath
.Op Fl m Ar manpath
.Op Fl S Ar arch
.Op Fl s Ar section
-.Ar term...
+.Ar name ...
.Sh DESCRIPTION
The
.Nm
-utility searches for manuals named or described with
-.Ar term
-in manual page databases generated by
-.Xr mandocdb 8 .
-Its arguments are as follows:
+utility searches databases generated by
+.Xr mandocdb 8
+for manuals containing the word
+.Ar name
+in their page name, ignoring case.
+It returns the header lines from all matching pages.
+You can then use the
+.Xr man 1
+command to get more information.
+.Pp
+The options are as follows:
.Bl -tag -width Ds
+.It Fl C Ar file
+Specify an alternative configuration
+.Ar file
+in
+.Xr man.conf 5
+format.
.It Fl M Ar manpath
-Use the colon-separated path instead of the default list of paths
-searched for
+Use the colon-separated
+.Ar manpath
+instead of the default list of paths searched for
.Xr mandocdb 8
databases.
Invalid paths, or paths without manual databases, are ignored.
.It Fl m Ar manpath
-Prepend the colon-separated paths to the list of paths searched
-for
+Prepend the colon-separated
+.Ar manpath
+to the list of paths searched for
.Xr mandocdb 8
databases.
Invalid paths, or paths without manual databases, are ignored.
@@ -102,16 +117,44 @@ Invalid paths, or paths without manual databases, are ignored.
Overridden by
.Fl M .
.El
-.\" .Sh FILES
+.Sh FILES
+.Bl -tag -width "/etc/man.conf" -compact
+.It Pa mandoc.db
+name of the
+.Xr mandocdb 8
+keyword database
+.It Pa mandoc.index
+name of the
+.Xr mandocdb 8
+filename database
+.It Pa /etc/man.conf
+default
+.Xr man 1
+configuration file
+.El
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr apropos 1 ,
.Xr man 1 ,
+.Xr man.conf 5 ,
.Xr mandocdb 8
-.Sh AUTHORS
+.Sh HISTORY
The
.Nm
-utility was written by
+utility first appeared in
+.Bx 2 .
+It was rewritten from scratch as part of the
+.Xr mandocdb 8
+project for
+.Ox 5.1 .
+.Sh AUTHORS
+.An -nosplit
+.An Bill Joy
+wrote the original
+.Bx
+.Nm
+in 1979.
+The current version was written by
.An Kristaps Dzonsons ,
.Mt kristaps@bsd.lv .