Manpage-Macher

Manual-Seiten im grafischen Editor ManEdit

01.06.2004
Manual-Seiten sind der Unix-typische Weg, Programme zu beschreiben: Sie erklären vor allem klassische Kommandozeilen-Tools. Wer diese Handbücher bearbeiten oder selbst erstellen will, schreckt vor dem eigenartigen Aufbau der Dokumente zurück, doch mit ManEdit geht es auch komfortabel.

Der Zweck von ManEdit ist es, Manual-Seiten komfortabel und ohne Kenntnis spezieller Manpage-Formate zu erstellen. Auf der Homepage des Projektes [1] finden Sie verschiedene Programmarchive, vom Tarball mit dem Sourcecode über ein Mandrake-RPM- bis zum Debian-Paket. Diese Pakete liegen auch auf der Heft-CD.

Da das Einspielen von RPM- und Debian-Paketen mit den Paket-Managern der Distributionen einfach ist, erläutern wir kurz die Installation aus dem Quelltext.

Die Installation

Nach dem Download des Archivs manedit-0.5.10.tar.bz2 entpacken Sie es und wandern mit cd in das neu erzeugte Verzeichnis manedit-0.5.10:

[andreas]~ > tar xvjf manedit-0.5.11.tar.bz2
[andreas]~ > cd manedit-0.5.11

Falls die Optionen xvjf bei Ihnen nicht funktionieren, arbeiten Sie mit einer alten Version von tar und verwenden stattdessen xIf.

Im Quellcode-Verzeichnis rufen Sie das Skript configure mit dem Parameter --help auf:

[andreas]~ > ./configure --help

Das Skript teilt Ihnen mit, dass die Installation mit folgendem Befehl vorbereitet wird:

./configure Linux --prefix=/usr/local/

(Anders als üblich, verwendet dieses Configure-Skript als Standardpfad /usr, wenn Sie nicht /usr/local von Hand angeben.) Auf dieses Kommando folgt eine kurze Überprüfung der installierten Software, an deren Ende das Skript Sie mit Type "make" to compile the program auffordert, den Befehl make einzugeben, um das Programm aus dem Quelltext zu kompilieren. Geben Sie diesen Befehl ein und schauen Sie zu, wie das Programm übersetzt wird.

Wird dieser Schritt ohne Fehlermeldungen beendet, geben Sie den Befehl su ein, um Root-Rechte zu erlangen. Dann installieren Sie das fertige Tool mit make install in den Verzeichniszweig /usr/local:

[andreas]~ > su
Password: (Ihr Root-Passwort)
root# make install

Sie sehen am Schluss eine Zusammenfassung, welche Teile von ManEdit in welche Verzeichnisse installiert wurden. Außerdem erscheint der Hinweis, dass die Installation gelungen ist und Sie lediglich manedit & in die Shell tippen müssen, um den Manpage-Editor zu starten.

Übersichtlich

Nach dem Start von ManEdit sehen Sie eine Oberfläche, die an einen HTML-Editor erinnert. Unter der Menüleiste liegt eine Leiste mit den gebräuchlichsten Funktionen, und noch eine Zeile weiter unten finden Sie Schalter für die Textausrichtung und Formatierung. Den Abschluss bildet eine Leiste, über die Sie schnell Text suchen und ersetzen können.

Den Großteil der Programmoberfläche nehmen zwei Bereiche ein, in denen Sie Ihre ManPage bearbeiten. Auf der linken Seite öffnen und schließen Sie neue Dateien oder fügen neue Textabschnitte ein, auf der rechten Seite bearbeiten Sie den Text.

Am schnellsten gewöhnen Sie sich an die Bedienung des Editors, wenn Sie per Klick auf Open eine vorhandene Manpage laden (Abbildung 1), zum Beispiel die Datei /usr/share/man/man1/man.1.gz. Nach dem Öffnen speichern Sie die Datei für weitere Experimente in Ihrem Home-Verzeichnis, dazu verwenden Sie den Menüpunkt File/Save as.

Abbildung 1: Eine Manpage wird bearbeitet.

Gegliedert

Im linken Bereich zeigt ManEdit die geöffnete Datei als aufgeschlagenes Buch an. Aus diesem Buch ragt eine Gliederung hervor, die mit Header beginnt und danach die verschiedenen Abschnitte der Manpage zeigt – da Manpages unterschiedlich strukturiert sein können, sieht diese Gliederung oft verschieden aus.

