chiark / gitweb /
[dev-ref] also clean generated epub
[developers-reference.git] / tools.dbk
index 7f62648..70514dc 100644 (file)
--- a/tools.dbk
+++ b/tools.dbk
@@ -26,7 +26,7 @@ exclusion of a competing tool.
 Most of the descriptions of these packages come from the actual package
 descriptions themselves.  Further information can be found in the package
 documentation itself.  You can also see more info with the command
 Most of the descriptions of these packages come from the actual package
 descriptions themselves.  Further information can be found in the package
 documentation itself.  You can also see more info with the command
-<command>apt-cache show &lt;package-name&gt;</command>.
+<command>apt-cache show <replaceable>package-name</replaceable></command>.
 </para>
 <section id="tools-core">
 <title>Core tools</title>
 </para>
 <section id="tools-core">
 <title>Core tools</title>
@@ -58,7 +58,7 @@ role="package">debconf-doc</systemitem> package.
 </para>
 <para>
 Many feel that this system should be used for all packages which require
 </para>
 <para>
 Many feel that this system should be used for all packages which require
-interactive configuration; see <xref linkend="bpp-config-mgmt"/> .  <systemitem
+interactive configuration; see <xref linkend="bpp-config-mgmt"/>.  <systemitem
 role="package">debconf</systemitem> is not currently required by Debian Policy,
 but that may change in the future.
 </para>
 role="package">debconf</systemitem> is not currently required by Debian Policy,
 but that may change in the future.
 </para>
@@ -95,10 +95,10 @@ errors.
 </para>
 <para>
 You should periodically get the newest <systemitem
 </para>
 <para>
 You should periodically get the newest <systemitem
