docbook2x-man – Online in der Cloud

PROGRAMM:

NAME/FUNKTION

docbook2x-man – DocBook in Manpages konvertieren

ZUSAMMENFASSUNG

docbook2x-man [Optionen] xml-Dokument

BESCHREIBUNG

docbook2x-man Konvertiert das angegebene DocBook-XML-Dokument in Manpages. Standardmäßig der Mann
Seiten werden in das aktuelle Verzeichnis ausgegeben.

Nur der Refentry-Inhalt im DocBook-Dokument wird konvertiert. (Um Inhalte zu konvertieren
Außerhalb eines Refentry ist eine Stylesheet-Anpassung erforderlich. Siehe das docbook2X-Paket für
Einzelheiten.)

Das docbook2x-man Befehl ist ein Wrapper-Skript für einen zweistufigen Konvertierungsprozess. Siehe die
Abschnitt „UMWANDLUNGSPROZESS“ unten für Details.

OPTIONAL

Die verfügbaren Optionen sind im Wesentlichen die Vereinigung der Optionen von db2x_xsltproc(1) und
db2x_manxml(1).

Einige häufig verwendete Optionen sind unten aufgeführt:

--encoding=Codierung
Legt die Zeichenkodierung der Ausgabe fest.

--string-param Parameter=Wert
Legt einen Stylesheet-Parameter fest (Optionen, die das Aussehen der Ausgabe beeinflussen). Sehen
„Stylesheet-Parameter“ unten für die einstellbaren Parameter.

--sgml Akzeptieren Sie ein SGML-Quelldokument als Eingabe anstelle von XML.

--solinks
Erstellen Sie Stub-Seiten für alternative Namen für eine Ausgabe-Manpage.

STILBLATT PARAMETER
Überschriften in Großbuchstaben
Kurz. Überschriften in Großbuchstaben schreiben?

Standard Einstellung. 1 (Boolean wahr)

Überschriften im Manpage-Inhalt sollten in Großbuchstaben geschrieben werden oder nicht.

manvolnum-cite-numeral-only
Kurz. Beim Zitieren von Manpage-Abschnitten sollte nur die Nummer verwendet werden

Standard Einstellung. 1 (Boolean wahr)

Beim Zitieren anderer Manpages wird der Manpage-Abschnitt entweder so angegeben, wie er ist, oder hat das
Es wurden Buchstaben entfernt und nur die Nummer des Abschnitts angegeben (z. B. Abschnitt 3x
wird 3). Diese Option gibt den Stil an.

Zitate über Literale
Kurz. Anführungszeichen für wörtliche Elemente anzeigen?

Standard Einstellung. 0 (boolesch falsch)

Wenn „true“, werden Literalelemente mit Anführungszeichen dargestellt.

Anmerkungen anzeigen
Kurz. Kommentarelemente anzeigen?

Standard Einstellung. 1 (Boolean wahr)

Bei true werden Kommentare angezeigt, andernfalls werden sie unterdrückt. Kommentare hier
bezieht sich auf das Kommentarelement, das in DocBook V4.0 in Kommentar umbenannt wird, nicht
XML-Kommentare (<-- wie diese -->), die nicht verfügbar sind.

funktion-parens
Kurz. Klammern nach einer Funktion generieren?

Standard Einstellung. 0 (boolesch falsch)

Wenn true, wird die Formatierung von a -Element enthält generierte Klammern.

XRef-on-Link
Kurz. Sollte der Link einen Querverweis generieren?

Standard Einstellung. 1 (Boolean wahr)

Manpages können die durch den Link erstellten Hypertext-Links nicht wiedergeben. Wenn diese Option gesetzt ist,
Anschließend stellt das Stylesheet einen Querverweis auf das Ziel des Links dar. (Das vielleicht
Unordnung reduzieren). Ansonsten wird nur der Inhalt des Links wiedergegeben und ist tatsächlich
Der Link selbst wird ignoriert.

header-3
Kurz. Dritter Kopfzeilentext

Standard Einstellung. (leer)

Gibt den Text der dritten Kopfzeile einer Manpage an, normalerweise das Datum für die
Manpage. Wenn leer, wird der Datumsinhalt für den Refentry verwendet.

header-4
Kurz. Vierter Kopfzeilentext

Standard Einstellung. (leer)

