31.07.2011, aktualisiert am 10.08.2013

18157

Manpages effizient nutzen

In dieser Anleitung beschreibe ich, wie man Manpages, also das Standard-Dokumentationssystem auf Unix/Linux-Systemen effizient nutzen kann.

Inhaltsverzeichnis

Nach einer Manpage suchen, die Befehle apropos, man -k und whatis

Updaten der whatis-Datenbank

Die Sections

Der Aufbau von Manpages

Suche und Navigation in Manpages

Suche

Suchen nach einer Option

Zeilen anspringen

Marken setzen

Umwandeln einer Manpage in ein PDF-Dokument

Nach einer Manpage suchen, die Befehle apropos, man -k und whatis

mit dem Befehl apropos, whatis oder man -k kann man die Überschriften aller Manpages nach einem bestimmten Begriff durchsuchen.

Beispiel: welche Manpages gibt es zum Thema DHCP?

markus@samsung:~$ apropos dhcp
dhclient           (8)  - script - DHCP client network configuration script
dhclient.conf      (5)  - DHCP client configuration file
dhclient.leases    (5)  - DHCP client lease database
dhcp               (5)  - eval - ISC DHCP conditional evaluation
dhcp               (5)  - options - Dynamic Host Configuration Protocol options
dhcpcd             (8)  - an RFC 2131 compliant DHCP client
dhcpctl_initialize  (3)  - dhcpctl library initialization
dhcpd              (8)  - Dynamic Host Configuration Protocol Server
dhcpd.conf         (5)  - dhcpd configuration file
dhcpd.leases       (5)  - DHCP client lease database
dnsmasq            (8)  - A lightweight DHCP and caching DNS server

Anmerkung: die Suche mit dem apropos Befehl unterscheidet nicht zwischen Groß- und Kleinschreibung
Der Unterschied zwischen den Kommandos: whatis sucht nach ganzen Wörtern während apropos nach Teilstrings sucht. Das bedeutet, wenn man nicht genau den Befehl kennt nach dem man such, dann kann man mit "apropos" alle Einträge finden, in denen der Suchstring auch als Teilstring vorkommt. Wenn man nach einem bestimmten Programm / Befehl sucht, dann ist whatis effizienter. Die beiden Befehle "man -k" und apropos sind identisch.

Beispiel: Suche mit whatis nach DHCP:

markus@samsung:~$ whatis dhcp
dhcp               (5)  - eval - ISC DHCP conditional evaluation
dhcp               (5)  - options - Dynamic Host Configuration Protocol options

Updaten der whatis-Datenbank

Wenn man neue Programme installiert hat, dann muss die Manpage des neuen Programms in die Datenbank des apropos-Befehls aufgenommen werden, normalerweise sollte das automatisch erfolgen. Falls man dies manuell erledigen muss erfolgt dies entweder mit dem Befehl mandb oder makewhatis , je nach Distribution. Beachtet, dass Ihr dazu root-Rechte benötigt, also entweder als root einloggen oder den Befehl mit sudo ausführen

sudo makewhatis

Die Sections

Die Manpages werden thematisch in 8 verschiedene Bereiche (Sections) unterteilt, hier ein Ausschnitt aus der Manpage zu "man"

MANUAL SECTIONS
       The standard sections of the manual include:
       1      User Commands
       2      System Calls
       3      C Library Functions
       4      Devices and Special Files
       5      File Formats and Conventions
       6      Games et. Al.
       7      Miscellanea
       8      System Administration tools and Deamons

Um die Manpage einer bestimmten Section aufzurufen kann man die Nummer als erstes Argument hinter dem man-Befehl angeben. Häufig kommt es vor, dass Manpages mit dem gleichen Namen in unterschielichen Bereichen auftauchen.

Beispiel, der Befehl "apropos man" (hier nur ein Ausschnitt der Ausgabe)

markus@samsung:~$ apropos man 
 ...
makecontext        (3)  - manipulate user context
makedev            (3)  - manage a device number
man                (1)  - format and display the on-line manual pages
man                (7)  - macros to format man pages
man                (7)  - pages - conventions for writing Linux man pages
man.conf           (5)  - configuration data for man
man2html           (1)  - format a manual page in html
manuals with       (7)  - mdoc
 ...  

