What is Linux Package Documentation

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.

$ 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.



Tech info

Comments