-role="package">lintian</systemitem> from `unstable' and check over all your
-packages.  Notice that the <literal>-i</literal> option provides detailed
-explanations of what each error or warning means, what its basis in Policy is,
-and commonly how you can fix the problem.
+role="package">lintian</systemitem> from <literal>unstable</literal> and check
+over all your packages.  Notice that the <literal>-i</literal> option provides
+detailed explanations of what each error or warning means, what its basis in
+Policy is, and commonly how you can fix the problem.
 </para>
 <para>
 Refer to <xref linkend="sanitycheck"/> for more information on how and when to
 </para>
 <para>
 Refer to <xref linkend="sanitycheck"/> for more information on how and when to
@@ -108,24 +108,15 @@ use Lintian.
 You can also see a summary of all problems reported by Lintian on your packages
 at <ulink url="&url-lintian;"></ulink>.  These reports contain the
 latest <command>lintian</command> output for the whole development distribution
 You can also see a summary of all problems reported by Lintian on your packages
 at <ulink url="&url-lintian;"></ulink>.  These reports contain the
 latest <command>lintian</command> output for the whole development distribution
-(unstable).
-</para>
-</section>
-
-<section id="linda">
-<title><systemitem role="package">linda</systemitem></title>
-<para>
-<systemitem role="package">linda</systemitem> is another package linter.  It is
-similar to <systemitem role="package">lintian</systemitem> but has a different
-set of checks.  Its written in Python rather than Perl.
+(<literal>unstable</literal>).
 </para>
 </section>
 
 <section id="debdiff">
 </para>
 </section>
 
 <section id="debdiff">
-<title><systemitem role="package">debdiff</systemitem></title>
+<title><command>debdiff</command></title>
 <para>
 <command>debdiff</command> (from the <systemitem
 <para>
 <command>debdiff</command> (from the <systemitem
-role="package">devscripts</systemitem> package, <xref linkend="devscripts"/> )
+role="package">devscripts</systemitem> package, <xref linkend="devscripts"/>)
 compares file lists and control files of two packages.  It is a simple
 regression test, as it will help you notice if the number of binary packages
 has changed since the last upload, or if something has changed in the control
 compares file lists and control files of two packages.  It is a simple
 regression test, as it will help you notice if the number of binary packages
 has changed since the last upload, or if something has changed in the control
@@ -184,27 +175,6 @@ them by doing <literal>apt-cache search ^dh-</literal>.
 </para>
 </section>
 
 </para>
 </section>
 
-<section id="debmake">
-<title><systemitem role="package">debmake</systemitem></title>
-<para>
-<systemitem role="package">debmake</systemitem>, a precursor to <systemitem
-role="package">debhelper</systemitem>, is a more coarse-grained
-<filename>debian/rules</filename> assistant.  It includes two main programs:
-<command>deb-make</command>, which can be used to help a maintainer convert a
-regular (non-Debian) source archive into a Debian source package; and
-<command>debstd</command>, which incorporates in one big shot the same sort of
-automated functions that one finds in <systemitem
-role="package">debhelper</systemitem>.
-</para>
-<para>
-The consensus is that <systemitem role="package">debmake</systemitem> is now
-deprecated in favor of <systemitem role="package">debhelper</systemitem>.  It
-is a bug to use <systemitem role="package">debmake</systemitem> in new
-packages.  New packages using <systemitem role="package">debmake</systemitem>
-will be rejected from the archive.
-</para>
-</section>
-
 <section id="dh-make">
 <title><systemitem role="package">dh-make</systemitem></title>
 <para>
 <section id="dh-make">
 <title><systemitem role="package">dh-make</systemitem></title>
 <para>
@@ -212,7 +182,7 @@ The <systemitem role="package">dh-make</systemitem> package contains
 <command>dh_make</command>, a program that creates a skeleton of files
 necessary to build a Debian package out of a source tree.  As the name
 suggests, <command>dh_make</command> is a rewrite of <systemitem
 <command>dh_make</command>, a program that creates a skeleton of files
 necessary to build a Debian package out of a source tree.  As the name
 suggests, <command>dh_make</command> is a rewrite of <systemitem
-role="package">debmake</systemitem> and its template files use dh_* programs
+role="package">debmake</systemitem> and its template files use <command>dh_*</command> programs
 from <systemitem role="package">debhelper</systemitem>.
 </para>
 <para>
 from <systemitem role="package">debhelper</systemitem>.
 </para>
 <para>
@@ -223,24 +193,6 @@ the package entirely functional and Policy-compliant.
 </para>
 </section>
 
 </para>
 </section>
 
-<section id="yada">
-<title><systemitem role="package">yada</systemitem></title>
-<para>
-<systemitem role="package">yada</systemitem> is another packaging helper tool.
-It uses a <filename>debian/packages</filename> file to auto-generate
-<filename>debian/rules</filename> and other necessary files in the
-<filename>debian/</filename> subdirectory.  The
-<filename>debian/packages</filename> file contains instruction to build
-packages and there is no need to create any <filename>Makefile</filename>
-files.  There is possibility to use macro engine similar to the one used in
-SPECS files from RPM source packages.
-</para>
-<para>
-For more informations see <literal><ulink
-url="http://yada.alioth.debian.org/">YADA site</ulink></literal>.
-</para>
-</section>
-
 <section id="equivs">
 <title><systemitem role="package">equivs</systemitem></title>
 <para>
 <section id="equivs">
 <title><systemitem role="package">equivs</systemitem></title>
 <para>
@@ -271,8 +223,8 @@ upstream changes into the repository.
 <para>
 These utilities provide an infrastructure to facilitate the use of CVS by
 Debian maintainers.  This allows one to keep separate CVS branches of a package
 <para>
 These utilities provide an infrastructure to facilitate the use of CVS by
 Debian maintainers.  This allows one to keep separate CVS branches of a package
-for <emphasis>stable</emphasis>, <emphasis>unstable</emphasis> and possibly
-<emphasis>experimental</emphasis> distributions, along with the other benefits
+for <literal>stable</literal>, <literal>unstable</literal> and possibly
+<literal>experimental</literal> distributions, along with the other benefits
 of a version control system.
 </para>
 </section>
 of a version control system.
 </para>
 </section>
@@ -315,8 +267,8 @@ environment.
 It can use chrooted environments as well.  It can be used stand-alone, or as
 part of a networked, distributed build environment.  As the latter, it is part
 of the system used by porters to build binary packages for all the available
 It can use chrooted environments as well.  It can be used stand-alone, or as
 part of a networked, distributed build environment.  As the latter, it is part
 of the system used by porters to build binary packages for all the available
-architectures.  See <xref linkend="buildd"/> for more information, and <ulink
-url="&url-buildd;"></ulink> to see the system in action.
+architectures.  See <xref linkend="wanna-build"/> for more information, and 
+<ulink url="&url-buildd;"></ulink> to see the system in action.
 </para>
 </section>
 
 </para>
 </section>
 
@@ -351,10 +303,10 @@ signature and checksums before uploading, and the possibility of running
 </section>
 
 <section id="dcut">
 </section>
 
 <section id="dcut">
-<title><systemitem role="package">dcut</systemitem></title>
+<title><command>dcut</command></title>
 <para>
 <para>
-The <systemitem role="package">dcut</systemitem> script (part of the package
-<xref linkend="dput"/> ) helps in removing files from the ftp upload directory.
+The <command>dcut</command> script (part of the package <systemitem role="package">dput</systemitem>,
+<xref linkend="dput"/>) helps in removing files from the ftp upload directory.
 </para>
 </section>
 
 </para>
 </section>
 
@@ -445,10 +397,10 @@ latest entry in a <filename>debian/changelog</filename> file.
 </section>
 
 <section id="dpkg-depcheck">
 </section>
 
 <section id="dpkg-depcheck">
-<title><systemitem role="package">dpkg-depcheck</systemitem></title>
+<title><command>dpkg-depcheck</command></title>
 <para>
 <command>dpkg-depcheck</command> (from the <systemitem
 <para>
 <command>dpkg-depcheck</command> (from the <systemitem
-role="package">devscripts</systemitem> package, <xref linkend="devscripts"/> )
+role="package">devscripts</systemitem> package, <xref linkend="devscripts"/>)
 runs a command under <command>strace</command> to determine all the packages
 that were used by the said command.
 </para>
 runs a command under <command>strace</command> to determine all the packages
 that were used by the said command.
 </para>
@@ -463,7 +415,9 @@ dpkg-depcheck -b debian/rules build
 </screen>
 <para>
 <command>dpkg-depcheck</command> can also be used to check for run-time
 </screen>
 <para>
 <command>dpkg-depcheck</command> can also be used to check for run-time
-dependencies, especially if your package uses exec(2) to run other programs.
+dependencies, especially if your package uses <citerefentry>
+<refentrytitle>exec</refentrytitle> <manvolnum>2</manvolnum> </citerefentry>
+to run other programs.
 </para>
 <para>
 For more information please see <citerefentry>
 </para>
 <para>
 For more information please see <citerefentry>
@@ -508,12 +462,40 @@ enhanced to support cross-compiling.
 The following packages provide information for maintainers or help with
 building documentation.
 </para>
 The following packages provide information for maintainers or help with
 building documentation.
 </para>
+
+<section id="docbook-xml">
+<title><systemitem role="package">docbook-xml</systemitem></title>
+<para>
+<systemitem role="package">docbook-xml</systemitem> provides the
+DocBook XML DTDs, which are commonly used for Debian documentation (as
+is the older debiandoc SGML DTD). This manual, for instance, is
+written in DocBook XML.
+</para>
+<para>
+The <systemitem role="package">docbook-xsl</systemitem> package
+provides the XSL files for building and styling the source to various
+output formats. You will need an XSLT processor, such as <systemitem
+role="package">xsltproc</systemitem>, to use the XSL stylesheets.
+Documentation for the stylesheets can be found in the various
+<systemitem role="package">docbook-xsl-doc-*</systemitem> packages.
+</para>
+<para>
+To produce PDF from FO, you need an FO processor, such as <systemitem
+role="package">xmlroff</systemitem> or <systemitem
+role="package">fop</systemitem>. Another tool to generate PDF from
+DocBook XML is <systemitem role="package">dblatex</systemitem>.
+</para>
+</section>
+
 <section id="debiandoc-sgml">
 <title><systemitem role="package">debiandoc-sgml</systemitem></title>
 <para>
 <systemitem role="package">debiandoc-sgml</systemitem> provides the DebianDoc
 <section id="debiandoc-sgml">
 <title><systemitem role="package">debiandoc-sgml</systemitem></title>
 <para>
 <systemitem role="package">debiandoc-sgml</systemitem> provides the DebianDoc
-SGML DTD, which is commonly used for Debian documentation.  This manual, for
-instance, is written in DebianDoc.  It also provides scripts for building and
+SGML DTD, which is commonly used for Debian documentation,
+but is now deprecated
+(<systemitem role="package">docbook-xml</systemitem>
+should be used instead).
+It also provides scripts for building and
 styling the source to various output formats.
 </para>
 <para>
 styling the source to various output formats.
 </para>
 <para>
@@ -521,22 +503,6 @@ Documentation for the DTD can be found in the <systemitem
 role="package">debiandoc-sgml-doc</systemitem> package.
 </para>
 </section>
 role="package">debiandoc-sgml-doc</systemitem> package.
 </para>
 </section>
-<!-- TODO: Maybe better:
-<section id="docbook-xml">
-<title><systemitem role="package">docbook-xml</systemitem></title>
-<para>
-<systemitem role="package">docbook-xml</systemitem> provides the
-DocBook XML DTDs, which are commonly used for Debian documentation (as
-is the older debiandoc SGML DTD). This manual, for instance, is written
-in DocBook XML. The <systemitem
-role="package">docbook-xsl</systemitem> package provides the XSL files
-for building and styling the source to various output formats. You
-will need an XSLT processor, such as <systemitem
-role="package">xsltproc</systemitem>, and an FO processor, such as
-<systemitem role="package">fop</systemitem>, to generate documentation.
-</para>
-</section>
--->
 
 <section id="debian-keyring">
 <title><systemitem role="package">debian-keyring</systemitem></title>
 
 <section id="debian-keyring">
 <title><systemitem role="package">debian-keyring</systemitem></title>
@@ -546,6 +512,14 @@ linkend="key-maint"/> and the package documentation for more information.
 </para>
 </section>
 
 </para>
 </section>
 
+<section id="debian-maintainers">
+<title><systemitem role="package">debian-maintainers</systemitem></title>
+<para>
+Contains the public GPG keys of Debian Maintainers.
+See <ulink url="&url-wiki-dm;"></ulink> for more information.
+</para>
+</section>
+
 <section id="debview">
 <title><systemitem role="package">debview</systemitem></title>
 <para>
 <section id="debview">
 <title><systemitem role="package">debview</systemitem></title>
 <para>