Ich habe einen Unix-Befehl namens macmac2unix, der eine Word-Datei von Mac nach Unix konvertiert.Dokumentation für einen Unix-Befehl bereitstellen?
Wie kann ich Dokumentation für mein Kommando bereitstellen? Ich möchte mit den Menschen über meinen Befehl lesen
$man macmac2unix
I Perl's POD format empfehlen. Trotz des Namens können Sie es außerhalb von Perl-Skripten verwenden, und der Befehl pod2man wird mit OS X ausgeliefert. Es ist viel sinnvoller, dass troff. Erinnert mich an Markdown.
Hier ist ein example pod document und der conversion script.
Sie können anscheinend auch DocBook verwenden, um Dokumentation für einen Unix-Befehl bereitzustellen.
BTW - Der Name "mac2unix" wird bereits häufig für ein Dienstprogramm verwendet, das Zeilenendezeichen in normalen Textdateien ändert. Die Verwendung dieses Namens kann zu Verwirrung führen ... – dmckee
Ich würde vorschlagen, die Frage zu ändern, um sie generisch zu machen. Die Tatsache, dass Sie mac2unix "neu erstellt" haben, lenkt von der Erstellung einer Manpage ab. –
Ich habe den Namen geändert. –