linuxdoc – Online in der Cloud

PROGRAMM:

NAME/FUNKTION

linuxdoc – LinuxDoc DTD SGML-Konverter in ein anderes Ausgabeformat

ZUSAMMENFASSUNG

Linuxdoc --backend=Format
--papersize=Größe --Sprache=lang --charset=verkohlen --style=Datei --debuggen
--definieren Attribut=Wert --enthalten Einheit [Backend-Optionen...] Datei(.sgml)

oder (Alte, veraltete Verwendung)
sgmlxxxx [generische Optionen...] [Backend-Optionen...] Datei(.sgml)

BESCHREIBUNG

Das Linuxdoc Suite ist eine Sammlung von Textformatierern, die eine LinuxDoc-DTD verstehen
SGML-Quelldatei. Jeder Formatierer (oder „Back-End“) rendert die Quelldatei in eine Vielzahl von Formaten
Ausgabeformate, einschließlich HTML, TeX, DVI, PostScript, Nur-Text und groff(1) Quelle in
Handbuchseitenformat. Die Linuxdoc-Suite wird aus Gründen der Abwärtskompatibilität bereitgestellt, weil
Es gibt immer noch viele nützliche Dokumente, die in der SGML-Quelle von LinuxDoc DTD geschrieben sind.

Die von diesen Formatierern akzeptierten Auszeichnungssprachen werden im beschrieben Linuxdoc-Tools
Benutzer Guide. Sie sind Varianten einer ursprünglich entworfenen SGML-Dokumenttypdefinition
von Matt Welsh für die Linux-Dokumentation.

ALLGEMEINE OPTIONEN

Die meisten Befehlszeilenoptionen werden von allen Back-Ends akzeptiert. Einige Back-Ends verfügen über zusätzliche
spezifische Optionen zur Steuerung des Renderns in ihr jeweiliges Ausgabeformat. Hier sind die
gängige Optionen:

--backend=Format, -B
Legen Sie das Backend für das angegebene Format fest. Standardmäßig ist keines der tatsächlichen Formate, aber
Geben Sie einfach die Nutzung dieser Suiten aus. Verfügbare Formate sind: HTML, Info, Latex,
lyx, rtf, txt, prüfen.

--papersize=Größe, -P
Stellen Sie das Papierformat ein. Die Standardeinstellung ist „A4“ (europäisches Papier im Format 297 x 210 mm). Du könntest auch
Geben Sie die Größe „Buchstabe“ an.

--Sprache=lang, -l
Geben Sie die Sprache des Dokuments an (dadurch kann sich ändern, welche Stildateien verwendet werden).
zur Formatierung durch ein Backend). Die Standardsprache ist Englisch. Führen Sie ein LinuxDoc aus.
tools-Befehl ohne Argumente, um die Liste der gültigen Sprachcodes anzuzeigen.

--charset=Zeichen, -C
Geben Sie die Zeichenkodierung für die Ausgabe an. Standardmäßig ist „ascii“ die Auswahl von ASCII
Satz; Sie können „latin“ angeben, um den Zeichensatz ISO 8859-1 (Latin-1) anzugeben.
Außerdem sind „nippon“ und „euc-kr“ erforderlich, um die kodierten Dateien euc-jp und euc-kr zu verarbeiten
sgml-Datei.

--style=Datei, -S
Fügen Sie eine zusätzliche DTD (Document Type Definition) aus /usr/share/linuxdoc- hinzu.
tools/dtd.

--tabsize=n, -T
Legen Sie den Tabulatorabstand fest, der für die Generierung des Ausgabedokuments angenommen wird. Die Standardregisterkarte
Der Abstand beträgt 8.

--debug, -d
Löschen Sie keine Zwischendateien (z. B. .TeX-Dateien, die auf dem Weg zu einer .dvi erstellt wurden,
oder .man-Dateien, die auf dem Weg zum Nur-Text gelöscht wurden).

