Gliederung verbessern
Optionen und Parameter
Pro Parameter ein Beispiel
Dateien und Verzeichnisse
Variablern

Manpage

ÜBERSICHT

Um dem Benutzer eine größtmögliche Flexibilität zu bieten, sind in man viele Optionen verfügbar.

Veränderungen können am Suchpfad, in der Reihenfolge der Abschnitte, am Ausgabeprozessor sowie weiteren Verhaltensweisen und Operationen vorgenommen werden.
Dies wird weiter unten beschrieben.

Wenn sie gesetzt sind, werden verschiedene Umgebungsvariablen für die Festlegung der Arbeitsweise von man ausgewertet.

Sie können die Allzweckvariable $MANOPT auf einen beliebigen Ausdruck im Befehlszeilenformat setzen.
Bei der Zuweisung des Wertes an $MANOPT müssen Sie Leerzeichen als Teil von Argumenten einer Option mit einem Backslash (linksseitigem Schrägstrich) maskieren (schützen).
man wertet diese Variable vor der eigenen Befehlszeile aus.
Die Optionen, die ein Argument benötigen, werden durch die gleichen Optionen in der Befehlszeile überschrieben.
Um alle in $MANOPT gesetzten Optionen zurückzusetzen, kann als erste Befehlszeilen-Option -D angegeben werden.
Dies ermöglicht man, alle in $MANOPT gesetzten Optionen zu vergessen, obwohl diese weiterhin gültig gewesen sein mussten.

Handbuchseiten werden normalerweise im Format nroff(1) in einem Verzeichnis wie /usr/share/man gespeichert.

In einigen Installationen kann es auch vorformatierte cat-Seiten geben, um die Performance zu verbessern.
Siehe manpath(5) für Details dazu, wo diese Dateien gespeichert sind.

Dieses Paket unterstützt Internationalisierung.

Wenn auf Ihrem System Handbuchseiten in Ihrer Muttersprache verfügbar sind, können Sie mittels Locale-Funktionen auf diese Seiten zugreifen.
Falls Ihr System nicht bereits automatisch vornimmt, muss um diese Unterstützung zu aktivieren,

entweder in $LC_MESSAGES, $LANG oder anderen systemabhängigen Umgebungsvariablen die gewünschte Sprache festgelegt werden.

Die Sprache wird normalerweise im POSIX- Format angegeben:

<Sprache>[_<Region>[.<Zeichensatz>[,<Version>]]]

Wenn die angeforderte Seite in Ihrer Locale verfügbar ist, wird sie anstelle der (normalerweise in amerikanischem Englisch verfassten) Standardseite angezeigt.

Wenn Sie diese Handbuchseiten und die Ausgaben der Hilfsprogramme gerne in Ihrer Landessprache hätten, aber diese nicht vorfinden und Sie diese beisteuern möchten, nehmen Sie bitte mit dem Betreuer dieser Software Kontakt auf, der dann die Übersetzung koordiniert.

Individuelle Handbuchseiten werden normalerweise von den Betreuern des Programms, der Funktion oder sonstigen Themas gepflegt und daher in diesem Paket nicht enthalten.

Wenn Sie der Meinung sind, dass eine Handbuchseite fehlt oder unzureichend ist, melden Sie dies an die Betreuer des fraglichen Pakets.

Informationen über weitere Funktionen und Erweiterungen, die für dieses Handbuch-Anzeigeprogramm verfügbar sind, geben Ihnen die mit dem Paket verteilten Dokumente.

VOREINSTELLUNGEN

Die Reihenfolge der zu durchsuchenden Abschnitte kann durch die Umgebungsvariable $MANSECT oder durch die SECTION-Anweisung in /etc/manpath.config außer Kraft gesetzt werden.

Folgende Reihenfolge ist voreingestelllt: 1 n l 8 3 0 2 3posix 3pm 3perl 3am 5 4 9 6 7

Die formatierte Handbuchseite wird mit Hilfe eines Anzeigeprogramms dargestellt.

