Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

makemandb(8) [netbsd man page]

MAKEMANDB(8)						    BSD System Manager's Manual 					      MAKEMANDB(8)

NAME
makemandb -- parse the manual pages and build a search index over them SYNOPSIS
makemandb [-floQqv] [-C path] DESCRIPTION
The makemandb utility traverses the directories containing man pages, parses the manual pages with the help of libmandoc and builds an Sqlite database man.db to support full text searches. It obtains the list of directories to traverse using the -path and -p options of man(1). It supports the following options: -C path Use different man(1) configuration file than the default, /etc/man.conf. -f Force rebuilding the index from scratch, pruning the existing one. -l Limit the parsing to only the NAME section of the pages. This option can be used to mimic the behavior of the classic apropos(1) and also to substantially save disk space. -o Use this option to optimize the index for speed and also to significantly reduce disk space usage. This is a somewhat expensive operation. -Q Print only fatal error messages (i.e., when the database is left in an inconsistent state and needs manual intervention). -q Print only warnings and error messages but no status updates. -v Enable verbose output. This prints the name of every file being parsed and a summary at the end of the index update. As the database file is stored under /var/db, root privileges are required to run makemandb. DATABASE SCHEMA The name of the FTS table is mandb and its schema is as follows: section The section number of the page name The name of the page from the NAME section. name_desc The one line description from the NAME section. desc The DESCRIPTION section. lib The LIBRARY section. return_vals The RETURN VALUES section. env The ENVIRONMENT section. files The FILES section. exit_status The EXIT STATUS section. diagnostics The DIAGNOSTICS section. errors The ERRORS section. md5_hash MD5 checksum of the man page. machine The machine architecture (if any) for which the man page is relevant. FILES
/var/db/man.db The Sqlite FTS database which contains an index of the manual pages. SEE ALSO
apropos(1), man(1), whatis(1), man.conf(5) AUTHORS
Abhinav Upadhyay BSD
August 29, 2012 BSD

Check Out this Related Man Page

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

NAME
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
Man Page