man(5) man(5)
NAME
man - Makros zur Formatierung von Handbucheinträgen (Manpages)
SYNTAX
nroff -man file ...
troff -man [-rs1] file ...
BESCHREIBUNG
Diese troff(1M)-Makros werden verwendet, um die Einträge (Manpages) in
einem Handbuch zu formatieren. Sie werden vom man(1)-Kommando einge-
setzt.
Die Standardgröße einer Seite ist 8,5" x 11", wobei der bedruckbare
Bereich 6,5" x 10" groß ist. Durch die Angabe der Option -rs1 verrin-
gern Sie diese Maße auf 6" x 9" bzw. 4,75" x 8,375". Außerdem verrin-
gern Sie durch die Angabe dieser Option, die unter nroff(1M) keine
Wirkung hat, die Standardzeichengröße von 10 auf 9 Punkt und den ver-
tikalen Zeilenabstand von 12 auf 10 Punkt. Mit der Option -rV2 können
Sie bestimmte Parameter auf Werte setzen, die für bestimmte Versatec-
Drucker erforderlich sind: Die Zeilenlänge wird auf 82 Zeichen und die
Seitenlänge auf 84 Zeilen gesetzt. Außerdem wird die Unterstreichung
unterdrückt. Diese Option ist nicht mit der Option -Tvp des Kommandos
man(1) zu verwechseln, das für einige UNIX Systeme verfügbar ist.
Jedes der unten aufgeführten Argumente text kann aus eins bis sechs
"Begriffen" bestehen. Sie können doppelte Anführungszeichen ("") ver-
wenden, wenn ein "Begriff" Leerzeichen enthalten soll. Wird für text
nichts angegeben, wird die Formatierung auf die nächste Zeile angewen-
det, die zu druckenden Text enthält. Durch die Angabe von .I bei-
spielsweise können Sie eine ganze Zeile in Kursivdruck formatieren.
Die Angabe .SM gefolgt von .B erzeugt Text in Fettdruck, der 1 Punkt
kleiner ist als die Standardschriftgröße. Die Silbentrennung wird
standardmäßig für nroff(1M) aus- und für troff(1M) eingeschaltet.
Schriftart und -größe werden vor jedem Absatz und nach der Verarbei-
tung von Makros, die die Schriftart und -größe ändern (z. B. .I, .RB,
.SM), auf die Standardwerte zurückgesetzt. Tabulatorstopps werden von
keinem Makro mit Ausnahme von .DT und .TH gesetzt oder verwendet.
Die Standardeinheiten für Einrückungen in sind ens. Wird in ausgelas-
sen, wird die vorige Einrückung weiter verwendet. Diese gespeicherte
Einrückung wird von .TH, .P und .RS auf den Standardwert gesetzt,
d. h. 7,2 ens für troff und 5 ens für nroff, und von .RE wiederherge-
stellt. Dieser Wert entspricht bei der Standardseitengröße 0,5".
Seite 1 Reliant UNIX 5.44 Gedruckt 11/98
man(5) man(5)
.TH t s c n Den Titel und die Eintragsüberschrift festlegen. t ist
der Titel, s die Kapitelnummer, c gibt einen zusätzli-
chen Kommentar an, z. B. "local", und n den neuen Titel
des Handbuchs. Außerdem wird .DT aufgerufen (siehe
unten).
.SH text Überschrift text der ersten Ordnung, z. B. SYNTAX, hier
einfügen.
.SS text Überschrift text der zweiten Ordnung, z. B. Attribute,
hier einfügen.
.B text text in Fettdruck formatieren.
.I text text in Kursivdruck formatieren.
.SM text text 1 Punkt kleiner als die Standardschriftgröße forma-
tieren.
.RI a b Schriftart Roman a mit Kursivdruck b verketten und diese
beiden Schriftarten für bis zu sechs Argumente abwech-
seln. Ähnliche Makros wechseln zwischen jeweils zwei
Schriftarten der Gruppe Roman, Kursivdruck und Fett-
druck: .IR .RB .BR .IB .BI
.P Absatz mit der normalen Schriftart, Schriftgröße und
Einrückung beginnen.
.PP Synonym zu .P.
.HP in Absatz mit hängender Einrückung beginnen.
.TP in Eingerückten Absatz mit hängendem Vortext beginnen. Die
nächste Zeile mit zu druckendem Text wird als Vortext
aufgefaßt. Ist der Vortext zu lang, wird er in einer
eigenen Zeile gedruckt.
.IP t in Wie .TP in mit Vortext t; wird häufig verwendet, um
einen eingerückten Absatz ohne Vortext zu erzeugen.
.RS in Relative Einrückung erhöhen (anfangs Null). Die gesamte
Ausgabe um weitere in Einheiten vom aktuellen linken
Rand einrücken.
.RE k Zur k-ten relativen Einrückungsebene zurückkehren.
(Anfangswert ist k=1; k=0 ist gleichbedeutend mit k=1.)
Wird k ausgelassen, wird zur letzten niedrigeren Einrük-
kungsebene zurückgekehrt.
Seite 2 Reliant UNIX 5.44 Gedruckt 11/98
man(5) man(5)
.PM m y Hinweise für die Sicherheitsstufe erzeugen. Dabei kann
für m P (Proprietary), RS (Restricted), RG (Registered),
CR (Copyright), UW (Unpublished Work) oder CP (See Cover
Page) stehen. y gibt das Jahr an, das in den Bemerkungen
CR und UW für die Copyright-Angabe verwendet wird (stan-
dardmäßig wird das aktuelle Jahr verwendet).
.DT Standardeinstellungen für Tabulatorzeichen wiederher-
stellen (7,2 ens für troff, 5 ens für nroff).
.PD v Den Abstand zwischen Absätzen auf v vertikale Zwischen-
räume setzen. Wird v nicht angegeben, wird dieser
Abstand auf den Standardwert gesetzt (0,4v für troff, 1v
für nroff).
Folgende Zeichenketten (Strings) sind vordefiniert:
\*R ® für troff, (Reg.) für nroff.
\*S In Standardschriftgröße ändern.
\*(Tm Warenzeichensymbol.
.TH weist folgenden numerischen Registern Standardwerte zu:
IN Einrückung für linken Rand relativ zur Überschrift der ersten
Ordnung setzen (Standardwert ist 7,2 ens für troff bzw. 5 ens
für nroff).
LL Zeilenlänge einschließlich IN.
PD Aktueller Abstand zwischen Absätzen.
HINWEISE
Zusätzlich zu den oben genannten Makros, Zeichenketten und numerischen
Registern sind eine Reihe interner Makros, Zeichenketten und numeri-
sche Register definiert. Mit Ausnahme der von troff(1M) vordefinierten
Namen und der numerischen Register d, m und y haben alle internen
Namen das Format XA. Dabei bezeichnet X eines der Zeichen ), ] oder }.
A steht für ein beliebiges alphanumerisches Zeichen.
Muß ein Handbucheintrag von eqn(1M) bzw. neqn(1M) und/oder tbl(1M)
vorbearbeitet werden, muß er mit einer Sonderzeile beginnen [siehe
man(1)]. Diese veranlaßt das Kommando man, die entsprechenden Präpro-
zessoren aufzurufen.
Die Programme, die das Inhaltsverzeichnis und den permutierten Index
für das Handbuch vorbereiten, setzen voraus, daß der Abschnitt NAME
der einzelnen Einträge aus einer einzelnen Eingabezeile in folgendem
Format besteht:
Seite 3 Reliant UNIX 5.44 Gedruckt 11/98
man(5) man(5)
name[, name, name ...] \- Kurzerläuterung
Das Makropaket vergrößert im Abschnitt SYNTAX des jeweiligen Eintrags
den Abstand zwischen den einzelnen Wörtern, um die Wörter deutlicher
voneinander abzugrenzen.
Das Makropaket verwendet nur die Schriftart Roman. Sie können daher
beispielsweise die Fettdruck durch eine dicktengleiche Schriftart (CW)
ersetzen. Enthält der Eingabetext eines Eintrags jedoch Requests für
andere Schriftarten (z. B. .I, .RB, \fI), müssen die entsprechenden
Zeichensätze geladen werden.
HINWEISE
Enthält das Argument für .TH Leerzeichen und ist nicht in doppelte
Anführungszeichen ("") eingeschlossen, erscheinen in der Ausgabe merk-
würdige unregelmäßige Punkte.
DATEIEN
/usr/lib/tmac/tmac.an
/usr/lib/macros/an
SIEHE AUCH
man(1), eqn(1M), nroff(1M), tbl(1M), tc(1M), troff(1M).
Claus Schirmer: "Dokumentations-Tools unter Unix. Troff, nroff,
Documenter's Workbench", R. Oldenbourg Verlag,
München/Wien 1990
Seite 4 Reliant UNIX 5.44 Gedruckt 11/98