Content-type: text/html Man page of efeudoc

efeudoc

Section: User Commands (1)
Index Return to Main Contents
 

BEZEICHNUNG

efeudoc - EFEU-Dokumentkonverter

 

ÜBERSICHT

efeudoc--help[=type] ] [ --version ] [ --info[=entry] ] [ --debug[=mode] ] [ --verbose ] [ -I dir ] [ -T type ] [ -C cfg ] [ -H hdr ] [ -0 ] [ -u ] [ -r name ] [ -d ] [ -t ] [ -l ] [ -p ] [ --pdf ] [ -h ] [ -o aus ] file(s)

 

BESCHREIBUNG

Das Kommando efeudoc ist ein Dokumentgenerator, der verschiedene Ausgabeformate (LaTeX, HTML, nroff/troff, ...) kennt. Der EFEU-Interpreter (Vergleiche dazu esh(1)) wird in Anweisungen verwendet und erlaubt Datenauswertungen direkt im Dokument.

 

BESCHREIBUNG

--help[=type]
generiert eine Beschreibung des Kommandos. Der zusätzliche Parameter type bestimmt die Formatierung und die Ausgabe der Beschreibung.
term
Terminalausgabe (default)
raw
Rohformat für efeudoc
man
nroff/troff Sourcen für man
lp
Ausgabe zum Drucker

--version
gibt die Versionsnummer des Kommandos aus.
--info[=entry]
listet verfügbare Informationseinträge des Kommandos auf.
--debug[=mode]
setzt den Protokollmodus für das Kommando. Vergleiche dazu .
--verbose
setzt den Debug-Level auf .info.
-I dir
erweitert den Suchpfad für Konfigurationsdateien um dir. Die Vorgabe für den Suchpfad ist:
.
-T type
Ausgabetype, ? liefert eine Auflistung.
-C cfg
Konfigurationsfile
-H hdr
Wertet den String hdr vor den Eingabedateien aus. Damit können Dokumentmakros definiert werden.
-0
Dokumentkopf unterdrücken
-u
UTF8 Kodierung verwenden.
-r name
Generierungsregeln mit Pseudoziel
-d
Abhängigkeitsregeln generieren
-t
Terminalausgabe
-l
LaTeX-Dokument
-p
PostScript-Dokument über LaTeX
--pdf
PDF-Dokument über LaTeX
-h
HTML-Dokument
-o aus
Ausgabefile
file(s)
Eingabedatei(en)

Die Beschreibungssprache ist ein Textformat mit Steueranweisungen, bei dem zusätzlich auch Strukturierungen und Einrückungen berücksichtigt werden. Der Beschreibungstext soll dabei schon ein grobes Bild der gewünschten Formatierung liefern. Am nachstehenden Beispiel der Konstruktion vo Listen wird dies deutlich:

Der Code

Beispiel für eine Aufzählungsliste:
*       Listeneintrag mit einem längeren Absatz zur
        Demonstration der Funktionsweise von
        Einrückungen.

        Ein neuer Absatz mit einer Aufzählung:
        #       Eintrag 1
        #       Eintrag 2
*       Ein weiterer Listeneintrag

Text nach der Aufzählung.

erzeugt die Ausgabe:

Beispiel für eine Aufzählungsliste:

*
Listeneintrag mit einem längeren Absatz zur Demonstration der Funktionsweise von Einrückungen.

Ein neuer Absatz mit einer Aufzählung:

*
Eintrag 1
*
Eintrag 2

*
Ein weiterer Listeneintrag

Text nach der Aufzählung.

 

Zeichensatz

Ein Dokument kann gemischt Zeichen in UTF8 oder ISO 8859-15 enthalten. Die Interpretation von UTF8-Sequenzen ist vorrangig. Gehört ein Byte nicht zu einer UTF8-Sequenz, wird es als Zeichen im Zeichensatz ISO 8859-15 interpretiert.

Intern werden die Zeichen im Unicode gespeichert.

