Format, Format

Viele Manpages liegen im groff-Format vor – es handelt sich um eine Textauszeichnungsmethode, die der von Markup-Sprachen (z. B. HTML und SGML) oder dem Satzsystem LaTeX ähnelt. Mit speziellen Formatierungsbefehlen beschreiben Sie das Aussehen bzw. die Struktur des Textes. Anschließend wandeln Sie auf der Kommandozeile groff-Dokumente in formatierte ASCII-Ausgaben, HTML-Seiten oder PostScript-Dateien um.

Viele groff-Formatierungsbefehle stehen in Zeilen, die mit einem Punkt beginnen. Dahinter stehen jeweils Anweisungen, welche die Struktur der Manpage beschreiben. So stehen beispielsweise .SH für eine Kapitelüberschrift in einer Manpage und .PP für einen Zeilenumbruch bzw. neuen Paragraphen. Darüber hinaus gibt es die Möglichkeit, mit Zeichenfolgen Elemente im Fließtext (und nicht in eigenen Zeilen) zu beschreiben: So schalten Sie mit \fB auf das Schriftattribut "fett" ("bold") um und mit \fP wieder zurück auf die vorherige Schriftart. Tabelle 1 zeigt die wichtigsten Formatierungsbefehle zum Nachschlagen; darüber hinaus lohnt sich ein Blick in die Manpage zu groff_man(7).

Tabelle 1: Formatierung in <C>groff<C>

