Home / LinuxUser / 2004 / 12 / groff

Newsletter abonnieren

Lies uns auf...

Folge LinuxCommunity auf Twitter

Top-Beiträge

Eingedost
(161 Punkte bei 4 Stimmen)
Aufteiler
(161 Punkte bei 4 Stimmen)

Heftarchiv

LinuxUser Heftarchiv

EasyLinux Heftarchiv

Ubuntu User Heftarchiv

Ubuntu User Heftarchiv

Partner-Links:

Das B2B Portal www.Linx.de informiert über Produkte und Dienstleistungen.

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

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

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).

Tip a friend    Druckansicht Bookmark and Share
Kommentare

1525 Hits
Wertung: 0 Punkte (2 Stimmen)

Schlecht Gut

Infos zur Publikation

Infos zur Publikation

LinuxUser 05/2014

Aktuelle Ausgabe kaufen:

Heft als PDF kaufen

LinuxUser erscheint monatlich und kostet in der Nomedia-Ausgabe EUR 5,95 und mit DVD EUR 8,50. Weitere Informationen zum Heft finden Sie auf der LinuxUser-Homepage.

Im LinuxUser-Probeabo erhalten Sie drei Ausgaben für 3 Euro. Das Jahresabo (ab EUR 60,60) können Sie im Medialinx-Shop bestellen.

Tipp der Woche

Bilder vergleichen mit diffimg
Bilder vergleichen mit diffimg
Tim Schürmann, 01.04.2014 12:40, 1 Kommentare

Das kleine Werkzeug diffimg kann zwei (scheinbar) identische Bilder miteinander vergleichen und die Unterschiede optisch hervorheben. Damit lassen sich nicht nur Rätsel a la „Orignial und Fäls...

Aktuelle Fragen

programm suche
Hans-Joachim Köpke, 13.04.2014 10:43, 8 Antworten
suche noch programme die zu windows gibt, die auch unter linux laufen bzw sich ähneln sozusagen a...
Funknetz (Web-Stick)
Hans-Joachim Köpke, 04.04.2014 07:31, 2 Antworten
Bei Windows7 brauche ich den Stick nur ins USB-Fach schieben dann erkennt Windows7 Automatisch, a...
Ubuntu 13.10 überschreibt immer Windows 8 Bootmanager
Thomas Weiss, 15.03.2014 19:20, 8 Antworten
Hallo Leute, ich hoffe das ich richtig bin. Ich habe einen Dell Insipron 660 Ich möchte gerne Ub...
USB-PTP-Class Kamera wird nicht erkannt (Windows-only)
Wimpy *, 14.03.2014 13:04, 15 Antworten
ich habe meiner Frau eine Digitalkamera, AGFA Optima 103, gekauft und wir sind sehr zufrieden dam...
Treiber
Michael Kristahn, 12.03.2014 08:28, 5 Antworten
Habe mir ein Scanner gebraucht gekauft von Canon CanoScan LiDE 70 kein Treiber wie bekomme ich de...