6.7. Package Documentation

If you install a package in your system, a directory /usr/share/doc/packages/packagename is created. You can find files from the package maintainer as well as additional information from SUSE. Sometimes there are also examples, configuration files, additional scripts, etc., available. Usually you can find the following files, but they are not standard and sometimes not all files are available.

AUTHORS

This file contains the list of the main developers of this package and usually their tasks.

BUGS

Lists known bugs or malfunctions of this package. Usually it also contains a link to a Bugzilla Web page where you can search all bugs.

CHANGES, ChangeLog

Summary of changes from version to version. Usually interesting for developers, because it is very detailed.

COPYING, LICENSE

Contains licensing information

FAQ

This file contains question and answers collected from mailing lists or newsgroups.

INSTALL

This file contains procedures for installing this package in your system. Normally you do not need it, because you have the package installed already.

README, README.*

General information about how to use it, what you can do with this package, etc.

TODO

Things that are not implemented yet, but probably will be in the future.

MANIFEST

List of files with a brief summary.

NEWS

Describes what is new in this version