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

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)