Manpage: Unterschied zwischen den Versionen

Aus UUGRN
Keine Bearbeitungszusammenfassung
 
(markup, gliederung,vorlagen im wiki)
 
(2 dazwischenliegende Versionen von einem anderen Benutzer werden nicht angezeigt)
Zeile 1: Zeile 1:
'''Manpage''' steht in Kurzform für ''Manual page'', also ''Seite aus der Bedienungsanleitung''. Manpages stellen ein mächtiges System zur Dokumentation von Betriebssystem und Zusatzsoftware dar. Ursprünglich handelte es sich bei solchen Manpages um tatsächlich gedruckte Dokumentation, die meist mehrere Regalmeter verschlang. Seit einigen Jahrzehnten hat sich jedoch die Online-Dokumentation durchgesetzt, die über das Kommando <code>man</code> aufgerufen werden kann.
'''Manpage''' steht in Kurzform für ''Manual page'', also ''Seite aus der Bedienungsanleitung''. Manpages stellen ein mächtiges System zur Dokumentation von Betriebssystem und Zusatzsoftware dar. Ursprünglich handelte es sich bei solchen Manpages um tatsächlich gedruckte Dokumentation, die meist mehrere Regalmeter verschlang. Seit einigen Jahrzehnten hat sich jedoch die Online-Dokumentation durchgesetzt, die über das Kommando <code>man</code> aufgerufen werden kann.


Beispiel:
;Beispiel:
  man man
  $ man man
ruft die Dokumentation zum <code>man</code>-Befehl selbst auf.
:ruft die Dokumentation zum <code>man</code>-Befehl selbst auf.


== Gliederung ==
Die Dokumentation ist dabei traditionell in unterschiedliche Sektionen gegliedert und einzelne Schlagwörter können in verschiedenen Sektionen gelistet sein, die jeweils auch unterschiedliche Seiten beinhalten.
Die Dokumentation ist dabei traditionell in unterschiedliche Sektionen gegliedert und einzelne Schlagwörter können in verschiedenen Sektionen gelistet sein, die jeweils auch unterschiedliche Seiten beinhalten.


Zeile 17: Zeile 18:
# Systemverwaltung
# Systemverwaltung
# Kernelverwaltung
# Kernelverwaltung
== Apropos ==
<code>apropos</code> ist ein nützliches Zusatztool für das Manpage-System und hilft beim Auffinden von Seiten.
'''$''' apropos printf
printf(1)                - formatted output
printf(3), fprintf(3)... - formatted output conversion
format(n)                - Format a string in the style of sprintf
gl_printf(3)            - write formatted output in graphic mode
gprintf(1), printf(1)    - format and print data
printftest(6)            - tests the vgagl gl_printf function
== im Wiki ==
In diesem Wiki können Manpages verlinkt werden. Dazu wird die [[:Vorlage:man]] verwendet.
;FreeBSD: <nowiki>{{man|freebsd|1|man}}</nowiki> ergibt {{man|freebsd|1|man}}
;OpenBSD: <nowiki>{{man|openbsd|1|man}}</nowiki> ergibt {{man|openbsd|1|man}}
== Siehe auch ==
* [[Texinfo]]


[[Kategorie:Tool]]
[[Kategorie:Tool]]
[[Kategorie:Dokumentation| Manpage]]
[[Kategorie:Dokumentation| Manpage]]

Aktuelle Version vom 22. Juli 2007, 19:13 Uhr

Manpage steht in Kurzform für Manual page, also Seite aus der Bedienungsanleitung. Manpages stellen ein mächtiges System zur Dokumentation von Betriebssystem und Zusatzsoftware dar. Ursprünglich handelte es sich bei solchen Manpages um tatsächlich gedruckte Dokumentation, die meist mehrere Regalmeter verschlang. Seit einigen Jahrzehnten hat sich jedoch die Online-Dokumentation durchgesetzt, die über das Kommando man aufgerufen werden kann.

Beispiel
$ man man
ruft die Dokumentation zum man-Befehl selbst auf.

Gliederung[Bearbeiten]

Die Dokumentation ist dabei traditionell in unterschiedliche Sektionen gegliedert und einzelne Schlagwörter können in verschiedenen Sektionen gelistet sein, die jeweils auch unterschiedliche Seiten beinhalten.

Die Sektionen sind

  1. Allgemeine Kommandos
  2. Systemaufrufe
  3. Bibliotheksaufrufe
  4. Geräte
  5. Dateiformate
  6. Spiele
  7. Verschiedenes
  8. Systemverwaltung
  9. Kernelverwaltung

Apropos[Bearbeiten]

apropos ist ein nützliches Zusatztool für das Manpage-System und hilft beim Auffinden von Seiten.

$ apropos printf
printf(1)                - formatted output
printf(3), fprintf(3)... - formatted output conversion
format(n)                - Format a string in the style of sprintf
gl_printf(3)             - write formatted output in graphic mode
gprintf(1), printf(1)    - format and print data
printftest(6)            - tests the vgagl gl_printf function

im Wiki[Bearbeiten]

In diesem Wiki können Manpages verlinkt werden. Dazu wird die Vorlage:man verwendet.

FreeBSD
{{man|freebsd|1|man}} ergibt man(1)
OpenBSD
{{man|openbsd|1|man}} ergibt man(1)


Siehe auch[Bearbeiten]