Von den weißen Zeichen wird nur das Leerzeichen, der Tabulator und der Zeilenvorschub interpretiert. Tabulatoren werden automatisch in Leerzeichen expandiert. Tabulatorbreite ist dabei 8 Zeichen. Mehrere aufeinanderfolgende Leerzeichen gelten im Regelfall wie ein einzelnes Leerzeichen. Eine Leerzeile trennt einzelne Absätze.

 

Einrücktiefe

Leerzeichen und Tabulatoren am Anfang einer Zeile werden nicht ausgegeben, sondern bestimmen die aktuelle Einrücktiefe. Diese dient zur automatischen Verwaltung von listenähnlichen Strukturen. Bei Tabellenzeilen und bei Befehlen mit langen Argumenten dient die Einrückung zur Kennzeichnung von Fortsetzungszeilen.

 

Kommentare

Eine Beschreibungsdatei kann Kommentare im C++-Stil enthalten. Diese sind etweder durch /* ... */ oder durch // ... Zeilenvorschub begrenzt, wobei der Zeilenvorschub selbst nicht zum Kommentar gerechnet wird.

Beginnt ein Kommentar unmittelbar am Zeilenanfang, wird ein dem Kommentar folgender Zeilenvorschub unterdrückt. Bei der Entfernung eines Kommentars aus dem Eingabestrom kann damit nie eine Leerzeile (Absatztrennung!) entstehen.

 

Namen

Befehle, Makros und Sonderzeichen werden durch einen Namen gekennzeichnet. Dieser muß mit einem Buchstaben beginnen und darf nur aus Buchstaben und Ziffern bestehen. Ein Unterstreichungssymbol gilt als Buchstabe.

Folgt auf einem Namen ein Leerzeichen oder ein Tabulator, werden alle folgenden Leerzeichen und Tabulatoren entfernt. Folgt auf einen Namen ein Strichpunkt, wird dieser entfernt. Jedes andere Zeichen nach einem Namen bleibt erhalten.

 

Ligaturen

Dabei handelt es sich um gewisse Buchstabenkombinationen, bei deren Zusammentreffen ein neues Zeichen gebildet, oder einzelne Zeichen anders gesetzt werden. Folgende Ligaturen sind definiert:
*
Ein einzelnes Minuszeichen - wird als kurzer Strich -, zwei aufeinanderfolgende Minuszeichen -- werden als mittellanger Strich - und drei aufeinanderfolgende Minuszeichen --- werden als langer Strich - gesetzt.
*
Drei aufeinanderfolgende Punkte werden mit einem breiteren Abstand gesetzt. Alternativ kann dafür &ldots; eingesetzt werden.
*
Ein Plus - oder ein Minus + vor einer Ziffer wird im mathematischen Modus gesetzt.

 

Fluchtsymbol

Der Dokumentgenerator kennt eine Reihe von Steuerzeichen. Zu ihrer Ausgabe wird als Fluchtsymbol der Gegenschrägstrich \ verwendet. Dieser dient auch zur Kennung eines Dokumentbefehls. Grundsätzlich gilt: folgt einem Gegenschrägstrich ein alphanumerisches Zeichen oder ein Unterstreichungssymbol, handelt es sich um einen Dokumentbefehl, ansonsten wird das nachfolgende Zeichen wie ein gewöhnliches Zeichen behandelt, unabhängig davon ob es sich um ein Sonderzeichen handelt oder nicht.

Für die Maskierung mit dem Fluchtsymbol gelten folgende Regeln:

*
Die Zeichen \, @, &, <, >, | und ~ benötigen immer das Fluchtsymbol.
*
Ein Zuweisungszeichen = nach einem Befehl- oder Makronamen benötigt das Fluchtsymbol.
*
Die Zeichen *, # und [ benötigen am Anfang einer Zeile oder im Tabellensatz das Fluchtsymbol.
*
Einzelne Steuerzeichen oder Befehle können die syntaktische Bedeutung einzelner Zeichen vorübergehend ändern.
*
Damit eine Kommentarkennung /* und // nicht interpretiert wird, ist eines der Zeichen zu maskieren.
*
Ligaturen können wahlweise durch Maskierung eines Zeichens oder durch Einfügen von leeren Kommentaren /**/ aufgehoben werden.
*
Bei Befehls- und Makroargumenten gelten eigene Maskierungsregeln, sie werden im Abschnitt [macro] beschrieben.

 

