Mehr Inhalt bitte!

Diese grundlegende Struktur füllen Sie nun nur noch mit Leben. Damit die Manpage von Kommandos wie apropos oder man -k nach Stichworten durchsucht werden kann, sollten Sie in der dritten Zeile (also direkt hinter dem Eintrag .SH NAME) den Namen und eine durch einen Bindestrich davon abgetrennte kurze Beschreibung des Befehls einfügen. Achten Sie darauf, dass vor dem Bindestrich ein Backslash steht:

.SH NAME
huhn \- Das sensationelle Henne-Ei-Skript

Im Abschnitt SYNOPSIS folgt die Kurzbeschreibung der Befehlssyntax mit einer Auflistung aller Optionen. Der Programmname soll hier fett (\fB...\fP) gesetzt sein, Parameterzusätze kursiv (\fI...\fP). Optionale Parameter stehen in eckigen Klammern:

.SH SYNOPSIS
\fBhuhn\fP [ -ei | -poak | -picken ] [ -t \fItyp\fP ] [ -escape \fIfarm\fP ]

Danach folgen ein Zeilenumbruch und in einem neuen Paragraph – optisch übersichtlich gestaltet – der Hinweis, wie die Befehlshilfe aufzurufen ist. Der Eintrag zur Versionsnummernabfrage kommt ebenfalls in eine eigene Zeile:

.PP
\fBhuhn\fP -h | --help
.PP
\fBhuhn\fP -v | --version

Im Abschnitt DESCRIPTION beschreiben Sie das Kommando nach Herzenslust in einem Fließtext. Mit den schon bekannten Formatanweisungen setzen Sie Befehle, Dateinamen und Optionen wieder kursiv oder fett, um sie besser kenntlich zu machen. Im Unterabschnitt Options notieren Sie in einer Liste die einzelnen Parameter und fügen eine Erklärung hinzu. Dazu verwenden Sie eine der in Tabelle 1 vorgestellten Listen, z. B. die Liste ohne Aufzählungszeichen: Zuerst steht in einer Zeile die Anweisung .TP, in der folgenden Zeile der Parameter und in der dritten Zeile die Erklärung. Ebenso gehen Sie für die restlichen Abschnitte vor – Listing 1 zeigt den Quelltext der huhn-Manpage zum Vergleich.

Listing 1

Manpage zu

huhn (1)
.TH HUHN 1 "22. Oktober 2004"
.SH NAME
huhn \- Das sensationelle Henne-Ei-Skript
.SH SYNOPSIS
\fBhuhn\fP [ -ei | -poak | -picken] [ -t \fItyp\fP ] [ -escape
\fIfarm\fP ]
.PP
\fBhuhn\fP -h | --help
.PP
\fBhuhn\fP -v | --version
.SH DESCRIPTION
Das sensationelle Henne-Ei-Skript kann viele tolle Dinge. Das Huhn kann
gackern, Koerner picken, Eier legen und von der Farm weglaufen. Die
einzelnen Parameter lauten:
.SS Options
.TP
\fB-ei\fP
Fordert das Huhn auf, ein Ei zu legen. Die Frage, ob die Henne oder das
Ei zuerst kommt, ist dabei unerheblich. Es bleibt abzuwarten, ob zu
diesem Problem jemals eine Loesung gefunden wird.
.TP
\fB-escape \fIfarm\fP
Da kein Huhn auf einer Huehnerfarm gefangen sein sollte, befreien Sie
die Hennen mit diesem Befehl, z. B. durch den Aufruf: \fB-escape
tweedie\fP.
.TP
\fB-h, --help\fP
Zeigt die vollstaendige Liste aller Parameter an.
.TP
\fB-poak\fP
Bringt das Huhn zum Gackern.
.TP
\fB-picken\fP
Zwingt das Huhn zur Nahrungsaufnahme.
.TP
\fB-t \fItyp\fP
Definiert den Huehnertyp, moegliche Werte:
.IP \(bu
\fIfrei\fP Freiland
.IP \(bu
\fIkaefig\fP Kaefig
.IP \(bu
\fIbatterie\fP Legebatterie
.TP
\fB-v, --version\fP
Zeigt die Versionsnummer des Skriptes an.
.SH SEE ALSO
Weitere Tipps zu Huehnern finden Sie im Internet. Fuer die Erstellung
von Handbuchseiten empfehlen wir die Manpages zu:
\fBgroff_man\fP(7), \fBgroff\fP(1), \fBman\fP(7)
.SH BUGS
Keine bekannten :)
.SH AUTHOR
Petronella, das Chefhuhn

Wandlungsfähig

Einen ersten Test, ob die Manpage Ihren optischen Vorstellungen entspricht, führen Sie auf der Kommandozeile durch. Wandeln Sie die gerade erstellte Handbuchseite mit den Manpage-Makros ins ASCII-Format um. Damit die Ausgabe nicht aus dem Terminal heraus scrollt, leiten Sie alles in den Pager less um:

groff -man -Tascii huhn.1 | less

Wer statt dessen lieber eine HTML- oder PostScript-Datei erstellt, setzt hinter den Parameter -T das entsprechende Format. Anstelle einer Ausgabe am Bildschirm empfiehlt sich hier, die Ausgabe in eine Datei umzuleiten, also

groff -man -Thtml huhn.1 > huhn.html

oder

groff -man -Tps huhn.1 > huhn.ps
Abbildung 3: Auf der Kommandozeile wandeln Sie die Manpage mit nur einem Befehl in eine Web-Seite um.

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 01/2015: E-Books im Griff

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

Ubuntu 14.10 und VirtualBox
Ubuntu 14.10 und VirtualBox
Tim Schürmann, 08.11.2014 18:45, 0 Kommentare

Wer Ubuntu 14.10 in einer virtuellen Maschine unter VirtualBox startet, der landet unter Umständen in einem Fenster mit Grafikmüll. Zu einem korrekt ...

Aktuelle Fragen

PCLinuxOS Version 2014.08 "FullMonty" Umstellung auf deutsch
Karl-Heinz Welz, 19.12.2014 09:55, 2 Antworten
Hallo, liebe Community, ich bin 63 Jahre alt und möchte jetzt nach Jahrzehnten Windows zu Linux...
ICEauthority
Thomas Mann, 17.12.2014 14:49, 2 Antworten
Fehlermeldung beim Start von Linux Mint: Could not update ICEauthority file / home/user/.ICEauth...
Linux einrichten
Sigrid Bölke, 10.12.2014 10:46, 5 Antworten
Hallo, liebe Community, bin hier ganz neu,also entschuldigt,wenn ich hier falsch bin. Mein Prob...
Externe USB-Festplatte mit Ext4 formatiert, USB-Stick wird nicht mehr eingebunden
Wimpy *, 02.12.2014 16:31, 0 Antworten
Hallo, ich habe die externe USB-FP, die nur für Daten-Backup benutzt wird, mit dem YaST-Partition...
Steuern mit Linux
Siegfried Markner, 01.12.2014 11:56, 2 Antworten
Welches Linux eignet sich am besten für Steuerungen.