Texteditor¶

Manpages können in einem beliebigen Texteditor erstellt werden ^[1]. Es genügt die Struktur und die grundlegenden Regeln zur Formatierung einer manpage zu kennen. Die Archivierung erfolgt dann beispielsweise mit gzip (bzw. das Entpacken mit gunzip) ^[2] im Terminal ^[3].

Gmanedit¶

Folgende Pakete müssen installiert ^[4] werden:

• gmanedit (universe)

mit apturl

sudo apt-get install gmanedit 

sudo aptitude install gmanedit 

Header¶

Gewöhnlich beginnt eine Manpage mit Kommentaren, beispielsweise einem Lizenzhinweis. Darauf folgt der Header.

Allgemein sieht der Header wie folgt aus:

1

.TH "Befehl" "Manpage-Bereich" "Version" "Autor" "section"

im konkreten Fall ergibt das beispielsweise:

1

.TH "manvorlage" "1" "23. Mai 2008" "Max Mustermann" "documentation"

Sektionen¶

Auf den Header folgen die einzelnen Sektionen. Je ausführlicher eine Hilfeseite ist bzw. je umfangreicher das beschriebene Programm ist, um so mehr Sektionen und Untersektionen werden sinnvollerweise genutzt.

Der übliche Aufbau einer Sektion sieht wie folgt aus:

1
2
3

.SH
NAME
manvorlage

Übliche Sektionen sind u.a. NAME, SYNTAX, BESCHREIBUNG, OPTIONEN, DATEIEN, SIEHE AUCH, FEHLER, und AUTOR (im Englischen NAME, SYNOPSYS, DESCRIPTION, OPTIONS, FILES, SEE ALSO, BUGS und AUTHOR).

Um die vollständige Struktur einer Manpage zu betrachten, bietet es sich an verschiedene auf dem eigenen System bereits vorhandene Seiten im Quelltext zu betrachten, ein guter Ausgangspunkt ist sicherlich die Manpage zu man.

Speicherorte¶

Üblicherweise werden englische Hilfeseiten unter usr/share/man/man1 (aus Debian-Paket) bzw. usr/local/share/man/man1 (andere Installtions-Methoden) abgelegt. Die deutschen Seiten liegen analog unter usr/share/man/de/man1 bzw. usr/local/share/man/de/man1.