Kann ich eine Manpage für ein Skript erstellen?

Question

Mögliches Duplikat:
Wie kann ich Manpage-Einträge für meine eigenen Powertools hinzufügen?

Für die meisten (wenn nicht alle) Linux-Befehle gibt es Manpages, in denen ihre Verwendungsoptionen usw. beschrieben werden. Kann ich für meine eigenen Bash-Skripte ähnliche Manpages erstellen?

Answer 1

Manpages sind man 7 roffDokumente im Roff-Format (siehe).

• Sie können es mit der Hand schreiben.
• Sie könnenhelp2manum es aus der Hilfeausgabe Ihres Skripts zu generieren.
• Sie können es in einer Auszeichnungssprache schreiben und ein spezielles Tool verwenden, um es in man zu konvertieren:
  • a2x(von demasciidocPaket) fürAsciiDoc
  • grutatxtfürGrutatxt
  • pod2man(von demperlPaket) fürPOD
  • rst2man(von demdokumentierenPaket) fürreStrukturierter Text
  • txt2tagsfürtxt2tags
  • Mantastisch(ein Heroku-Webdienst) fürMarkdown

Answer 2

Ja, das können Sie. Die Manpages lauten wie folgt:NroffDateien.
Das Verzeichnis /usr/local/man ist der Speicherort, der normalerweise für lokal installierte Pakete/Dateien verwendet wird.
Sie können sich Beispiele in den vorhandenen Manpages ansehen (die wahrscheinlich zuerst entpackt werden müssen), lesen Sie auchMann.
Derzeit bevorzugen viele Benutzer groff gegenüber nroff, man groffum loszulegen