summaryrefslogtreecommitdiff
path: root/usr.bin
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@cvs.openbsd.org>2014-03-17 11:29:12 +0000
committerIngo Schwarze <schwarze@cvs.openbsd.org>2014-03-17 11:29:12 +0000
commitacf0d48209926319be0f33f39704140db1464266 (patch)
tree370a23fe33c905889d78ec91348925621eb9c23c /usr.bin
parentcdfa66d33a7b79c04cd854673ce6a4504d48d422 (diff)
describe new features
Diffstat (limited to 'usr.bin')
-rw-r--r--usr.bin/mandoc/apropos.124
-rw-r--r--usr.bin/mandoc/makewhatis.828
-rw-r--r--usr.bin/mandoc/whatis.16
3 files changed, 45 insertions, 13 deletions
diff --git a/usr.bin/mandoc/apropos.1 b/usr.bin/mandoc/apropos.1
index c00e3d70140..57714849be1 100644
--- a/usr.bin/mandoc/apropos.1
+++ b/usr.bin/mandoc/apropos.1
@@ -1,4 +1,4 @@
-.\" $Id: apropos.1,v 1.19 2014/03/17 09:25:39 schwarze Exp $
+.\" $Id: apropos.1,v 1.20 2014/03/17 11:29:11 schwarze Exp $
.\"
.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
.\"
@@ -25,6 +25,7 @@
.Op Fl C Ar file
.Op Fl M Ar path
.Op Fl m Ar path
+.Op Fl O Ar outkey
.Op Fl S Ar arch
.Op Fl s Ar section
.Ar expression ...
@@ -70,6 +71,10 @@ for
.Xr makewhatis 8
databases.
Invalid paths, or paths without manual databases, are ignored.
+.It Fl O Ar outkey
+Show the values associated with the key
+.Ar outkey
+instead of the manual descriptions.
.It Fl S Ar arch
Restrict the search to pages for the specified
.Xr machine 1
@@ -182,6 +187,8 @@ Names and description:
.Bl -column "xLix" description -offset indent -compact
.It Li \&Nm Ta manual name
.It Li \&Nd Ta one-line manual description
+.It Li arch Ta machine architecture (case-insensitive)
+.It Li sec Ta manual section number
.El
.Pp
Sections and cross references:
@@ -310,6 +317,15 @@ with the argument
.Qq ssh :
.Pp
.Dl $ apropos \-\- \-i 'Nm~[[:<:]]ssh[[:>:]]'
+.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 $
+.Ed
.Sh SEE ALSO
.Xr man 1 ,
.Xr re_format 7 ,
@@ -320,7 +336,7 @@ An
utility first appeared in
.Bx 2 .
It was rewritten from scratch for
-.Ox 5.1 .
+.Ox 5.6 .
.Pp
The
.Fl M
@@ -348,4 +364,6 @@ wrote the original
.Nm
in February 1979.
The current version was written by
-.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
+.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
+and
+.An Ingo Schwarze Aq Mt schwarze@openbsd.org .
diff --git a/usr.bin/mandoc/makewhatis.8 b/usr.bin/mandoc/makewhatis.8
index f59d92b3cee..bd89e692119 100644
--- a/usr.bin/mandoc/makewhatis.8
+++ b/usr.bin/mandoc/makewhatis.8
@@ -1,4 +1,4 @@
-.\" $Id: makewhatis.8,v 1.5 2014/03/17 08:31:54 schwarze Exp $
+.\" $Id: makewhatis.8,v 1.6 2014/03/17 11:29:11 schwarze Exp $
.\"
.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2011, 2012 Ingo Schwarze <schwarze@openbsd.org>
@@ -23,20 +23,25 @@
.Nd index UNIX manuals
.Sh SYNOPSIS
.Nm
-.Op Fl anvW
+.Op Fl anQvW
+.Op Fl T Cm utf8
.Op Fl C Ar file
.Nm
-.Op Fl anvW
+.Op Fl anQvW
+.Op Fl T Cm utf8
.Ar dir ...
.Nm
-.Op Fl nvW
+.Op Fl nQvW
+.Op Fl T Cm utf8
.Fl d Ar dir
.Op Ar
.Nm
.Op Fl nvW
+.Op Fl T Cm utf8
.Fl u Ar dir
.Op Ar
.Nm
+.Op Fl Q
.Fl t Ar
.Sh DESCRIPTION
The
@@ -95,6 +100,12 @@ to the database in
.It Fl n
Do not create or modify any database;
scan and parse only.
+.It Fl Q
+Quickly build reduced-size databases
+by reading only the NAME sections of manuals.
+The resulting databases will usually contain names and descriptions only.
+.It Fl T Cm utf8
+Use UTF-8 encoding instead of ASCII for strings stored in the databases.
.It Fl t Ar
Check the given
.Ar files
@@ -113,6 +124,9 @@ from the database in
.Ar dir .
.It Fl v
Display all files added or removed to the index.
+With a second
+.Fl v ,
+also show all keyswords added for each file.
.It Fl W
Print warnings about potential problems with manual pages
to the standard error output.
@@ -166,7 +180,7 @@ It was rewritten in
for
.Ox 2.7
and in C for
-.Ox 5.1 .
+.Ox 5.6 .
.Pp
The
.Ar dir
@@ -177,9 +191,9 @@ the options
in
.Ox 2.7 ;
and the options
-.Fl aCvW
+.Fl aCnQTvW
in
-.Ox 5.1 .
+.Ox 5.6 .
.Sh AUTHORS
.An -nosplit
.An Bill Joy
diff --git a/usr.bin/mandoc/whatis.1 b/usr.bin/mandoc/whatis.1
index 7d45b026562..335ea856afc 100644
--- a/usr.bin/mandoc/whatis.1
+++ b/usr.bin/mandoc/whatis.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: whatis.1,v 1.9 2014/03/17 09:25:39 schwarze Exp $
+.\" $OpenBSD: whatis.1,v 1.10 2014/03/17 11:29:11 schwarze Exp $
.\"
.\" Copyright (c) 1989, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -156,7 +156,7 @@ The
command first appeared in
.Bx 2 .
It was rewritten from scratch for
-.Ox 5.1 .
+.Ox 5.6 .
.Pp
The
.Fl M
@@ -175,7 +175,7 @@ and
and
.Fl s
in
-.Ox 5.1 .
+.Ox 5.6 .
.Sh AUTHORS
.An -nosplit
.An Bill Joy