Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

apropos(1) [netbsd man page]

APROPOS(1)						    BSD General Commands Manual 						APROPOS(1)

apropos -- search the complete content of all man pages SYNOPSIS
apropos [-123456789Ccp] [-n Number of results] [-S machine] [-s section] query DESCRIPTION
The apropos utility performs a full text search over the complete content of all man pages. It uses the FTS engine of Sqlite to perform the search. The database is created with the help of makemandb(8) utility. This implementation of the apropos utility is more sophisticated than the classical version of apropos. Like modern search applications, it uses advanced techniques like stemming and term weighting to rank the matching results in decreasing order of relevance. By default apropos will only display the top 10 matches in the output. Quotes are optional for specifying multiword queries. It supports the following options: -1 Search only within section 1 manual pages. -2 Search only within section 2 manual pages. -3 Search only within section 3 manual pages. -4 Search only within section 4 manual pages. -5 Search only within section 5 manual pages. -6 Search only within section 6 manual pages. -7 Search only within section 7 manual pages. -8 Search only within section 8 manual pages. -9 Search only within section 9 manual pages. -C Do not show the context of the match. -c Do show the context of the match (default). -n Output up to the specified number of search results. The default limit is 10. -p Display all matching results and pipe them through a pager (defaulting to more(1)). -S machine Limit the search to the pages for the specified machine architecture. By default pages for all architectures are shown in the search results. -s section Restrict the search to the specified section of the manual. By default, pages from all section are shown. This option is for back- wards compatibility with the classic version of apropos, using it is equivalent to using the [123456789] options directly. FILES
/var/db/man.db The Sqlite FTS database which contains an index of the manual pages. SEE ALSO
man(1), whatis(1), makemandb(8) HISTORY
The apropos command appeared in 3.0BSD. It was rewritten in NetBSD 6.0 to support full text search using Sqlite. AUTHORS
Abhinav Upadhyay BSD
April 21, 2012 BSD

Check Out this Related Man Page

apropos(1)							   User Commands							apropos(1)

apropos - locate commands by keyword lookup SYNOPSIS
apropos keyword... DESCRIPTION
The apropos utility displays the man page name, section number, and a short description for each man page whose NAME line contains keyword. This information is contained in the /usr/share/man/windex database created by catman(1M). If catman(1M) was not run, or was run with the -n option, apropos fails. Each word is considered separately and the case of letters is ignored. Words which are part of other words are considered; for example, when looking for `compile', apropos finds all instances of `compiler' also. apropos is actually just the -k option to the man(1) command. EXAMPLES
Example 1 To find a man page whose NAME line contains a keyword Try example% apropos password and example% apropos editor If the line starts `filename(section) ...' you can run man -s section filename to display the man page for filename. Example 2 To find the man page for the subroutine printf() Try example% apropos format and then example% man -s 3s printf to get the manual page on the subroutine printf(). FILES
/usr/share/man/windex table of contents and keyword database ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Availability |SUNWdoc | +-----------------------------+-----------------------------+ |CSI |Enabled | +-----------------------------+-----------------------------+ SEE ALSO
man(1), whatis(1), catman(1M), attributes(5) DIAGNOSTICS
/usr/share/man/windex: No such file or directory This database does not exist. catman(1M) must be run to create it. SunOS 5.11 20 Dec 1996 apropos(1)
Man Page