Ich habe keine Ahnung, wie ich meine selbst erstellten Spezialskripte (hauptsächlich in Bash und Perl) über die man
Seiten verfügbar machen kann .
Wie muss ich vorgehen, und gibt es ein bestimmtes Format, in dem die Dokumentation geschrieben werden muss, damit ich dies tun kann?
man
documentation
Zaid
quelle
quelle
info
ist das neueman
.Antworten:
Ich habe festgestellt, dass die Verwendung von Perls POD viel einfacher ist als das direkte Schreiben von Manpages, und Sie können mit dem
pod2man
Dienstprogramm (Teil des Perl-Basispakets) eine Manpage aus der POD-Datei erstellen. Da einige Ihrer ausführbaren Dateien bereits in Perl geschrieben sind, können Sie Ihren Skripten POD-Formatierungen hinzufügen und diese direkt in POD-Dateien umwandeln. Ich habe auch gesehen, dass einige Projekte das POD-Format verwenden, obwohl der Code aufgrund der Einfachheit von POD in anderen Sprachen geschrieben ist.Um ein zusätzliches Verzeichnis mit Manpages hinzuzufügen, können Sie die
$MANPATH
Umgebungsvariable festlegen . Präfix$MANPATH
mit einem:
, um es zur Liste der bereits konfigurierten man-Pfade hinzuzufügen. Verwenden Sie denmanpath
Befehl, um die aktuell definierten man-Pfade anzuzeigen.quelle
Kurz gesagt, siehe
man groff_man
für das Dateiformat ( Webversion ).Speichern Sie es in
/usr/local/man/man1
oder/usr/share/man/man1
wenn das nicht funktioniert.Weitere Informationen finden Sie auf der Manpage HOWTO .
quelle
groff_an
oder seingroff_man
, aber Sie müssen möglicherweise ein nicht standardmäßiges Paket installieren, um es zu erhalten.groff_an
, und für die meisten Leute wird es so sein,groff_man
wenn Sie sich darauf beziehen. :-)Try
pandoc
- es wird eine erweiterte Markdown- Syntax verwendet, die Sie von StackOverflow kennen .Hier ist das Beispiel der Manualpage :
So konvertieren Sie es in eine Manpage:
Visualisiertes Ergebnis der Konvertierung (Fragment der generierten Manualpage):
Sie können installieren Pandoc von Repositories der meisten populären Linux - Distributionen .
Weitere Links:
quelle
Ich benutze dieses schnelle und einfache Tutorial schon seit einiger Zeit, um benutzerdefinierte Manpages zu erstellen .
Der allgemeine Prozess ist wie folgt:
sed
Skript, für das es formatiert werden sollnroff
nroff
Sie können es dann optional (b | g) komprimieren und in das entsprechende man-Verzeichnis stellen.
quelle
Nach dieser Seite ist es einfach:
Fügen Sie dann ein Beispiel wie dieses ein und ändern Sie es. Diese Seite (oder
man 7 mdoc
) erklärt die Formatierungsoptionen:Dann gzip einfach und kopiere deine neue Manpage in den richtigen Man-Bereich:
Da es sich bei dem Beispiel um ein Admin-Tool handelt, wird auf Abschnitt 8 verwiesen:
Oder lassen Sie es von anderen Personen lesen , z. B. vor Ort:
man ./nuseradd
quelle
sudo su
Platzieren Sie den gewünschten Namen in der Datei "md2man.sh" oder nach Ihrer Wahl.
Verwendungszweck:
md2man.sh myManPage.md
Kurznotiz: Nicht alle groff,,
-T
Ausgabegeräte unterstützen utf8. Utf8 funktioniert in groff, wird jedoch nicht von allen Treibern unterstützt. Zum Beispielpdf
undps
nicht mit utf8-Eingabe arbeiten. Wenn Sie-Kutf8
groff verwendet haben, wird utf8-Eingabe verwendet. Andere Treiber wiehtml
und die Textausgabe als uft8-Tutf8
, werden mit utf8-Zeichen ausgegeben.quelle