Annotation of src/usr.sbin/makemandb/apropos.1, Revision 1.1
1.1 ! joerg 1: .\" $NetBSD$
! 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: .\"
! 32: .Dd February 6, 2012
! 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
! 40: .Op Fl 123456789Ccp
! 41: .Op Fl n Ar Number of results
! 42: .Op Fl S Ar machine
! 43: .Ar query
! 44: .Sh DESCRIPTION
! 45: The
! 46: .Nm
! 47: utility performs a full text search over the complete content of all man pages.
! 48: It uses the FTS engine of Sqlite to perform the search.
! 49: The database is created with the help of
! 50: .Xr makemandb 1
! 51: utility.
! 52: .Pp
! 53: This implementation of the
! 54: .Nm
! 55: utility is more sophisticated than the classical version of
! 56: .Nm .
! 57: Like modern search applications, it uses advanced techniques like stemming
! 58: and term weighting to rank the matching results in decreasing order of
! 59: relevance.
! 60: By default
! 61: .Nm
! 62: will only display the top 10 matches in the output.
! 63: .Pp
! 64: It supports the following options:
! 65: .Bl -tag -width indent
! 66: .It Fl 1
! 67: Search only within section 1 manual pages.
! 68: .It Fl 2
! 69: Search only within section 2 manual pages.
! 70: .It Fl 3
! 71: Search only within section 3 manual pages.
! 72: .It Fl 4
! 73: Search only within section 4 manual pages.
! 74: .It Fl 5
! 75: Search only within section 5 manual pages.
! 76: .It Fl 6
! 77: Search only within section 6 manual pages.
! 78: .It Fl 7
! 79: Search only within section 7 manual pages.
! 80: .It Fl 8
! 81: Search only within section 8 manual pages.
! 82: .It Fl 9
! 83: Search only within section 9 manual pages.
! 84: .It Fl C
! 85: Do not show the context of the match.
! 86: .It Fl c
! 87: Do show the context of the match (default).
! 88: .It Fl n
! 89: Output up to the specified number of search results.
! 90: The default limit is 10.
! 91: .It Fl p
! 92: Display all matching results and pipe them through a pager (defaulting to
! 93: .Xr more 1 ) .
! 94: .It Fl S
! 95: Limit the search to the pages for the specified machine architecture.
! 96: By default pages for all architectures are shown in the search results.
! 97: .El
! 98: .Sh FILES
! 99: .Bl -hang -width -compact
! 100: .It Pa /var/db/man.db
! 101: The Sqlite FTS database which contains an index of the manual pages.
! 102: .El
! 103: .Sh SEE ALSO
! 104: .Xr makemandb 1 ,
! 105: .Xr man 1
! 106: .Sh AUTHORS
! 107: .An Abhinav Upadhyay
CVSweb <webmaster@jp.NetBSD.org>