Return to whatis.1 CVS log

Up to [cvs.NetBSD.org] / src / usr.sbin / makemandb

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

1.2     ! wiz         1: .\" $NetBSD: whatis.1,v 1.1 2012/02/07 19:13:32 joerg 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.2     ! wiz        30: .Dd October 5, 2012
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
                     38: .Ar command Ar ...
                     39: .Sh DESCRIPTION
                     40: The
                     41: .Nm
1.2     ! wiz        42: program queries the apropos database built by
        !            43: .Xr makemandb 8 .
        !            44: It searches for manual pages with name
1.1       joerg      45: .Ar command
1.2     ! wiz        46: and outputs name of the matching manual pages along with the section and the
        !            47: brief description from the NAME section.
        !            48: .Sh FILES
        !            49: .Bl -hang -width /etc/man.conf -compact
        !            50: .It Pa /etc/man.conf
        !            51: The location of the Sqlite FTS database can be configured using the
        !            52: .Cd _mandb
        !            53: tag.
        !            54: .El
1.1       joerg      55: .Sh SEE ALSO
                     56: .Xr apropos 1 ,
                     57: .Xr makemandb 8
                     58: .Sh HISTORY
                     59: The
                     60: .Nm
                     61: command appeared in 3.0BSD.
                     62: It was rewritten in
                     63: .Nx 6.0
                     64: to use the SQLite index created by
                     65: .Xr makemandb 8 .