(debian-policy.info)The description of a package


Next: Dependencies Prev: The maintainer of a package Up: Binary packages
Enter node , (file) or (file)node

3.4 The description of a package
================================

Every Debian package must have a ‘Description’ control field which
contains a synopsis and extended description of the package.  Technical
information about the format of the ‘Description’ field is in Note:
Description.

The description should describe the package (the program) to a user
(system administrator) who has never met it before so that they have
enough information to decide whether they want to install it.  This
description should not just be copied verbatim from the program’s
documentation.

Put important information first, both in the synopsis and extended
description.  Sometimes only the first part of the synopsis or of the
description will be displayed.  You can assume that there will usually
be a way to see the whole extended description.

The description should also give information about the significant
dependencies and conflicts between this package and others, so that the
user knows why these dependencies and conflicts have been declared.

Instructions for configuring or using the package should not be included
(that is what installation scripts, manual pages, info files, etc., are
for).  Copyright statements and other administrivia should not be
included either (that is what the copyright file is for).

The single line synopsis
The extended description

automatically generated by info2www version 1.2.2.9