ndx(1M) ndx(1M)
NAME
ndx - Themenindex für ein Dokument erstellen
SYNTAX
ndx subjfile "formatter command line"
BESCHREIBUNG
ndx durchsucht ein angegebenes Dokument nach einer Liste mit Begriffen
(subjfile) und schreibt einen Themenindex in die Standardausgabe.
subjfile ist die Liste der Begriffe, die im Index aufgeführt werden
sollen. Jeder Begriff muß in einer neuen Zeile beginnen und folgendes
Format haben:
word1 [word2 ...] [, wordk ...]
Beispiel:
gedruckte Schaltkarten
Bereiche
Bereiche, dynamische Speicherung
Schmidt, W. P.
gedruckte Schaltkarten, kanalorientiert mit mehreren Schichten
Aranoff
University of Illinois
PL/1
Der Begriff muß in Spalte 1 beginnen.
Für die Aufrufzeile des Formatierprogramms gilt folgende Syntax:
formatter [option(s)] file(s)
Mit diesem Kommando wird das endgültige Format des Dokuments erstellt.
Es folgen Beispiele für gültige Aufrufzeilen des Formatierprogramms:
mm -Tlp file(s)
nroff -mm -Tlp -rW60 file(s)
troff -rB2 -Taps -r01.5i file(s)
Weitere Informationen zur Aufrufzeile des Formatierprogramms finden
Sie in den Abschnitten mm(1M), mmt(1M), nroff(1M) und troff(1M).
Das Dokument muß Formatierkommandos für mm, nroff oder troff enthal-
ten. Die Aufrufzeile des Formatierprogramms teilt ndx mit, ob die End-
version des Dokuments mit troff, nroff, mm oder mmt erzeugt wird. Die
Angabe troff oder mmt besagt, daß troff als Formatierprogramm verwen-
det wird. Mit nroff oder mm wird nroff als Formatierprogramm angege-
ben. Die Optionen option(s) entsprechen denen, die Sie auch beim Kom-
mando troff, nroff, mm oder mmt für das Drucken der Endversion des
Dokuments angeben würden. Sie sind erforderlich, um die korrekte Sei-
tennummer für die im Dokument gefundenen Begriffe zu ermitteln.
Seite 1 Reliant UNIX 5.44 Gedruckt 11/98
ndx(1M) ndx(1M)
ndx simuliert lediglich das Ausdrucken der Endversion des Dokuments.
Der Autor muß das Dokument separat erstellen. Die Indexerstellung
sollte logischerweise erst erfolgen, wenn das Dokument vollständig ist
und keine weiteren Änderungen erwartet werden.
BEISPIELE
Das Kommando
ndx subjfile "nroff -mm -rW70 file(s)" > indexfile
erzeugt einen Themenindex für das Dokument file(s). Die Begriffe wer-
den dabei der Liste subjfile entnommen. Die Seitennummern entsprechen
denen, die von
nroff -mm -rW70 file(s)
erstellt werden.
Das Kommando
ndx subjfile "mm -rW60 -rN2 -rO0 ch1 ch2 ch3" > indexfile
erzeugt einen Themenindex für die Dokumente ch1, ch2 und ch3. Die Sei-
tennummern entsprechen denen, die von
mm -rW60 -rN2 -rO0 ch1 ch2 ch3
erstellt werden.
Das Kommando
ndx subjfile "troff -rB2 -rW5i -rO1.5i -mm file(s)" > indexfile
erzeugt einen Themenindex für das Dokument file(s) Die Seitennummern
entsprechen denen, die von
troff -rB2 -rW5i -rO1.5i -mm file(s)
erstellt werden.
SIEHE AUCH
mm(1M), mmt(1M), nroff(1M), subj(1M), troff(1M).
Seite 2 Reliant UNIX 5.44 Gedruckt 11/98