also gibt es eine Manpage zum Thema "man" in den Sections 1 und 7. Wenn man nun die Manpage zu "macros to format man pages" aufrufen möchte, dann geht das so

man 7 man

Der Aufbau von Manpages

Die Manpages sind eigentlich weitgehen alle nach dem gleichen Schema aufgebaut.
In der ersten Zeile steht der Name der Manpage zusammen mit der Section in Klammern. Danach folgt eine kurze Beschreibung. Der weitere Aufbau ist immer wie folgt:

Name: Name und kurze Beschreibung in Stichworten

Synopsis: Kurze Beschreibung der Syntax und Aufzählung der Optionen

Description: Beschreibung des Befehls

Options: Hier werden ausführlich die Optionen eines Befehls erklärt

Bugs: Wie der Name schon sagt, hier werden bekannte Programmfehler aufgeführt

Author: Autor des Befehls und ggf. der Dokumentation

See also: Hinweis auf Manpages zu ähnlichen respektive zusammenhängenden Befehlen.

Insbesondere die letzte Position "See also" ist sehr nützlich wenn man sich über ein Thema informieren möchte, aber noch nicht genau weiß, welche Programme/Befehle damit zusammenhängen.
Es können allerdings dazwischen noch viele andere Überschriften in einer Manpage stehen, die oben beschriebenen sind aber eigentlich immer vorhanden.
Am Schluss steht das Datum der letzten Änderung der Manpage.

Suche und Navigation in Manpages

Manpages werden mit dem Programm "less" gelesen. Dieses benutzt die Tastaturbefehle des vi-Editors.

Suche
Die Suche erfolgt mit "/" (vorwärts) und mit "?" (rückwärts), "Weitersuchen" erfolgt mit "n". Wie beim vi-Editor wird der Suchbefehl unten links im Fenster angezeigt. Zur Übung: ruft die Manpage für "man" auf und sucht nach der Option "-k".

Ein Beispiel: Ihr möchtet wissen, was genau passiert wenn die Bash-Shell als login-shell ausgeführt wird. Aufrufen der Manpage erfolgt mit

man bash

und nun sucht Ihr nach dem Wort "login"

/login

das führt zu folgendem Abschnitt

When bash is invoked as an interactive login shell, or  as  a  non-interactive  shell  with  the
       --login  option,  it  first reads and executes commands from the file /etc/profile, if that file
       exists.  After reading that file, it looks for ~/.bash_profile, ~/.bash_login,  and  ~/.profile,
       in  that  order, and reads and executes commands from the first one that exists and is readable.
       The --noprofile option may be used when the shell is started to inhibit this behavior.

Wenn Ihr Euch am Ende der Manpage befindet, könnt Ihr Rückwärts suchen

?login

Suchen nach einer Option
Beispiel, Suche nach der Option -h in der Manpage zum ls-Befehl

/-h

führt zu folgendem Abschnitt

 -h, --human-readable
              with -l, print sizes in human readable format (e.g., 1K 234M 2G)

Zeilen anspringen
Zurück zur ersten Zeile geht's mit dem Befehl 1G , die letzte Zeile erreicht man mit G , eine beliebige Zeilennummer n mit nG .

Marken setzen
Genau wie in vi kann man Marken setzen, an einer interessanten Stelle ma eingeben speichert die Marke a an der Stelle, später kann man mit 'a wieder dorthin zurück, das bleibt allerdings nach beenden von less nicht erhalten.

Man verlässte eine Manpage mit q .

Umwandeln einer Manpage in ein PDF-Dokument

Mit dem Befehl (hier am Beispiel der Manpage für "man")

man -t man | ps2pdf -> man.pdf

kann man die Manpage in ein PDF-Dokument exportieren.

Markus

Bitte markiere auch die Kommentare, die zur Lösung des Beitrags beigetragen haben

Content-ID: 170683

Url: https://administrator.de/contentid/170683

Ausgedruckt am: 26.11.2024 um 07:11 Uhr

1 Kommentar

Hallo Markus,

eine nützliche und gelungene Anleitung mit einem guten Layout. Ist per PDF-Drucker direkt in mein Archiv gewandert.

Wo ist der "Gefällt mir"-Button? Ah, oben rechts.