Zum Inhalt springen

Man: Unterschied zwischen den Versionen

Aus Foxwiki
Versionsgeschichte interaktiv durchsuchen
← Zum vorherigen Versionsunterschied
VisuellWikitext
K Textersetzung - „–“ durch „-“
 
(127 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
'''man''' zeigt Manual Pages von Befehlen an.
'''man''' - [[manpage |Systemhandbücher]] anzeigen


= Beschreibung =
== Beschreibung ==
== Manual Pages==
''man'' zeigt [[manpage|Systemhandbücher]] an
* Jedes an man übergebene Argument Seite ist normalerweise der Name eines Programms oder einer Funktion
* Gefunden und angezeigt 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 Angabe 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


= Installation =
== Installation ==
= Syntax =
<syntaxhighlight lang="bash" highlight="1" line copy>
== Parameter ==
sudo apt install man
== Optionen ==
</syntaxhighlight>
= Konfiguration =
= Anwendungen =


= Links =
== Aufruf ==
== Dateien ==
<syntaxhighlight lang="bash" highlight="1-6" line copy>
== Man-Pages ==
man [man Optionen] [[Abschnitt] Seite ...] ..
== Intern ==
man -k [apropos Optionen] Regulärer_Ausdruck ..
== Weblinks ==
man -K [man Optionen] [Abschnitt] Begriff ..
=Kontrollfragen=
man -f [whatis Optionen] Seite ..
<div class="toccolours mw-collapsible mw-collapsed">
man -l [man Optionen] Datei ..
''Testfrage 1''
man -w|-W [man Optionen] Seite ..
<div class="mw-collapsible-content">'''Antwort1'''</div>
</syntaxhighlight>
</div>
<div class="toccolours mw-collapsible mw-collapsed">
''Testfrage 2''
<div class="mw-collapsible-content">'''Antwort2'''</div>
</div>
<div class="toccolours mw-collapsible mw-collapsed">
''Testfrage 3''
<div class="mw-collapsible-content">'''Antwort3'''</div>
</div>
<div class="toccolours mw-collapsible mw-collapsed">
''Testfrage 4''
<div class="mw-collapsible-content">'''Antwort4'''</div>
</div>
<div class="toccolours mw-collapsible mw-collapsed">
''Testfrage 5''
<div class="mw-collapsible-content">'''Antwort5'''</div>
</div>


== Anwendung ==
=== Suche in Manual-Pages ===
* Die Einzeldokumentationen enthalten am Beginn einen Abschnitt (Name), der den Zweck des Programms kurz beschreibt (Apropos)
* In diesem Abschnitt kann nach bestimmten Stichworten gesucht werden
* Für jeden Manualeintrag, der im Abschnitt "Name" dieses Stichwort enthält, wird ein entsprechender Hinweis ausgegeben
$ '''apropos <stichwort>'''


== Beispiel==
=== Alternative ===
  so schreibt man das Kommando
  $ '''man -k <stichwort>'''


man BEFEHL
'''Beispiel'''


MAN(1)            Dienstprogramme für Handbuchseiten          MAN(1)
Sie suchen die Beschreibung des Aufbaus der Passwortdatenbank /etc/passwd
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.


= Mehr Beispiele=
$ '''man -k passwd'''
  man ls
  passwd (5) - password file
passwd, npasswd (1) - change login password
rpc.yppasswdd (8) - NIS password update server
yppasswd, ypchfn, ypchsh (1) - NIS password update clients


man cat
Die Angaben in Klammern (zum Beispiel passwd (5)) geben an, in welcher Sektion des Manuals sich dieser Eintrag befindet


man cp
Die gewünschte Information kann aufgerufen werden
 
  $ '''man -S 5 passwd'''
  man loginctl | cat > loginctl.txt
 
==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. Ä.


oder kurz mit
$ '''man 5 passwd'''


=== Manpage exportieren ===
man loginctl > loginctl.txt


= Manual-Pages =
=== Beispiele ===
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
; Handbuchseite für ''ls'' anzeigen
<syntaxhighlight lang="bash" highlight="1" line copy>
man ls
</syntaxhighlight>


$ '''man [-S Sektion] <Kommando>'''
; Handbuchseite für das Makropaket man aus Abschnitt 7 anzeigen
* Dies sind alternative Schreibweisen für ''man 7 man''
<syntaxhighlight lang="bash" highlight="1" line copy>
man 'man(7)'
man man.7
</syntaxhighlight>


aufrufen.
; Zeigt die Handbuchseite für das Makropaket man aus Abschnitt 7 an
* Dies ist eine weitere alternative Schreibweise für "man 7 man"
* Dies könnte beim Kopieren und Einfügen von Querverweisen in Handbuchseiten bequemer sein
* Beachten Sie, dass die Klammern normalerweise in Anführungszeichen gesetzt werden müssen, um zu verhindern, dass sie von der Shell interpretiert werden


'''Beispiel'''
; Zeigt nacheinander alle vorhandenen ''intro''-Handbuchseiten an
$ '''man ls'''
* Sie können zwischen den aufeinander folgendenden Ausgaben der Seiten abbrechen oder beliebige Seiten überspringen
VDIR(1)                                  FSF                                  VDIR(1)
<syntaxhighlight lang="bash" highlight="1" line copy>
 
man -a intro
 
</syntaxhighlight>
 
  '''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.
 
  <span > Manual page ls(1) line 1</span>


== Sektionen der Manual-Pages ==
; Formatiert die Handbuchseite für bash in das Standardformat von Troff oder Groff und schickt sie zum Drucker ps
0 Dateiheader (gewöhnlich in /usr/include)
* Für Groff ist das Standardausgabeformat gewöhnlich PostScript
1 Ausführbare Programme oder Shellbefehle
* Mit man --help können Sie herausfinden, welcher Prozessor mit der Option -t verbunden ist
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 ==
; Dieser Befehl dekomprimiert und formatiert den Nroff-Quelltext der Handbuchseite ./foo.1x.gz in eine geräteunabhängige (device-independent)
{|class="wikitable sortable"
dvi-Datei
|-
* Die Umleitung der Ausgabe ist notwendig, da die Option -T ohne Anzeigeprogramm die Ausgabe zur Standardausgabe schickt
|  | <tt>'''NAME '''</tt>
* Die Ausgabe kann mit einem Programm wie xdvi betrachtet oder mit einem Programm wie dvips zu PostScript weiterverarbeitet werden
|  | kurze Beschreibung der Funktion
<syntaxhighlight lang="bash" highlight="1" line copy>
|-
man -l -T dvi ./foo.1x.gz > ./foo.1x.dvi
|  | <tt>'''SYNOPSIS'''</tt>
</syntaxhighlight>
|  | Aufrufsyntax
|-
|  | <tt>'''DESCRIPTION '''</tt>
|  | Detaillierte Beschreibung der Wirkungsweise aller möglichen Optionen
|-
|  | <tt>'''Files'''</tt>
|  | Vom Kommando benötigte/modifizierte Dateien
|-
|  | <tt>'''SEE ALSO '''</tt>
|  | Hinweise auf verwandte Kommandos und Verweise auf ergänzende Informationen
|-
|  | <tt>'''DIAGNOSTICS '''</tt>
|  | Erläuterungen zu Fehlercodes, die das Kommando zurückliefert
|-
|  | <tt>'''BUGS'''</tt>
|  | Bekannte Fehlverhalten des Kommandos, aber auch Hinweise auf Wirkungen, die gewollt aber ungewöhnlich sind0,00cm
|-
|  | <tt>'''EXAMPLE'''</tt>
|  | Beispiele zur Verwendung des Kommandos (fehlt leider oft)
|-
|}


== Suche in Manual-Pages ==
; Sucht in den Beschreibungen und Namen der Handbuchseiten nach dem als regulären Ausdruck angesehenen Schlüsselwort printf und gibt alle Fundstellen aus
* Die Einzeldokumentationen enthalten am Beginn einen Abschnitt (Name), der den Zweck des Programms kurz beschreibt (Apropos).
* Diese Option entspricht apropos printf
* In diesem Abschnitt kann nach bestimmten Stichworten gesucht werden.
<syntaxhighlight lang="bash" highlight="1" line copy>
* Für jeden Manualeintrag, der im Abschnitt "Name" dieses Stichwort enthält, wird ein entsprechender Hinweis ausgegeben.
man -k printf
$ '''apropos <stichwort>'''
</syntaxhighlight>
 
== Alternative ==
$ '''man -k <stichwort>'''


'''Beispiel'''
; Sucht die durch smail angegebenen Handbuchseiten und gibt alle Beschreibungen der gefundenen Seiten aus
* Diese Option entspricht apropos smail
<syntaxhighlight lang="bash" highlight="1" line copy>
man -f smail
</syntaxhighlight>


Sie suchen die Beschreibung des Aufbaus der Passwortdatenbank /etc/passwd.
=== Parameter ===
=== Exit-Status ===


$ '''man -k passwd'''
passwd (5)          - password file
passwd, npasswd (1)  - change login password
rpc.yppasswdd (8)    - NIS password update server
yppasswd, ypchfn, ypchsh (1) - NIS password update clients


Die Angaben in Klammern (zum Beispiel passwd (5)) geben an, in welcher Sektion des Manuals sich dieser Eintrag befindet.
<noinclude>


Die gewünschte Information kann aufgerufen werden.
== Anhang ==
$ '''man –S 5 passwd'''
=== Siehe auch ===
{{Special:PrefixIndex/{{BASEPAGENAME}}/}}
=== Dokumentation ===
; Man-Pages


oder kurz mit
; Info-Pages
$ '''man 5 passwd'''


== Grafische Frontends ==
=== Links ===
* Alternativen zum Konsolen-Befehl sind die grafischen Frontends xman oder tkman.
==== Weblinks ====
* Bequem können die Manual-Seiten auch mit dem KDE-Konquror gelesen werden.
* Geben Sie dazu in die Adresszeile » man<tt>''':<Befehl>'''</tt> « ein.
* Das Programm xman ist eine X-Window-Version von man.


{{DEFAULTSORT:man}}
{{DISPLAYTITLE:man}}


[[Kategorie:Linux/Befehl]]
[[Kategorie:Manpage]]


[[Category:Linux:Dokumentation]]
</noinclude>

Aktuelle Version vom 11. Mai 2025, 19:59 Uhr

man - Systemhandbücher anzeigen

Beschreibung

man zeigt Systemhandbücher an

  • Jedes an man übergebene Argument Seite ist normalerweise der Name eines Programms oder einer Funktion
  • Gefunden und angezeigt 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 Angabe 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

Installation

sudo apt install man

Aufruf

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 ..

Anwendung

Suche in Manual-Pages

  • Die Einzeldokumentationen enthalten am Beginn einen Abschnitt (Name), der den Zweck des Programms kurz beschreibt (Apropos)
  • In diesem Abschnitt kann nach bestimmten Stichworten gesucht werden
  • Für jeden Manualeintrag, der im Abschnitt "Name" dieses Stichwort enthält, wird ein entsprechender Hinweis ausgegeben
$ apropos <stichwort>

Alternative

$ man -k <stichwort>

Beispiel

Sie suchen die Beschreibung des Aufbaus der Passwortdatenbank /etc/passwd 

$ man -k passwd
passwd (5) - password file
passwd, npasswd (1) - change login password
rpc.yppasswdd (8) - NIS password update server
yppasswd, ypchfn, ypchsh (1) - NIS password update clients

Die Angaben in Klammern (zum Beispiel passwd (5)) geben an, in welcher Sektion des Manuals sich dieser Eintrag befindet

Die gewünschte Information kann aufgerufen werden 

$ man -S 5 passwd

oder kurz mit 

$ man 5 passwd

Manpage exportieren

man loginctl > loginctl.txt

Beispiele

Handbuchseite für ls anzeigen
man ls
Handbuchseite für das Makropaket man aus Abschnitt 7 anzeigen
  • Dies sind alternative Schreibweisen für man 7 man
man 'man(7)'
man man.7
Zeigt die Handbuchseite für das Makropaket man aus Abschnitt 7 an
  • Dies ist eine weitere alternative Schreibweise für "man 7 man"
  • Dies könnte beim Kopieren und Einfügen von Querverweisen in Handbuchseiten bequemer sein
  • Beachten Sie, dass die Klammern normalerweise in Anführungszeichen gesetzt werden müssen, um zu verhindern, dass sie von der Shell interpretiert werden
Zeigt nacheinander alle vorhandenen intro-Handbuchseiten an
  • Sie können zwischen den aufeinander folgendenden Ausgaben der Seiten abbrechen oder beliebige Seiten überspringen
man -a intro
Formatiert die Handbuchseite für bash in das Standardformat von Troff oder Groff und schickt sie zum Drucker ps
  • Für Groff ist das Standardausgabeformat gewöhnlich PostScript
  • Mit man --help können Sie herausfinden, welcher Prozessor mit der Option -t verbunden ist
Dieser Befehl dekomprimiert und formatiert den Nroff-Quelltext der Handbuchseite ./foo.1x.gz in eine geräteunabhängige (device-independent)

dvi-Datei

  • Die Umleitung der Ausgabe ist notwendig, da die Option -T ohne Anzeigeprogramm die Ausgabe zur Standardausgabe schickt
  • Die Ausgabe kann mit einem Programm wie xdvi betrachtet oder mit einem Programm wie dvips zu PostScript weiterverarbeitet werden
man -l -T dvi ./foo.1x.gz > ./foo.1x.dvi
Sucht in den Beschreibungen und Namen der Handbuchseiten nach dem als regulären Ausdruck angesehenen Schlüsselwort printf und gibt alle Fundstellen aus
  • Diese Option entspricht apropos printf
man -k printf
Sucht die durch smail angegebenen Handbuchseiten und gibt alle Beschreibungen der gefundenen Seiten aus
  • Diese Option entspricht apropos smail
man -f smail

Parameter

Exit-Status

Anhang

Siehe auch

Dokumentation

Man-Pages
Info-Pages

Links

Weblinks


Abgerufen von „https://wiki.foxtom.de/index.php?title=Man&oldid=142497“