titel_man.png

Neue Manpages braucht das Land!

groff

01.12.2004
Wie ging gleich nochmal…? Guter Rat ist nicht immer teuer – ein Blick in Manpages lohnt sich fast immer. Wie diese entstehen und mit welchem Kommando Sie die Handbuchseiten in andere Formate konvertieren, zeigt diese "Zu Befehl"-Folge.

Zu Befehl

Auch wenn sich viele Dinge 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. Abgesehen davon gibt es auch sonst viele Situationen, in denen es gut ist, sich im Befehlszeilendschungel ein wenig auszukennen.

Eine gute Dokumentation ist fast so wichtig wie das Programm. Auch für kleine selbstgestrickte Skripte ist es sinnvoll, die wichtigsten Funktionen strukturiert aufzuschreiben, damit man sich später noch an die Features erinnert. Auf Linux-Systemen bietet es sich an, das vorhandene Dokumentationssystem zu nutzen: In Manpages finden Sie zu den meisten Befehlen Erklärungen der Funktionsweise, möglicher Optionen und manchmal auch Anwendungsbeispiele oder Hinweise auf verwandte Programme.

Manpages haben den Vorteil, dass man sie nicht nur im Terminal-Fenster lesen, sondern ebenso schnell und einfach in andere Formate wie HTML, PostScript oder PDF konvertieren kann. Traditionell werden die Handbuchseiten mit dem Textformatierungs-Tool groff erstellt. Eine erste Version dieses Programm gab es schon auf ganz alten Unix-Systemen unter dem Namen roff (= "run off"). Spätere Erweiterungen des Dokumentenformatierers waren nroff und troff; groff ist die GNU-Version, die auch auf aktuellen Linux-Systemen zum Einsatz kommt. Dieser Artikel zeigt, wie Sie mit groff eine Manpage schreiben und diese in verschiedene Formate umwandeln.

Ein "man" für alle Fälle

Sämtliche Manpages eines Linux-Systems liegen unterhalb des Verzeichnisses /usr/share/man – hier liegen u. a. übersetzte Handbuchseiten und die Unterverzeichnisse man1 bis man9. Die Ziffer verrät den thematischen Bereich, dem die Manpage zugeordnet ist: So liegen in Abschnitt 1 beispielsweise Beschreibungen zu Benutzerkommandos, in 5 Manpages, welche die Formate wichtiger Dateien erklären, und 8 bezieht sich auf Kommandos für den Systemverwalter. Eine gute Übersicht und stichwortartige Erklärungen der einzelnen Abteilungen zeigt das KDE-Hilfezentrum im Bereich Linux-Dokumentation / Man-Pages (Abbildung 1).

Abbildung 1: Manpages nach Abteilungen geordnet gibt's auch im KDE-Hilfezentrum.

Normalerweise muss man die Sektion beim Aufruf des man-Kommandos nicht mit angeben – nur, wenn es mehrere gleichnamige Manpages in verschiedenen Abteilungen gibt, müssen Sie genau definieren, welche Handbuchseite Sie meinen. Um beispielsweise die Manpage des Benutzerkommandos printf zu lesen, tippen Sie am Prompt

man 1 printf

Wer hingegen die C-Library-Funktion aus Abteilung 3 meint, tippt stattdessen:

man 3 printf

Ob es mehrere Manpages gibt, können Sie übrigens schnell über KDEs Konqueror herausfinden: Tippen Sie in die Adresszeile einfach man: gefolgt von dem Kommando, das Sie nachschlagen wollen. Gibt es nur eine Manpage, zeigt Konqueror diese direkt an; gibt es hingegen mehrere Möglichkeiten, stehen diese zur Auswahl (Abbildung 2).

Abbildung 2: Per Klick zur richtigen Manpage im Konqueror.

Struktur einer Manpage

Eine Manpage ist in der Regel in verschiedene Kapitel unterteilt – ganz oben sehen Sie den Namen des Befehls und die Sektion, der das Kommando zugeordnet ist. Im Bereich NAME finden Sie eine Kurzbeschreibung des Befehls, SYNOPSIS zeigt das Kommando mit den möglichen Argumenten an, und DESCRIPTION beschreibt, wie der Befehl funktioniert.

Danach geht's ins Detail: Es folgt eine vollständige Auflistung aller Parameter. Einige Handbuchseiten bieten unter EXAMPLES mehr oder weniger ausführliche Beispiele für die Benutzung des Kommandos. Am Ende der Manpage finden Sie Hinweise auf eventuelle bekannte Programmfehler (BUGS), den Autor der Handbuchseite (AUTHOR) und verwandte Programme (SEE ALSO).

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 05/2016: DATEISYSTEME

Digitale Ausgabe: Preis € 5,99
(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!       

Aktuelle Fragen

MS LifeCam HD-5000 an Debian
Kay Michael, 13.04.2016 22:55, 0 Antworten
Hallo, ich versuche die oben erwähnte Cam an einem Thin Client mit Debian zu betreiben. Linux...
Import von Evolution nach KMail erzeugt nur leere Ordner
Klaus-Christian Falkner, 06.04.2016 12:57, 2 Antworten
Hallo, da ich vor einiger Zeit von Ubuntu auf Kubuntu umgestiegen bin, würde ich gerne meine E...
Sophos lässt sich nicht unter Lubuntu installieren
Chrstina Turm, 30.03.2016 20:56, 3 Antworten
Hi Leute, habe mir vor paar Tagen auf ein Notebook, das ohne Linux ausgedient hätte, Linux dr...
Novell Client auf Raspbian
Chris Baum, 16.03.2016 15:13, 3 Antworten
Hallo Community, ich hätte eine Frage, und zwar geht es um folgendes: Ich möchte eine Datei...
Pantheon konfigurieren (eOS)
John Smith, 16.03.2016 13:50, 0 Antworten
Hallo ins Forum, ich bin neu in der Linuxwelt und fühle mich bereits sehr wohl. Mein neues Sys...