Ich habe keine Ahnung, wie ich meine selbst entwickelten Spezialskripte (hauptsächlich in Bash und Perl geschrieben) über den man verfügbar machen kann Seiten.
Welches Verfahren muss ich befolgen, und gibt es ein bestimmtes Format, in dem die Dokumentation geschrieben werden muss, damit ich dies tun kann?
Akzeptierte Antwort:
Ich habe festgestellt, dass die Verwendung von Perls POD viel einfacher ist als das direkte Schreiben von Manpages, und Sie können mit pod2man eine Manpage aus der POD-Datei erstellen Utility (Teil des Perl-Basispakets). Da einige Ihrer ausführbaren Dateien bereits in Perl geschrieben sind, können Sie POD-Formatierungen direkt zu Ihren Skripten hinzufügen und diese direkt in POD-Dateien umwandeln. Ich habe auch mehrere Projekte gesehen, die das POD-Format verwenden, obwohl ihr Code aufgrund der Einfachheit von POD in anderen Sprachen geschrieben ist.
Um ein zusätzliches Verzeichnis mit Handbuchseiten hinzuzufügen, können Sie den $MANPATH festlegen Umgebungsvariable. Präfix $MANPATH mit einem : um es zur Liste der bereits konfigurierten man-Pfade hinzuzufügen. Verwenden Sie den manpath Befehl, um die aktuell definierten Benutzerpfade anzuzeigen.