Dieses kann auf verschiedene Arten angegeben werden oder anderenfalls auf eine Voreinstellung ausgewichen werden (siehe die Option -P für Details).

Die Filter werden in mehreren Schritten zusammengestellt: Zuerst wird die Befehlszeilenoption -p oder die Umgebungsvariable $MANROFFSEQ untersucht. Wenn -p nicht benutzt wird und die Umgebungsvariable nicht gesetzt ist, wird die Anfangszeile der Nroff-Datei nach einer Zeichenkette für den Präprozessor untersucht.

Um eine gültige Präprozessor-Zeichenkette zu enthalten, muss die erste Zeile '\" <Zeichenkette> ähneln, wobei Zeichenkette jede weiter unten unter -p beschriebene Buchstabenkombination sein kann.
Wenn keine der obigen Methoden eine Filterinformation ergibt, wird ein Satz von Standardwerten verwendet.

Aus den Filtern und dem Hauptformatierprogramm (Nroff oder [tg]roff mit -t) wird eine Formatier-Pipeline gebildet und ausgeführt.

Wenn alternativ ein ausführbares Programm mandb_nfmt (oder mandb_tfmt mit -t) in der Wurzel der Handbuchhierarchie existiert, wird dieses an Stelle der Pipeline ausgeführt.
Ihm wird die Handbuchquelldatei, die Zeichenkette für den Präprozessor und wahlweise das durch die Argumente -T oder -E festgelegte

Gerät (tatsächlich ein Dateiformat oder ein Zeichensatz) übergeben.

TMP

Beschreibung

Wenn ihr über einen Befehl stolpert und nicht wisst, was er tut. Gebt einfach man ein, gefolgt von dem Befehl.
Dann seht ihr eine Anleitung (Manual), wie dieser funktioniert. Mit den Pfeiltasten könnt ihr durch die Anleitung im Terminal scrollen.
Mit der Taste Q beendet ihr die Anleitung.

Beispiel

$ man man

MAN(1)            Dienstprogramme für Handbuchseiten           MAN(1)

BEZEICHNUNG
      man - eine Oberfläche für die System-Referenzhandbücher

ÜBERSICHT
      man [man Optionen] [[Abschnitt] Seite ...] ...
      man -k [apropos Optionen] Regulärer_Ausdruck ...
      man -K [man Optionen] [Abschnitt] Begriff ...
      man -f [whatis Optionen] Seite ...
      man -l [man Optionen] Datei ...
      man -w|-W [man Optionen] Seite ...
 
BESCHREIBUNG
      man ist das System-Anzeigeprogramm für die Handbuchseiten. Je‐
      des an man übergebene Argument  Seite  ist  normalerweise  der
      Name  eines  Programms oder einer Funktion. Gefunden und ange‐
      zeigt wird die Handbuchseite,  die  auf  jedes  der  Argumente
      passt.  Wenn  ein  Abschnitt  angegeben wird, sucht man nur in
      diesem Abschnitt der Handbuchseiten. Ohne eine  explizite  An‐
      gabe  werden alle verfügbaren Abschnitte in einer festgelegten
      Reihenfolge durchsucht (siehe VOREINSTELLUNGEN)  und  nur  die
      jeweils  zuerst  gefundene  Seite angezeigt, wenn die Seite in
      mehreren Abschnitten vorkommt.
[...]

Funktionsweise

Immer, wenn Sie eine man Page aufrufen, konsultiert das Programm man die in der Variablen $MANPATH

enthaltenen Verzeichnisse. Hier können mehrere Verzeichnisse auf einmal hinterlegt sein.

In nach Sektionen unterteilten Unterverzeichnissen befinden sich die Dateien der man Pages im komprimierten

Zustand

Das man System dekomprimiert die angeforderte Datei und übergibt sie anschließend an einen Pager. Dieser zeigt

daraufhin die gewünschte man Page an.

Sektionen

Das man System ist in mehrere Sektionen unterteilt. Diese Sektionen sind folgendermaßen gegliedert:

