» SelfLinux » Grundlagen » Linux Hilfe » Abschnitt 3 SelfLinux-0.12.1
zurück   Startseite Kapitelanfang Inhaltsverzeichnis GFDL   weiter

SelfLinux-Logo
Dokument Linux Hilfe  Autor
 Formatierung
 GFDL
 

3 man

Nachdem --help eine eher spärliche Ausbeute brachte, ist es nun an der Zeit man (engl.: manual Handbuch) kennen zu lernen. Dieses Handbuch bietet detaillierte Informationen über die auf dem System installierten Programme.

Dabei bringt jedes (Programm-)Paket seine eigenen Handbuchseiten mit. Bei der Installation wird es zum bereits bestehenden Teil hinzugefügt.


3.1 Aufruf

Die Handbuch-Seite (manpage) über ein bestimmtes Programm kann man sich mittels

user@linux ~$ man N "Programmname"

anzeigen lassen.

N ist dabei eine Nummer, die angibt, in welchem Kapitel des Handbuches nachgeschlagen werden soll. In den meisten Fällen kann sie weg gelassen werden.

Von Bedeutung ist sie jedoch dann, wenn ein Programm in mehreren Teilen des Handbuchs beschrieben ist. Die Einteilung erfolgt standardmäßig in acht Kategorien, die der folgenden Liste oder

user@linux $ man man

entnommen werden können.

1 Benutzerbefehle
2 Systemaufrufe
3 Funktionen aus Systembibliotheken
4 Spezielle Dateien (z.B. Geräte)
5 Dateiformate
6 Spiele
7 Makropakete und Konventionen (z.B. man)
8 Befehle für Systemadministration (i.d.R. nur für root)

Wird keine Zahl angegeben, wird die Manpage angezeigt, die zuerst gefunden wird.

Da wir es bei der Anzeige wieder mit less zu tun haben, kann man sich in den Seiten per Cursortasten bewegen und durch Druck auf die Taste q zur Shell zurückkehren.

Eine Suche lässt sich über /"Suchtext" starten. Um sich für den gleichen Begriff weitere Treffer anzeigen zu lassen, reicht ein Druck auf die Taste n. Die Fundstellen im Text sind jeweils hervorgehoben.

Wer mit diesen elementaren Funktionen nicht zufrieden ist, dem kann ein Hilfetext zu less, der über h zu erreichen ist, auf die Sprünge helfen.

Tip: Nicht jeder mag längere Texte am Monitor lesen. Besitzt man ein funktionierendes Drucksystem, so kann man die Manpage mit Hilfe des Kommandos
user@linux ~$ man -t "Programmname" | lpr

zu Papier bringen.


3.2 Aufbau

Die Gliederung einer typischen Manpage orientiert sich an gewissen Vorgaben.

Folgende Punkte findet man in den meisten Manpages (in Klammern sind die englischen Bezeichnungen angegeben):


3.2.1 Name

Wie der Name schon sagt, beinhaltet dieser Abschnitt den Namen des Programms. Außerdem wird noch eine einzeilige Kurzbeschreibung des Programms angegeben.

Für das Programm apropos, das wir in diesem Kapitel auch noch behandeln werden, würde das beispielsweise so aussehen:

"apropos - sucht die Manualkurzbeschreibung in der Indexdatenbank"


3.2.2 Syntax (Synopsis)

Sie beschreibt wie man das Programm aufruft, welche Angaben in jedem Fall gemacht werden müssen und welche zusätzlich gemacht werden können.

Für apropos sieht das wie folgt aus:

user@linux $ apropos [-dhV] [-e|-r|-w] [-m System[,...]] [-M Pfad] Schlüsselwort

Alles, was nicht in eckigen Klammern steht, muss angegeben werden. In unserem Beispiel ist dies zum einen der Programmname (logisch) und zum anderen ein Schlüsselwort (also Suchbegriff).

Die eckigen Klammern umschließen alle freiwilligen Optionen. Man kann also (muss aber nicht) -d oder -h oder -V bzw. beliebige Kombinationen dieser Buchstaben als Optionen verwenden (z.B. -Vd; das Minus muss nur einmal angegeben werden).

Alternative Optionen werden durch vertikale Striche getrennt. [-e|-r|-w] heißt also, man kann -eine- der drei Optionen angeben.

Die darauf folgenden Optionen verlangen beide die Angabe eines Arguments. Beispielsweise muss auf -M (wenn man es verwendet) eine Pfadangabe folgen.


3.2.3 Beschreibung (Description)

Hier wird der Sinn und Zweck des Programms erläutert und grundlegende Bedienprinzipien dargelegt.


3.2.4 Optionen (Options)

Bisher weiß man noch nicht unbedingt, was z.B. die Option -e bewirkt. Genau darüber wird man in diesem Abschnitt aufgeklärt.


3.2.5 Dateien (Files)

Hier sind die wichtigsten Dateien aufgelistet, die das Programm für seine Arbeit benutzt. Dazu findet man oft ein kurze Beschreibung, wofür die jeweilige Datei gut ist.

Es handelt sich zumeist um Konfigurationsdateien, aber auch mal um solche, in denen Datenbanken gespeichert sind oder ähnliches.


3.2.6 Siehe auch (See also)

In diesem Abschnitt wird auf Manpages zu anderen Programmen hingewiesen, die entweder mit dem jeweiligen Programm zusammen arbeiten oder aber ähnliche Funktionen erfüllen (und daher von Interesse sein könnten).


3.2.7 Fehler (Bugs)

Es werden bekannte Fehler des Programms, sowie Inkompatibilitäten und häufige Bedienungsfehler aufgelistet.

Manchmal findet sich auch ein Hinweis, an wen man sich wenden kann, wenn man glaubt einen noch unentdeckten Fehler gefunden zu haben.


3.2.8 Autoren (Authors)

Hier werden Lorbeeren an alle diejenigen verteilt, die wesentlich zur Entwicklung des Programms beigetragen haben.

Übrigens: Bisher war immer von Programmen die Rede. Darüber hinaus existieren aber auch noch Manpages für bestimmte Konfigurationsdateien. Z.B. liefert:

user@linux ~$ man fstab

Hinweise zum Aufbau von /etc/fstab.



zurück   Seitenanfang Startseite Kapitelanfang Inhaltsverzeichnis GFDL   weiter