Hilfe

Hilfe zur Selbsthilfe ganz ohne Google & Co.

Hilfe-Parameter

Die meisten Befehle kennen den Hilfe-Parameter command --help, alternativ command -h. Einige alte Programme unterscheiden: --help zeigt dann eine ausführliche Parameter-Hilfe, -h dagegen nur eine Kurz-Übersicht.

/usr/share/doc

Unter /usr/share/doc liegen teils Informationen zu diversen Programmen - meist Lizenzangaben, Readme-Dateien oder Installationsanweisungen. Wenn man Glück hat, finden sich hier zu einigen Programmen brauchbare Beispiele für Konfigurationsdateien.

man

Zusätzlich gibt es zu fast allen Kommandos und Bereichen im System eigene Hilfeseiten - die so genannten Manpages (kurz für „manual page“).

Manpages werden in acht Kategorien eingeteilt:

Kategorie

Beschreibung

1

Allgemeine Kommandos

2

Systemaufrufe

3

Bibliotheksfunktionen

4

Spezialisierte Dateien (in der Regel Geräte unter /dev) und Treiber

5

Dateiformate und Konventionen

6

Spiele und Bildschirmschoner

7

Verschiedenes

8

Admin-Programme und Daemons

Umgang mit man

So installiert man das Manual-Tool man, allgemeine und wichtige SELinux-Manpages und aktualisiert anschliessend die Man-Datenbank:

yum -y install man man-pages
mandb

Hinweis

Der letzte Befehl hilft auch, eine korrupte Manpage-Datenbank neu aufzubauen.

Aufruf der Manpage für den Befehl ls:

man ls

Eine Unterseite zum Befehl mount:

man mount.cifs

Anzeige der Bibliotheksbeschreibung oder Verschiedenes statt des Kommandos:

man printf.3
man kernel_lockdown.7

Ohne Angabe der Kategorie wird auf die erste verfügbare Kategorie zugegriffen.

Kennt man das gesuchte Kommando oder das Thema nicht genau, bedient man sich der Schlagwortsuche und findet so beispielsweise alle Manpages zu „SELinux“ (apropos ist ein Alias für man -k):

man -k selinux
apropos selinux

Diese Ausgabe lässt sich mit grep einschränken.

Um ähnlich wie grep nach einer Zeichenfolge in allen man-Pages zu suchen:

man -Kw --regex selinux
man --global-apropos --where --regex

Um die Manpage direkt auf den Bildschirm zu drucken statt sie interaktiv darzustellen, verwendet man:

man httpd_selinux | col

Um nach der Zeichenfolge semanage in der Manpage zu httpd_selinux zu suchen, nutzt man:

man httpd_selinux | grep -i semanage

Manpages sind .gz-Dateien:

# search for manuals:
whereis -m ls
man /usr/share/man/man1/ls.1.gz

Interessante Man-Pages

man ascii      # ASCCI table
man 7 regexp   # Regular Expression Patterns

Tipp

Wem an langen, dunklen Winterabenden so richtig langweilig ist, erfährt mit diesen kilometerlangen, prominenten Manpages stundenlanges Lesevergnügen:

  • man systemd.directives: ca. 7’800 Zeilen

  • man bash: ca. 5’500 Zeilen (entspricht ca. 100 DIN A4-Seiten)

  • man gpg2: ca. 3’100 Zeilen

  • man iptables-extensions: ca. 2’800 Zeilen

  • man mount: ca. 2’300 Zeilen

Layout einer Manpage

Manpages orientieren sich an folgendem Layout:

NAME

Name des Programms gefolgt von einer einzeiligen Kurzbeschreibung.

SYNOPSIS

Von altgriechisch für „Übersicht“: Für Programme wird hier eine vollständige Liste der Parameter und Optionen beschrieben (Beschreibung der Kommando-Syntax).

DESCRIPTION

Eine Textbeschreibung der Funktionsweise des Befehls oder der Funktion. (Üblicherweise jedoch nicht der Benutzung, siehe unten.)

OPTIONS / FLAGS

Eine - üblicherweise alphabetisch sortierte - Liste der Optionen und ihrer zulässigen Argumente.

(USAGE)

Eine Anleitung für den Einsatz des Programms.

EXIT STATUS

Beschreibung möglicher Rückgabewerte und deren Bedeutung.

(EXAMPLES)

Einige Beispiele für die Benutzung.

(FILES)

Falls bestimmte Dateien (etwa Konfigurationsdateien) an der Funktion des Programms beteiligt oder durch die Ausführung betroffen sind, so werden sie hier aufgeführt und ihre Funktion beschrieben.

SEE ALSO

Eine Liste ähnlicher oder verwandter Befehle oder Funktionen, bei betroffenen Dateien wird hier auf die entsprechenden Einträge in Sektion 5 verwiesen.

info

info zeigt weitestgehend die gleichen Inhalte wie man an, ist jedoch interaktiver: man navigiert mit den Cursor-Tasten und wählt einzelne Kapitel über die Enter-Taste.

Beispiel:

# shows the top-level info page
info
# start at nano node from top-level dir
info nano

Built on 2022-06-03