Now everything builds. Translators needed!

[developers-reference.git] / tools.dbk

diff --git a/tools.dbk b/tools.dbk
index 7f18532b7a5732b7fbeac4265c9fca3ee915d719..7f6264824884f7aff730e212966bc8c34e9b35bd 100644 (file)
--- a/tools.dbk
+++ b/tools.dbk
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
-    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+  <!ENTITY % commondata SYSTEM "common.ent" > %commondata;
+]>
 <appendix id="tools">
 <title>Overview of Debian Maintainer Tools</title>
 <para>
@@ -24,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
-<literal>apt-cache show &lt;package-name&gt;</literal>.
+<command>apt-cache show &lt;package-name&gt;</command>.
 </para>
 <section id="tools-core">
 <title>Core tools</title>
@@ -104,7 +106,7 @@ use Lintian.
 </para>
 <para>
 You can also see a summary of all problems reported by Lintian on your packages
-at <ulink url="http://lintian.debian.org/"></ulink>.  These reports contain the
+at <ulink url="&url-lintian;"></ulink>.  These reports contain the
 latest <command>lintian</command> output for the whole development distribution
 (unstable).
 </para>
@@ -134,13 +136,13 @@ help you prevent various accidents.
 You can run it over a pair of binary packages:
 </para>
 <screen>
- package_1-1_arch.deb package_2-1_arch.deb
+debdiff package_1-1_arch.deb package_2-1_arch.deb
 </screen>
 <para>
 Or even a pair of changes files:
 </para>
 <screen>
- package_1-1_arch.changes package_2-1_arch.changes
+debdiff package_1-1_arch.changes package_2-1_arch.changes
 </screen>
 <para>
 For more information please see <citerefentry>
@@ -314,7 +316,7 @@ 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="http://buildd.debian.org/"></ulink> to see the system in action.
+url="&url-buildd;"></ulink> to see the system in action.
 </para>
 </section>
 
@@ -457,7 +459,7 @@ process through <command>dpkg-depcheck</command> will provide you with a good
 first approximation of the build-dependencies.  For example:
 </para>
 <screen>
--depcheck -b debian/rules build
+dpkg-depcheck -b debian/rules build
 </screen>
 <para>
 <command>dpkg-depcheck</command> can also be used to check for run-time
@@ -519,6 +521,22 @@ Documentation for the DTD can be found in the <systemitem
 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>
@@ -538,6 +556,28 @@ unpacking it.
 </section>
 
 </section>
-
+<!-- FIXME: add the following
+
+questionable:
+  dbs (referred to above)
+  dpatch (referred to above)
+  debarchiver
+  ucf
+  dpkg-awk
+  grep-dctrl
+  d-shlibs
+  wajig
+  magpie
+  apt-dpkg-ref
+  apt-show-source
+  apt-show-versions
+  pdbv
+  epm
+  apt-src
+  apt-build
+
+rejected:
+  debaux: too new, unmaintained?
+  dh-make-perl: too new, unmaintained?
+-->
 </appendix>
-