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
 
TABLET & SMARTPHONE APPS
Bald erhältlich
Get it on Google Play

Deutschland

Ä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.
  • Shell-Tipps
    Erfahrene Linux-Nutzer schwören auf flexible Kommandozeilentools, mit denen sie manche Aufgabe schneller bewältigen als in grafischen Programmen. Wir stellen interessante Anwendungen und Aufrufparameter vor, um auch Einsteiger zu einem Ausflug in die Shell zu ermutigen.
  • 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.
  • Kein Kauderwelsch
    Mit Po4a haben Sie alle notwendigen Werkzeuge an der Hand, um Dokumentationen an eine Landessprache anzupassen.
  • 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.
Kommentare

Infos zur Publikation

LU 12/2016: Neue Desktops

Digitale Ausgabe: Preis € 5,99
(inkl. 19% MwSt.)

LinuxUser erscheint monatlich und kostet 5,95 Euro (mit DVD 8,50 Euro). Weitere Infos zum Heft finden Sie auf der Homepage.

Das Jahresabo kostet ab 86,70 Euro. Details dazu finden Sie im Computec-Shop. Im Probeabo erhalten Sie zudem drei Ausgaben zum reduzierten Preis.

Bei Google Play finden Sie digitale Ausgaben für Tablet & Smartphone.

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

Aktuelle Fragen

Drucker Epson XP-332 unter ubuntu 14.04 einrichten
Andrea Wagenblast, 30.11.2016 22:07, 2 Antworten
Hallo, habe vergeblich versucht mein Multifunktionsgerät Epson XP-332 als neuen Drucker unter...
Apricity Gnome unter Win 10 via VirtualBox
André Driesel, 30.11.2016 06:28, 2 Antworten
Halo Leute, ich versuche hier schon seit mehreren Tagen Apricity OS Gnome via VirtualBox zum l...
EYE of Gnome
FRank Schubert, 15.11.2016 20:06, 2 Antworten
Hallo, EOG öffnet Fotos nur in der Größenordnung 4000 × 3000 Pixel. Größere Fotos werden nic...
Kamera mit Notebook koppeln
Karl Spiegel, 12.11.2016 15:02, 2 Antworten
Hi, Fotografen ich werde eine SONY alpha 77ii bekommen, und möchte die LifeView-Möglichkeit nu...
Linux auf externe SSD installieren
Roland Seidl, 28.10.2016 20:44, 1 Antworten
Bin mit einem Mac unterwegs. Mac Mini 2012 i7. Würde gerne Linux parallel betreiben. Aber auf e...