Sonderzeichen

Satztechnische Zeichen (z.B: Umbruchstellen) und schwer über die Standardtastatur eingebbare Zeichen werden als Sonderzeichen bezeichnet.

Ein Sonderzeichen wird mit dem Steuerzeichen & eingeleitet, danach folgt der Name des Sonderzeichens oder ein einzelnes, nichtnumerisches Zeichen. Als Namenskonvention werden die in HTML üblichen Namen für Character Entitäten verwendet.

Die nichtnumerischen Zeichen werden für häufig verwendete Sonderzeichen eingesetzt. Ist die entsprechende Zeichenkombination nicht definiert, wirkt & wie ein Fluchtsymbol. Derzeit wird nur &- für das Sonderzeichen &shy;, das eine Umbruchstelle markiert, verwendet. Die Kombination &; gilt als Leerzeichein und kann z.B. zum Aufbrechen einer Ligatur verwendet werden.

Für das häufig benötigte Leerzeichen ohne Umbrucherlaubnis wird das Steuerzeichen ~ (entspricht &nbsp;) verwendet.

 

Absätze

Die Grundelemente eines Dokumentes sind Absätze. Diese werden voneinander durch Leerzeilen getrennt. Bei Befehlen, die einen neuen Absatz erzwingen, kann die Leerzeile entfallen. Die Zahl der Leerzeilen zwischen einem Absatz ist beliebig.

 

ANWEISUNGEN

Dieser Abschnitt listet alle vordefinierten Anweisungen von efeudoc auf.

Bezüglich der Argumentdarstellung von Befehlen gilt folgende Konvention:

*
Gibt es mehrere Varianten der Argumentübergabe, werden diese der Reihe nach angegeben. Eine Befehlsvariante beginnt immer mit dem Befehlswort selbst.
*
Mit Klammern versehene Ausdrücke müssen auch mit den entsprechenden Klammern eingegeben werden. Sie sind optional und können mit den zugehörigen Klammern weggelassen werden.
*
Ein Argument ohne Klammerung in der gleichen Zeile des Befehls wird mit dem nächsten Zeilenvorschub abgeschlossen.
*
Eingerückte Punkte in der nächsten Zeile deuten eine Fortsetzbarkeit des Arguments mit eingerückten Zeilen an.
*
Ein Argument in der nächsten Zeile bedeutet einen physikalischen Absatz, d.h. die Anweisung endet bei der ersten Leerzeile.
\addflag
Dokumentflags
\addflag flags
Der Befehl \addflag erweitert die Flags zur Dokumentverarbeitung. Inwieweit einzelne Flags bei der Formatierung berücksichtigt werden, hängt vom jeweiligem Ausgabetreiber ab.
\addsrc
Liste der Programmsourcen um Einzeldatei erweitern
\addsrc name
Der Befehl \addsrc erweitert die Liste der Programmsourcen mit der Datei name.
\addsrclist
Liste der Programmsourcen um Dateien in Bibliothek erweitern
\addsrclist dir
Der Befehl \addsrclist erweitert die Liste der Programmsourcen zur Konstruktion von Handbucheinträgen mit allen Dateien aus der Bibliothek dir. Fehlt die Angabe von dir, wird der Bibliotheksname der aktuellen Eingabedatei genommen.
\appendix
Anhang
\appendix [Kurzform] Bezeichnung
Der Befehl \appendix beginnt einen neuen Anhangteil.
\author
Autorenliste
\author Autorenliste
    ...
