=================================================================== RCS file: /cvs/mandoc/Attic/whatis.1,v retrieving revision 1.3 retrieving revision 1.4 diff -u -p -r1.3 -r1.4 --- mandoc/Attic/whatis.1 2011/11/29 10:59:19 1.3 +++ mandoc/Attic/whatis.1 2011/12/12 02:00:49 1.4 @@ -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 .\" @@ -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 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 .