ausführbare Programme für Benutzer
Systemaufrufe (Funktionen, die durch den Kernel unterstützt werden)
Bibliothek aufrufe (Libraries)
besondere Dateien (normalerweise in /dev)
Dateiformate und Konventionen
Spiele
Sonstiges (Makro-Pakete und Konventionen)
administrative Programme (nur für den User root)
Kernel-Routinen (nicht standardisiert)

Aufbau

Der Aufbau einer Manpage ist festgelegt und sollte immer die folgenden Elemente enthalten:

Name – die Bezeichnung des Elements mit einer kurzen Beschreibung
Synopsis – eine vollständige Beschreibung der Syntax
Description – eine ausführliche Beschreibung des Elements
Defaults – voreingestellte Parameter
Overview – ein Überblick über die komplexeren Zusammenhänge
Options – Optionen und deren Beschreibung *Return Values – Informationen über eventuelle Rückgabewerte, teilweise auch als Rückgabewert bezeichnet
See also – Verweise auf artverwandte Themen
Bugs – bekannte Fehler
Files – Konfigurationsdateien u. Ä.

Manual-Pages

Darüber hinaus erhalten sie ausführliche Informationen in der Online-Dokumentation des Systems den so genannten Manual-Pages. Diese können Sie mit dem Befehl

$ man [-S Sektion] <Kommando>

aufrufen.

Beispiel

$ man ls 
VDIR(1)                                   FSF                                  VDIR(1)  
 
 NAME
        ls - zeigt Verzeichnisinhalt an
 
 ÜBERSICHT
        ls [OPTION]... [DATEI]...
 
 BESCHREIBUNG
        Auflistung  von  Informationen  der  DATEIen (Standardvorgabe ist das momentane
        Verzeichnis). Alphabetisches Sortieren der Einträge, falls weder -cftuSUX  noch
        --sort angegeben.
 
        -a, --all
               Einträge, die mit . beginnen, nicht verstecken.
 
        -A, --almost-all
               Keine Anzeige implizierter . Und ..
 
        -b, --escape
               Ausgabe oktaler Repräsentation für nicht-druck- bare Zeichen.
 
        --block-size=GRÖßE
               Verwendung von GRÖßE großen Blöcken.
 
        -B, --ignore-backups
               Einträge, die mit ~ enden, nicht ausgeben.
 
        -c     mit  -lt:  sortieren  nach,  und  anzeige  von  ctime  (Zeit der letzten
               Veränderung der Datei-Status- informationen) ; mit  -l:  ctime  anzeigen
               und nach Namen sortieren.
 
  Manual page ls(1) line 1

Sektionen der Manual-Pages

0 Dateiheader (gewöhnlich in /usr/include)
1 Ausführbare Programme oder Shellbefehle
2 Systemaufrufe (Kernelfunktionen)
3 Bibliotheksaufrufe (Funktionen in System-Bibliotheken)
4 Spezielle Dateien (gewöhnlich in /dev)
5 Dateiformate und Konventionen, z. B. /etc/passwd
6 Spiele
7 Makropakete und Konventionen, z. B. man(7), groff(7)
8 Systemadministrationsbefehle (in der Regel nur für root)
9 Kernelroutinen [Nicht Standard]
n neu [veraltet]
l lokal [veraltet]
p öffentlich [veraltet]
o alt [veraltet]

Aufbau einer Manual-Page

`NAME`	kurze Beschreibung der Funktion
`SYNOPSIS`	Aufrufsyntax
`DESCRIPTION`	Detaillierte Beschreibung der Wirkungsweise aller möglichen Optionen
`Files`	Vom Kommando benötigte/modifizierte Dateien
`SEE ALSO`	Hinweise auf verwandte Kommandos und Verweise auf ergänzende Informationen
`DIAGNOSTICS`	Erläuterungen zu Fehlercodes, die das Kommando zurückliefert
`BUGS`	Bekannte Fehlverhalten des Kommandos, aber auch Hinweise auf Wirkungen, die gewollt aber ungewöhnlich sind0,00cm
`EXAMPLE`	Beispiele zur Verwendung des Kommandos (fehlt leider oft)