.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "PO4A-BUILD.CONF 5"
.TH PO4A-BUILD.CONF 5 "2018-05-27" "Po4a-Werkzeuge" "Po4a-Werkzeuge"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
po4a\-build.conf \- Konfigurationsdatei zur Erstellung übersetzter Inhalte
.SH "Einleitung"
.IX Header "Einleitung"
\&\fIpo4a\-build.conf\fR beschreibt, wie \f(CW\*(C`po4a\-build\*(C'\fR die übersetzte und die
unübersetzte Dokumentation aus einer Sammlung an Quelldokumenten und
zugehörigen PO-Dateien bauen soll.
.PP
Alle unterstützten Formate in allen unterstützten Kombinationen können in
einer einzigen Konfigurationsdatei \fIpo4a\-build.conf\fR und mit einem einzigen
Aufruf von \f(CW\*(C`po4a\-build\*(C'\fR verwandt werden. Sie können sich aber auch dafür
entscheiden, die \fIpo/\fR\-Verzeichnisse zu trennen und eine einzelne
Konfigurationsdatei für jeden Aufruf zu verwenden. (Rufen Sie \f(CW\*(C`po4a\-build
\&\-f DATEI\*(C'\fR für jede Konfigurationsdatei auf.)
.PP
Beachten Sie, dass \fIpo4a\-build\fR zwar Unterstützung für das Hinzufügen von
Gettext\-Unterstützung zur Übersetzung von Skriptausgabenachrichten enthält,
allerdings \fIpo4a\-build.conf\fR keinen Einfluss auf solche Übersetzungen
hat. \fIpo4a\-build.conf\fR ist nur für die Übersetzung von statischen Inhalten
wie Handbuchseiten zuständig.
.PP
Für Informationen über die Unterstützung der Übersetzung von Nachrichten zur
Programmlaufzeit durch \fIpo4a\-build\fR lesen Sie \fIpo4a\-runtime\fR\|(7).
.SH "Unterstützte Formate"
.IX Header "Unterstützte Formate"
Derzeit unterstützt \f(CW\*(C`po4a\-build\*(C'\fR die folgenden Kombinationen:
.IP "DocBook \s-1XML\s0 für Abschnitt 1 und 3" 4
.IX Item "DocBook XML für Abschnitt 1 und 3"
Typischerweise für Handbuchseiten für Shell-Skripte oder andere Interpreter
verwandt, die über keine eigenen Dokumentationsformate wie \s-1POD\s0
verfügen. Geeignetes \s-1XML\s0 kann direkt aus einer existierenden Handbuchseite
mittels \f(CW\*(C`doclifter\*(C'\fR(1) erstellt werden und \f(CW\*(C`po4a\-build\*(C'\fR wird dann eine
POT-Datei ohne zusätzlichen Arbeitsaufwand generiert. Die POT-Datei kann
dann zur Übersetzung angeboten und die PO-Dateien dem relevanten
\&\fIpo/\fR\-Verzeichnis hinzugefügt werden. \f(CW\*(C`po4a\-build\*(C'\fR wird dann nicht nur die
unübersetzte Handbuchseite aus dem \f(CW\*(C`doclifter\*(C'\fR\-XML erstellen, sondern auch
\&\f(CW\*(C`po4a\*(C'\fR verwenden, um übersetztes \s-1XML\s0 aus der PO-Datei zu generieren und
dann die übersetzten Handbuchseiten aus dem \s-1XML\s0 zu bauen.
.Sp
Handbuchseiten werden mit der standardmäßigen Unterstützung in Docbook-xsl
gebaut \- das zu verwendende Stylesheet kann mit der \f(CW\*(C`XSLFILE\*(C'\fR\-Einstellung
in der Konfigurationsdatei \f(CW\*(C`po4a\-build\*(C'\fR überschrieben werden.
.IP "DocBook \s-1XML\s0 für \s-1HTML\s0" 4
.IX Item "DocBook XML für HTML"
Das standardmäßige Stylesheet, das zur Erstellung des abschließenden HTMLs
verwandt wird, kann mit der Einstellung \f(CW\*(C`HTMLXSL\*(C'\fR in der
Konfigurationsdatei \f(CW\*(C`po4a\-build\*(C'\fR überschrieben werden.
.IP "\s-1POD\s0 für Abschnitt 1, 3, 5 und 7" 4
.IX Item "POD für Abschnitt 1, 3, 5 und 7"
Pod2man wird zum Konvertieren von POD-Inhalten für jeden unterstützten
Abschnitt verwandt.
.Sp
Verwenden Sie \f(CW\*(C`PODFILE\*(C'\fR für Abschnitt 1, \f(CW\*(C`PODMODULES\*(C'\fR für Abschnitt 3,
\&\f(CW\*(C`POD5FILES\*(C'\fR für Abschnitt 5 und \f(CW\*(C`POD7FILES\*(C'\fR für Abschnitt 7.
.Sp
Für Inhalte in den Abschnitten 5 oder 7 (wo oft ein Dateiname benötigt wird,
der auch für Inhalte in Abschnitt 1 verwandt wird) wird, wenn der Dateiname
»5« oder »7« als Teil des Dateinamens enthält, diese Nummer (und alle
Dateinamenerweiterungen) automatisch entfernt.
.Sp
Wird z.B. \fI/usr/share/man/man7/po4a.7.gz\fR vorbereitet:
.Sp
.Vb 2
\& # POD\-Dateien für Abschnitt 7
\& POD7FILES="doc/po4a.7.pod"
.Ve
.SH "Dateiinhalte"
.IX Header "Dateiinhalte"
Konfigurationswerte können in jeder Reihenfolge in der Konfigurationsdatei
auftauchen.
.PP
Alle Inhalte nach einem »#« werden ignoriert.
.PP
Jeder Wert, der immer leer wäre, kann aus der Datei entfallen.
.PP
Einige Konfigurationsfelder müssen angegeben werden \- \fIpo4a\-build\fR könnte
im Nichts enden, falls erforderliche Felder leer sind.
.IP "\s-1CONFIG\s0" 4
.IX Item "CONFIG"
Erforderlich
.Sp
Name und Ort der (temporären) \f(CW\*(C`po4a\*(C'\fR\-Konfigurationsdatei, die \f(CW\*(C`po4a\-build\*(C'\fR
erstellen und verwalten wird. Diese Datei muss nicht in Ihrem
Versionskontrollsystem gepflegt werden und kann während der Paketerstellung
problemlos aufgeräumt werden.
.Sp
.Vb 2
\& # Name und Ort der Konfigurationsdatei
\& CONFIG="_build/po4a.config"
.Ve
.IP "\s-1PODIR\s0" 4
.IX Item "PODIR"
Erforderlich
.Sp
Verzeichnis, das die PO-Dateien für \s-1ALLE\s0 Übersetzungen enthält, die von
dieser Konfigurationsdatei verarbeitet werden. Alle Zeichenketten werden in
eine POT-Datei in diesem Verzeichnis zusammengeführt und alle PO-Dateien
werden mit dieser POT-Datei zusammengeführt. »KEEP«\-Schwellwerte (siehe
unten) werden auf alle Zeichenketten von allen in dieser Datei angegebenen
Eingabedateien und allen PO-Dateien in diesem Verzeichnis angewandt. Das
Verzeichnis muss nicht »po« heißen. Bitte beachten Sie allerdings, dass
einige Statistikwerkzeuge erwarten, dass der Name »po« lauten sollte, daher
wird empfohlen, diesen Namen beizubehalten.
.Sp
.Vb 2
\& # PO\-Verzeichnis für Handbuchseiten/Dokumentation
\& PODIR="po/pod"
.Ve
.IP "\s-1POTFILE\s0" 4
.IX Item "POTFILE"
Erforderlich
.Sp
Pfad zur POT-Datei (relativ zu der Lage dieser Konfigurationsdatei), die
durch \f(CW\*(C`po4a\-build\*(C'\fR für diese Übersetzung erstellt, gewartet und
aktualisiert wird.
.Sp
.Vb 2
\& # POT\-Dateipfad
\& POTFILE="po/pod/po4a\-pod.pot"
.Ve
.IP "\s-1BASEDIR\s0" 4
.IX Item "BASEDIR"
Erforderlich
.Sp
Basisverzeichnis zum Schreiben der übersetzten Inhalte.
.Sp
.Vb 2
\& # Basisverzeichnis für erstellte Dateien, z.B. dok
\& BASEDIR="_build"
.Ve
.IP "\s-1BINARIES\s0" 4
.IX Item "BINARIES"
Erforderlich
.Sp
Selbst falls nur ein Paket gebaut wird, wird mindestens ein Wert hier
benötigt.
.Sp
Die Zeichenkette ist beliebig, besteht aber typischerweise aus dem
Paketnamen. Erstellte Inhalte werden dann in Unterverzeichnissen von
\&\fI\s-1BASEDIR/BINARIES\s0\fR gespeichert:
.Sp
.Vb 1
\& _build/po4a/man/man1/foo.1
.Ve
.Sp
Falls das Paket mehr als ein Binärpaket baut (d.h. ein Quellpaket und
mehrere .deb\- oder .rpm\-Dateien), kann dieses Feld dabei helfen, Inhalte für
jedes Ziel abzugrenzen und damit die Automatisierung des Bauprozesses zu
erleichtern.
.Sp
Zeichenketten mit Leerzeichen trennen.
.Sp
.Vb 2
\& # Binärpakete, die erstellte Handbuchseiten enthalten werden
\& BINARIES="po4a"
.Ve
.IP "\s-1KEEP\s0" 4
.IX Item "KEEP"
Wert, der direkt an \f(CW\*(C`po4a \-k\*(C'\fR übergeben wird, um den Schwellwert für den
korrekt übersetzten Inhalt anzugeben, bevor eine bestimmte Übersetzung beim
Bauen ausgeschlossen wird. Lassen Sie dies leer oder entfernen Sie es, um
den Standardwert (80%) zu verwenden oder geben Sie Null an, um allen Inhalt
aufzunehmen, selbst falls er vollständig unübersetzt ist.
.Sp
Für vollständige Kontrolle über dieses Verhalten, beachten Sie sorgfältig,
welche Dateien welcher Konfigurationsdatei \fIpo4a\-build.conf\fR zugeordnet
sind.
.Sp
Beachten Sie, dass viele Dateien in einer POT-Datei für Übersetzer bequemer
sind, insbesondere falls Dateien über gemeinsame Zeichenketten
verfügen. Andersherum sind POT-Dateien mit tausenden von langen
Zeichenketten für Übersetzer einschüchternd, woraus lange Perioden mit
eingefrorenen Zeichenketten resultieren.
.Sp
.Vb 2
\& # minimaler Schwellwert, ab dem Übersetzungen beibehalten werden sollen
\& KEEP=
.Ve
.IP "\s-1XMLMAN1\s0" 4
.IX Item "XMLMAN1"
DocBook-XML-Dateien, um Handbuchseiten in Abschnitt 1 zu erstellen. Trennen
Sie Dateinamen durch Leerzeichen. Alle Dateien müssen sich im
XMLDIR-Verzeichnis befinden.
.Sp
Es ist übliche Praxis, mehrere XML-Dateien in einem Buch zusammenzustellen,
um ein Inhaltsverzeichnis usw. bereitzustellen. Falls das Buch auch Dateien
enthält, die in \s-1XMLMAN3\s0 angegeben sind, dann geben Sie nur die XML-Dateien
für Abschnitt 1 hier an, nicht das Buch selbst. Falls das Buch nur Inhalte
für diesen Abschnitt enthält, geben Sie das Buch hier an.
.Sp
.Vb 2
\& # DocBook\-XML\-Dateien für Abschnitt 1
\& XMLMAN1="po4a\-build.xml po4aman\-display\-po.xml po4apod\-display\-po.xml"
.Ve
.IP "\s-1XMLMAN3\s0" 4
.IX Item "XMLMAN3"
DocBook-XML-Dateien, um Handbuchseiten in Abschnitt 3 zu erstellen. Trennen
Sie Dateinamen durch Leerzeichen. Alle Dateien müssen sich im
XMLDIR-Verzeichnis befinden.
.Sp
Es ist übliche Praxis, mehrere XML-Dateien in einem Buch zusammenzustellen,
um ein Inhaltsverzeichnis usw. bereitzustellen. Falls das Buch auch Dateien
enthält, die in \s-1XMLMAN1\s0 angegeben sind, dann geben Sie nur die XML-Dateien
für Abschnitt 3 hier an, nicht das Buch selbst. Falls das Buch nur Inhalte
für diesen Abschnitt enthält, geben Sie das Buch hier an.
.Sp
.Vb 2
\& # DocBook\-XML\-Dateien für Abschnitt 3
\& XMLMAN3=""
.Ve
.IP "\s-1XMLDIR\s0" 4
.IX Item "XMLDIR"
Ablageort aller DocBook-XML-Dateien. Derzeit erwartet \f(CW\*(C`po4a\-build\*(C'\fR, alle in
\&\s-1XMLMAN1\s0 und \s-1XMLMAN3\s0 aufgeführten Dateien zu finden, indem es nach *.xml in
diesem Verzeichnis sucht.
.Sp
Muss angegeben werden, falls \s-1XMLMAN1\s0 oder \s-1XMLMAN3\s0 verwandt wird. Pfade sind
relativ zum Ort der Konfigurationsdatei.
.Sp
.Vb 2
\& # Ort der XML\-Dateien
\& XMLDIR="share/doc/"
.Ve
.IP "\s-1XMLPACKAGES\s0" 4
.IX Item "XMLPACKAGES"
welche Pakete aus der Liste in \s-1BINARIES\s0 XML-Quellinhalte verwenden
.Sp
Falls \s-1XMLMAN1\s0 oder \s-1XMLMAN3\s0 ein Wert gegeben wird, muss hier auch ein Wert
angegeben werden.
.Sp
.Vb 2
\& # Binärpakete, die DocBook\-XML & xsltproc verwenden
\& XMLPACKAGES="po4a"
.Ve
.IP "\s-1DOCBOOKDIR\s0" 4
.IX Item "DOCBOOKDIR"
Ähnlich zu \s-1XMLDIR,\s0 aber nur für die Vorbereitung der übersetzten
DocBook-Dateien verwandt. Falls Ihr Paket .sgml\-Dateien verwenden soll,
diskutieren Sie bitte die Bauvorschriften auf der Mailingliste po4a\-devel.
.Sp
.Vb 2
\& # Muster zum Finden der .docbook\-Dateien
\& DOCBOOKDIR=""
.Ve
.IP "\s-1XSLFILE\s0" 4
.IX Item "XSLFILE"
XSL-Stylesheet, das zum Vorbereiten der übersetzten und nicht übersetzten
Inhalte aus den DocBook-XML-Dateien verwandt wird.
.Sp
.Vb 2
\& # XSL\-Datei für die Verwendung mit DocBook\-XML
\& XSLFILE="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"
.Ve
.IP "\s-1PODFILE\s0" 4
.IX Item "PODFILE"
POD-Dateien zur Erstellung von Handbuchseiten-Inhalten in Abschnitt
1. Trennen Sie POD-Dateien durch Leerzeichen. Pfade, falls verwandt, müssen
relativ zum Ort der angegebenen Konfigurationsdatei sein.
.Sp
.Vb 2
\& # POD\-Dateien für Abschnitt 1
\& PODFILE="po4a po4a\-gettextize po4a\-normalize scripts/msguntypot"
.Ve
.IP "\s-1PODMODULES\s0" 4
.IX Item "PODMODULES"
Spezialisierte Unterstützung für Perl-Module, die POD-Inhalte enthalten \-
der Modulname wird aus dem Pfad rekonstruiert (er sollte daher dem typischen
Perl-Layout entsprechen) und die Handbuchseiten werden automatisch in
Abschnitt 3 abgelegt.
.Sp
.Vb 2
\& # POD\-Dateien für Abschnitt 3 \- Modulnamen aus dem Pfad neu erstellt
\& PODMODULES="lib/Locale/Po4a/*.pm"
.Ve
.IP "\s-1POD5FILES\s0" 4
.IX Item "POD5FILES"
Beliebiger POD-Inhalt für die Erstellung von Handbuchseiten in Abschnitt
5. Pfade, falls verwandt, müssen relativ zum Ort der angegebenen
Konfigurationsdatei sein.
.Sp
Für Inhalte in den Abschnitten 5 oder 7 (wo oft ein Dateiname benötigt wird,
der auch für Inhalte in Abschnitt 1 verwandt wird) wird, wenn der Dateiname
»5« oder »7« als Teil des Dateinamens enthält, diese Nummer (und alle
Dateinamenerweiterungen) automatisch entfernt.
.Sp
.Vb 2
\& # POD\-Dateien für Abschnitt 5
\& POD5FILES="doc/po4a\-build.conf.5.pod"
.Ve
.IP "\s-1POD7FILES\s0" 4
.IX Item "POD7FILES"
Beliebiger POD-Inhalt für die Erstellung von Handbuchseiten in Abschnitt
7. Pfade, falls verwandt, müssen relativ zum Ort der angegebenen
Konfigurationsdatei sein.
.Sp
Für Inhalte in den Abschnitten 5 oder 7 (wo oft ein Dateiname benötigt wird,
der auch für Inhalte in Abschnitt 1 verwandt wird) wird, wenn der Dateiname
»5« oder »7« als Teil des Dateinamens enthält, diese Nummer (und alle
Dateinamenerweiterungen) automatisch entfernt.
.Sp
.Vb 2
\& # POD\-Dateien für Abschnitt 7
\& POD7FILES="doc/po4a.7.pod"
.Ve
.IP "\s-1PODPACKAGES\s0" 4
.IX Item "PODPACKAGES"
Ähnlich zu \s-1XMLPACKAGES\s0 \- für jedes Paket, für das Inhalte aus POD-Dateien
gebaut werden sollen, muss ein Wert in \s-1PODPACKAGES\s0 aufgenommen
werden. Benötigt, falls Werte für \s-1PODFILE, PODMODULES, POD5FILES\s0 oder
\&\s-1POD7FILES\s0 angegeben sind.
.Sp
.Vb 2
\& # POD\-verwendende Binärpakete
\& PODPACKAGES="po4a"
.Ve
.IP "\s-1HTMLDIR\s0" 4
.IX Item "HTMLDIR"
Unterverzeichnis von \s-1BASEDIR,\s0 das für die Ausgabe der unübersetzten und
übersetzten HTML-Ausgabe verwandt werden soll.
.Sp
.Vb 2
\& # HTML\-Ausgabe (Unterverzeichnis von BASEDIR)
\& HTMLDIR=""
.Ve
.IP "\s-1HTMLFILE\s0" 4
.IX Item "HTMLFILE"
DocBook-Datei, die nach \s-1HTML\s0 konvertiert werden soll (kann eine der gleichen
Dateien aus \s-1XMLMAN1\s0 oder \s-1XMLMAN3\s0 sein). Abschnitte sind für die HTML-Ausgabe
nicht relevant, Sie können daher hier eine einzelne Buchdatei verwenden, so
dass das \s-1HTML\s0 ein Inhaltsverzeichnis usw. hat.
.Sp
.Vb 2
\& # HTML\-DocBook\-Datei
\& HTMLFILE=""
.Ve
.IP "\s-1HTMLXSL\s0" 4
.IX Item "HTMLXSL"
Standardmäßig wird ein zerteiltes (»chunked«) XSL-Stylesheet
verwandt. Derzeit wird die Verwendung von mehr als einem Stylesheet pro
HTML-Lauf nicht unterstützt.
.Sp
.Vb 2
\& # für HTML zu verwendende XSL\-Datei
\& HTMLXSL="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"
.Ve
.SH "AUTOREN"
.IX Header "AUTOREN"
.Vb 1
\& Neil Williams <linux@codehelp.co.uk>
.Ve