Der Befehl \author definiert die Autorenliste für die Titelseite.
\bfitem
Beschreibungsmarke in Fettschrift
\bfitem Marke
Der Befehl \bfitem setzt eine Beschreibungsmarke in Fettschrift.
\bibitem
Eintrag ins Literaturverzeichnis

Der Befehl \bibitem beginnt einen Eintrag ins Literaturverzeichnis

\bibliography
Literaturverzeichnis

Der Befehl \bibliography beginnt das Literaturverzeichnis

\br
Zeilenumbruch

Der Befehl \br bewirkt einen Zeilenumbruch.

\caption
Über- und Unterschriften für Übersichten
\caption [Kurzform] Überschrift
Der Befehl \caption setzt eine Über- bzw. Unterschrift in einer gleitenden Übersicht.
\chap
Kapitel
\chap [Kurzform] Kapiteltitel
    ...
Der Befehl \chap beginnt ein neues Kapitel.
\cite
Abruf eines Literatureintrages

Der Befehl \cite ruft einen Literatureintrag ab.

\cmdinclude
Befehlsscript einbinden
\cmdinclude "name" \cmdinclude <name>
\code
Kodeumgebung

Der Befehl \code wechselt in die Code-Umgebung. Innerhalb dieser Umgebung wird der Text in Schreibmaschine gesetzt.

\config
Konfigurationsfile laden
\config name
Der Befehl \config ladet die Befehle in der Konfigurationsdatei name.
\Copyright
Hauptüberschrift COPYRIGHT
\date
Datum setzen
\date Datum
Der Befehl \date setzt das Datum des Dokuments.
\delsrc
Dateien aus der Liste der Programmsourcen löschen
\delsrc list
Der Befehl \delsrc löscht alle Dateien aus der Liste der Programmsourcen, die der Musterliste list entsprechen. Eine leere Liste löcht alle Einträge.
\Description
Hauptüberschrift BESCHREIBUNG
\Diagnostics
Hauptüberschrift DIAGNOSE
\docfile
Pfadname einer Dokumentdatei suchen
\docfile Name
\docfile {Name}
Der Befehl \docfile sucht nach der Datei name in Bezug auf den aktuellen Dokumentpfad und liefert bei Erfolg den Pfadnamen.
\end
Aktuelle Umgebung beenden

Der Befehl \end schließt die aktuelle Umgebung ab.

\endall
Alle Umgebungen beenden

Der Befehl \endall schließt alle Umgebungen ab.

\endlist
Liste beenden

Der Befehl \endlist schließt die aktuelle Liste ab.

\Environment
Hauptüberschrift UMGEBUNGSVARIABLEN
\Errors
Hauptüberschrift FEHLER
\eval
Ausdruck auswerten
\eval Ausdruck
\eval {Ausdruck}
Der Befehl \eval wertet den nachfolgenden Ausdruck Ausdruck aus und stellt das Ergebnis in die Standardeingabe. Der Ausdruck kann wahlweise als Befehlszeile oder als Block mit geschwungenen Klammern angegeben werden.

Beispiel: \eval{3*5} liefert 15.

\Example
Hauptüberschrift BEISPIEL
\Examples
Hauptüberschrift BEISPIELE
\fig
Abbildung
\fig [pos]
Der Befehl \fig beginnt eine gleitende Abbildung.
\Files
Hauptüberschrift DATEIEN
\getsrc
Dateien der Sourceliste einbinden
\getsrc [cmd] list
Das Argument list gibt eine Liste von Selektionsmustern zur Auswahl der Dateien an. Der optionale Parameter cmd bestimmt das Filterprogramm zur Aufbereitung des Datenfiles.
\geval
Ausdruck global auswerten
\geval Ausdruck
\geval {Ausdruck}
Der Befehl \geval arbeitet wie \eval, jedoch werden neue Variablen global angelegt.
\hang
Hängende Absätze

Der Befehl \hang beginnt eine Umgebung mit hängenden Absätzen.

\head
Hauptüberschrift in Handbucheinträgen
\head [Kurzform] Hauptüberschrift
    ...
