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 02/2016: Alt-PCs flott machen

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!       

Der Tipp der Woche

Schon gewußt?

14.11.2015

Auch unter Ubuntu 15.10 kann man wieder mit dem Startmedienersteller (alias Startup Disk Creator) ein Live-System auf einem USB-Stick einrichten. ...

Fehler des Startmedienerstellers von Ubuntu 15.10 umgehen

Aktuelle Fragen

Leap 42.1 und LibreOffice
Heinz Kolbe, 09.02.2016 21:54, 0 Antworten
Moin moin, auf meinem Notebook habe ich Leap 42.1 und Win 10 installiert. Alles läuft rund nur...
Tails Update
Val Lerie, 11.01.2016 10:51, 0 Antworten
Hallo zusammen, updaten > update Speichern unter > Persistent nicht möglich, mit der Meldung;...
Recoll
Jürgen Heck, 20.12.2015 18:13, 4 Antworten
Wie kann man mit Recoll nach bestimmten Zeichen/Satzzeichen bzw. Zeichenkombinationen suchen, z....
Wings Platinum 4 auf Linux?
Bodo Steguweit, 18.12.2015 11:37, 4 Antworten
Hallo in die Runde ich nutze für meine Diashows Wings Platinum 4 als Diareferent. Arbeite jetzt...
Bandbreite regulieren
Georg Armani, 25.11.2015 16:50, 1 Antworten
Hallo, ich bin ein Neuling in Sachen Linux und hoffe auf Hilfe. Ich habe zwei Windows Rechner...