--define, -D
Übergeben Sie Attribut/Wert-Paare, die mit „if“- und „es sei denn“-Bedingungen abgeglichen werden sollen.
Eine ausführliche Beschreibung dieser Funktion finden Sie im Benutzerhandbuch. Das
Die Konditionalisierung wird vom Befehl sgmlpre durchgeführt. Sehen sgmlpre(1) sowie die
Bedienungsanleitung.

--include, -i
Übergeben Sie eine Option -i an nsgmls(1). Dies kann zur bedingten Einbeziehung verwendet werden. Sehen
nsgmls(1) Handbuchseite für Details.

--pass, -P
Übergeben Sie eine Optionszeichenfolge an das Backend. Die genaue Semantik dieser Option ist
Dies ist abhängig vom Backend und sollte in den einzelnen Handbuchseiten erläutert werden
für jeden.

file Die SGML-Quelldatei mit dem Namen entweder Datei or Datei.sgml.

Wenn Sie ein Back-End ohne Argumente ausführen, werden alle seine Optionen aufgelistet (Fehlermeldung
Hinweise zu „Keine Dateinamen angegeben“ können in diesem Fall getrost ignoriert werden. Die verfügbaren Backends
include (Namen in Klammern sind alt und veraltet):

linuxdoc -B html (sgml2html)
in HTML übersetzen

linuxdoc -B info (sgml2info)
in GNU-Info übersetzen

linuxdoc -B lyx (sgml2lyx)
in Lyx-Makros übersetzen

linuxdoc -B latex (sgml2latex)
in LaTeX 2e übersetzen

linuxdoc -B rtf (sgml2rtf)
in das Microsoft Rich Text Format übersetzen

linuxdoc -B txt (sgml2txt)
in einfachen Text oder Unix-Manpage-Markup übersetzen

Es gibt auch ein Werkzeug Linuxdoc-Baus der Ferne überprüfen
(sgmlcheck) zur Überprüfung der Linuxdoc DTD SGML-Syntax von Dokumentquellen verfügbar
ohne tatsächlich eine übersetzte Version zu erstellen.

BACKEND-TREIBER

Hier ist die Beschreibung für jeden Backend-Treiber:

************************************************** **

Linuxdoc -B html (sgml2html) konvertiert eine LinuxDoc DTD SGML-Quelldatei in eine HTML-Ausgabe.
Die Ausgabe erscheint in der Datei der obersten Ebene Datei.html und Datei-n.html für jeden Abschnitt
(Standardaktion, kann aber per Option geändert werden), wobei Datei ist der Name der SGML-Quelle
Datei-und n ist der Abschnittsname.

Für Bedingungen wird das Attribut/Wert-Paar „output=html“ festgelegt.

Linuxdoc -B html akzeptiert die folgenden Optionen: [--Teilt 0 | 1 | 2 ] [--dosnames]
[--imagebuttons] [--toc 0 | 1 | 2 ]

Ihre Bedeutungen sind:

--split, -s
Auf welcher Ebene sollen Quelldokumente aufgeteilt werden? 0 = nicht teilen, 1 = nach Dur teilen
Abschnitte, 2 = aufgeteilt nach Unterabschnitten.

--toc, -T
Auf welcher Ebene soll TOC generiert werden?
0 = überhaupt kein Inhaltsverzeichnis generieren,
1 = enthält Hauptabschnitte (/Kapitel/Teile),
2 = enthält Unterabschnitte.

--dosnames, -h
Verwenden Sie „.htm“ anstelle von „.html“ als Erweiterung von

--imagebuttons, -I
Verwenden Sie die in enthaltenen Pfeilbildsymbole „Weiter“, „Zurück“ und „Inhalt“.
/usr/share/linuxdoc-tools als Navigationsschaltflächen.

--footer, -F
Verwenden Sie die angegebene Datei als Fußzeile in jeder resultierenden HTML-Datei. Die Standardfußzeile ist
ohne alles

\N \N

--header, -H
Verwenden Sie die angegebene Datei als oberen Teil des Headers in jeder resultierenden HTML-Datei.
Beachten Sie, dass dies nicht der vollständige Teil des Headers ist. (also der Titel und die Links
(nächster, vorheriger, Inhalt) im Standardheader bleiben erhalten. Standard ist

\N
\N \N

************************************************** **

Linuxdoc -B Info (sgml2info) konvertiert eine LinuxDoc DTD SGML-Quelldatei in das GNU-Info-Format.
Die Ausgabe erscheint in Dateiinformation woher Datei ist der Name der SGML-Quelldatei.

Für Bedingungen wird das Attribut/Wert-Paar „output=info“ festgelegt.

Linuxdoc -B Info hat keine Backend-spezifischen Optionen.

************************************************** **

Linuxdoc -B Latex (sgml2latex) konvertiert eine LinuxDoc DTD SGML-Quelldatei in eine LaTeX-Ausgabe.
Verwendung der nsgmls(1) oder onsgmls(1) Parser und der sgmlsasp(1) Übersetzer. Verwendung von LaTeX
Ausgabe, und die Latex(1) Textformatierer, Sie können dann eine DVI-Ausgabe und PostScript erstellen
Ausgabe mit der dvips(1) Konverter. Die Ausgabe erscheint in Datei.tex für die LaTeX-Ausgabe,
Datei.dvi für DVI-Ausgabe, bzw Datei.ps für die PostScript-Ausgabe, wo Datei ist der Name des
SGML-Quelldatei.

Verwenden der LaTeX-Ausgabe und der pdflatex(1) Textformatierer, dann können Sie einen schönen erstellen
PDF-Ausgabe, geeignet zur Anzeige mit PDF-Viewern wie z xpdf(1) acroread(1) oder Geisteransicht(1).

Für Bedingungen wird das Attribut/Wert-Paar „output=latex2e“ festgelegt.

Linuxdoc -B Latex akzeptiert folgende Backend-spezifische Optionen: [--Ausgabe=tex|Dvi|ps|pdf]
[--bibtex] [--makeindex] [--pagenumber=n] --schnell [--latex=Latex|hlatexp|Platex|jLatex]
[--dvips=dvips|dvi2ps]

Ihre Bedeutungen sind:

--ausgabe=fmt, -Ö
Geben Sie das gewünschte Ausgabeformat an. Der Spezifizierer fmt kann „tex“, „dvi“ sein,
„ps“ oder „pdf“.

Hinweis: Diese Version überschreibt/entfernt die Zwischendateien nicht: tex-Datei für dvi
Ausgabe oder tex/dvi-Dateien für die PS-Ausgabe. Dies ist ein anderes Verhalten als im Original
SGML-Tools 1.0.9, daher werden Sie hier gewarnt.

--bibtex, -b
Verarbeiten Sie das generierte TeX mit Bibtex(1).

--makeindex, -m
Generieren Sie eine TeX-Indexdatei, die zur Verarbeitung mit geeignet ist Makeindex(1) von und
Und Tags, die in der SGML-Quelle vorhanden sind.

--pagenumber, -n
Legen Sie die erste Seitenzahl in der DVI- oder PS-Ausgabedatei fest.

--quick, -q
Führen Sie die LaTeX-Formatierung nur einmal durch. Dies reicht oft nicht aus, um zu produzieren
Endausgabe (aufgrund von Referenzen usw.), ist aber nützlich, um TeX-Fehler zu erkennen
und Rechtfertigungsprobleme.

--pass, -P
Das Argument der Pass-Option wird direkt nach der generierten LaTeX-Präambel eingefügt
durch das document-type-Tag. Geben Sie das gewünschte Ausgabeformat an. Der Spezifizierer fmt
kann „tex“, „dvi“, „ps“ oder „pdf“ sein.

--latex=alternativer_latex_befehl, -X
Diese Option gilt derzeit für Koreanisch und Japanisch. Der alternativer_latex_befehl kann
sei „latex“ (Standard), „hlatexp“ (für Koreanisch), „platex“ oder „jlatex“ (für
Japanisch). Diese Option kann zum Rendern koreanischer Dokumente mit HLaTeXp verwendet werden
Japanisches Dokument mit pLaTeX/jLaTeX rendern. Wenn nicht, sollte HLaTeX installiert werden
Koreanisches Dokument erstellen. Andererseits können japanische Dokumente gerendert werden
mit jLaTeX
(Dies ist die Standardeinstellung, wenn „-c nippon“ angegeben ist), falls Sie dies bereits getan haben
Wenn Sie jLaTeX verwenden, müssen Sie pLaTeX möglicherweise nicht installieren.

--dvips=alternate_dvips_command, -S
Diese Option ist derzeit für Japanisch verfügbar. Der alternate_dvips_command kann sein
„dvips“ oder „dvi2ps“. Wenn Sie das nicht wissen, brauchen Sie es möglicherweise nicht.

************************************************** **

Linuxdoc -B lyx (sgml2lyx) konvertiert eine LinuxDoc DTD SGML-Quelldatei in eine LyX-Ausgabe.
Die Ausgabe erscheint in Datei.lyx woher Datei ist der Name der SGML-Quelldatei.

Für Bedingungen wird das Attribut/Wert-Paar „output=lyx“ festgelegt.

Linuxdoc -B lyx hat keine Backend-spezifischen Optionen.

************************************************** **

Linuxdoc -B rtf (sgml2rtf) konvertiert eine LinuxDoc DTD SGML-Quelldatei in RTF, den Rich Text
Tormat, das vom Microsoft Windows-Hilfesystem verwendet wird. Die Ausgabe erscheint in der Datei der obersten Ebene
Datei.rtf und Datei-n.rtf für jeden Abschnitt, wo Datei ist der Name der SGML-Quelldatei.
Die RTF-Ausgabe ist auf die Kompilierung durch den Windows Help Compiler (hc31.exe) zugeschnitten.

Für Bedingungen wird das Attribut/Wert-Paar „output=rtf“ festgelegt.

Linuxdoc -B rtf akzeptiert [--twosplit] als Backend-spezifische Option. Es folgt das
Bedeutung dieser Option:

--twosplit, -2
Teilt Dateien bei n. Abschnitte und nm-Unterabschnitte

************************************************** **

Linuxdoc -B txt (sgml2txt) konvertiert eine LinuxDoc DTD SGML-Quelldatei in ASCII, ISO-8859-1,
oder EUC-JP-Ausgabe. Die Ausgabe erscheint in Datei.txt woher Datei ist der Name der SGML-Quelle
Datei.

Für Bedingungen wird das Attribut/Wert-Paar „output=txt“ festgelegt.

Linuxdoc -B txt akzeptiert folgende Backend-Optionen: [--manpage] [--Filter] [--blanks=n]

Die Bedeutung dieser Optionen ist:

--manpage, -m
Gibt eine Groff-Quelldatei aus, die zum Formatieren mit geeignet ist groff -Mann für Manpages

--filter, -f
Entfernen Sie Backspace-Overstrikes aus dem von generierten Zwischenformular groff(1).

--pass, -P
Das Argument der Pass-Option wird zu den übergebenen Befehlszeilenoptionen hinzugefügt
groff(1).

--blanks=n, -B
Legen Sie die Grenze fortlaufender Leerzeilen für die Generierung des Ausgabedokuments fest. Der
Der Standardgrenzwert ist 3. Wenn 0 (Null) angegeben wird, weist das Ergebnis viele fortlaufende Leerzeichen auf
Linien.

************************************************** **

Linuxdoc -B aus der Ferne überprüfen (sgmlcheck) führt eine SGML-Analyse für die angegebene Dokumentquelle aus. Beliebig
Fehler werden an die Standardausgabe gemeldet. Es wird keine formatierte Version der Quelle erstellt.

Beachten Sie, dass Linuxdoc -B aus der Ferne überprüfen verarbeitet die LinuxDoc DTD SGML-Quelle vor und führt dabei Folgendes aus
Konditionalisierung beschrieben durch ein beliebiges <#if> und <#es sei denn> Stichworte. Dokumentieren
Quellen, die diese Tags enthalten, verwirren einen eigenständigen SGML-Parser. Linuxdoc -B aus der Ferne überprüfen
hat keine Backend-spezifischen Optionen.
************************************************** **

Verwenden Sie Linuxdoc online über die Dienste von onworks.net