POD2TEXI(1) Von Benutzern beigetragene Perl-Dokumentation POD2TEXI(1)
BEZEICHNUNG
pod2texi - Pod zu Texinfo umwandeln
UBERSICHT
pod2texi [OPTION] > POD >
BESCHREIBUNG
Ubersetzt Pod-Datei(en) in Texinfo. Es gibt zwei grundlegende
Arbeitsmodi. Im ersten Modus (die Vorgabe) wird jede Pod-Datei in ein
eigenstandiges Texinfo-Handbuch ubersetzt.
Im zweiten Modus, falls --base-level auf einen Wert grosser als 0
gesetzt ist, wird jede Pod-Datei in eine fur @include geeignete Datei
ubersetzt. Ausserdem wird eine weitere Datei mit einem Hauptmenu und
allen @includes erstellt.
OPTIONEN
--appendix-sections
verwendet Anhang-Abschnittsbefehle (@appendix, >) anstelle der
vorgegebenen nummerierten @-Abschnittsbefehle von Texinfo
(@chapter, @section, >).
--base-level=ZAHL|NAME
legt die Ebene der >>head1<<-Befehle fest. Diese kann eine Ganzzahl
oder ein Texinfo-Abschnittsbefehl sein (ohne das >>@<<: 1
entspricht der @chapter/@unnumbered-Ebene, 2 der @section-Ebene und
so weiter. Die Voreinstellung ist 0, wodurch die >>head1<<-Befehle
immer noch als Kapitel ausgegeben werden, aber die Ausgabe als
eigenstandiges Handbuch zusammengestellt wird.
Falls die Ebene nicht 0 ist, wird aus der Pod-Datei ein Fragment
eines Texinfo-Handbuchs erstellt, das sich als @include verwenden
lasst. In diesem Fall besitzt jede Pod-Datei einen zusatzlichen
Abschnittsbefehl, der die gesamte Datei abdeckt, eine Ebene uber
dem --base-level-Wert. Um jede Pod-Datei als Kapitel eines grossen
Handbuchs zu definieren, sollten Sie >>section<< als Basisebene
verwenden.
Ein Beispiel dafur, wie Texinfo aus der Perl-Dokumentation selbst
erstellt wird, finden Sie in >>contrib/perldoc-all<< in der
Quelldistribution von Textinfo.
--debug=ZAHL
setzt die Debugging-Stufe auf die angegebene ZAHL.
--generate-setfilename
erstellt eine @setfilename-Zeile fur freistehende Handbucher. Kann
mit --no-generate-setfilename verneint werden. Wird ignoriert,
falls --base-level nicht 0 ist.
--headings-as-sections
verwendet Uberschrift-Befehle (@heading, >) anstelle der
vorgegebenen nummerierten @-Abschnittsbefehle von Texinfo
(@chapter, @section, >). Der Abschnittsbefehl, der die gesamte
Dateiausgabe fur jede Pod-Datei abdeckt, sofern --base-level nicht
0 ist, ist ein nummerierter Befehl.
--help
zeigt einen Hilfetext an und beendet das Programm.
--menus
gibt Knotenmenus aus. Falls ein Haupthandbuch existiert, wird
dessen Knotenmenu der obersten Ebene stets ausgegeben, da ein Menu
der obersten Ebene erzeugt wird. Andere Knotenmenus werden
standardmassig nicht ausgegeben.
--outdir=NAME
legt erstellte Texinfo-Dateien im Verzeichnis NAME ab, falls es ein
Haupthandbuch mit Einbindungsdateien gibt (wovon jede einer
Pod-Eingabedatei entspricht). Die Vorgabe basiert auf --subdir.
--output=NAME
legt den Namen des ersten Handbuchs fest, oder den Namen des
Haupthandbuchs, falls es ein solches gibt. Standardmassig wird in
die Standardausgabe geschrieben.
--no-section-nodes
verwendet Anker anstatt Knoten fur Abschnitte.
--no-fill-section-gaps
fullt die Abschnittslucken nicht mit leeren @unnumbered-Dateien.
Fur gewohnlich ist es gut, die Abschnittshierarchie intakt zu
halten.
--preamble=ZEICHENKETTE
fugt die angegebene ZEICHENKETTE als obersten Textbaustein vor
Menus und Einbindungen ein. Falls die ZEICHENKETTE als "-"
angegeben ist, wird der oberste Textbaustein aus der
Standardeingabe gelesen. Der oberste Textbaustein ist ein minimaler
Anfang fur ein Texinfo-Dokument.
--setfilename=ZEICHENKETTE
fugt die angegebene ZEICHENKETTE als obersten Textbaustein vor
Menus und Einbindungen fur @setfilename fur das Haupthandbuch ein,
falls --base-level nicht auf 0 gesetzt ist. Dies wird ignoriert,
falls --base-level 0 ist. Standardmassig wird kein @setfilename fur
das Haupthandbuch ausgegeben.
--subdir=NAME
bindet Einbindungsdateien aus NAME ein, falls es ein Haupthandbuch
mit Einbindungsdateien gibt (wovon jede einer Pod-Eingabedatei
entspricht).
Falls --outdir gestzt ist, sollte NAME im Allgemeinen auf das
relative Verzeichnis zwischen dem Haupthandbuch und dem Argument
--outdir gesetzt werden.
--unnumbered-sections
verwendet unnummerierte Abschnittsbefehle (@unnumbered, >)
anstelle der vorgegebenen nummerierten @-Abschnittsbefehle von
Texinfo (@chapter, @section, >).
--top=TOP
legt den Namen des @top-Elements fur das Haupthandbuch fest. Dies
darf Texinfo-Code enthalten.
--version
zeigt Versionsinformationen an und beendet das Programm.
SIEHE AUCH
Pod::Simple::Texinfo. perlpod. Das Texinfo-Handbuch. Homepage von GNU
Texinfo:
COPYRIGHT und LIZENZ
Copyright 2012-2024 Free Software Foundation, Inc.
Dieses Programm ist freie Software; Sie konnen es unter den Bedingungen
der GNU General Public License weitergeben und/oder verandern, so wie
sie von der Free Software Foundation veroffentlicht wurde; entweder in
Version 3 der Lizenz oder (nach Ihrem Ermessen) in jeder spateren
Version.
Es gibt KEINERLEI GARANTIEN, soweit gesetzlich zulassig.
AUTOR
Patrice Dumas .
UBERSETZUNG
Die deutsche Ubersetzung dieser Handbuchseite wurde von Mario
Blattermann und Helge Kreutzmann
erstellt.
Diese Ubersetzung ist Freie Dokumentation; lesen Sie die GNU General
Public License Version 3
oder neuer bezuglich der Copyright-Bedingungen. Es wird KEINE HAFTUNG
ubernommen.
Wenn Sie Fehler in der Ubersetzung dieser Handbuchseite finden,
schicken Sie bitte eine E-Mail an die Mailingliste der Ubersetzer:
.
perl 25. Oktober 2024 POD2TEXI(1)