Bookmark this page

Reading Documentation in /usr/share/doc

The practice of bundling documentation with RPM packages, which are then stored under the directory /usr/share/doc.

Objectives

After completing this section, students should be able to research information using Red Hat Package Manager documentation.

Introducing package documentation

Reading documentation in /usr/share/doc

In addition to man and pinfo, developers may also choose to include documentation in their application's RPM distribution package. When the package is installed, files recognized as documentation are moved to /usr/share/doc/packagename. Software package builders may include anything deemed helpful as a complement to, but not duplicating, man pages. GNU packages also use /usr/share/doc to supplement info nodes.

Most packages include files describing package distribution licensing. Some packages include extensive PDF- or HTML-based documentation. Accordingly, a useful package browsing method is pointing a browser of choice to file:///usr/share/doc and utilizing a mouse.

[student@desktopX ~]$ firefox file:///usr/share/doc

Some packages come with extensive examples, configuration file templates, scripts, tutorials, or user guides. Browse /usr/share/doc/vsftpd-* as an example. Some documentation is sparse; the zip utility includes the compression algorithm used and little else. Other packages includes large user manuals or developer guides, or electronic copies of related, published books.

Note

Developers may choose to bundle extensive documentation in a separate RPM. The gnuplot program has the extra gnuplot-doc package, which must be installed separately. Other similar packages to browse include bash-doc and samba-doc. Often, extra packages are found in Red Hat Enterprise Linux's Optional software channel.

Many packages also include developer documentation, such as an Application Programming Interface (API) specification, provided in a package with a name ending in -devel or similar. Packages may include additional files, such as headers; useful documentation usually only needed for software development or compiling.

Note

The kernel itself has a significant documentation package. The kernel-doc package is a treasure of kernel, driver, tuning, and advanced configuration information. Experienced system administrators regularly research kernel-doc files.

References

hier(7) man page

  • Discusses the hierarchy of Linux directories, including /usr/share/doc.

Revision: rh124-7-1b00421