# SOME DESCRIPTIVE TITLE. # Copyright (C) 1996, 1997, 1998 Ian Jackson, Christian Schwarz, 1998-2017, # The Debian Policy Mailing List # This file is distributed under the same license as the Debian Policy # Manual package. # FIRST AUTHOR , 2018. # #, fuzzy msgid "" msgstr "" "Project-Id-Version: Debian Policy Manual 4.1.6.0\n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2021-08-17 20:06-0700\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" "Generated-By: Babel 2.8.0\n" #: ../../ch-docs.rst:2 msgid "Documentation" msgstr "" #: ../../ch-docs.rst:7 msgid "Manual pages" msgstr "" #: ../../ch-docs.rst:9 msgid "" "You should install manual pages in ``nroff`` source form, in appropriate " "places under ``/usr/share/man``. You should only use sections 1 to 9 (see" " the FHS for more details). You must not install a pre-formatted \"cat " "page\"." msgstr "" #: ../../ch-docs.rst:14 msgid "" "Each program, utility, and function should have an associated manual page" " included in the same package or a dependency. 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." msgstr "" #: ../../ch-docs.rst:19 msgid "" "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. [#]_" msgstr "" #: ../../ch-docs.rst:25 msgid "" "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." msgstr "" #: ../../ch-docs.rst:32 msgid "Manual pages should be installed compressed using ``gzip -9``." msgstr "" #: ../../ch-docs.rst:34 msgid "" "If one man page needs to be accessible via several names it is better to " "use a symbolic link than the ``.so`` feature, but there is no need to " "fiddle with the relevant parts of the upstream source to change from " "``.so`` 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 " "``.so`` directives. The filename in a ``.so`` in a man page should be " "relative to the base of the man page tree (usually ``/usr/share/man``). " "If you do not create any links (whether symlinks, hard links, or ``.so`` " "directives) in the file system to the alternate names of the man page, " "then you should not rely on ``man`` finding your man page under those " "names based solely on the information in the man page's header. [#]_" msgstr "" #: ../../ch-docs.rst:46 msgid "" "Manual pages in locale-specific subdirectories of ``/usr/share/man`` " "should use either UTF-8 or the usual legacy encoding for that language " "(normally the one corresponding to the shortest relevant locale name in " "``/usr/share/i18n/SUPPORTED``). For example, pages under " "``/usr/share/man/fr`` should use either UTF-8 or ISO-8859-1. [#]_" msgstr "" #: ../../ch-docs.rst:52 msgid "" "A country name (the ``DE`` in ``de_DE``) 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. " "[#]_" msgstr "" #: ../../ch-docs.rst:57 msgid "" "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." msgstr "" #: ../../ch-docs.rst:67 msgid "Info documents" msgstr "" #: ../../ch-docs.rst:69 msgid "" "Info documents should be installed in ``/usr/share/info``. They should be" " compressed with ``gzip -9``." msgstr "" #: ../../ch-docs.rst:72 msgid "" "The ``install-info`` program maintains a directory of installed info " "documents in ``/usr/share/info/dir`` for the use of info readers. This " "file must not be included in packages other than install-info." msgstr "" #: ../../ch-docs.rst:76 msgid "" "``install-info`` is automatically invoked when appropriate using dpkg " "triggers. Packages other than install-info *should not* invoke ``install-" "info`` directly and *should not* depend on, recommend, or suggest " "install-info for this purpose." msgstr "" #: ../../ch-docs.rst:81 msgid "" "Info readers requiring the ``/usr/share/info/dir`` file should depend on " "install-info." msgstr "" #: ../../ch-docs.rst:84 msgid "" "Info documents should contain section and directory entry information in " "the document for the use of ``install-info``. The section should be " "specified via a line starting with ``INFO-DIR-SECTION`` followed by a " "space and the section of this info page. The directory entry or entries " "should be included between a ``START-INFO-DIR-ENTRY`` line and an ``END-" "INFO-DIR-ENTRY`` line. For example:" msgstr "" #: ../../ch-docs.rst:98 msgid "" "To determine which section to use, you should look at " "``/usr/share/info/dir`` on your system and choose the most relevant (or " "create a new section if none of the current sections are relevant). [#]_" msgstr "" #: ../../ch-docs.rst:106 msgid "Additional documentation" msgstr "" #: ../../ch-docs.rst:108 msgid "" "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 (``README``\\ 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!" msgstr "" #: ../../ch-docs.rst:115 msgid "" "Plain text documentation should be compressed with ``gzip -9`` unless it " "is small." msgstr "" #: ../../ch-docs.rst:117 msgid "" "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 (:ref:`s" "-sharedlibs-dev`) 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)." msgstr "" #: ../../ch-docs.rst:130 msgid "" "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 ``Suggests`` on package-doc. Otherwise, " "package should declare at most a ``Recommends`` on package-doc." msgstr "" #: ../../ch-docs.rst:138 msgid "" "Additional documentation included in the package should be installed " "under ``/usr/share/doc/package``. 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 (``/usr/share/doc/package-doc`` in this example). " "However, installing the documentation into the documentation directory of" " the main package is encouraged since it is independent of the packaging " "method and will be easier for users to find." msgstr "" #: ../../ch-docs.rst:147 msgid "" "Any separate package providing documentation must still install standard " "documentation files in its own ``/usr/share/doc`` directory as specified " "in the rest of this policy. See, for example, :ref:`s-copyrightfile` and " ":ref:`s-changelogs`." msgstr "" #: ../../ch-docs.rst:153 msgid "" "Packages must not require the existence of any files in " "``/usr/share/doc/`` in order to function. [#]_ Any files that are used " "or read by programs but are also useful as stand alone documentation " "should be installed elsewhere, such as under ``/usr/share/package/``, and" " then included via symbolic links in ``/usr/share/doc/package``." msgstr "" #: ../../ch-docs.rst:160 msgid "" "``/usr/share/doc/package`` is permitted to be a symbolic link to another " "directory in ``/usr/share/doc`` only if the two packages both come from " "the same source and the first package Depends on the second. Otherwise, " "``/usr/share/doc/package`` must not be a symbolic link. [#]_" msgstr "" #: ../../ch-docs.rst:168 msgid "Preferred documentation formats" msgstr "" #: ../../ch-docs.rst:170 msgid "The unification of Debian documentation is being carried out via HTML." msgstr "" #: ../../ch-docs.rst:172 msgid "" "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. [#]_ The documentation must be " "installed as specified in :ref:`s-docs-additional`." msgstr "" #: ../../ch-docs.rst:177 msgid "" "Other formats such as PostScript may be provided at the package " "maintainer's discretion." msgstr "" #: ../../ch-docs.rst:183 msgid "Copyright information" msgstr "" #: ../../ch-docs.rst:185 msgid "" "Every package must be accompanied by a verbatim copy of its distribution " "license(s) in the file ``/usr/share/doc/PACKAGE/copyright``. This file " "must neither be compressed nor be a symbolic link." msgstr "" #: ../../ch-docs.rst:189 msgid "" "A verbatim copy of the package's copyright information is often required " "to be present in ``/usr/share/doc/PACKAGE/copyright``, too; see " ":ref:`s-pkgcopyright`." msgstr "" #: ../../ch-docs.rst:193 msgid "" "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." msgstr "" #: ../../ch-docs.rst:200 msgid "" "Packages in the *contrib* or *non-free* archive areas should state in the" " copyright file that the package is not part of the Debian distribution " "and briefly explain why." msgstr "" #: ../../ch-docs.rst:204 msgid "" "A copy of the file which will be installed in " "``/usr/share/doc/PACKAGE/copyright`` should be in ``debian/copyright`` in" " the source package." msgstr "" #: ../../ch-docs.rst:208 msgid "" "``/usr/share/doc/package`` is permitted be a symbolic link to another " "directory in ``/usr/share/doc`` only if the two packages both come from " "the same source and the first package Depends on the second. Otherwise, " "``/usr/share/doc/package`` must not be a symbolic link. These rules are " "important because ``copyright`` files must be extractable by mechanical " "means." msgstr "" #: ../../ch-docs.rst:215 msgid "" "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 ``/usr/share/common-licenses``, " "[#]_ rather than quoting them in the copyright file." msgstr "" #: ../../ch-docs.rst:223 msgid "" "You should not use the copyright file as a general ``README`` file. If " "your package has such a file it should be installed in " "``/usr/share/doc/package/README`` or ``README.Debian`` or some other " "appropriate place." msgstr "" #: ../../ch-docs.rst:228 msgid "All copyright files must be encoded in UTF-8." msgstr "" #: ../../ch-docs.rst:233 msgid "Machine-readable copyright information" msgstr "" #: ../../ch-docs.rst:235 msgid "" "A specification for a standard, machine-readable format for " "``debian/copyright`` files is maintained as part of the debian-policy " "package. This document is in the ``copyright-format`` files in the " "debian-policy package. It is also available from the Debian web mirrors " "at https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/." msgstr "" #: ../../ch-docs.rst:241 msgid "Use of this format is optional." msgstr "" #: ../../ch-docs.rst:246 msgid "Examples" msgstr "" #: ../../ch-docs.rst:248 msgid "" "Any examples (configurations, source files, whatever), should be " "installed in a directory ``/usr/share/doc/package/examples``. 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 " "``/usr/lib/package/examples`` with symbolic links to them from " "``/usr/share/doc/package/examples``, or the latter directory itself may " "be a symbolic link to the former." msgstr "" #: ../../ch-docs.rst:257 msgid "" "If the purpose of a package is to provide examples, then the example " "files may be installed into ``/usr/share/doc/package``." msgstr "" #: ../../ch-docs.rst:263 msgid "Changelog files and release notes" msgstr "" #: ../../ch-docs.rst:265 msgid "" "Packages that are not Debian-native must contain a compressed copy of the" " ``debian/changelog`` file from the Debian source tree in " "``/usr/share/doc/package`` with the name ``changelog.Debian.gz``." msgstr "" #: ../../ch-docs.rst:269 msgid "" "If an upstream release notes file is available, containing a summary of " "changes between upstream releases intended for end users of the package " "and often called ``NEWS``, it should be accessible as " "``/usr/share/doc/package/NEWS.gz``. An older practice of installing the " "upstream release notes as ``/usr/share/doc/package/changelog.gz`` is " "permitted but deprecated." msgstr "" #: ../../ch-docs.rst:276 msgid "" "If there is an upstream changelog available, it may be made available as " "``/usr/share/doc/package/changelog.gz``." msgstr "" #: ../../ch-docs.rst:279 msgid "" "If either of these files are distributed in HTML, they should be made " "available at ``/usr/share/doc/package/NEWS.html.gz`` and " "``/usr/share/doc/package/changelog.html.gz`` respectively, and plain text" " versions ``NEWS.gz`` and ``changelog.gz`` should be generated from them," " using, for example, ``lynx -dump -nolist``." msgstr "" #: ../../ch-docs.rst:285 msgid "" "If the upstream release notes or changelog 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. " "[#]_" msgstr "" #: ../../ch-docs.rst:290 msgid "" "All of these files should be installed compressed using ``gzip -9``, as " "they will become large with time even if they start out small." msgstr "" #: ../../ch-docs.rst:293 msgid "" "If the package has only one file which is used both as the Debian " "changelog and the upstream release notes or changelog, because there is " "no separate upstream maintainer, then that file should usually be " "installed as ``/usr/share/doc/package/NEWS.gz`` or " "``/usr/share/doc/package/changelog.gz`` (depending on whether the file is" " release notes or a changelog); if there is a separate upstream " "maintainer, but no upstream release notes or changelog, then the Debian " "changelog should still be called ``changelog.Debian.gz``." msgstr "" #: ../../ch-docs.rst:302 msgid "" "For details about the format and contents of the Debian changelog file, " "please see :ref:`s-dpkgchangelog`." msgstr "" #: ../../ch-docs.rst:306 msgid "" "It is not very hard to write a man page. See the `Man-Page-HOWTO " "`_, :manpage:`man(7)`, " "the examples created by ``dh_make``, the helper program ``help2man``, or " "the directory ``/usr/share/doc/man-db/examples``." msgstr "" #: ../../ch-docs.rst:312 msgid "" "Supporting this in ``man`` 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." msgstr "" #: ../../ch-docs.rst:319 msgid "" "``man`` will automatically detect whether UTF-8 is in use. In future, all" " manual pages will be required to use UTF-8." msgstr "" #: ../../ch-docs.rst:323 msgid "" "At the time of writing, Chinese and Portuguese are the main languages " "with such differences, so ``pt_BR``, ``zh_CN``, and ``zh_TW`` are all " "allowed." msgstr "" #: ../../ch-docs.rst:328 msgid "" "Normally, info documents are generated from Texinfo source. To include " "this information in the generated info document, if it is absent, add " "commands like:" msgstr "" #: ../../ch-docs.rst:339 msgid "" "to the Texinfo source of the document and ensure that the info documents " "are rebuilt from source during the package build." msgstr "" #: ../../ch-docs.rst:343 msgid "" "The system administrator should be able to delete files in " "``/usr/share/doc/`` without causing any programs to break." msgstr "" #: ../../ch-docs.rst:347 msgid "" "Please note that this does not override the section on changelog files " "below, so the file ``/usr/share/doc/package/changelog.Debian.gz`` 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)." msgstr "" #: ../../ch-docs.rst:356 msgid "" "Rationale: The important thing here is that HTML documentation should be " "available from *some* binary package." msgstr "" #: ../../ch-docs.rst:360 msgid "" "In particular, ``/usr/share/common-licenses/Apache-2.0``, ``/usr/share" "/common-licenses/Artistic``, ``/usr/share/common-licenses/CC0-1.0``, " "``/usr/share/common-licenses/GPL-1``, ``/usr/share/common-" "licenses/GPL-2``, ``/usr/share/common-licenses/GPL-3``, ``/usr/share" "/common-licenses/LGPL-2``, ``/usr/share/common-licenses/LGPL-2.1``, " "``/usr/share/common-licenses/LGPL-3``, ``/usr/share/common-" "licenses/GFDL-1.2``, ``/usr/share/common-licenses/GFDL-1.3``, " "``/usr/share/common-licenses/MPL-1.1``, and ``/usr/share/common-" "licenses/MPL-2.0`` respectively. The University of California BSD license" " is also included in base-files as ``/usr/share/common-licenses/BSD``, " "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." msgstr "" #: ../../ch-docs.rst:381 msgid "" "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." msgstr "" #~ msgid "Changelog files" #~ msgstr "" #~ msgid "" #~ "If an upstream changelog is available," #~ " it should be accessible as " #~ "``/usr/share/doc/package/changelog.gz`` in plain " #~ "text. If the upstream changelog is " #~ "distributed in HTML, it should be " #~ "made available in that form as " #~ "``/usr/share/doc/package/changelog.html.gz`` and a " #~ "plain text ``changelog.gz`` should be " #~ "generated from it using, for example," #~ " ``lynx -dump -nolist``. 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. [#]_" #~ msgstr "" #~ msgid "" #~ "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 " #~ "``/usr/share/doc/package/changelog.gz``; if there is" #~ " a separate upstream maintainer, but " #~ "no upstream changelog, then the Debian" #~ " changelog should still be called " #~ "``changelog.Debian.gz``." #~ msgstr "" #~ msgid "" #~ "It is not very hard to write " #~ "a man page. See the `Man-Page-" #~ "HOWTO `_, " #~ "man(7), the examples created by " #~ "``dh_make``, the helper program ``help2man``," #~ " or the directory ``/usr/share/doc/man-" #~ "db/examples``." #~ msgstr "" #~ msgid "" #~ "Every package must be accompanied by " #~ "a verbatim copy of its copyright " #~ "information and distribution license in " #~ "the file ``/usr/share/doc/package/copyright``. This" #~ " file must neither be compressed nor" #~ " be a symbolic link." #~ msgstr "" #~ msgid "" #~ "A copy of the file which will " #~ "be installed in ``/usr/share/doc/package/copyright``" #~ " should be in ``debian/copyright`` in " #~ "the source package." #~ msgstr "" #~ msgid "" #~ "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." #~ msgstr "" #~ msgid "" #~ "Additional documentation included in the " #~ "package should be installed under " #~ "``/usr/share/doc/package``. 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 (``/usr/share/doc/package-" #~ "doc`` 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." #~ msgstr "" #~ msgid "" #~ "``/usr/share/doc/package`` may be a symbolic" #~ " link to another directory in " #~ "``/usr/share/doc`` only if the two " #~ "packages both come from the same " #~ "source and the first package Depends " #~ "on the second. [#]_" #~ msgstr "" #~ msgid "" #~ "``/usr/share/doc/package`` may be a symbolic" #~ " link to another directory in " #~ "``/usr/share/doc`` only if the two " #~ "packages both come from the same " #~ "source and the first package Depends " #~ "on the second. These rules are " #~ "important because ``copyright`` files must " #~ "be extractable by mechanical means." #~ msgstr "" #~ msgid "" #~ "A specification for a standard, " #~ "machine-readable format for ``debian/copyright``" #~ " files is maintained as part of " #~ "the debian-policy package. This document" #~ " may be found in the ``copyright-" #~ "format`` files in the debian-policy " #~ "package. It is also available from " #~ "the Debian web mirrors at " #~ "https://www.debian.org/doc/packaging-manuals/copyright-" #~ "format/1.0/." #~ msgstr ""