/usr/share/doc/debian-policy/policy.html/ch-docs.html is in debian-policy 4.1.4.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>12. Documentation — Debian Policy Manual v4.1.4.1</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '4.1.4.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="1. Introduction and scope of these appendices" href="ap-pkg-scope.html" />
<link rel="prev" title="11. Customized programs" href="ch-customized-programs.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="ap-pkg-scope.html" title="1. Introduction and scope of these appendices"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="ch-customized-programs.html" title="11. Customized programs"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Debian Policy Manual v4.1.4.1</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="documentation">
<h1>12. Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="manual-pages">
<span id="s12-1"></span><h2>12.1. Manual pages<a class="headerlink" href="#manual-pages" title="Permalink to this headline">¶</a></h2>
<p>You should install manual pages in <code class="docutils literal"><span class="pre">nroff</span></code> source form, in appropriate
places under <code class="docutils literal"><span class="pre">/usr/share/man</span></code>. You should only use sections 1 to 9
(see the FHS for more details). You must not install a pre-formatted
“cat page”.</p>
<p>Each program, utility, and function should have an associated manual
page included in the same package. It is suggested that all
configuration files also have a manual page included as well. Manual
pages for protocols and other auxiliary things are optional.</p>
<p>If no manual page is available, this is considered as a bug and should
be reported to the Debian Bug Tracking System (the maintainer of the
package is allowed to write this bug report themselves, if they so
desire). Do not close the bug report until a proper man page is
available. <a class="footnote-reference" href="#id11" id="id1">[1]</a></p>
<p>You may forward a complaint about a missing man page to the upstream
authors, and mark the bug as forwarded in the Debian bug tracking
system. Even though the GNU Project do not in general consider the lack
of a man page to be a bug, we do; if they tell you that they don’t
consider it a bug you should leave the bug in our bug tracking system
open anyway.</p>
<p>Manual pages should be installed compressed using <code class="docutils literal"><span class="pre">gzip</span> <span class="pre">-9</span></code>.</p>
<p>If one man page needs to be accessible via several names it is better to
use a symbolic link than the <code class="docutils literal"><span class="pre">.so</span></code> feature, but there is no need to
fiddle with the relevant parts of the upstream source to change from
<code class="docutils literal"><span class="pre">.so</span></code> to symlinks: don’t do it unless it’s easy. You should not create
hard links in the manual page directories, nor put absolute filenames in
<code class="docutils literal"><span class="pre">.so</span></code> directives. The filename in a <code class="docutils literal"><span class="pre">.so</span></code> in a man page should be
relative to the base of the man page tree (usually <code class="docutils literal"><span class="pre">/usr/share/man</span></code>).
If you do not create any links (whether symlinks, hard links, or <code class="docutils literal"><span class="pre">.so</span></code>
directives) in the file system to the alternate names of the man page,
then you should not rely on <code class="docutils literal"><span class="pre">man</span></code> finding your man page under those
names based solely on the information in the man page’s header. <a class="footnote-reference" href="#id12" id="id2">[2]</a></p>
<p>Manual pages in locale-specific subdirectories of <code class="docutils literal"><span class="pre">/usr/share/man</span></code>
should use either UTF-8 or the usual legacy encoding for that language
(normally the one corresponding to the shortest relevant locale name in
<code class="docutils literal"><span class="pre">/usr/share/i18n/SUPPORTED</span></code>). For example, pages under
<code class="docutils literal"><span class="pre">/usr/share/man/fr</span></code> should use either UTF-8 or ISO-8859-1. <a class="footnote-reference" href="#id13" id="id3">[3]</a></p>
<p>A country name (the <code class="docutils literal"><span class="pre">DE</span></code> in <code class="docutils literal"><span class="pre">de_DE</span></code>) should not be included in the
subdirectory name unless it indicates a significant difference in the
language, as this excludes speakers of the language in other countries.
<a class="footnote-reference" href="#id14" id="id4">[4]</a></p>
<p>If a localized version of a manual page is provided, it should either be
up-to-date or it should be obvious to the reader that it is outdated and
the original manual page should be used instead. This can be done either
by a note at the beginning of the manual page or by showing the missing
or changed portions in the original language instead of the target
language.</p>
</div>
<div class="section" id="info-documents">
<span id="s12-2"></span><h2>12.2. Info documents<a class="headerlink" href="#info-documents" title="Permalink to this headline">¶</a></h2>
<p>Info documents should be installed in <code class="docutils literal"><span class="pre">/usr/share/info</span></code>. They should
be compressed with <code class="docutils literal"><span class="pre">gzip</span> <span class="pre">-9</span></code>.</p>
<p>The <code class="docutils literal"><span class="pre">install-info</span></code> program maintains a directory of installed info
documents in <code class="docutils literal"><span class="pre">/usr/share/info/dir</span></code> for the use of info readers. This
file must not be included in packages other than install-info.</p>
<p><code class="docutils literal"><span class="pre">install-info</span></code> is automatically invoked when appropriate using dpkg
triggers. Packages other than install-info <em>should not</em> invoke
<code class="docutils literal"><span class="pre">install-info</span></code> directly and <em>should not</em> depend on, recommend, or
suggest install-info for this purpose.</p>
<p>Info readers requiring the <code class="docutils literal"><span class="pre">/usr/share/info/dir</span></code> file should depend on
install-info.</p>
<p>Info documents should contain section and directory entry information in
the document for the use of <code class="docutils literal"><span class="pre">install-info</span></code>. The section should be
specified via a line starting with <code class="docutils literal"><span class="pre">INFO-DIR-SECTION</span></code> followed by a
space and the section of this info page. The directory entry or entries
should be included between a <code class="docutils literal"><span class="pre">START-INFO-DIR-ENTRY</span></code> line and an
<code class="docutils literal"><span class="pre">END-INFO-DIR-ENTRY</span></code> line. For example:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">INFO</span><span class="o">-</span><span class="n">DIR</span><span class="o">-</span><span class="n">SECTION</span> <span class="n">Individual</span> <span class="n">utilities</span>
<span class="n">START</span><span class="o">-</span><span class="n">INFO</span><span class="o">-</span><span class="n">DIR</span><span class="o">-</span><span class="n">ENTRY</span>
<span class="o">*</span> <span class="n">example</span><span class="p">:</span> <span class="p">(</span><span class="n">example</span><span class="p">)</span><span class="o">.</span> <span class="n">An</span> <span class="n">example</span> <span class="n">info</span> <span class="n">directory</span> <span class="n">entry</span><span class="o">.</span>
<span class="n">END</span><span class="o">-</span><span class="n">INFO</span><span class="o">-</span><span class="n">DIR</span><span class="o">-</span><span class="n">ENTRY</span>
</pre></div>
</div>
<p>To determine which section to use, you should look at
<code class="docutils literal"><span class="pre">/usr/share/info/dir</span></code> on your system and choose the most relevant (or
create a new section if none of the current sections are relevant).
<a class="footnote-reference" href="#id15" id="id5">[5]</a></p>
</div>
<div class="section" id="additional-documentation">
<span id="s-docs-additional"></span><h2>12.3. Additional documentation<a class="headerlink" href="#additional-documentation" title="Permalink to this headline">¶</a></h2>
<p>Any additional documentation that comes with the package may be
installed at the discretion of the package maintainer. It is often a
good idea to include text information files (<code class="docutils literal"><span class="pre">README</span></code>s, FAQs, and so
forth) that come with the source package in the binary package. However,
you don’t need to install the instructions for building and installing
the package, of course!</p>
<p>Plain text documentation should be compressed with <code class="docutils literal"><span class="pre">gzip</span> <span class="pre">-9</span></code> unless it is small.</p>
<p>If a package comes with large amounts of documentation that many users
of the package will not require, you should create a separate binary
package to contain it so that it does not take up disk space on the
machines of users who do not need or want it installed. As a special
case of this rule, shared library documentation of any appreciable size
should always be packaged with the library development package
(<a class="reference internal" href="ch-sharedlibs.html#s-sharedlibs-dev"><span class="std std-ref">Development files</span></a>) or in a separate documentation
package, since shared libraries are frequently installed as dependencies
of other packages by users who have little interest in documentation of
the library itself. The documentation package for the package package is
conventionally named package-doc (or package-doc-language-code if there
are separate documentation packages for multiple languages).</p>
<p>If package is a build tool, development tool, command-line tool, or
library development package, package (or package-dev in the case of a
library development package) already provides documentation in man,
info, or plain text format, and package-doc provides HTML or other
formats, package should declare at most a <code class="docutils literal"><span class="pre">Suggests</span></code> on package-doc.
Otherwise, package should declare at most a <code class="docutils literal"><span class="pre">Recommends</span></code> on
package-doc.</p>
<p>Additional documentation included in the package should be installed
under <code class="docutils literal"><span class="pre">/usr/share/doc/package</span></code>. If the documentation is packaged
separately, as package-doc for example, it may be installed under either
that path or into the documentation directory for the separate
documentation package (<code class="docutils literal"><span class="pre">/usr/share/doc/package-doc</span></code> in this example).
However, installing the documentation into the documentation directory
of the main package is preferred since it is independent of the
packaging method and will be easier for users to find.</p>
<p>Any separate package providing documentation must still install standard
documentation files in its own <code class="docutils literal"><span class="pre">/usr/share/doc</span></code> directory as specified
in the rest of this policy. See, for example,
<a class="reference internal" href="#s-copyrightfile"><span class="std std-ref">Copyright information</span></a> and
<a class="reference internal" href="#s-changelogs"><span class="std std-ref">Changelog files</span></a>.</p>
<p>Packages must not require the existence of any files in
<code class="docutils literal"><span class="pre">/usr/share/doc/</span></code> in order to function. <a class="footnote-reference" href="#id16" id="id6">[6]</a> Any files that are
used or read by programs but are also useful as stand alone
documentation should be installed elsewhere, such as under
<code class="docutils literal"><span class="pre">/usr/share/package/</span></code>, and then included via symbolic links in
<code class="docutils literal"><span class="pre">/usr/share/doc/package</span></code>.</p>
<p><code class="docutils literal"><span class="pre">/usr/share/doc/package</span></code> may be a symbolic link to another directory
in <code class="docutils literal"><span class="pre">/usr/share/doc</span></code> only if the two packages both come from the same
source and the first package Depends on the second. <a class="footnote-reference" href="#id17" id="id7">[7]</a></p>
</div>
<div class="section" id="preferred-documentation-formats">
<span id="s12-4"></span><h2>12.4. Preferred documentation formats<a class="headerlink" href="#preferred-documentation-formats" title="Permalink to this headline">¶</a></h2>
<p>The unification of Debian documentation is being carried out via HTML.</p>
<p>If the package comes with extensive documentation in a markup format
that can be converted to various other formats you should if possible
ship HTML versions in a binary package. <a class="footnote-reference" href="#id18" id="id8">[8]</a> The documentation must
be installed as specified in <a class="reference internal" href="#s-docs-additional"><span class="std std-ref">Additional documentation</span></a>.</p>
<p>Other formats such as PostScript may be provided at the package
maintainer’s discretion.</p>
</div>
<div class="section" id="copyright-information">
<span id="s-copyrightfile"></span><h2>12.5. Copyright information<a class="headerlink" href="#copyright-information" title="Permalink to this headline">¶</a></h2>
<p>Every package must be accompanied by a verbatim copy of its copyright
information and distribution license in the file
<code class="docutils literal"><span class="pre">/usr/share/doc/package/copyright</span></code>. This file must neither be
compressed nor be a symbolic link.</p>
<p>In addition, the copyright file must say where the upstream sources (if
any) were obtained, and should include a name or contact address for the
upstream authors. This can be the name of an individual or an
organization, an email address, a web forum or bugtracker, or any other
means to unambiguously identify who to contact to participate in the
development of the upstream source code.</p>
<p>Packages in the <em>contrib</em> or <em>non-free</em> archive areas should state in
the copyright file that the package is not part of the Debian
distribution and briefly explain why.</p>
<p>A copy of the file which will be installed in
<code class="docutils literal"><span class="pre">/usr/share/doc/package/copyright</span></code> should be in <code class="docutils literal"><span class="pre">debian/copyright</span></code>
in the source package.</p>
<p><code class="docutils literal"><span class="pre">/usr/share/doc/package</span></code> may be a symbolic link to another directory
in <code class="docutils literal"><span class="pre">/usr/share/doc</span></code> only if the two packages both come from the same
source and the first package Depends on the second. These rules are
important because <code class="docutils literal"><span class="pre">copyright</span></code> files must be extractable by mechanical
means.</p>
<p>Packages distributed under the Apache license (version 2.0), the
Artistic license, the Creative Commons CC0-1.0 license, the GNU GPL
(versions 1, 2, or 3), the GNU LGPL (versions 2, 2.1, or 3), the GNU FDL
(versions 1.2 or 1.3), and the Mozilla Public License (version 1.1 or
2.0) should refer to the corresponding files under
<code class="docutils literal"><span class="pre">/usr/share/common-licenses</span></code>, <a class="footnote-reference" href="#id19" id="id9">[9]</a> rather than quoting them in the
copyright file.</p>
<p>You should not use the copyright file as a general <code class="docutils literal"><span class="pre">README</span></code> file. If
your package has such a file it should be installed in
<code class="docutils literal"><span class="pre">/usr/share/doc/package/README</span></code> or <code class="docutils literal"><span class="pre">README.Debian</span></code> or some other
appropriate place.</p>
<p>All copyright files must be encoded in UTF-8.</p>
<div class="section" id="machine-readable-copyright-information">
<span id="s-copyrightformat"></span><h3>12.5.1. Machine-readable copyright information<a class="headerlink" href="#machine-readable-copyright-information" title="Permalink to this headline">¶</a></h3>
<p>A specification for a standard, machine-readable format for
<code class="docutils literal"><span class="pre">debian/copyright</span></code> files is maintained as part of the debian-policy
package. This document may be found in the <code class="docutils literal"><span class="pre">copyright-format</span></code> files in
the debian-policy package. It is also available from the Debian web
mirrors at
<a class="reference external" href="https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/">https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/</a>.</p>
<p>Use of this format is optional.</p>
</div>
</div>
<div class="section" id="examples">
<span id="s12-6"></span><h2>12.6. Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<p>Any examples (configurations, source files, whatever), should be
installed in a directory <code class="docutils literal"><span class="pre">/usr/share/doc/package/examples</span></code>. These
files should not be referenced by any program: they’re there for the
benefit of the system administrator and users as documentation only.
Architecture-specific example files should be installed in a directory
<code class="docutils literal"><span class="pre">/usr/lib/package/examples</span></code> with symbolic links to them from
<code class="docutils literal"><span class="pre">/usr/share/doc/package/examples</span></code>, or the latter directory itself may
be a symbolic link to the former.</p>
<p>If the purpose of a package is to provide examples, then the example
files may be installed into <code class="docutils literal"><span class="pre">/usr/share/doc/package</span></code>.</p>
</div>
<div class="section" id="changelog-files">
<span id="s-changelogs"></span><h2>12.7. Changelog files<a class="headerlink" href="#changelog-files" title="Permalink to this headline">¶</a></h2>
<p>Packages that are not Debian-native must contain a compressed copy of
the <code class="docutils literal"><span class="pre">debian/changelog</span></code> file from the Debian source tree in
<code class="docutils literal"><span class="pre">/usr/share/doc/package</span></code> with the name <code class="docutils literal"><span class="pre">changelog.Debian.gz</span></code>.</p>
<p>If an upstream changelog is available, it should be accessible as
<code class="docutils literal"><span class="pre">/usr/share/doc/package/changelog.gz</span></code> in plain text. If the upstream
changelog is distributed in HTML, it should be made available in that
form as <code class="docutils literal"><span class="pre">/usr/share/doc/package/changelog.html.gz</span></code> and a plain text
<code class="docutils literal"><span class="pre">changelog.gz</span></code> should be generated from it using, for example,
<code class="docutils literal"><span class="pre">lynx</span> <span class="pre">-dump</span> <span class="pre">-nolist</span></code>. If the upstream changelog files do not already
conform to this naming convention, then this may be achieved either by
renaming the files, or by adding a symbolic link, at the maintainer’s
discretion. <a class="footnote-reference" href="#id20" id="id10">[10]</a></p>
<p>All of these files should be installed compressed using <code class="docutils literal"><span class="pre">gzip</span> <span class="pre">-9</span></code>, as
they will become large with time even if they start out small.</p>
<p>If the package has only one changelog which is used both as the Debian
changelog and the upstream one because there is no separate upstream
maintainer then that changelog should usually be installed as
<code class="docutils literal"><span class="pre">/usr/share/doc/package/changelog.gz</span></code>; if there is a separate upstream
maintainer, but no upstream changelog, then the Debian changelog should
still be called <code class="docutils literal"><span class="pre">changelog.Debian.gz</span></code>.</p>
<p>For details about the format and contents of the Debian changelog file,
please see <a class="reference internal" href="ch-source.html#s-dpkgchangelog"><span class="std std-ref">Debian changelog: debian/changelog</span></a>.</p>
<table class="docutils footnote" frame="void" id="id11" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>It is not very hard to write a man page. See the
<a class="reference external" href="http://www.schweikhardt.net/man_page_howto.html">Man-Page-HOWTO</a>,
man(7), the examples created by <code class="docutils literal"><span class="pre">dh_make</span></code>, the helper program
<code class="docutils literal"><span class="pre">help2man</span></code>, or the directory <code class="docutils literal"><span class="pre">/usr/share/doc/man-db/examples</span></code>.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id12" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td>Supporting this in <code class="docutils literal"><span class="pre">man</span></code> often requires unreasonable processing
time to find a manual page or to report that none exists, and moves
knowledge into man’s database that would be better left in the file
system. This support is therefore deprecated and will cease to be
present in the future.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id13" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id3">[3]</a></td><td><code class="docutils literal"><span class="pre">man</span></code> will automatically detect whether UTF-8 is in use. In future,
all manual pages will be required to use UTF-8.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id14" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id4">[4]</a></td><td>At the time of writing, Chinese and Portuguese are the main languages
with such differences, so <code class="docutils literal"><span class="pre">pt_BR</span></code>, <code class="docutils literal"><span class="pre">zh_CN</span></code>, and <code class="docutils literal"><span class="pre">zh_TW</span></code> are all
allowed.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id15" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id5">[5]</a></td><td><p class="first">Normally, info documents are generated from Texinfo source. To
include this information in the generated info document, if it is
absent, add commands like:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="nd">@dircategory</span> <span class="n">Individual</span> <span class="n">utilities</span>
<span class="nd">@direntry</span>
<span class="o">*</span> <span class="n">example</span><span class="p">:</span> <span class="p">(</span><span class="n">example</span><span class="p">)</span><span class="o">.</span> <span class="n">An</span> <span class="n">example</span> <span class="n">info</span> <span class="n">directory</span> <span class="n">entry</span><span class="o">.</span>
<span class="nd">@end</span> <span class="n">direntry</span>
</pre></div>
</div>
<p class="last">to the Texinfo source of the document and ensure that the info
documents are rebuilt from source during the package build.</p>
</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id16" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id6">[6]</a></td><td>The system administrator should be able to delete files in
<code class="docutils literal"><span class="pre">/usr/share/doc/</span></code> without causing any programs to break.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id17" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id7">[7]</a></td><td>Please note that this does not override the section on changelog
files below, so the file
<code class="docutils literal"><span class="pre">/usr/share/doc/package/changelog.Debian.gz</span></code> must refer to the
changelog for the current version of package in question. In
practice, this means that the sources of the target and the
destination of the symlink must be the same (same source package and
version).</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id18" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id8">[8]</a></td><td>Rationale: The important thing here is that HTML documentation should
be available from <em>some</em> binary package.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id19" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id9">[9]</a></td><td>In particular, <code class="docutils literal"><span class="pre">/usr/share/common-licenses/Apache-2.0</span></code>,
<code class="docutils literal"><span class="pre">/usr/share/common-licenses/Artistic</span></code>,
<code class="docutils literal"><span class="pre">/usr/share/common-licenses/CC0-1.0</span></code>,
<code class="docutils literal"><span class="pre">/usr/share/common-licenses/GPL-1</span></code>,
<code class="docutils literal"><span class="pre">/usr/share/common-licenses/GPL-2</span></code>,
<code class="docutils literal"><span class="pre">/usr/share/common-licenses/GPL-3</span></code>,
<code class="docutils literal"><span class="pre">/usr/share/common-licenses/LGPL-2</span></code>,
<code class="docutils literal"><span class="pre">/usr/share/common-licenses/LGPL-2.1</span></code>,
<code class="docutils literal"><span class="pre">/usr/share/common-licenses/LGPL-3</span></code>,
<code class="docutils literal"><span class="pre">/usr/share/common-licenses/GFDL-1.2</span></code>,
<code class="docutils literal"><span class="pre">/usr/share/common-licenses/GFDL-1.3</span></code>,
<code class="docutils literal"><span class="pre">/usr/share/common-licenses/MPL-1.1</span></code>, and
<code class="docutils literal"><span class="pre">/usr/share/common-licenses/MPL-2.0</span></code> respectively. The University
of California BSD license is also included in base-files as
<code class="docutils literal"><span class="pre">/usr/share/common-licenses/BSD</span></code>, but given the brevity of this
license, its specificity to code whose copyright is held by the
Regents of the University of California, and the frequency of minor
wording changes, its text should be included in the copyright file
rather than referencing this file.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id20" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id10">[10]</a></td><td>Rationale: People should not have to look in places for upstream
changelogs merely because they are given different names or are
distributed in HTML format.</td></tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">12. Documentation</a><ul>
<li><a class="reference internal" href="#manual-pages">12.1. Manual pages</a></li>
<li><a class="reference internal" href="#info-documents">12.2. Info documents</a></li>
<li><a class="reference internal" href="#additional-documentation">12.3. Additional documentation</a></li>
<li><a class="reference internal" href="#preferred-documentation-formats">12.4. Preferred documentation formats</a></li>
<li><a class="reference internal" href="#copyright-information">12.5. Copyright information</a><ul>
<li><a class="reference internal" href="#machine-readable-copyright-information">12.5.1. Machine-readable copyright information</a></li>
</ul>
</li>
<li><a class="reference internal" href="#examples">12.6. Examples</a></li>
<li><a class="reference internal" href="#changelog-files">12.7. Changelog files</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="ch-customized-programs.html"
title="previous chapter">11. Customized programs</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="ap-pkg-scope.html"
title="next chapter">1. Introduction and scope of these appendices</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/ch-docs.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="ap-pkg-scope.html" title="1. Introduction and scope of these appendices"
>next</a> |</li>
<li class="right" >
<a href="ch-customized-programs.html" title="11. Customized programs"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Debian Policy Manual v4.1.4.1</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.
</div>
</body>
</html>
|