System Documentation Search

Using the module is as simple as entering a search term and clicking Search. If you choose to Match any in your search, the module will return a list of all pages that it can find that match your query. You may specify which types of documentation you'd like to search, including man pages, Webmin help files, documentation for installed packages, Perl module documentation, and The Book of Webmin either locally or remotely. It will also provide a simple gateway to a Google search.

Man pages are divided into numbered sections, in order to clearly distinguish programming documentation from user command documentation, etc. When performing a search of the man pages, you will likely see multiple results matching your search term. In some cases, there will be more than one entry precisely matching the command or term you're looking for, in different manual sections. The sections are roughly divided as described below:

• User commands that may be run by all users.

• System calls, or functions provided by the kernel.

• Library Functions.

Searching documentation from another module

• Devices, or special files in the /dev directory.

• File format descriptions, for such files as /etc/passwd and sendmail's /etc/aliases file.

• Miscellaneous, macro packages, and conventions. Examples include bootparam and unicode.

• System administration tools that only root can execute. Examples include ifconfig and halt.

• OS Specific kernel routine documentation. Not always available on all systems.

Also available on some systems are a few lettered sections. They are: n for New documentation, which may be moved in the future to a new location, o for Old documentation, which will likely be phased out, and l for Local documentation specific to this particular system.

Was this article helpful?

0 0
SEO Guide for Top Rankings

SEO Guide for Top Rankings

Search engines are special sites on the web that are designed to help people find information stored on other sites. There are differences in the ways various search engines work. Learn more about this topic within this guide.

Get My Free Ebook

Post a comment