[BACK]Return to whatis.1 CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / usr.sbin / makemandb

Annotation of src/usr.sbin/makemandb/whatis.1, Revision 1.4

1.4     ! abhinav     1: .\" $NetBSD: whatis.1,v 1.3 2016/05/22 19:26:04 abhinav Exp $
1.1       joerg       2: .\"
                      3: .\" Copyright (c) 2012 Joerg Sonnenberger <joerg@NetBSD.org>
                      4: .\" All rights reserved.
                      5: .\"
                      6: .\" Redistribution and use in source and binary forms, with or without
                      7: .\" modification, are permitted provided that the following conditions
                      8: .\" are met:
                      9: .\"
                     10: .\" 1. Redistributions of source code must retain the above copyright
                     11: .\"    notice, this list of conditions and the following disclaimer.
                     12: .\" 2. Redistributions in binary form must reproduce the above copyright
                     13: .\"    notice, this list of conditions and the following disclaimer in
                     14: .\"    the documentation and/or other materials provided with the
                     15: .\"    distribution.
                     16: .\"
                     17: .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
                     18: .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
                     19: .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
                     20: .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
                     21: .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
                     22: .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
                     23: .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
                     24: .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
                     25: .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
                     26: .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
                     27: .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     28: .\" SUCH DAMAGE.
                     29: .\"
1.4     ! abhinav    30: .Dd June 16, 2016
1.1       joerg      31: .Dt WHATIS 1
                     32: .Os
                     33: .Sh NAME
                     34: .Nm whatis
                     35: .Nd describe what a command is
                     36: .Sh SYNOPSIS
                     37: .Nm
1.3       abhinav    38: .Op Fl C Ar path
1.1       joerg      39: .Ar command Ar ...
                     40: .Sh DESCRIPTION
                     41: The
                     42: .Nm
1.2       wiz        43: program queries the apropos database built by
                     44: .Xr makemandb 8 .
                     45: It searches for manual pages with name
1.1       joerg      46: .Ar command
1.2       wiz        47: and outputs name of the matching manual pages along with the section and the
                     48: brief description from the NAME section.
1.3       abhinav    49: .Pp
                     50: It supports the following options:
                     51: .Bl -tag -width indent
                     52: .It Fl C Ar path
                     53: Use different
                     54: .Xr man 1
                     55: configuration file than the default,
                     56: .Pa /etc/man.conf .
                     57: .El
1.2       wiz        58: .Sh FILES
                     59: .Bl -hang -width /etc/man.conf -compact
                     60: .It Pa /etc/man.conf
                     61: The location of the Sqlite FTS database can be configured using the
                     62: .Cd _mandb
                     63: tag.
                     64: .El
1.1       joerg      65: .Sh SEE ALSO
                     66: .Xr apropos 1 ,
1.4     ! abhinav    67: .Xr man 1 ,
        !            68: .Xr man.conf 5 ,
1.1       joerg      69: .Xr makemandb 8
                     70: .Sh HISTORY
                     71: The
                     72: .Nm
                     73: command appeared in 3.0BSD.
                     74: It was rewritten in
                     75: .Nx 6.0
                     76: to use the SQLite index created by
                     77: .Xr makemandb 8 .

CVSweb <webmaster@jp.NetBSD.org>