Wenn Sie Header anklicken, teilt sich die rechte Fensterhälfte in einen oberen und einen unteren Bereich. Oben sehen Sie verschiedene Angaben zur Manpage. Die untere Hälfte stellt den Kopf der Datei da, der beim Aufruf das Manuals mit man man unsichtbar bleibt. Er enthält Notizen zur Lizenz der angezeigten Seite und den Namen des Urhebers.

Der Abschnitt NAME zeigt Ihnen die Beschreibung der Man-Seite an. Wie alle folgenden Abschnitte ist er mit man man lesbar. Um einen neuen Abschnitt einzufügen, verwenden Sie den Knopf Section in der Werkzeugleiste. Der Arbeitstitel des neuen Abschnitts im linken Fensterbereich ist vorerst UNTITLED. Per Mausklick öffnen Sie ihn in der rechten Fensterhälfte. Dort geben Sie ihm im Feld Section einen aussagekräftigen Namen. Der Remove-Knopf in der Werkzeugleiste entfernt Abschnitte.

Auf die ersten kryptischen Formatierungs-Tags <\<>I<\>> und <\<>B<\>> stoßen Sie im Abschnitt DESCRIPTION der Manpage zu man: Mit diesen an HTML erinnernden Textauszeichnungen machen Sie Textstellen bündig, unterstrichen oder fett (Abbildung 2). Um Text fett oder unterstrichen zu formatieren, markieren Sie ihn und klicken dann auf einen der Knöpfe U und B. Über die Ausrichtungsschalter in der Menüleiste formatieren Sie den mit der Maus markierten Text, also zum Beispiel links- oder rechtsbündig.

Abbildung 2: In Manpages gibt es unterschiedlich hervorgehobene Textteile.

Die Bedeutung der Tags, die nicht in der Button-Leiste zur Verfügung stehen, schlagen Sie im Handuch zu ManEdit nach; das Hilfemenü Help bietet Ihnen zwei Seiten zum Nachschlagen an: How To Write ManPages und ManPage XML Format Reference. Die Bezeichnung XML ist dabei irreführend, da es sich nicht um XML-Tags handelt.

Vorschau

Zum Anzeigen der Manpages verwendet ManEdit den Viewer manview, der Teil des ManEdit-Pakets ist. Sie starten ihn, indem Sie in ManEdit (bei geöffneter Manpage) auf Preview klicken. ManEdit übergibt ManView dann die aktuell bearbeitete Datei zur Voransicht und Kontrolle.

Die ManPage XML Format Reference nennt 13 Formatierungs-Tags und beschreibt sie. Wer sich diese Liste jedoch ausdrucken möchte, wird enttäuscht: Sowohl im Viewer als auch im Editor von ManEdit gibt es keinen Schalter, mit dem Sie eine geöffnete Datei an den Drucker senden könnten. Dafür ordnet manview die Pfade, unter denen sich Manual-Seiten befinden, übersichtlich. Hier ist allerdings eine Anpassung notwendig: Die regulären Manpages (Global) erwartet ManView im Verzeichnis /usr/man/, sie befinden sich bei aktuellen Distributionen aber in /usr/share/man. Das Verzeichnis korrigieren Sie, indem Sie in ManEdit den Menüpunkt Edit/Preferences aufrufen und dann unter Locations den Eintrag /usr/man auswählen und auf Properties klicken. Im erscheinenden Dialog ändern Sie das Verzeichnis ab (Abbildung 3). Die Übersicht der Manpages erhalten Sie in ManView über den Tab mit der Beschriftung Index (Abbildung 4).

Abbildung 3: Um den Index sinnvoll zu nutzen, korrigieren Sie zunächst den Pfad zu den allgemeinen Manpages ("Global").
Abbildung 4: Die Index-Anzeige des Viewers.

Ein Handicap gibt das Tool offen zu: Nach Einschalten des Syntax-Highlighting unter View poppt ein Hinweis auf, der Sie warnt, dass eingeschaltetes Highlightning Programmabstürzen verursachen kann. Ein Verhalten, das im Test nicht zu bobachten war. Ein Markieren des Textes mit der Maus und ein Klick auf den Button Strip tags from selection führte allerdings hin und wieder zu nicht reproduzierbaren Abstürzen. ManEdit erkannte jedoch nach dem Neustart den vorherigen Abbruch und stellte die Daten aus dem temorären Verzeichnis wieder her.

