aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authordancer <dancer>2006-03-07 17:46:30 +0000
committerdancer <dancer>2006-03-07 17:46:30 +0000
commit198eaed07600d75b2e58138c526e7dec78b4e38d (patch)
tree6d040470e6a7ec15fd42070bfb9c694407062327 /Documentation
parenta031cc5429e7a2ad14e3003f835f62d501f4eb90 (diff)
downloadpbuilder-198eaed07600d75b2e58138c526e7dec78b4e38d.tar
pbuilder-198eaed07600d75b2e58138c526e7dec78b4e38d.tar.gz
documentation update, and add hooks to generate PDF documentation for pbuilder.
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/.cvsignore6
-rw-r--r--Documentation/Makefile19
-rw-r--r--Documentation/debian-latex.xsl71
-rw-r--r--Documentation/pbuilder-doc.xml11
4 files changed, 101 insertions, 6 deletions
diff --git a/Documentation/.cvsignore b/Documentation/.cvsignore
index 420bf36..2a05a58 100644
--- a/Documentation/.cvsignore
+++ b/Documentation/.cvsignore
@@ -1 +1,7 @@
+pbuilder-doc.aux
+pbuilder-doc.glo
pbuilder-doc.html
+pbuilder-doc.idx
+pbuilder-doc.log
+pbuilder-doc.out
+pbuilder-doc.pdf
diff --git a/Documentation/Makefile b/Documentation/Makefile
index d0bd5ad..850542a 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -11,6 +11,15 @@ all: pbuilder-doc.html
xsltproc pbuilder-doc.xsl $< > $@.tmp
mv $@.tmp $@
+%.tex: %.xml debian-latex.xsl
+ ## requires db2latex-xsl and xsltproc package.
+ xsltproc --nonet --novalid --xinclude debian-latex.xsl $< > $@.tmp
+ mv $@.tmp $@
+
+%.pdf: %.tex
+ pdflatex $<
+ pdflatex $<
+
install: pbuilder-doc.html
install -d -m 755 -o root -g root $(DESTDIR)/usr/share/doc/pbuilder/
install -m 644 -o root -g root pbuilder-doc.html $(DESTDIR)/usr/share/doc/pbuilder/
@@ -18,12 +27,16 @@ install: pbuilder-doc.html
preview: pbuilder-doc.html
mozilla-firefox -remote "openfile($(PWD)/$<)"
-release: pbuilder-doc.html pbuilder-doc.xml pbuilder-doc.css pbuilder-doc.xsl
+release: pbuilder-doc.html pbuilder-doc.xml pbuilder-doc.css pbuilder-doc.xsl pbuilder-doc.pdf
scp $^ cvs.alioth.debian.org:/org/alioth.debian.org/chroot/home/groups/pbuilder/htdocs/
+ $(MAKE) release-netfort
# for my homepage-publishing.
-release-netfort: pbuilder-doc.html pbuilder-doc.xml pbuilder-doc.css pbuilder-doc.xsl
+release-netfort: pbuilder-doc.html pbuilder-doc.xml pbuilder-doc.css pbuilder-doc.xsl pbuilder-doc.pdf
cp $^ ~/public_html/netfort/software/pbuilder-doc/
+clean:
+ -rm pbuilder-doc.pdf pbuilder-doc.glo pbuilder-doc.idx pbuilder-doc.log pbuilder-doc.out
+
-.PHONY: preview release-netfort release \ No newline at end of file
+.PHONY: preview release-netfort release clean \ No newline at end of file
diff --git a/Documentation/debian-latex.xsl b/Documentation/debian-latex.xsl
new file mode 100644
index 0000000..6a16b5f
--- /dev/null
+++ b/Documentation/debian-latex.xsl
@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
+
+ <xsl:import href="http://db2latex.sourceforge.net/xsl/docbook.xsl"/>
+ <!-- xsl:import
+ href="/usr/share/sgml/docbook/stylesheet/xsl/db2latex/latex/docbook.xsl"/ -->
+
+ <xsl:param name="admon.graphics.path">/usr/share/xml/docbook/stylesheet/db2latex/latex/figures</xsl:param>
+ <xsl:param name="latex.document.font">default</xsl:param>
+ <xsl:param name="latex.documentclass.article">10pt,a4paper,onecolumn,twoside</xsl:param>
+ <xsl:param name="latex.graphics.formats">PDF</xsl:param>
+ <xsl:param name="latex.hyperref.param.dvips">1</xsl:param>
+ <xsl:param name="latex.inputenc">latin1</xsl:param> <!-- this doesn't look correct, but anyway -->
+ <xsl:param name="latex.pdf.support">1</xsl:param>
+ <xsl:param name="latex.use.fancybox">1</xsl:param>
+ <xsl:param name="latex.use.fancyhdr">1</xsl:param>
+ <xsl:param name="latex.use.fancyvrb">1</xsl:param>
+ <xsl:param name="latex.use.hyperref">1</xsl:param>
+ <xsl:param name="latex.use.parskip">1</xsl:param>
+ <xsl:param name="latex.use.tabularx">1</xsl:param>
+
+ <xsl:variable name="latex.hyperref.param.pdftex">
+ pdfauthor={<xsl:value-of
+ select="/book/bookinfo/editor/firstname"/> <xsl:value-of
+ select="/book/bookinfo/editor/surname"/>},
+ pdfpagemode=UseNone,
+ pdftitle={<xsl:value-of select="/book/bookinfo/title"/>},
+ pdfpagelabels,
+ pdfsubject={<xsl:value-of select="/book/bookinfo/subtitle"/>},
+ pdfkeywords={<xsl:call-template name="keyword-list"/>},
+ pdfcreator={DocBook/XML db2latex-xsl},
+ pdfstartview=FitH
+ </xsl:variable>
+
+ <xsl:variable name="latex.book.preamble.post">
+ <xsl:text>
+ \pagestyle{fancy}
+ \rhead[\leftmark]{}
+ \lhead[]{\rightmark}
+ \sloppy
+ </xsl:text>
+ </xsl:variable>
+
+ <xsl:template name="keyword-list">
+ <xsl:for-each select="/book/bookinfo/keywordset/keyword">
+ <xsl:value-of select="."/>
+ <xsl:if test="position()!=last()">
+ <xsl:text>, </xsl:text>
+ </xsl:if>
+ </xsl:for-each>
+ </xsl:template>
+
+ <!-- I'm probably missing something here, I don't know why -->
+ <xsl:template name="debian">
+ \begin{center}
+ \includegraphics[height=2cm]{openlogo-nd.pdf} \\
+ \texttt{http://www.debian.org/}
+ \end{center}
+ </xsl:template>
+
+ <xsl:template match="book/title">
+ </xsl:template>
+
+ <xsl:template match="book/bookinfo"
+ mode="standalone.book">
+ <xsl:call-template name="debian"/>
+ <xsl:apply-templates select="keywordset" />
+ <xsl:apply-templates select="legalnotice" />
+ <xsl:apply-templates select="abstract"/>
+ </xsl:template>
+</xsl:stylesheet>
diff --git a/Documentation/pbuilder-doc.xml b/Documentation/pbuilder-doc.xml
index 34bea20..da89dc3 100644
--- a/Documentation/pbuilder-doc.xml
+++ b/Documentation/pbuilder-doc.xml
@@ -2,9 +2,9 @@
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "/usr/share/sgml/docbook/dtd/xml/4.2/docbookx.dtd">
<!-- the original of this documentation is in pbuilder source tar-ball,
and the latest version is found in CVS repository. -->
-<book>
+<book xml:lang="en">
<bookinfo>
- <date>2005-11-03</date>
+ <date>2006-3-8</date>
<title>pbuilder User's Manual</title>
<abbrev>pbuilder-doc</abbrev>
<subtitle>Usage and operations</subtitle>
@@ -16,6 +16,7 @@
</author>
</authorgroup>
</bookinfo>
+
<!-- FIXME: consistent markup of commands, files, and variables -->
<chapter>
<title>Introducing pbuilder</title>
@@ -1038,7 +1039,7 @@ $ sudo pbuilder update --hookdir ~/loginhooks/E10shell
</para>
<para>
<screen>
-<command>pbuilder create --distribution sid --debootstrapopts "--arch=i386" --basetgz /var/cache/pbuilder/base-i386.tgz --mirror http://ftp.jp.debian.org/debian</command>
+<command>pbuilder create --distribution sid --debootstrapopts --arch --debootstrapopts i386 --basetgz /var/cache/pbuilder/base-i386.tgz --mirror http://ftp.jp.debian.org/debian</command>
<command>linux32 pbuilder build --basetgz /var/cache/pbuilder/base-i386.tgz</command>
</screen>
</para>
@@ -1245,6 +1246,8 @@ cvs -z3 -d:pserver:anonymous@cvs.alioth.debian.org:/cvsroot/pbuilder co pbuilder
<table>
<title>Directory Structure outside the chroot </title>
<tgroup cols="2">
+ <colspec colnum="1" colname="c1" colwidth="1*" align="left" />
+ <colspec colnum="2" colname="c2" colwidth="1*" align="left" />
<thead>
<row>
<entry>Directory</entry>
@@ -1307,6 +1310,8 @@ cvs -z3 -d:pserver:anonymous@cvs.alioth.debian.org:/cvsroot/pbuilder co pbuilder
<table>
<title>Directory Structure inside the chroot </title>
<tgroup cols="2">
+ <colspec colnum="1" colname="c1" colwidth="1*" align="left" />
+ <colspec colnum="2" colname="c2" colwidth="1*" align="left" />
<thead>
<row>
<entry>Directory</entry>