Handbuchseiten, auch Manpages genannt, sind eine gut unterstützte und beliebte Möglichkeit, Software unter Unix-, BSD- und GNU / Linux-Betriebssystemen zu dokumentieren. Ein Textformatierungsprogramm ist erforderlich, um die intrinsischen Formate von Manpages in andere für die Anzeige geeignete Formate zu verarbeiten. GNU / Linux-Systeme verwenden normalerweise Groff und einige BSD-Systeme, wie zum Beispiel OpenBSD, verwenden Mandoc-Programme als Textformatierer. Zum Anzeigen von Manpages in Windows benötigen Sie jedoch noch ein Formatierungsprogramm. Daher haben wir uns entschlossen, die Hauptprogramme der mandoc suite für Windows zu erstellen und die Binärdateien zum Download zusammen mit einer kurzen Erklärung zu Verwendung und Aufbau aus Quellen zusammenzustellen.
1
embedeo
Ich bin mit der Webseite verbunden, die JakeGould in seiner Antwort gepostet hat. Ich habe die Essenz der Mandoc-Suite auf Windows (MinGW / MSYS) portiert und diese Seite erstellt. Ich danke den Autoren und Mitwirkenden von mandoc suite und MinGW / MSYS! Sie haben also 3 Möglichkeiten:
Gehen Sie zu meiner Seite Manpages in Windows und MinGW / MSYS anzeigen, lesen Sie den Haftungsausschluss :) Bitte laden Sie die ZIP-Datei mit vorinstallierten Binärdateien herunter, z. B. mdocml-1.13.1-win32-embedeo-02.zip, lokal extrahieren Führen Sie dann einen der folgenden Befehle auf der Windows-Befehlszeile (cmd.exe) mit Ihrer Manpage als Argument aus:
mandoc.exe openvpn.8 | more
oder, meine bevorzugte Art, in eine HTML-Seite zu konvertieren:
Außerdem ist es eine gute Idee, auf mandoc aufmerksam zu werden, wenn Sie jemals auf die Idee kommen, Ihre eigenen Manpages zu schreiben. Aus meiner Sicht ist die mandoc-Suite einem reinen Toolset und einem besseren "gemeinsamen Nenner" aus Sicht der Autoren überlegen.
Wenn Ihre Manpage jedoch zu "traditionell" roff ist oder Sie mit der Formatierung von mandoc nicht zufrieden sind, möchten Sie Ihre Manpage möglicherweise mit GNU troff (groff) formatieren / anzeigen. Beispielsweise können Sie von ezwinports vorgefertigte groff-Binärdateien für Windows erhalten .
Sie können nach einer Online-HTML-Variante Ihrer Manpage suchen. Ich würde diese Option jedoch nicht empfehlen, da immer das Risiko besteht, dass das Online-Dokument eine andere Version der Software abdeckt als die Version, die Sie lokal haben.