4.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, or other things available. Usually you can find the following files, but they are not standard and sometimes not all files are available.

AUTHORS

The list of the main developers of this package and usually their tasks.

BUGS

Known bugs or malfunctions of this package. Usually also 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

Licensing information.

FAQ

Question and answers collected from mailing lists or newsgroups.

INSTALL

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 such as how to use it and what you can do with this package.

TODO

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

MANIFEST

List of files with a brief summary.

NEWS

Description of what is new in this version.