Gibt den Text der vierten Kopfzeile einer Manpage an. Wenn leer, wird die refmiscinfo
Inhalt für die Refentry wird verwendet.

header-5
Kurz. Fünfter Kopfzeilentext

Standard Einstellung. (leer)

Gibt den Text der fünften Kopfzeile einer Manpage an. Wenn leer, der „manuelle Name“,
das heißt, es wird der Titel des Buchs oder des Referenzcontainers verwendet.

Standard-Manpage-Abschnitt
Kurz. Standardabschnitt der Manpage

Standard Einstellung. 1

Das Quelldokument gibt normalerweise die Abschnitte an, zu denen jede Manpage gehören sollte
zu (mit manvolnum in refmeta). Für den Fall, dass das Quelldokument keinen Hinweis darauf gibt,
Bei Seitenabschnitten gibt diese Option die Standardeinstellung an.

benutzerdefinierte-lokalisierungsdatei
Kurz. URI des XML-Dokuments mit benutzerdefinierten Lokalisierungsdaten

Standard Einstellung. (leer)

Dieser Parameter gibt den URI eines XML-Dokuments an, das Textübersetzungen beschreibt
(und andere länderspezifische Informationen), die vom Stylesheet zur Verarbeitung benötigt werden
das DocBook-Dokument.

Die Textübersetzungen, auf die dieser Parameter verweist, überschreiben immer den Standardtext
Übersetzungen (aus dem internen Parameter localization-file). Wenn ein besonderes
Übersetzung hier nicht vorhanden ist, wird die entsprechende Standardübersetzung als a . verwendet
zurückgreifen.

Dieser Parameter dient hauptsächlich zum Ändern bestimmter Satzzeichen, die in verwendet werden
Formatieren des Quelldokuments. Die Einstellungen für Satzzeichen sind oft
spezifisch für das Quelldokument, kann aber auch vom Gebietsschema abhängig sein.

Um keine benutzerdefinierten Textübersetzungen zu verwenden, lassen Sie diesen Parameter als leere Zeichenfolge.

benutzerdefinierte-l10n-daten
Kurz. XML-Dokument mit benutzerdefinierten Lokalisierungsdaten

Standard Einstellung. document($custom-localization-file)

Dieser Parameter gibt das XML-Dokument an, das Textübersetzungen beschreibt (und
andere gebietsschemaspezifische Informationen), die das Stylesheet benötigt, um die
DocBook-Dokument.

Dieser Parameter ist im Stylesheet intern. So verweisen Sie auf ein externes XML-Dokument
mit einer URI oder einem Dateinamen sollten Sie den Parameter custom-localization-file verwenden
stattdessen.

Innerhalb eines benutzerdefinierten Stylesheets (nicht on Befehlszeilen) kann dieser Parameter sein
auf den XPath-Ausdruck document('') gesetzt, was die benutzerdefinierten Übersetzungen verursacht
direkt in das zu lesende benutzerdefinierte Stylesheet eingebettet.

Autor-anderername-in-mitte
Kurz. Ist othername in author ein zweiter Vorname?

Standard Einstellung. 1

Bei true steht der andere Name eines Autors zwischen Vor- und Nachname.
Andernfalls wird othername unterdrückt.

Beispiele:

$ docbook2x-man --solinks manpages.xml
$ docbook2x-man --solinks --encoding=utf-8//TRANSLIT manpages.xml
$ docbook2x-man --string-param header-4="Free Recode 3.6" document.xml
. WLAN

UMWANDLUNG PROZESSE

weiterverarbeitende Industrie zu Mann Seiten
DocBook-Dokumente werden in zwei Schritten in Manpages konvertiert:

1. Die DocBook-Quelle wird von einem XSLT-Stylesheet in ein XML-Zwischenformat konvertiert,
Man-XML.

Man-XML ist einfacher als DocBook und näher am Manpage-Format. es ist beabsichtigt
erleichtern die Arbeit der Stylesheets.

Das Stylesheet für diesen Zweck ist in xslt/man/docbook.xsl. Für die Portabilität
sollte immer durch den folgenden URI referenziert werden:

http://docbook2x.sourceforge.net/latest/xslt/man/docbook.xsl

Führen Sie dieses Stylesheet mit . aus db2x_xsltproc(1).