Der Befehl \head setzt eine Hauptüberschift.
\hmode
Absatz beginnen, Horizontaler Modus
\hmode
Der Befehl \hmode beginnt einen Absatz, falls noch keiner angefangen wurde.
\if
Testblock
\if {expr} ifpart ;[\else elsepart;] \endif
Falls expr wahr ist, wird ifpart ausgegeben, ansonsten elsepart. Das Schlüsselwort \else kann zusammen mit elsepart entfallen. Testblöcke können verschachtelt werden. Kommentare und mit | ... | oder ---- ... ---- geklammerte Textteile werden nicht nach Schlüsselwörtern untersucht.
\include
Datei einbinden
\include [flags] name
Der Befehl \include bindet die Datei file an der aktuellen Position ein. Folgende Steuerflags können angegeben werden:
verbatim
Wortwörtlicher Text ohne Interpretation von Sonderzeichen. Tabulatoren werden durch Leerzeichen ersetzt.
latex
Datei enthält LaTeX-Steuersequenzen
html
Datei enthält HTML-Steuersequenzen
man
Datei enthält nroff-Steuersequnenzen im Handbuchstandard
ignore
Datei wird verarbeitet, aber es erfolgt keine Ausgabe.
eval
Die Datei wird als Befehlsskript ausgewertet.
geval
Die Datei wird als Befehlsskript ausgewertet, wobei neue Variablen global angelegt werden.

\index
Indexeintrag
\index [Eintrag]{Bereich}
Der Befehl \index generiert einen Indexeintrag Eintrag zu einem Textbereich Bereich. Fehlt Eintrag wird Bereich als Indexeintrag verwendet.
\intro
Einführung

Der Befehl \intro beginnt die Einführung

\item
Beschreibungsmarke in Standardschrift
\item Marke
Der Befehl \item setzt eine Beschreibungsmarke in Standardschrift.
\ititem
Beschreibungsmarke in Kursivschrift
\ititem Marke
Der Befehl \ititem setzt eine Beschreibungsmarke in Kursivschrift.
\label
Label
\label {Name}
Der Befehl \label setzt einen Label an der aktuellen Position.
\langpar
Sprachabhängiger Absatz
\langpar
par
Experimentell, könnte geändert werden.
\latex
LaTeX-Befehl
\latex [Alternative] {LaTeX-Code}
\latex [Alternative] LaTeX-Code
Der Befehl \latex erlaubt die direkte Ausgabe von LaTeX-Code an den LaTeX-Treiber. Bei allen anderen Ausgabetreibern wird die Alternative ausgegeben.
\lmark
Literaturmarke
\lmark {name}
Der Befehl \lmark generiert eine Literaturmarke.
\lof
Verzeichnis der Abbildungen

Der Befehl \lof generiert ein Tabellenverzeichnis.

\lot
Verzeichnis der Tabellen

Der Befehl \lot generiert ein Tabellenverzeichnis.

\margin
Randnotiz
\margin [Links] {Randnotiz}
Der Befehl \margin setzt eine Randnotiz. Der optionale Text Links für linke Seiten wird nur bei doppelseitigem Druck verwendet.
\mark
Fußnotenmarke
\mark {num}
Der Befehl \mark generiert eine Fußnotenmarke.
\math
Mathematischer Formelsatz
\math {Formel}
\mchap
Handbuchkapitel
\mchap [Nummer] Kapiteltitel
    ...
