Man-Pages erstellen

Linux Man-Pages erstellen

Wer Software für Linux entwickelt, wird früher oder später sogenannte Man-Pages erstellen müssen. Diese Anleitung ist entstanden, weil ich genau vor dieser Aufgabe stand: Für mein "[LINK:START:161]Take a Joint[LINK:END]" Projekt brauchte ich ein paar Handbuchseiten in deutscher und englischer Sprache.

Man-Pages sind zunächst ganz normale Textdateien, die mit jedem Texteditor erstellt und bearbeitet werden können. Da ich mich aber nicht mit der genauen Syntax befassen wollte, suchte ich nach einem entsprechenden Programm, welches ich auch ziemlich bald gefunden habe: "manedit". Zum Glück gab es bei meinem Debian GNU/Linux 3.0 (Woody) das gleichnamige Paket, welches ich mit dem folgenden Befehl installiert habe:

apt-get install manedit

Wenn es bei deiner Linux-Distribution kein ManEdit-Paket gibt, musst du die Quellen von der [LINK:START:169]Homepage[LINK:END] herunterladen und es selber compilieren. Ist ManEdit installiert, dann lässt es sich mit dem Kommando "manedit" aufrufen.

Neben einem Header enthält eine Man-Page üblicherweise folgende Abschnitte:

 

NAME          (NAME)
ÜBERSICHT     (SYNOPSIS)
BESCHREIBUNG  (DESCRIPTION)
PARAMETER     (OPTIONS)
BEISPIELE     (EXAMPLES)
DATEIEN       (FILES)
AUTOR         (AUTHOR)
FEHLER MELDEN (REPORTING BUGS)
COPYRIGHT     (COPYRIGHT)

 

Ich empfehle dir, eine vorhandene Man-Page als Vorlage zu verwenden und deinem Programm anzupassen.

Screenshot von ManEdit

Lokal gespeicherte Man-Pages kannst du bereits während der Erstellung mit dem folgenden Kommando anschauen:

man -l taju.1

Screenshot von man taju

Hast du die Man-Page fertig gestellt, solltest du wissen, dass Man-Pages normalerweise in verschiedenen Verzeichnissen unterhalb von "/usr/share/man/" gespeichert werden. Englische Man-Pages befinden sich in der Verzeichnisstruktur "man1" bis "man8", deutschsprachige werden in derselben Struktur unterhalb des Verzeichnisses "de" gespeichert. Der Dateiname einer Man-Page besteht aus dem Programmnamen, einem Punkt und der Zahl (1 bis 8). Die Zahl ist identisch mit dem Verzeichnis, in welchem die Man-Page gespeichert wird. Nach Eingabe von "man man" erhält man unter anderem eine Übersicht ähnlich der folgenden:

 

1 Ausführbare Programme oder Shellbefehle
2 Systemaufrufe
3 Bibliotheksaufrufe
4 Spezielle Dateien
5 Dateiformate und Konventionen
6 Spiele
7 Makropakete und Konventionen
8 Systemadministrationsbefehle

Die englischen Man-Pages für die Programme "taja" (Admin-Programm) und "taju" (Benutzer-Programm) wurden also wie folgt gespeichert:

/usr/share/man/man1/taju.1
/usr/share/man/man8/taja.8

Die deutschen Handbuchseiten befinden sich an folgenden Orten:

/usr/share/man/de/man1/taju.1
/usr/share/man/de/man8/taja.8

Das nächste Problem war, die Man-Page als reine Textdatei abzuspeichern. Das Kommando "man taju > tajuman.txt" funktioniert nicht wirklich, da die Steuersequenzen auch gespeichert wurden. Nach einer Suche im Internet fand ich folgendes Kommando, welches wunderbar klappt.

nroff -man taju.1 | col -xb > tajuman.txt

Artikelbewertung: 
No votes yet
War dieser Artikel hilfreich?