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

Annotation of src/usr.sbin/makemandb/apropos.1, Revision 1.7

1.7     ! christos    1: .\" $NetBSD: apropos.1,v 1.6 2012/10/06 15:33:59 wiz Exp $
1.1       joerg       2: .\"
                      3: .\" Copyright (c) 2011 Abhinav Upadhyay <er.abhinav.upadhyay@gmail.com>
                      4: .\" All rights reserved.
                      5: .\"
                      6: .\" This code was developed as part of Google's Summer of Code 2011 program.
                      7: .\"
                      8: .\" Redistribution and use in source and binary forms, with or without
                      9: .\" modification, are permitted provided that the following conditions
                     10: .\" are met:
                     11: .\"
                     12: .\" 1. Redistributions of source code must retain the above copyright
                     13: .\"    notice, this list of conditions and the following disclaimer.
                     14: .\" 2. Redistributions in binary form must reproduce the above copyright
                     15: .\"    notice, this list of conditions and the following disclaimer in
                     16: .\"    the documentation and/or other materials provided with the
                     17: .\"    distribution.
                     18: .\"
                     19: .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
                     20: .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
                     21: .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
                     22: .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
                     23: .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
                     24: .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
                     25: .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
                     26: .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
                     27: .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
                     28: .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
                     29: .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     30: .\" SUCH DAMAGE.
                     31: .\"
1.7     ! christos   32: .Dd February 10, 2013
1.1       joerg      33: .Dt APROPOS 1
                     34: .Os
                     35: .Sh NAME
                     36: .Nm apropos
                     37: .Nd search the complete content of all man pages
                     38: .Sh SYNOPSIS
                     39: .Nm
1.7     ! christos   40: .Op Fl 123456789Ccpr
1.1       joerg      41: .Op Fl n Ar Number of results
                     42: .Op Fl S Ar machine
1.3       joerg      43: .Op Fl s Ar section
1.1       joerg      44: .Ar query
                     45: .Sh DESCRIPTION
                     46: The
                     47: .Nm
                     48: utility performs a full text search over the complete content of all man pages.
                     49: It uses the FTS engine of Sqlite to perform the search.
                     50: The database is created with the help of
1.2       njoly      51: .Xr makemandb 8
1.1       joerg      52: utility.
                     53: .Pp
                     54: This implementation of the
                     55: .Nm
                     56: utility is more sophisticated than the classical version of
                     57: .Nm .
                     58: Like modern search applications, it uses advanced techniques like stemming
                     59: and term weighting to rank the matching results in decreasing order of
                     60: relevance.
                     61: By default
                     62: .Nm
                     63: will only display the top 10 matches in the output.
                     64: .Pp
1.3       joerg      65: Quotes are optional for specifying multiword queries.
                     66: .Pp
1.1       joerg      67: It supports the following options:
                     68: .Bl -tag -width indent
                     69: .It Fl 1
                     70: Search only within section 1 manual pages.
                     71: .It Fl 2
                     72: Search only within section 2 manual pages.
                     73: .It Fl 3
                     74: Search only within section 3 manual pages.
                     75: .It Fl 4
                     76: Search only within section 4 manual pages.
                     77: .It Fl 5
                     78: Search only within section 5 manual pages.
                     79: .It Fl 6
                     80: Search only within section 6 manual pages.
                     81: .It Fl 7
                     82: Search only within section 7 manual pages.
                     83: .It Fl 8
                     84: Search only within section 8 manual pages.
                     85: .It Fl 9
                     86: Search only within section 9 manual pages.
                     87: .It Fl C
                     88: Do not show the context of the match.
                     89: .It Fl c
                     90: Do show the context of the match (default).
                     91: .It Fl n
                     92: Output up to the specified number of search results.
                     93: The default limit is 10.
                     94: .It Fl p
                     95: Display all matching results and pipe them through a pager (defaulting to
                     96: .Xr more 1 ) .
1.7     ! christos   97: .It Fl r
        !            98: On tty output don't issue any formatting escape codes.
1.3       joerg      99: .It Fl S Ar machine
1.1       joerg     100: Limit the search to the pages for the specified machine architecture.
                    101: By default pages for all architectures are shown in the search results.
1.3       joerg     102: .It Fl s Ar section
                    103: Restrict the search to the specified section of the manual.
                    104: By default, pages from all section are shown.
                    105: This option is for backwards compatibility with the classic version of apropos,
                    106: using it is equivalent to using the
                    107: .Op 123456789
                    108: options directly.
1.1       joerg     109: .El
                    110: .Sh FILES
1.6       wiz       111: .Bl -hang -width /etc/man.conf -compact
                    112: .It Pa /etc/man.conf
                    113: The location of the Sqlite FTS database can be configured using the
                    114: .Cd _mandb
                    115: tag.
1.1       joerg     116: .El
                    117: .Sh SEE ALSO
1.2       njoly     118: .Xr man 1 ,
1.4       joerg     119: .Xr whatis 1 ,
1.2       njoly     120: .Xr makemandb 8
1.5       wiz       121: .Sh HISTORY
                    122: The
                    123: .Nm
                    124: command appeared in 3.0BSD.
                    125: It was rewritten in
                    126: .Nx 6.0
                    127: to support full text search using Sqlite.
1.1       joerg     128: .Sh AUTHORS
                    129: .An Abhinav Upadhyay

CVSweb <webmaster@jp.NetBSD.org>