man aus Benutzersicht

Programme zum Anzeigen der Man-Pages

man
xman

Beispiele

man man
man ls

Verzeichnisse

/usr/local/man/
/usr/man/
/usr/man/de/
...

Konfiguration

$MANPATH-Variable (SuSE?, RedHat?)
/etc/manpath.config (Debian und verwandte Distributionen)

man aus Programmierersicht

Man-Pages bestehen aus einer Folge von Tags, die mit einem Punkt eingeleitet werden.

ex1.1
.TH ex1 1 "Version 1.0" "September 2000" .SH NAME .SH SYNOPSIS .SH DESCRIPTION .SH OPTIONS .SH FILES .SH ENVIRONMENT .SH DIAGNOSTICS .SH BUGS .SH EXAMPLE .SH NOTES .SH AUTHOR .SH SEE ALSO

Eine einfache Man-Page

ex2.1

.\" Dies ist ein Kommentar .TH ex2 1 "Version 1.0" "September 2000" .\" hier folgt die Sektion "NAME" .SH NAME ex2 \- tut nix .SH AUTHOR Eike Lange eike.lange@uni-essen.de

ex2.1
.\" Dies ist ein Kommentar .TH ex2 1 "Version 1.0" "September 2000" .\" hier folgt die Sektion "NAME" .SH NAME ex2 \- tut nix .SH AUTHOR Eike Lange eike.lange@uni-essen.de

Eine vollständige Man-Page

ex3.1

.\" Dieses ist die Man-Page von "ex3". .\" Copy-Me (:-)) by Eike Lange .TH ex3 1 "Version 1.0" "September 2000" "ELUG-Spielerei" .\" hier folgt die Sektion "NAME" .SH NAME ex2 \- tut nix .SH SYNOPSIS .B ex3 .RB [ "\-v" ] .RB [ "\-\-version" ] .SH DESCRIPTION .B Dieses Programm tut gar nichts. Es ist vermutlich .I nicht einmal auf ihrem Computer installiert. .SH OPTIONS Diese Optionen werden vom Programm .B ex3 akzeptiert: .TP .B "\-v" Könnte ja vielleicht "Verbose" bedeuten .TP .B "\-\-version" Würde Ihnen bestimmt die Versionsnummer anzeigen. Bestimmt! .SH "RETURN VALUES" .TP .B 0 Alles in Ordnung .TP .B 1 Irgendwo trat ein Fehler auf .TP .B 2 Ein schwerwiegender Fehler .SH BUGS Immer, wenn man .I ex3 aufruft, erscheint dieser merkwürdige Fehler: .B bash: ex3: command not found :-) .SH AUTHOR Eike Lange eike.lange@uni-essen.de .SH "SEE ALSO" .BR man (1), .BR ex1 (irgendwo), .BR ex2 (irgendwo), .BR ex4 (irgendwo)

ex3.1
.\" Dieses ist die Man-Page von "ex3". .\" Copy-Me (:-)) by Eike Lange .TH ex3 1 "Version 1.0" "September 2000" "ELUG-Spielerei" .\" hier folgt die Sektion "NAME" .SH NAME ex2 \- tut nix .SH SYNOPSIS .B ex3 .RB [ "\-v" ] .RB [ "\-\-version" ] .SH DESCRIPTION .B Dieses Programm tut gar nichts. Es ist vermutlich .I nicht einmal auf ihrem Computer installiert. .SH OPTIONS Diese Optionen werden vom Programm .B ex3 akzeptiert: .TP .B "\-v" Könnte ja vielleicht "Verbose" bedeuten .TP .B "\-\-version" Würde Ihnen bestimmt die Versionsnummer anzeigen. Bestimmt! .SH "RETURN VALUES" .TP .B 0 Alles in Ordnung .TP .B 1 Irgendwo trat ein Fehler auf .TP .B 2 Ein schwerwiegender Fehler .SH BUGS Immer, wenn man .I ex3 aufruft, erscheint dieser merkwürdige Fehler: .B bash: ex3: command not found :-) .SH AUTHOR Eike Lange eike.lange@uni-essen.de .SH "SEE ALSO" .BR man (1), .BR ex1 (irgendwo), .BR ex2 (irgendwo), .BR ex4 (irgendwo)

Manche Man-Pages enthalten zwei oder mehr Themen, die dokumentiert werden. Beispiel: man fdopen. Um nicht für jeden eintrag dieser Man-Pages eine identische Kopie mit neuem Namen abzulegen, gibt es den .so-Tag:

ex4rc.5

.so ex4.1

ex4rc.5
.so ex4.1

Dazu die Man-Page von ex4.1

ex4.1

.TH ex4 1 "Version 1.0" "September 2000" "ELUG-Spielerei" .SH NAME ex2 \- Dies gibt es gar nicht! .SH SYNOPSIS .B ex4 [ .B -h ] [ .B \-\-help ] .SH DESCRIPTION .B ex4 Ist ein Tool, das es gar nicht gibt. .PP Es ist nur als Beispiel gedacht. .SH OPTIONS .TP .B \-h Zeigt Hilfeseite an .TP .B \-\-help Dasselbe wie .B -h .SH FILES .I ~/.ex4rc Die Konfigurations-Datei .SH EXAMPLE .TP Die Konfigurationsdatei kann folgendermassen aussehen: .br # Berühmte Physiker .br # .br 11.02.1847.Thomas Edison .br 10.07.1856.Nicola Tesla .SH NOTES Bitte rufen Sie ex4 niemals auf, da Ihnen sonst auffällt, dass es ex4 nicht gibt. ;-) .SH AUTHOR Eike Lange (eike.lange@uni-essen.de)

ex4.1
.TH ex4 1 "Version 1.0" "September 2000" "ELUG-Spielerei" .SH NAME ex2 \- Dies gibt es gar nicht! .SH SYNOPSIS .B ex4 [ .B -h ] [ .B \-\-help ] .SH DESCRIPTION .B ex4 Ist ein Tool, das es gar nicht gibt. .PP Es ist nur als Beispiel gedacht. .SH OPTIONS .TP .B \-h Zeigt Hilfeseite an .TP .B \-\-help Dasselbe wie .B -h .SH FILES .I ~/.ex4rc Die Konfigurations-Datei .SH EXAMPLE .TP Die Konfigurationsdatei kann folgendermassen aussehen: .br # Berühmte Physiker .br # .br 11.02.1847.Thomas Edison .br 10.07.1856.Nicola Tesla .SH NOTES Bitte rufen Sie ex4 niemals auf, da Ihnen sonst auffällt, dass es ex4 nicht gibt. ;-) .SH AUTHOR Eike Lange (eike.lange@uni-essen.de)

letzte Änderung: 2000-09-08