Der Befehl \mchap beginnt ein neues Handbuchkapitel.
\mkmf
Makefile generieren und einbinden
\mkmf Imakefile
Der Befehl \mkmf wendet mkmf auf das angegebene Imakefile an und bindet das Makefile wortwörtlich ein.
\mksource
Sourcefile generieren
\mksource Datei
Der Befehl \mksource wendet mksource auf die angegebene Skriptdatei an und bindet die Ergebnisdateien wortwörtlich ein.
\mpage
Handbucheintrag
\mpage [num] name
Der Befehl \mpage beginnt einen neuen Handbucheintrag mit Namen name zum Handbuchkapitel num. Dieser Befehl wird automatisch zu Beginn einer Datei eingefügt, dessen Filezusatz mit einer Ziffer beginnt.
\mref
Referenz auf einen Handbucheintrag.
\mref {arg}
Der Befehl \mref generiert eine Referenz auf einen Handbucheintrag.
\ms_example
Beispiel für mksource ausführen
\ms_example name Beispielskript \\end
Der Befehl \ms_example wendet mksource auf das Beispielskript an und bindet dieses mit allen Ergebnisdateien wortwörtlich ein.
\n
Zeilenvorschub
\n
Der Befehl \n schreibt einen Zeilenvorschub zurück.
\Name
Namensabschnitt einer Handbuchseite mit Hauptüberschrift BEZEICHNUNG
\Name [Kurzform] Titel
    ...
\Name [Kurzform]
Einzeiliger Titel
\newpage
Seitenumbruch

Der Befehl \newpage bewirkt einen Seitenumbruch.

\note
Fußnote
\note [Marke] {Anmerkung}
Der Befehl \note setzt eine Fußnote.
\Notes
Hauptüberschrift BEMERKUNGEN
\package
LaTeX-Pakete
\package[opt] name
Der Befehl \package generiert für LaTeX die Definitionszeile \usepackage[opt]{name}. Damit werden Zusatzpakete geladen.
\par
Absatz beenden, vertikaler Modus
\par
Der Befehl \par beendet einen Absatz.
\para
Paragraph
\para [Kurzform] Paragraph
    ...
Der Befehl \para setzt einen Pargraphen.
\part
Teilabschnitt
\part [Kurzform] Abschnittstitel
    ...
Der Befehl \part beginnt einen neuen Teilabschnitt.
\pipe
Prozesseingabe
\pipe [flags] cmd     ...
Der Befehl \pipe bindet die Ausgabe des Kommandos cmd ein. Die Flags flags sind äquivalent zu \include.
\pop
Befehlstabelle entfernen

Der Befehl \pop entfernt die unterste Tabelle vom Tabellenstack.

\pref
Seitenreferenz
\pref {Name}
Der Befehl \pref referenziert die Seite eines Labels.
\preface
Vorwort

Der Befehl \preface beginnt das Vorwort

\printindex
Stichwortverzeichnis

Der Befehl \printindex generiert das Stichwortverzeichnis.

\printsrclist
Aktuelle Liste der Programmsourcen ausgeben
\printsrclist fmt
Der Befehl \printsrclist gibt die aktuelle Liste der Programmsourcen aus.
\proto
Funktionsprototype
\proto Prototype
Die Funktion \proto dient zur Ausgabe eines Funktionsprototypes der EFEU INterpretersprache
\push
Neue Befehlstabelle

Der Befehl \push generiert eine neue Tabelle für Befehle, Makros und Variablen und legt sie am Tabellenstack ab.

\quote
Einrückung

Der Befehl \quote wechselt in die quote-Umgebung. Innerhalb dieser Umgebung wird der Text eingerückt.

\ref
Referenz
\ref {Name}
Der Befehl \ref referenziert den Wert eines Labels.
\relax
Leerbefehl

Der Befehl \relax bewirkt nichts.

\rem
Kommentar
\rem Kommentar
Der Befehl \rem schreibt einen Kommentar in das Ausgabefile.
\sec
Bereich
\sec [Kurzform] Bereichstitel
    ...
Der Befehl \sec beginnt einen neuen Bereich.
\SeeAlso
Hauptüberschrift SIEHE AUCH
\shead
Nebenüberschrift in Handbucheinträgen
\shead [Kurzform] Nebenüberschrift
    ...
