Hallo zusammen,
in der Diskussion zum Artikel Wiki/Kopiervorlage habe ich ab hier bereits Vorschläge unterbreitet, wie man das Verlinken von Manpages zielführender gestalten könnte.
Diese Vorschläge möchte ich hiermit aufgreifen und an dieser Stelle einen ähnlichen, m.E. zum jetzigen Zeitpunkt noch zielführenderen Vorschlag unterbreiten:
Nämlich, einen Textbaustein zu kreieren, welcher zum einen meine früheren Vorschläge betr. man, aber zum anderen auch Shell-Builtins, info-Seiten und evtl. auch noch Dokumentationen mit einbezieht.
Und zwar z.B. in der Form:
[[Vorlage(Dokumentation, "kurz" oder "lang", dual:ja oder nein, Shell:Shell1:Shell2, Prüfen:Befehl, Builtin:Befehl, Start-Befehl:Pfad, Paket:Name, Manpage:Name, Online:englisch oder deutsch:Seitenname, Infoseite:Name, Doc-Verzeichnis:Pfad)]]
Seht selbst:
Dokumentation¶
Verwendung: Um je nach Typ des beschriebenen Befehles (externes Programm/Skript oder Shell-Builtin) Informationen betreffend Manpages, Ubuntu-Online-Manpage (englisch oder deutsch), Shell-Builtin-Aufruf, info-Seite und evtl. auch noch Dokumentationen, aber auch noch weitere Infos bereitzustellen. Dies kann entweder als Kurzform (geeignet für die Darstellung in Listen) oder als Langform (geeignet für die Darstellung in Fließtext) erstellt werden.
Syntax¶
[[Vorlage(Dokumentation, "kurz" oder "lang", dual:ja oder nein, Shell:Shell1:Shell2, Prüfen:Befehl, Builtin:Befehl, Start-Befehl:Pfad, Paket:Name, Manpage:Name, Online:englisch oder deutsch:Seitenname, Infoseite:Name, Doc-Verzeichnis:Pfad)]]
| Parameter | |
kurz oder lang | Ob der ausgegebene Text entweder für die Darstellung in Listen oder aber für die Darstellung in Fließtext geeignet sein soll. |
dual:ja oder dual:nein | Nur bei Shell-Builtins. Ob das Programm lediglich als Shell-Builtin oder auch als externes Programm verfügbar ist. |
Shell | Die Shell(s), in die bzw. in denen das Programm eingebaut ist, z.B. Bash:Dash. |
Prüfen | Der Befehl, um zu prüfen, ob das Programm auch für die gerade benutzte Shell als Shell-Builtin verfügbar ist, z.B. "type echo". |
Builtin:Befehl | Der Befehl, um den Shell-Builtin aufzurufen, z.B. "help cd". |
Start-Befehl | Der Befehl (meistens ein Pfad), mit dem man das externe Programm aufrufen kann, z.B. /bin/echo. |
Paket | Der Paket-Name, in dem das externe Programm enthalten ist, z.B. coreutils. |
Manpage:Name | Der korrekte Name der Manpage, z.B. mpv. |
Online:englisch oder deutsch:Seitenname | Die Sprache (englisch oder deutsch) sowie der korrekte Seitenname der Ubuntu-Online-Manpage, z.B. en:mpv. |
Infoseite:Name | Der korrekte Name der Infoseite, z.B. mpv. |
Doc-Verzeichnis:Pfad | Der korrekte Pfad zum Dokumentationen-Verzeichnis, z.B. /usr/share/doc/mpv. |
Beispiele¶
kurz, externes Programm¶
Code:
[[(Vorlage(Dokumentation, kurz, Manpage:mpv, Online:en:mpv, Infoseite:mpv, Doc-Verzeichnis:/usr/share/doc/mpv)]]
Ergebnis:
"Manpage-Aufruf: man mpv (Online-Version 🇬🇧), Infoseiten-Aufruf: info mpv und Dokumentationen-Verzeichnis: /usr/share/doc/mpv"
lang, externes Programm¶
Code:
[[(Vorlage(Dokumentation, lang, Manpage:mpv, Online:en:mpv, Infoseite:mpv, Doc-Verzeichnis:/usr/share/doc/mpv)]]
Ergebnis:
"Weitere Einstellungen und Optionen finden sich in der manpage zu mpv mit dem Aufruf man mpv – auch online abrufbar unter mpv 🇬🇧 – sowie auch zum einen auf der Infoseite mit dem Aufruf info mpv und zum anderen im Dokumentationen-Verzeichnis /usr/share/doc/mpv."
kurz, Shell-Builtin¶
Code:
[[(Vorlage(Dokumentation, kurz, dual:nein, Builtin:"help cd", Online:en:cd)]]
Ergebnis:
"Shell-Builtin-Aufruf: help cd (Online-Version 🇬🇧)"
lang, Shell-Builtin¶
Code:
[[(Vorlage(Dokumentation, lang, dual:nein, Builtin:"help cd", Online:en:cd)]]
Ergebnis:
"cd ist lediglich als Shell-Builtin verfügbar. Man kann mit dem Befehl help cd weitere Einstellungen und Optionen abrufen – auch online abrufbar unter cd 🇬🇧."
kurz, dual¶
Code:
[[(Vorlage(Dokumentation, kurz, dual:ja, Shell:Bash:Dash, Prüfen:"type echo", Builtin:"help echo", Start-Befehl:/bin/echo, Paket:coreutils, Manpage:echo, Online:en:echo, Infoseite:echo)]]
Ergebnis:
"Shell-Builtin in Shells Bash und Dash (Überprüfung f. akt, Shell: type echo), dort Hilfe-Aufruf: help echo, Aufruf als externes Programm: /bin/echo, aus Paket: coreutils, Manpage-Aufruf: man echo (Online-Version 🇬🇧), Infoseiten-Aufruf: info echo."
lang, dual¶
Code:
[[(Vorlage(Dokumentation, lang, dual:ja, Shell:Bash:Dash, Prüfen:"type echo", Builtin:"help echo", Start-Befehl:/bin/echo, Paket:coreutils, Manpage:echo, Online:en:echo, Infoseite:echo)]]
Ergebnis:
"echo ist als Shell-Builtin für die Shells Bash und Dash sowie als externes Programm verfügbar. Mit dem Befehl type echo kann überprüft werden, ob echo auch für die gerade benutzte Shell als Shell-Builtin verfügbar ist. Die benutzte Shell verwendet ggf. eine eigene Version von echo. Es kann sein, dass diese eigene Optionen mitbringt. Falls dem so wäre, könnte man mit dem Befehl help echo weitere Einstellungen und Optionen abrufen. Mit dem Befehl /bin/echo kann man explizit echo aus dem Paket coreutils aufrufen. Dann finden sich weitere Einstellungen und Optionen in der manpage mit dem Aufruf man echo – auch online abrufbar unter echo 🇬🇧 – sowie auch auf der Infoseite mit dem Aufruf info echo."
Alternativ (bzw. zusätzlich) könnte man die Dokumentation aber auch mit in der Vorlage Infobox unterbringen. Ich würde aber eher für "zusätzlich" plädieren.
Außerdem könnte generell auch etwas im Wiki über Shell-Builtins und ihre Handhabung stehen. Ob nun als eigener Artikel oder z.B. als Unter-Abschnitt von man, das wäre dann die nächste Frage.
Schließlich könnte man für Programme/Skripte einerseits sowie Shell-Builtins andererseits auch jeweils eigene Textbausteine erstellen.
Moderiert von noisefloor:
Abgetrennt von der Diskussion Wiki/Textbausteine, weil eigenes Thema / allgemeiner Verbesserungsvorschlag
.
