Man

Aus Foxwiki

Funktion

Mit dem Befehl "man" kann man in einer Konsole eine Manual (Anleitung) für auf dem PC installierte Software oder andere Konsolenbefehle aufrufen.

man – Anleitung zum Befehl anzeigen

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

so schreibt man das Kommando |

man BEFEHL
Datei:Screenshot 20201104 095015.png

Mehr Beispiele

  • man ls
  • man cat
  • man cp und soweiter und sofort.

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 Kurzbeschreibung 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 Exit-Status bezeichnet
  • See also – Verweise auf artverwandte Themen
  • Bugs – bekannte Fehler
  • Files – Konfigurationsdateien u. Ä.