Der Befehl \shead setzt eine Nebenüberschrift.
\spage
Teilseite
\spage [margin] flags
Der Befehl \spage beginnt eine neue Teilseite, veraltet.
\src2doc
Handbucheinträge aus Programmsourcen generieren
\src2doc [flags] Musterliste
Das Argument Musterliste gibt eine Liste von Selektionsmustern an. Der Optionale Parameter flags erlaubt die Übergabe von Optionen an das Kommando src2doc.
\srcinclude
Dateien der Sourceliste einbinden
\srcinclude Musterliste
Das Argument list gibt eine Liste von Selektionsmustern zur Auswahl der Dateien an.
\ssec
Zwischentitel
\ssec [Kurzform] Zwischentitel
    ...
Der Befehl \ssec setzt einen Zwischentitel und beginnt einen neuen Teilbereich.
\style
Dokumentart
\style Stil
Der Befehl \style setzt die Dokumentart.
\Synopsis
Hauptüberschrift ÜBERSICHT
\t
Tabulator
\t
Der Befehl \t schreibt einen Tabulator zurück.
\tab
Tabellensatz
\tab [pos] fmt
Tabellenzeilen
Der Befehl \tab beginnt eine Tabelle mit vertiklarer Ausrichtung pos und Spaltenformartierung fmt. Die Tabellendefinition endet bei der ersten Leerzeile.
\table
Tabelle
\table [pos]
Der Befehl \table beginnt eine gleitende Tabelle.
\thedate
Datum abfragen
\thedate
Der Befehl \thedate ruft das Dokumentdatum ab.
\title
Titel und Untertitel
\title [Kurzform] Titel
Untertitel
Falls das Dokument noch nicht begonnen wurde, setzt der Befehl \title Titel und Untertitel des Dokuments. Ansonsten wird ein neues Kapitel begonnen, wobei die Kurzform für den Eintrag ins Inhaltsverzeichnis verwendet wird.
\toc
Inhaltsverzeichnis

Der Befehl \toc generiert ein Inhaltsverzeichnis.

\ttitem
Listeneintrag in Schreibmaschinenschrift
\ttitem Marke
Der Befehl \ttitem setzt eine Beschreibungsmarke in Schreibmaschinenschrift.
\url
Referenz auf einen Hyperlink.
\url |url| {Bezeichnung}
Der Befehl \url generiert einen Hyperlink.
\vref
Kombinierte Referenz
\vref {Name}
Der Befehl \vref referenziert Wert und Seite eines Labels.
\vspace
Vertikale Verschiebung
\vspace offset
Der Befehl \vspace beendet den laufenden Absatz und generiert eine vertikale Verschiebung um offset Zeilen.
\Warnings
Hauptüberschrift WARNUNGEN

 

MAKROS

Dieser Abschnitt enthält eine Auflistung aller vordefinierten Makros von efeudoc.
@if
Bedingter Ausdruck
@if (expr,ifpart,elsepart)
Falls expr wahr ist, wird ifpart ausgegeben, ansonsten elsepart.
@MSExample
mksource Beispiel einbinden
@MSExample (name,text)
Der Makro bindet ein Beispielskript und sein Ergebnis ein. Dabei ist name der Name des Skripts und text der Trenntext zwischen Skriptfile und den Ergebnisdateien.
@PRM
reference to the Programmer''s Reference Manual
 

UMGEBUNGSVARIABLEN

APPLPATH
definiert zusätzliche Verzeichnisse für Konfigurationsdateien.
LANG
bestimmt die Sprache für Meldungen und Hilfetexte.
 

SIEHE AUCH

esh(1).

 

COPYRIGHT

Copyright (C) 1999 Erich Frühstück


 

Index

BEZEICHNUNG
ÜBERSICHT
BESCHREIBUNG
BESCHREIBUNG
Zeichensatz
Einrücktiefe
Kommentare
Namen
Ligaturen
Fluchtsymbol
Sonderzeichen
Absätze
ANWEISUNGEN
MAKROS
UMGEBUNGSVARIABLEN
SIEHE AUCH
COPYRIGHT

This document was created by man2html, using the manual pages.
Time: 09:44:47 GMT, December 18, 2011