Customizing. Sie können die Ausgabe auch anpassen, indem Sie Ihr eigenes XSLT-Stylesheet erstellen —
Parameter ändern oder neue Vorlagen hinzufügen – und importieren xslt/man/docbook.xsl.

2. Man-XML wird von in die eigentlichen Manpages konvertiert db2x_manxml(1).

Das docbook2x-man Befehl führt beide Schritte automatisch aus, aber wenn Probleme auftreten, können Sie
können die Fehler deutlicher sehen, wenn Sie jeden Schritt separat ausführen:

$ db2x_xsltproc -s man meindoc.xml -o meindoc.mxml
$ db2x_manxml meindoc.mxml
. WLAN

Optionen für das Konvertierungs-Stylesheet werden in beschrieben
die Stylesheets der Manpages
Referenz.

Pure XSLT Umwandlung.
Eine Alternative zum db2x_manxml Perl-Skript ist das XSLT
Stylesheet in
xslt/backend/db2x_manxml.xsl.
Dieses Stylesheet führt eine ähnliche Funktion aus
Man-XML in echte Manpages umzuwandeln.
Dies ist nützlich, wenn Sie ein reines XSLT wünschen
Lösung zur Manpage-Konvertierung.
Natürlich die Qualität der Konvertierung mit diesem Stylesheet
wird nie so gut sein wie Perl db2x_manxml,
und es läuft langsamer.
Insbesondere die reine XSLT-Version
unterstützt derzeit keine Tabellen in Manpages,
aber sein Perl-Gegenstück tut es.

Charakter kompensieren Umwandlung
Beim Übersetzen von XML in ältere ASCII-basierte Formate mit schlechter Unterstützung für Unicode, wie z
man-Seiten und Texinfo gibt es immer das Problem, dass Unicode-Zeichen in der Quelle
Dokument muss auch irgendwie übersetzt werden.

Eine einfache Zeichensatzkonvertierung aus Unicode reicht nicht aus, da die
Zielzeichensatz, normalerweise US-ASCII oder ISO Latin-1, enthalten keine gemeinsamen Zeichen
B. Bindestriche und gerichtete Anführungszeichen, die in XML-Dokumenten häufig verwendet werden. Aber
Dokumentformatierer (man und Texinfo) ermöglichen die Eingabe solcher Zeichen durch ein Markup
escape: zum Beispiel \(lq für das linksgerichtete Anführungszeichen „. Und wenn ein Escape auf Markup-Ebene
nicht verfügbar ist, kann eine ASCII-Transliteration verwendet werden: zum Beispiel mit ASCII
Kleiner-als-Zeichen < für das Winkelanführungszeichen ⟨.

So lässt sich das Unicode-Zeichenproblem in zwei Schritten lösen:

1. utf8trans(1), ein in docbook2X enthaltenes Programm, ordnet Unicode-Zeichen auf Markup-Ebene zu
Fluchten oder Transliterationen.

Da es nicht unbedingt eine feste, offizielle Zuordnung von Unicode-Zeichen gibt,
utf8trans kann vom Benutzer veränderbare Zeichenzuordnungen einlesen, die in Textdateien ausgedrückt werden und
wenden sie an. (Im Gegensatz zu den meisten Zeichensatzkonvertern.)

In charmaps/man/roff.charmap und charmaps/man/texi.charmap sind Zeichentabellen, die möglicherweise
für die Manpage- und Texinfo-Konvertierung verwendet werden. Die Programme db2x_manxml(1) und
db2x_temixml(1) wird diese Zeichentabellen oder eine andere von spezifizierte Zeichentabelle anwenden
der Benutzer, automatisch.

2. Der Rest des Unicode-Textes wird in einen anderen Zeichensatz (Kodierung) umgewandelt. Zum
Beispielsweise könnte ein französisches Dokument mit Akzentzeichen (wie é) in konvertiert werden
ISO-Latein 1.

Dieser Schritt wird angewendet, nachdem utf8trans Zeichenzuordnung, mit dem iconv(1) Kodierung
Konvertierungstool. Beide db2x_manxml(1) und db2x_temixml(1) kann anrufen iconv(1)
automatisch bei der Produktion ihrer Ausgabe.

Nutzen Sie docbook2x-man online über die Dienste von onworks.net