Name

soelim - Quellanfragen in roff oder anderen Textdateien rekursiv interpolieren

Übersicht

Beschreibung

GNU soelim is a preprocessor for the groff(7) document formatting system. soelim works as a filter to eliminate source requests in roff(7) input files; that is, it replaces lines of the form “.so included-file” within each text input-file with the contents of included-file, recursively. Standardmäßig schreibt es auch 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. Die Ausgabe wird in den Standardausgabendatenstrom geschrieben.

Falls der Name der Makrodatei einen Rückwärtsschrägstrich enthält, verwenden Sie zu dessen Einbettung \\ oder \e. Um ein Leerzeichen einzubetten, schreiben Sie »\ « (einen Rückwärtsschrägstrich, gefolgt von einem Leerzeichen). Alle anderen Maskiersequenzen in Makrodatei, einschließlich »\[rs]«, hindern soelim daran, die Quellanfrage zu ersetzen.

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 Makrodatei 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 was designed to handle situations where the target of a roff source request requires a preprocessor such as eqn(1), pic(1), refer(1), or tbl(1). The usual processing sequence of groff(1) is as follows.

          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 Eingabedatei 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 den Verzeichnispfad Verz nach Eingabe- und Einbinde-Dateien. -I kann mehr als einmal angegeben werden. Jedes Verz wird in der angegebenen Reihenfolge durchsucht. Um das aktuelle Arbeitsverzeichnis vor anderen zu durchsuchen, fügen Sie »-I ." « an der gewünschten Stelle hinzu. Andernfalls wird es als letztes durchsucht.

-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.

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.