.TH Titel-/Kopfzeile der Manpage
.SH Kapitel- bzw. Sektionsüberschrift
.SS Überschrift zweiter Ordnung
.PP Neuer Paragraph / Zeilenumbruch
.HP Beginn eines eingerückten Absatzes
.RE Ende eines eingerückten Absatzes
.IP Liste mit Aufzählungszeichen; in der Zeile nach der Formatanweisung steht als Aufzählungszeichen entweder eine Ziffer, ein Gliederungspunkt (\(bu oder ein Gedankenstrich (\(em), in der dritten Zeile die Definition.
.TP Liste ohne Aufzählungszeichen; die Zeile nach der Formatanweisung enthält die Bezeichner, die dritte Zeile die Beschreibung.
." Kommentar
\fB Formatiert den nachfolgenden Text fett ("bold")
\fI Formatiert den nachfolgenden Text kursiv ("italic")
\fR Formatiert den nachfolgenden Text mit Serifen ("roman")
\fP Schaltet zur vorherigen Schriftart zurück

Das Grundgerüst erstellen

Learning by doing – am schnellsten lernen Sie die groff-Befehle, indem Sie eine eigene Manpage schreiben. Mehr als einen einfachen Text-Editor brauchen Sie dazu nicht. Legen Sie eine neue Datei an und geben Sie dieser beispielsweise die Endung .1, wenn es sich um ein Benutzerkommando handelt, das später in der ersten Manpage-Abteilung liegen soll. Die erste Zeile einer Manpage enthält traditionell den Titel, die Manpage-Sektion und das Datum der letzten Bearbeitung; tragen Sie also ein:

.TH HUHN 1 "22. Oktober 2004"

Als Nächstes legen Sie die einzelnen Kapitel an. Welche der schon genannten Sektionen Sie verwenden wollen, bleibt Ihnen selbst überlassen – es handelt sich lediglich um eine Konvention, nicht um eine feste Vorgabe; Sie können auch eigene Abschnitte definieren. Die einzelnen Sektionen fangen jeweils mit dem Befehl .SH an und stehen in einer neuen Zeile, danach folgt der Name der Sektion:

.SH NAME
.SH SYNOPSIS
.SH DESCRIPTION
.SH SEE ALSO
.SH BUGS
.SH AUTHOR

Ein Unterkapitel namens Options soll im Abschnitt DESCRIPTION die einzelnen Befehlsparameter erklären. Fügen Sie dazu ein strukturierendes Element ein:

.SH DESCRIPTION
.SS Options
…

LinuxCommunity kaufen

Einzelne Ausgabe
 
Abonnements
 

Ähnliche Artikel

  • man und info
    Schnell eine Befehlsoption nachschauen, einfach stöbern, was ein Kommando sonst noch alles kann, oder ausführliche Hilfetexte lesen mit Querverweisen – mit man und info bleiben Sie im Bilde.
  • Zu Befehl
    Auch wenn viele Dinge sich bequem über grafische Oberflächen wie KDE oder GNOME regeln lassen – wer sein Linux-System richtig ausreizen möchte, kommt um die Kommandozeile nicht herum. Und auch sonst gibt es viele Situationen, wo es gut ist, sich im Befehlszeilendschungel ein wenig auszukennen.
  • Bunte Manpages anzeigen mit most und less
  • Shell-Tipps
    Erfahrene Linux-Nutzer schwören auf flexible Kommandozeilentools, mit denen sich manche Aufgabe schneller bewältigen lässt als in grafischen Programmen. Wir stellen die wichtigsten Anwendungen vor, um auch Einsteiger zu einem Ausflug in die Shell zu ermutigen.
  • Know-how für die Kommandozeile
    Erfahrene Linux-Nutzer schwören auf flexible Kommandozeilentools, mit denen sich manche Aufgabe schneller bewältigen lässt als in grafischen Programmen. Wir stellen die wichtigsten Anwendungen vor, um auch Einsteiger zu einem Ausflug in die Shell zu ermutigen.
Kommentare

Infos zur Publikation

LU 11/2014: VIDEOS BEARBEITEN

Digitale Ausgabe: Preis € 4,95
(inkl. 19% MwSt.)

Mit der Zeitschrift LinuxUser sind Sie als Power-User, Shell-Guru oder Administrator im kleinen Unternehmen monatlich auf dem aktuelle Stand in Sachen Linux und Open Source.

Sie sind sich nicht sicher, ob die Themen Ihnen liegen? Im Probeabo erhalten Sie drei Ausgaben zum reduzierten Preis. Einzelhefte, Abonnements sowie digitale Ausgaben erwerben Sie ganz einfach in unserem Online-Shop.

NEU: DIGITALE AUSGABEN FÜR TABLET & SMARTPHONE

HINWEIS ZU PAYPAL: Die Zahlung ist auch ohne eigenes Paypal-Konto ganz einfach per Kreditkarte oder Lastschrift möglich!       

Tipp der Woche

Schnell Multi-Boot-Medien mit MultiCD erstellen
Schnell Multi-Boot-Medien mit MultiCD erstellen
Tim Schürmann, 24.06.2014 12:40, 0 Kommentare

Wer mehrere nützliche Live-Systeme auf eine DVD brennen möchte, kommt mit den Startmedienerstellern der Distributionen nicht besonders weit: Diese ...

Aktuelle Fragen

Artikelsuche
Erwin Ruitenberg, 09.10.2014 07:51, 1 Antworten
Ich habe seit einige Jahre ein Dugisub LinuxUser. Dann weiß ich das irgendwann ein bestimmtes Art...
Windows 8 startet nur mit externer Festplatte
Anne La, 10.09.2014 17:25, 4 Antworten
Hallo Leute, also, ich bin auf folgendes Problem gestoßen: Ich habe Ubuntu 14.04 auf meiner...
Videoüberwachung mit Zoneminder
Heinz Becker, 10.08.2014 17:57, 0 Antworten
Hallo, ich habe den ZONEMINDER erfolgreich installiert. Das Bild erscheint jedoch nicht,...
internes Wlan und USB-Wlan-Srick
Gerhard Blobner, 04.08.2014 15:20, 2 Antworten
Hallo Linux-Forum: ich bin ein neuer Linux-User (ca. 25 Jahre Windows) und bin von WIN 8 auf Mint...
Server antwortet mit falschem Namen
oin notna, 21.07.2014 19:13, 1 Antworten
Hallo liebe Community, Ich habe mit Apache einen Server aufgesetzt. Soweit, so gut. Im Heimnet...