So erstellen Sie eine Linux-Manpage

Der Befehl Mann auf Linux ist in den Muskelspeicher jedes Linux-Entwicklers und -Benutzers eingebettet. Es wird buchstäblich von jedem verwendet; von Amateur- und Anfängerentwicklern bis hin zu Linux-Profis und -Experten.

Es wird verwendet, um die Handbuchseite der Befehlszeile für einen Linux-Befehl, eine Konfigurationsdatei oder eine andere Funktion zu lesen. Handbuchseiten werden normalerweise zusammen mit der Installation einer Software unter Linux installiert. Für Handbuchseiten gibt es eine definierte Syntax, die vom Befehl geparst wird.

Lassen Sie uns eine Manpage für das folgende Bash-Skript erstellen, das ich geschrieben habe: 

#!/bin/bash if [ "$1" == "h" ]; dann echo "Hallo" fi if [ "$1" = "b" ]; dann echo "Tschüss" fi

Dieses Skript macht nur zwei Dinge: Es gibt „Hallo“ aus, wenn die Option „h“ als Argument angegeben ist, und es gibt „Tschüss“ aus, wenn die Option „b“ als Argument angegeben ist.

Lassen Sie uns eine Manpage für dieses Programm erstellen. Benutzen vim oder einen beliebigen Editor Ihrer Wahl, um eine Textdatei zu erstellen.

vim test.1

Die Erweiterung ‚.1‘ bedeutet, dass diese Manpage für einen ausführbaren Befehl gedacht ist. Es ist kein Zwang, sondern eine weit verbreitete Konvention beim Schreiben von Manpages. Die Handbuchseite für den Menschen (Mann Mann !) listet die Kategorien auf:

 1 Ausführbare Programme oder Shell-Befehle 2 Systemaufrufe (vom Kernel bereitgestellte Funktionen) 3 Bibliotheksaufrufe (Funktionen innerhalb von Programmbibliotheken) 4 Spezielle Dateien (normalerweise in /dev zu finden) 5 Dateiformate und Konventionen zB /etc/passwd 6 Spiele 7 Verschiedenes ( einschließlich Makropakete und Konventionen), zB man(7), groff(7) 8 Systemverwaltungsbefehle (normalerweise nur für Root) 9 Kernel-Routinen [Nicht standardmäßig]

Eine Manpage wird mit der sehr alten Markup-Sprache roff erstellt. Es verfügt über Befehle (Lesemarkierungen) für verschiedene Titel und Abschnitte.

  • .TH – Dies sollte der erste Befehl in der man-Datei sein. Es wird verwendet, um die Titelüberschrift der Manpage anzugeben.
  • .SCH - Bereichsüberschrift.
  • .B – Es wird verwendet, um den Text daneben fett anzuzeigen.
  • .TP – Es wird verwendet, um Informationen über ein Argument (Flag) zum Befehl anzuzeigen.
  • .BR – Es wird verwendet, um Text fett und in normaler lateinischer Schrift anzuzeigen.

Es folgt die Manpage für mein Programm, die nur mit den obigen (einfachen) roff-Befehlen erstellt wurde.

.TH test.sh 1 .SH NAME test.sh \- Drucken Hallo oder Auf Wiedersehen .SH ZUSAMMENFASSUNG .B test.sh [ h ] [ b ] .SH BESCHREIBUNG .B test.sh Dies ist ein Beispielskript, das nur 2 Dinge tut . Es wird entweder "Hallo" ausgegeben, wenn das Argument "h" ist, oder "Bye", wenn das Argument "b" ist .SH OPTIONS .TP .BR h Drucken Hallo .TP .BR b Drucken Tschüss

Speicher die Datei indem Sie zuerst die ESC -Taste und geben Sie dann ein :wq um die Datei zu speichern und die vim-Konsole zu beenden.

Testen Sie die gerade erstellte Manpage mit dem folgenden Befehl:

Mann ./test.1

Für weitere Informationen zu Mann Nutzung, Lauf man-man-pages Befehl in Ihrem Terminal.

? Spitze

Dies ist die grundlegende Syntax zum Schreiben von Manpages. Um es einfacher zu machen, können Sie Tools wie txt2man verwenden, um eine Datei in einem Markup-Sprachformat in das Roff-Format zu konvertieren.