Das Syntax-Highlighting ist nicht nur durch den Schalter View einstellbar. Neben einer kleinen Anzahl von Konfigurationsmöglichkeiten erreichen Sie es ebenfalls unter Edit/Preferences. Im Konfiguationsfenster können Sie die Farben und das Schriftbild von Editor und Viewer definieren, die Menüleiste verändern und verschiedene Verzeichnisse festlegen, mit denen ManEdit arbeitet.

Fazit

Trotz fehlender Druckfunktion und vereinzelten Abstürzen beim Entfernen der Tags ist ManEdit ein kleines, nützliches Werkzeug für den Umgang mit Manual-Seiten. Es ermöglicht es, Manpages effizient und übersichtlich zu erstellen oder zu bearbeiten, bietet verständliche (wenn auch nur englischsprachige) Hilfetexte und kann mehrere Dateien gleichzeitig bearbeiten.

Glossar

Syntax-Highlighting

Syntaktische Elemente einer (Programmier- oder Auszeichnungs-) Sprache werden farblich oder durch Fett- oder Kursivstellen hervorgehoben. ManEdit hebt nur die spitzen Klammern < und > hervor.

Infos

[1] ManEdit: http://wolfpack.twu.net/ManEdit/

[2] Artikel zu "man", Heike Jurzik: "Fach-Lektüre", LinuxUser 01/2002, S. 90, http://www.linux-user.de/ausgabe/2002/01/090-zubefehl/man-4.html

LinuxCommunity kaufen

Einzelne Ausgabe
 
Abonnements
 

Ähnliche Artikel

  • groff
    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.
  • Systemdokumentation ausreizen
    Linux und freie Software: Unzählige Möglichkeiten, Programme und Optionen. Da den Überblick zu behalten, ist nicht immer leicht. Wer weiß, wo er Anleitungen und Hilfen findet, kann sich in vielen Fällen selber helfen.
  • 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.
  • Frisch lackiert
    Mit Pinfo erlebt die altbewährte Info-Seite ein farbiges Revival. Damit nutzen Sie die Standard-Dokumentation auf Ihrem Linux-System noch effektiver.
  • Dr. Linux
    Komplizierte Organismen, wie Linuxsysteme es nun einmal sind, haben so ihre ganz eigenen Wehwehchen. Dr. Linux beobachtet die Patienten in den Linux-Newsgruppen, stellt an dieser Stelle Rezepte für aktuelle Probleme aus und alternative Heilmethoden vor.
Kommentare

Infos zur Publikation

LU 12/2014: ANONYM & SICHER

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!       

Tipp der Woche

Ubuntu 14.10 und VirtualBox
Ubuntu 14.10 und VirtualBox
Tim Schürmann, 08.11.2014 18:45, 0 Kommentare

Wer Ubuntu 14.10 in einer virtuellen Maschine unter VirtualBox startet, der landet unter Umständen in einem Fenster mit Grafikmüll. Zu einem korrekt ...

Aktuelle Fragen

Nach Ubdates alles weg ...
Maria Hänel, 15.11.2014 17:23, 4 Antworten
Ich brauche dringen eure Hilfe . Ich habe am wochenende ein paar Ubdates durch mein Notebook von...
Brother Drucker MFC-7420
helmut berger, 11.11.2014 12:40, 1 Antworten
Hallo, ich habe einen Drucker, brother MFC-7420. Bin erst seit einigen Tagen ubuntu 14.04-Nutzer...
Treiber für Drucker brother MFC-7420
helmut berger, 10.11.2014 16:05, 2 Antworten
Hallo, ich habe einen Drucker, brother MFC-7420. Bin erst seit einigen Tagen ubuntu12.14-Nutzer u...
Can't find X includes.
Roland Welcker, 05.11.2014 14:39, 1 Antworten
Diese Meldung erhalte ich beim Versuch, kdar zu installieren. OpenSuse 12.3. Gruß an alle Linuxf...
DVDs über einen geeigneten DLNA-Server schauen
GoaSkin , 03.11.2014 17:19, 0 Antworten
Mein DVD-Player wird fast nie genutzt. Darum möchte ich ihn eigentlich gerne abbauen. Dennoch wür...