Linux From ScratchThis Forum is for the discussion of LFS.
LFS is a project that provides you with the steps necessary to build your own custom Linux system.
Notices
Welcome to LinuxQuestions.org, a friendly and active Linux Community.
You are currently viewing LQ as a guest. By joining our community you will have the ability to post topics, receive our newsletter, use the advanced search, subscribe to threads and access many other special features. Registration is quick, simple and absolutely free. Join our community today!
Note that registered members see fewer ads, and ContentLink is completely disabled once you log in.
If you have any problems with the registration process or your account login, please contact us. If you need to reset your password, click here.
Having a problem logging in? Please visit this page to clear all LQ-related cookies.
Get a virtual cloud desktop with the Linux distro that you want in less than five minutes with Shells! With over 10 pre-installed distros to choose from, the worry-free installation life is here! Whether you are a digital nomad or just looking for flexibility, Shells can put your Linux machine on the device that you want to use.
Exclusive for LQ members, get up to 45% off per month. Click here for more info.
DESCRIPTION
Each manual page has a short description available within it. whatis searches the manual page names and displays the manual page descriptions
of any name matched.
name may contain wildcards (-w) or be a regular expression (-r). Using these options, it may be necessary to quote the name or escape (\) the
special characters to stop the shell from interpreting them.
index databases are used during the search, and are updated by the mandb program. Depending on your installation, this may be run by a peri-
odic cron job, or may need to be run manually after new manual pages have been installed. To produce an old style text whatis database from
the relative index database, issue the command:
whatis -M manpath -w '*' | sort > manpath/whatis
where manpath is a manual page hierarchy such as /usr/man.
OPTIONS
-d, --debug
Print debugging information.
-v, --verbose
Print verbose warning messages.
-r, --regex
Interpret each name as a regular expression. If a name matches any part of a page name, a match will be made. This option causes
whatis to be somewhat slower due to the nature of database searches.
-w, --wildcard
Interpret each name as a pattern containing shell style wildcards. For a match to be made, an expanded name must match the entire page
name. This option causes whatis to be somewhat slower due to the nature of database searches.
-l, --long
Do not trim output to the terminal width. Normally, output will be truncated to the terminal width to avoid ugly results from poorly-
written NAME sections.
-s section, --section section
Search only the given manual section. If section is a simple section, for example "3", then the displayed list of descriptions will
include pages in sections "3", "3perl", "3x", and so on; while if section has an extension, for example "3perl", then the list will only
include pages in that exact part of the manual section.
-m system[,...], --systems=system[,...]
If this system has access to other operating system's manual page names, they can be accessed using this option. To search NewOS's man-
ual page names, use the option -m NewOS.
The system specified can be a combination of comma delimited operating system names. To include a search of the native operating sys-
tem's manual page names, include the system name man in the argument string. This option will override the $SYSTEM environment vari-
able.
-M path, --manpath=path
Specify an alternate set of colon-delimited manual page hierarchies to search. By default, whatis uses the $MANPATH environment vari-
able, unless it is empty or unset, in which case it will determine an appropriate manpath based on your $PATH environment variable.
This option overrides the contents of $MANPATH.
-L locale, --locale=locale
whatis will normally determine your current locale by a call to the C function setlocale(3) which interrogates various environment vari-
ables, possibly including $LC_MESSAGES and $LANG. To temporarily override the determined value, use this option to supply a locale
string directly to whatis. Note that it will not take effect until the search for pages actually begins. Output such as the help mes-
sage will always be displayed in the initially determined locale.
-C file, --config-file=file
Use this user configuration file rather than the default of ~/.manpath.
-h, --help
Print a help message and exit.
-V, --version
Display version information.
EXIT STATUS
0 Successful program execution.
1 Usage, syntax or configuration file error.
2 Operational error.
16 Nothing was found that matched the criteria specified.
ENVIRONMENT
SYSTEM If $SYSTEM is set, it will have the same effect as if it had been specified as the argument to the -m option.
MANPATH
If $MANPATH is set, its value is interpreted as the colon-delimited manual page hierarchy search path to use.
MANWIDTH
If $MANWIDTH is set, its value is used as the terminal width (see the --long option). If it is not set, the terminal width will be cal-
culated using an ioctl(2) if available, the value of $COLUMNS, or falling back to 80 characters if all else fails.
FILES
/usr/share/man/index.(bt|db|dir|pag)
A traditional global index database cache.
/var/cache/man/index.(bt|db|dir|pag)
An FHS compliant global index database cache.
/usr/share/man/.../whatis
A traditional whatis text database.
SEE ALSO
apropos(1), man(1), mandb(8).
AUTHOR
Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).
LinuxQuestions.org is looking for people interested in writing
Editorials, Articles, Reviews, and more. If you'd like to contribute
content, let us know.