'\" t
.\" Title: po4a-build
.\" Author: [see the "Autor" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1
.\" Date: 21.08.2013
.\" Manual: PO4A
.\" Source: PO4A
.\" Language: German
.\"
.TH "PO4A\-BUILD" "1" "21.08.2013" "PO4A" "PO4A"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
po4a-build \- \(:ubersetzte Dokumentation erstellen
.SH "\(:UBERSICHT"
.HP \w'\fBpo4a\-build\fR\ 'u
\fBpo4a\-build\fR [\fB\-f\fR | \fB\-\-file\fR\fI
DATEI\fR] [\fB\-\-pot\-only\fR]
.HP \w'\fBpo4a\-build\fR\ 'u
\fBpo4a\-build\fR [\fB\-?\fR | \fB\-h\fR | \fB\-\-help\fR | \fB\-\-version\fR]
.SH "BESCHREIBUNG"
.PP
\fBpo4a\-build\fR
ist f\(:ur die leichte Erstellung \(:ubersetzter Dokumentation gedacht, da es den derzeitigen un\(:ubersetzten Inhalt erstellen kann\&.
.PP
Wenn
\fBpo4a\fR
den \(:ubersetzten Inhalt als POD oder DocBook XML vorbereitet, kann die endg\(:ultige Dokumentation mit
\fBpo4a\-build\fR
erstellt werden\&. Sowohl der \(:ubersetzte als auch der un\(:ubersetzte Inhalt wird in einem Durchgang gebaut, gleichzeitig wird die POT\-Datei aktualisiert\&.
.PP
Bestehende Erstellungsanweisungen werden durch einen einzelnen Aufruf von
\fBpo4a\-build\fR
ersetzt und eine einfache Konfigurationsdatei wird verwandt, um
\fBpo4a\-build\fR
mitzuteilen, wie jedes Element erstellt wird und welche bin\(:aren Pakete die \(:ubersetzten und un\(:ubersetzten Inhalte enthalten werden\&.
.PP
Nach der Erstellung befindet sich der Inhalt in Paket\-spezifischen Verzeichnissen unterhalb des in der Konfigurationsdatei angegebenen
\fBBASEDIR\fR\&. F\(:ur ein Bin\(:arpaket foo, mit \(:Ubersetzungen nach Deutsch und Franz\(:osisch, entst\(:unde damit Folgendes:
.sp
.if n \{\
.RS 4
.\}
.nf
BASEDIR/foo/man/man1/foo\&.1
BASEDIR/foo/man/de/man1/foo\&.1
BASEDIR/foo/man/fr/man1/foo\&.1
.fi
.if n \{\
.RE
.\}
.PP
Damit kann leicht der gesamte erstellte Inhalt mit einer einzigen Install\-Angabe in das Bin\(:arpaket aufgenommen werden:
.sp
.if n \{\
.RS 4
.\}
.nf
doc/foo/man/* \&./usr/share/man/
doc/foo/html/* \&./usr/share/doc/foo/
.fi
.if n \{\
.RE
.\}
.PP
Diese Regel muss nicht aktualisiert werden, wenn neue \(:Ubersetzungen hinzugef\(:ugt werden und wird ein zweites Bin\(:arpaket (bar) hinzugef\(:ugt, kann der Inhalt f\(:ur dieses Paket getrennt gehalten werden\&.
.SS "Unterst\(:utzte Formate"
.PP
Derzeit unterst\(:utzt
\fBpo4a\-build\fR
die folgenden Kombinationen:
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 1." 4.2
.\}
DocBook XML f\(:ur Abschnitt 1
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 2." 4.2
.\}
DocBook XML f\(:ur Abschnitt 3
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 3.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 3." 4.2
.\}
DocBook XML f\(:ur HTML
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 4.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 4." 4.2
.\}
POD f\(:ur Abschnitt 1
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 5.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 5." 4.2
.\}
POD f\(:ur Abschnitt 3
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 6.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 6." 4.2
.\}
POD f\(:ur Abschnitt 5
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 7.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 7." 4.2
.\}
POD f\(:ur Abschnitt 7
.RE
.PP
Alle unterst\(:utzen Formate, in allen unterst\(:utzten Kombinationen, k\(:onnen in einer einzigen Konfigurationsdatei
po4a\-build\&.conf
und in einem einzigen Aufruf von
\fBpo4a\-build\fR
vereint werden\&. Lesen Sie
\fBpo4a-build.conf\fR(5)\&.
.SH "KONFIGURATION"
.PP
\fBpo4a\-build\fR
verwendet eine Standardkonfigurationsdatei
po4a\-build\&.conf, die sich in dem obersten Verzeichnis des VCS Ihres Paketes befinden sollte\&. (Verwenden Sie die Option
\fB\-f\fR, um eine andere Datei anzugeben\&.) Siehe
\fBpo4a-build.conf\fR(5)\&.
.PP
\fBBeispiel 1. Beispielkonfigurationsdatei\fR
.PP
Eine Beispielkonfigurationsdatei ist an folgender Stelle verf\(:ugbar:
.sp
.if n \{\
.RS 4
.\}
.nf
/usr/share/doc/po4a/examples/po4a\-build\&.conf\&.example
.fi
.if n \{\
.RE
.\}
.SS "Aufbau der Konfigurationsdatei"
.PP
Die Konfigurationsdatei besteht aus verschiedenen Abschnitten: general, XML/XSL support, POD support und HTML support\&.
.PP
\(FcGeneral\(Fo enth\(:alt den Namen und Ablageort der Po4a\-Konfigurationsdatei (am besten bei
po4a\&.config
zu belassen), das PO\-Verzeichnis, das die PO\-Dokumentationsdateien enth\(:alt (oft
doc/po), den vollen Namen der zu Erstellung der \(:Ubersetzung verwandten POT\-Datei, das BASEDIR f\(:ur die erstellte Ausgabe, ob das Paket Handbuchseiten in Abschnitt 3, statt blo\(ss Abschnitt 1 enth\(:alt und die Namen der Bin\(:arpakete, die die erstellten Ausgaben enthalten sollen\&.
.PP
\(FcXML/XSL support\(Fo enth\(:alt die Angabe, welches der Bin\(:arpakete XML\-Unterst\(:utzung in der XMLPACKAGES\-Variablen enth\(:alt, die oberste DocBook\-Datei, die an
\fBxsltproc\fR
\(:ubergeben werden soll und den Ablageort der XML\- oder DocBook\-Dateien\&. Falls notwendig, kann XSLFILE \(:uberschrieben werden\&.
.PP
\(FcPOD support\(Fo enth\(:alt die Angabe, welches der Bin\(:arpakete die POD\-Unterst\(:utzung in der PODPACKAGES\-Variablen enth\(:alt und den kompletten Namen der POD\-Datei\&.
.PP
\(FcHTML support\(Fo gibt das Unterverzeichnis an, das unterhalb von BASEDIR f\(:ur den un\(:ubersetzten und den \(:ubersetzten HTML\-Inhalt und f\(:ur die DocBook\-Datei, die das HTML erstellt, erstellt werden soll\&. Falls notwendig, kann die HTMLXSL\-Datei \(:uberschrieben werden\&.
.SH "BEFEHLE"
.PP
\fB\-\-pot\-only\fR
.RS 4
Aktualisiert nur die POT\-Datei(en)\&.
\fB\-\-pot\-only\fR
ist zur Unterst\(:utzung von Paketen gedacht, die alle POT\-Dateien in den Paketquellen enthalten\&. Pakete, die die Autotools verwenden, k\(:onnen die POT\-Dateien leicht mittels EXTRA_DIST hinzuf\(:ugen, aber Pakete, die nur eine Makefile oder bestimmte VCS\-Bau\-Hilfsprogramme verwenden, k\(:onnen es als komisch empfinden, die POT\-Datei hinzuzuf\(:ugen (da es eine generierte Datei ist), ohne die POT\-Datei in das VCS aufzunehmen\&. Um diese h\(:assliche und unn\(:otige Arbeit zu vermeiden, kann
\fBpo4a\-build\fR
die POT\-Datei(en) am Beginn des Paketbaus aktualisieren, so dass
\fBdpkg\-source\fR
sie in den Quell\-Tarball aufnimmt\&.
.PP
\fBBeispiel 2. svn-buildpackage-Beispiel\fR
.PP
\fBsvn\-buildpackage\fR
unterst\(:utzt explizit diese Art von Zusatz, die mit der SVN\-Eigenschaft
\fBuseNativeDist\fR
und dem Make\-Ziel
\fBnative\-dist\fR
verwandt wird\&.
.sp
.if n \{\
.RS 4
.\}
.nf
# f\(:ugt die POT\-Datei zum Quell\-Tarball hinzu
native\-dist: Makefile
po4a\-build \-\-pot\-only
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
$ svn propset useNativeDist 1 debian
.fi
.if n \{\
.RE
.\}
.RE
.PP
\fB\-h\fR|\fB\-\-help\fR
.RS 4
Benutzungshinweis ausgeben und Programm beenden
.RE
.PP
\fB\-\-version\fR
.RS 4
Benutzungshinweis ausgeben und Programm beenden
.RE
.SH "OPTIONEN"
.PP
\fB\-f\fR|\fB\-\-file\fR\fI DATEI\fR
.RS 4
Angabe einer eigenen Konfigurationsdatei statt der standardm\(:a\(ssigen Datei (po4a\-build\&.conf)\&.
.RE
.SH "AUTOR"
.PP
\fBpo4a\-build\fR
wurde von Neil Williams
geschrieben\&.
.PP
Diese Handbuchseite wurde von Neil Williams
geschrieben\&.