Name¶

soelim - Quellanfragen in roff oder anderen Textdateien rekursiv interpolieren

Übersicht¶

Beschreibung¶

GNU soelim ist ein Präprozessor für das groff(7) -Dokumentenformatierungssystem. soelim beseitigt Quellanfragen in roff(7) - und anderen Textdateien. Es ersetzt Zeilen der Form ».so Einbindedatei« innerhalb jeder Text-Eingabedatei rekursiv durch den Inhalt von Einbindedatei, um einen Baum an Dokumenten zu glätten. Standardmäßig schreibt es auch roff lf-Anfragen, um den Namen und die Zeilennummer jeder Eingabedatei und Einbindedatei aufzuzeichnen, so dass alle Diagnostikangaben, die in der späteren Verarbeitung auftreten, genau der Originaleingabe zugeordnet werden können. Optionen ermöglichen es, diese Informationen zu unterdrücken (-r) oder stattdessen in TeX-Kommentaren (-t) bereitzustellen. Falls keine Argumente für Eingabedatei vorhanden sind, liest soelim den Standardeingabedatenstrom. Das Programm schreibt in den Standardausgabendatenstrom.

soelim liest das Argument Einbinde-Datei wie es GNU- troff(1) macht. Es ignoriert Leerzeichen direkt nach »so«. Um eine Abfolge von einem oder mehreren Leerzeichen am Anfang eines Arguments zu kodieren, stellen Sie der Abfolge ein neutrales englisches Anführungszeichen (") voran. Leerzeichen, die nicht am Anfang sind, werden wörtlich interpretiert. Ein Rückwärtsschrägstrich, gefolgt von einem Leerzeichen (»\ «) kodiert auch ein Leerzeichen. Dies dient der Kompatibilität mit früheren Version von GNU soelim. Falls der eingebundene Dateiname einen Rückwärtsschrägstrich benötigt, verwenden Sie zu dessen Einbettung \\ oder \e. Alle anderen Maskiersequenzen in Einbinde-Dateien, einschließlich »\[rs]«, hindern soelim daran, die Quellanfrage zu ersetzen. AT&T und abgeleitete Versionen von soelim stellen keine Möglichkeit der Einbettung von Leerzeichen in Dateinamen bereit. Sie ersetzen das erste auftretende Leerzeichen durch einen Zeilenumbruch und beenden die Interpretation der Anforderung.

Der Punkt muss am Zeilenanfang sein und ihm muss »so« ohne Leerzeichen oder Tabulatoren folgen, damit soelim damit umgehen kann. Diese Konvention erlaubt es, Quellanfragen vor der Verarbeitung durch soelim zu schützen, zum Beispiel als Teil einer Makrodefinition oder »if«-Anfragen.

Es muss auch mindestens ein Leerzeichen zwischen »so« und seinem Argument Einbinde-Datei sein. Die Option -C setzt diese Anforderung außer Kraft.

Das Vorgestellte ist die Obergrenze des Verständnisses von soelim von der Sprache roff. Es ersetzt beispielsweise die Eingabezeile

.if 1 .so Anderedatei

soelim wurde entwickelt, um mit Situationen umzugehen, bei denen das Ziel einer roff(7) -Quellanfrage die Verarbeitung durch einen Präprozesser wie eqn(1), pic(1), refer(1) oder tbl(1) verlangt, Die normale Verarbeitungssequenz von groff(1) ist wie folgt:

          input        sourced


          file          file


            ⎪             ⎪


            ↓             ↓


        preprocessor ⎯→ troff ⎯→ postprocessor


                                      ⎪


                                      ↓


                                   output


                                    file

Das heißt, mit ».so« eingelesene Dateien werden normalerweise nur von troff(1) (dem eigentlichen Formatierungsprogramm) gelesen. soelim wird von troff(1) nicht für Quelldateien benötigt.

Falls eine eingelesene Datei auch vorverarbeitet werden soll, muss sie bereits gelesen worden sein, bevor die Eingabe durch den Präprozessor gegeben wird. soelim, aufgerufen mittels der Option -s von groff, erledigt dies.

          input


          file


            ⎪


            ↓


          soelim ⎯→ preprocessor ⎯→ troff ⎯→ postprocessor


            ↑                                     ⎪


            ⎪                                     ↓


         sourced                               output


          file                                  file

Optionen¶

--help zeigt eine Hilfe zur Verwendung an, während -v und --version die Versionsinformation anzeigen. Alle drei beenden sich danach.

-C

Erkennt eine Eingabezeile, die mit .so beginnt, selbst wenn diesem kein Leerzeichen oder Zeilenumbruch folgt.

-I Verz

Durchsucht das Verzeichnis Verz nach Eingabe- und Einbinde-Dateien. Falls mehr als einmal angegeben, wird jedes Verz in der angegebenen Reihenfolge durchsucht. To search the current working directory before others, add “-I .” at the desired place; it is otherwise searched last.

-r

Schreibt Dateien »roh«. Fügt keine lf-Anfragen hinzu.

-t

Gibt mit »%« beginnende TeX-Kommentarzeilen aus, die die aktuelle Datei und Zeilennummer anzeigen, anstatt lf-Anfragen für den gleichen Zweck.

Falls sowohl -r als auch -t angegeben sind, steuert die zuletzt angegebene Option.

Rückgabewert¶

soelim beendet sich mit Status 0 bei erfolgreicher Aktion, Status 2, falls das Prgoramm seine Befehlszeilenargumente nicht interpretieren kann und Status 1, falls es während der Aktion auf einen Fehler trifft.

Siehe auch¶

groff(1)

ÜBERSETZUNG¶

Die deutsche Übersetzung dieser Handbuchseite wurde von Helge Kreutzmann <debian@helgefjell.de> erstellt.

Diese Übersetzung ist Freie Dokumentation; lesen Sie die GNU General Public License Version 3 oder neuer bezüglich der Copyright-Bedingungen. Es wird KEINE HAFTUNG übernommen.

Wenn Sie Fehler in der Übersetzung dieser Handbuchseite finden, schicken Sie bitte eine E-Mail an die Mailingliste der Übersetzer.