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)							   User Commands							apropos(1)

NAME
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)

Featured Tech Videos