103.1 Manpages

Komfortables Hilfesystem, welches für fast alle Linux-Befehle zur Verfügung steht

• man <Kommando>           Aufruf der Manpage im Terminal
• $MANPATH Variable, in der die Verzeichnisse enthalten sind, wo die Manpages abgelegt sind
• /etc/manpath.config hier werden die Informationen für die Variable $MANPATH gesammelt und es können darüber hinaus weitere Informationen z.B. anderen Befehlen, die auf die Manpages zugreifen hier definiert werden
• Die Manpages befinden sich in den in Sektionen unterteilten Verzeichnissen. Zumeist in komprimierter Form, die durch den Aufruf über man dekomprimiert werden und über einen Pager ausgegeben werden.
• manpath            Aufruf der Verzeichnisse, wo die Manpages abgelegt sind
• manpath -c         Aufruf der temporären Verzeichnisse, in die die Manpages entpackt werden. Diese Verzeichnisse werden zyklisch über den Daemon cron von catman bereinigt
• catman             Funktion zum Erzeugen und Aktualisieren von Handbuchseiten

Sektionen des Mansystems

• Das Mansystem wird in verschiedene Sektionen unterteilt, so dass es für unterschiedliche Kommandos, eine unterschiedliche Anzahl an Manpages existieren

1. ausführbare Programme für Benutzer
2. Systemaufrufe (Funktionen, die durch den Kernel unterstützt werden)
3. Bibĺiotheksaufrufe (Libaries)
4. besondere Dateien (normalerweise in /dev)
5. Dateiformate und Konventionen
6. Spiele
7. Sonstige (Makro-Pakete und Konventionen)
8. administrative Programme (nur für den Root)
9. Kernel-Routinen (nicht standardisiert)

      A mehrteilige Manpages

• Viele Manpages haben meistens nur eine Manpage. Sollte es noch weitere geben, werden diese bei Aufruf der Manpage unter Angabe der Sektionsnummer angegeben
• man <Nummer> <Kommando>      Aufruf einer speziellen Manpage

Aufbau einer Manpage

• Name               Bezeichnung des Elements mit kurzer Beschreibung
• Synopsis          vollständige Kurzbeschreibung der Syntax
• Description       ausführliche Beschreibung des Elements
• Defaults            voreingestellte Parameter
• Overview          Überblick über komplexe Zusammenhänge
• Options             Optionen und deren Beschreibungen
• Return Values   Informationen über Rückgabewerte, teilweise als Exitstatus bezeichnet
• See also            Verweise auf artverwandte Themen
• Bugs                  bekannte Fehler
• Files                   Konfigurationsdateien u.Ä.
• es sind noch weitere Elemente denkbar, dies sind die gängigsten

Verwandte Befehle

• whatis          durchsucht nur das Feld Name in den Manpages. Vorteil, dass wenn es mehrere Sektionen einer Manpage gibt, werden diese dann aufgelistet. Vergisst man whatis das Argument zu übergeben, fragt whatis nach:
  archangel:/ # whatis
  whatis what
• apropos           durchsucht das Feld Name und das Feld Description. Suche nach Programmen, die eine spezielle Funktion erfüllen möglich
  archangel:/ # apropos tape
  mt (1)            - control magnetic tape drive operation
  st (4)            - SCSI tape device
  smbtar (1)        - shell script for backing uo SMB/CIFS
• whereis            zeigt an, wo sich ein Programm, die Konfigurationsdateien und die Manpages befinden
  ilonka@superhero:~$ whereis croncron: /usr/sbin/cron /etc/cron.hourly /etc/cron.daily /etc/cron.d /etc/cron.monthly /etc/cron.weekly /usr/share/man/man8/cron.8.gz
• which               zeigt den vollständigen Pfad eines Kommandos an. Existieren mehrere Versionen eines Programms, kann mit which geklärt werden, welche ohne Pfadangabe ausgeführt wird. which gibt dabei den Pfad des aufgerufenen Programms an 
  ilonka@superhero:~$ which less/usr/bin/less