Vorlage:Man/Doku

aus Wikipedia, der freien Enzyklopädie

Beschreibung

Dieser Baustein dient zum standarisierten und vereinfachten Verlinken auf Online-Manpages in Artikeln zu Unix und seinen Varianten.

Kopiervorlage

Groß- und Kleinschreibung ist signifikant.

Quelle Eingabe Ergebnis
BSD {{man|1|man|bsd}} man(1) – OpenBSD General Commands Manual
GNU/Linux {{man|1|man|gnu}} man(1) – Debian GNU/Linux Ausführbare Programme oder Shell-Befehle Handbuchseite
POSIX / SUS {{man||man|posix}} man – Open Group Base Specification

Weitere in den Unterseiten zur Vorlage definierte Quellen:

Quelle Eingabe Ergebnis
Darwin / macOS {{man|1|man|Darwin}} man(1) – Darwin – Man Page
DragonFly BSD {{man|1|man|DragonFly BSD}} man(1) – DragonFly BSD General Commands Manual
FreeBSD {{man|1|man|FreeBSD}} man(1) – FreeBSD General Commands Manual
OpenBSD {{man|1|man|OpenBSD}} man(1) – OpenBSD General Commands Manual
Plan 9 {{man|1|man|Plan 9}} man(1) – Plan 9 – Man Page
GMT {{man||pscoast|GMT}} pscoast(1gmt): To plot land-masses, water-masses, coastlines, borders and rivers – Generic Mapping Tools

Parameter

  1. Bereichs-Nummer (section) der Manpage, diese ist nicht standardisiert
  2. Name der Manpage
  3. Kurzbezeichnung der entsprechenden Manpage-Variante posix, bsd oder gnu. Es ist mindestens eine dieser Varianten anzugeben.
  4. optionale Beschreibung der Manpage (z. B. zur Angabe des Manpage-Titels).
  5. Darstellungsparameter: Zurzeit steht nur der optionale Parameter inline zur Verfügung, damit wird im Fließtext der Verweis auf die Manpage verlinkt und in der üblichen Schreibung angezeigt.

Beispiele

Die Verwendung der Vorlage ohne Angabe der Variante, z.B. {{man|3|printf}} ist mehrdeutig und wird nicht mehr empfohlen!

Eingabe Ausgabe
… {{man||printf|posix||inline}} … Mit printf die Ausgabe formatieren
{{man|1|printf|bsd|…}} printf(1): formatted output – OpenBSD General Commands Manual
{{man|3|printf|bsd|…}} printf(3): formatted output conversion – OpenBSD Library Functions Manual
{{man|3|printf|FreeBSD}} printf(3): Library Functions – FreeBSD Library Functions Manual
{{man|1|printf|gnu|…}} printf(1): Daten formatieren und ausgeben – Debian GNU/Linux Ausführbare Programme oder Shell-Befehle Handbuchseite
{{man|3|printf|gnu|…}} printf(3): formatierte Ausgabe – Debian GNU/Linux Bibliotheksaufrufe Handbuchseite
{{man|1|top|bsd|…}} top(1): display and update information about the top CPU processes – OpenBSD General Commands Manual
{{man|1|top|gnu|…}} top(1): display Linux processes – Debian GNU/Linux Ausführbare Programme oder Shell-Befehle Handbuchseite
{{man||pscoast|GMT}} pscoast(1gmt): To plot land-masses, water-masses, coastlines, borders and rivers – Generic Mapping Tools