Mann Seite

Die Mannseite auf Mann (1), wie in verschiedenen Linux -Verteilungen. Diese Version ist von Man-DB.

A Mann Seite (kurz für Handbuch Seite) ist eine Form von Softwaredokumentation normalerweise auf a gefunden Unix oder Unix-artig Betriebssystem. Zu den behandelten Themen gehören Computerprogramme (einschließlich Bibliothek und Systemaufrufe), formale Standards und Konventionen und sogar abstrakte Konzepte. EIN Benutzer kann eine Mannseite aufrufen, indem sie die ausgeben Mann Befehl.

Standardmäßig, Mann verwendet normalerweise a Terminalpager Programm wie mehr oder weniger seine Ausgabe anzeigen.

Mannseiten werden oft als als bezeichnet online oder online Form der Softwaredokumentation,[1] obwohl die Mann Der Befehl erfordert keinen Internetzugang und stammt aus der Zeit, wenn sie gedruckt werden außerhalb der Bandbreite Handbücher waren die Norm.

Geschichte

X Mannfrüh X11 Antrag auf Ansichtshandbuchseiten
OpenBSD Abschnitt 8 Intro Man -Seite, Anzeige in einer Textkonsole

In den ersten zwei Jahren der Geschichte der UnixEs gab keine Dokumentation.[2] Das UNIX -Programmierhandbuch wurde erstmals am 3. November 1971 veröffentlicht. Die ersten tatsächlichen Mannseiten wurden von geschrieben von Dennis Ritchie und Ken Thompson Bei der Beharrlichkeit ihres Managers Doug McIlroy 1971. Abgesehen von den Mannseiten die Programmierhandbuch akkumulierte auch eine Reihe von kurzen Papieren, einige von ihnen Tutorials (z. B. für die allgemeine UNIX -Verwendung, die C Programmiersprache und Tools wie Yacc) und andere detailliertere Beschreibungen von Betriebssystemmerkmalen. Die gedruckte Version des Handbuchs passte zunächst in einen einzelnen Ordner, aber abs PWB/UNIX und die 7. Ausgabe von Forschung UnixEs wurde in zwei Bände aufgeteilt, wobei die gedruckten Mannseiten mit Volumen 1 bildeten.[3]

Spätere Versionen der Dokumentation imitierten die Kneipe der ersten Mannseiten. Ritchie fügte dem Abschnitt "Wie man losgeht" hinzugefügt Dritte Edition Einführung und Lorinda Cherry vorausgesetzt die Taschenreferenz "Purple Card" für die Sechste und Siebte Ausgaben.[2] Versionen der Software wurden nach der Überarbeitung des Handbuchs benannt; die siebte Ausgabe der UNIX -ProgrammierhandbuchZum Beispiel kam die 7. Ausgabe oder Version 7 von Unix.[4]

Für die Vierte Ausgabe Die Mannseiten wurden mit dem formatiert TROFF Paket zum Typensatz[2] und sein Satz von -Mann Makros (die zwischen der sechsten und siebten Ausgabe der von der vollständig überarbeitet wurden Handbuch,[3] aber seitdem nicht drastisch verändert). Zu diesem Zeitpunkt wurde die Verfügbarkeit von Online -Dokumentationen über das manuelle Seitensystem als großer Fortschritt angesehen. Bis heute wird praktisch jede Unix -Befehlszeilenanwendung mit einer Mannseite geliefert, und viele UNIX -Benutzer empfinden den Mangel an Mannseiten eines Programms als Zeichen von geringer Qualität. in der Tat einige Projekte, wie z. Debian, Machen Sie sich alle Mühe, um Mannseiten für Programme zu schreiben, denen es fehlt. Die modernen Nachkommen von 4.4bs Verteilen Sie auch Menschen Seiten als eine der Hauptformen der Systemdokumentation (nachdem Sie den alten ersetzt haben -Mann Makros mit dem neueren -Mdoc).

Es gab eine versteckte Osterei In der Man-DB-Version des Man-Befehls, die dazu führen würde, dass der Befehl "gimme gimme gimme" beim Ausführen von 00:30 zurückgibt (ein Verweis auf die Abba Lied Gib mir! Gib mir! Gib mir! (Ein Mann nach Mitternacht). Es wurde 2011 eingeführt[5] aber zuerst eingeschränkt[6] und dann 2017 entfernt[7] Nach schließlich gefunden.[8]

Formatierung

Teil von Freebsd Mann (1) Handbuch Seite, Typet in PDF Format.

Das Standardformat der Mannseiten ist TROFFmit beiden der Makropaket Mann (aussehenorientiert) oder MDOC (semantisch ausgerichtet). Dies ermöglicht es, eine Mannseite in die Seite zu setzen PostScript, PDFund verschiedene andere Formate zum Betrachten oder Drucken.

Etwas Unix Systeme haben ein Paket für die Man2html Befehl, mit dem Benutzer ihre Mannseiten mit einem HTML -Browser durchsuchen können. Systeme mit Groff und Man-DB sollten die hochwertige native HTML-Ausgabe verwenden (Mann - -html) stattdessen. Das GNU EMACS Programm Frau (Aus "ohne Mann") erlaubt es, Mannseiten des Herausgebers zu durchsuchen.[9]

In 2010, OpenBSD veraltet TROFF Für die Formatierung von Menschenseiten zugunsten von Mandoc, ein spezialisierter Compiler/Formatierer für Manpages mit nationaler Unterstützung für die Ausgabe in PostScript, Html, Xhtmlund das Terminal. Es soll nur eine Untergruppe von TROFF unterstützen, die auf manuellen Seiten verwendet werden, insbesondere diejenigen, die MDOC -Makros verwenden.

Online Dienste

Nicht wenige Websites bieten Online-Zugriff auf manuelle Seiten aus verschiedenen unixähnlichen Systemen.

Im Februar 2013 die BSD Die Community sah eine neue Open Source mdoc.su Der Dienst gestartet, der einen einheitlichen und verkürzten Zugang zu den mann.cgi -Skripten der großen modernen BSD -Projekte durch ein einzigartiges Projekt nginx-Basis deterministisch URL -Verkürzung Service für die *BSD -Mannseiten.[10][11][12]

Für Linux wurde ein Man7.org -Dienst eingerichtet, um Handbücher für das System zu erstellen.[13] Ein mankierer Dienst bietet eine breitere Auswahl und integriert auch die TLDR -Seiten.[14]

Befehlsnutzung

Um eine manuelle Seite für einen UNIX -Befehl zu lesen, kann ein Benutzer eingeben:

Mann <command_name>

Seiten werden traditionell auf die Notation "Name (Abschnitt)" verwiesen: zum Beispiel: FTP (1). Der Abschnitt bezieht sich auf unterschiedliche Möglichkeiten, wie auf das Thema verwiesen werden kann - beispielsweise als Systemaufruf, Befehl oder Befehlszeile (Befehlszeile) oder Paket oder die Konfigurationsdatei eines Pakets oder als Codierungskonstrukt / Header.

Der gleiche Seitenname kann in mehr als einem Abschnitt des Handbuchs angezeigt werden, z. B. wenn die Namen von Systemaufrufe, Benutzer Befehle, oder Makropakete übereinstimmen. Beispiele sind Mann (1) und Mann (7), oder Ausgang (2) und Ausgang (3). Die Syntax für den Zugriff auf den Abschnitt Nicht-Default-Handbuch variiert zwischen verschiedenen Menschenimplementierungen.

Auf Solaris und Illumos beispielsweise die Syntax zum Lesen printf (3c) ist:

MAN -S 3C printf

Unter Linux- und BSD -Derivaten wäre der gleiche Aufruf:

Mann 3 printf

die nach sucht printf In Abschnitt 3 der Mannseiten.

Manuelle Abschnitte

Das Handbuch ist in der Regel in acht nummerierte Abschnitte aufgeteilt, die wie folgt organisiert sind (on Forschung Unix, BSD, Mac OS und Linux):[15][16][17][18]

Abschnitt Beschreibung
1 Allgemein Befehle
2 Systemaufrufe
3 Bibliothek Funktionen, die insbesondere die abdecken C Standardbibliothek
4 Sonderdateien (normalerweise Geräte, die in /dev gefunden) und Treiber
5 Dateiformate und Konventionen
6 Spiele und Bildschirmschoner
7 Sonstig
8 Systemadministration Befehle und Daemons

Posix Systemanrufe sind häufig in den Abschnitten 2 und 3 vorhanden, wobei Abschnitt 2 die Dokumentation des Systemaufrufs aus dem lokalen Betriebssystem und Abschnitt 3 die Dokumentation des Systemaufrufs aus dem POSIX -Programmierhandbuch enthält.

Unix System v Verwendet ein ähnliches Nummerierungsschema, außer in einer anderen Reihenfolge:[19]

Abschnitt Beschreibung
1 Allgemein Befehle
1m Systemadministration Befehle und Daemons
2 Systemaufrufe
3 C Bibliothek Funktionen
4 Dateiformate und Konventionen
5 Verschiedenes
6 Spiele und Bildschirmschoner
7 Sonderdateien (normalerweise Geräte, die in /dev gefunden) und Treiber

Auf einigen Systemen sind einige der folgenden Abschnitte verfügbar:

Abschnitt Beschreibung
0 C Bibliothek Header -Dateien (UNIX V6)
9 Kernel Routinen (FreeBSD, SVR4, Linux)[18][16]
l Lapack Bibliotheksfunktionen[20]
n Tcl/Tk Befehle
x Das X Fenstersystem

Einige Abschnitte werden mittels eines Suffix weiter unterteilt; In einigen Systemen ist beispielsweise Abschnitt 3C für C -Bibliotheksaufrufe, 3M für die Mathematikbibliothek usw. Eine Folge davon ist, dass Abschnitt 8 (Systemverwaltungsbefehle) manchmal in den Abschnitt 1M Unterabschnitt des Hauptbefehle abgestimmt wird. Einige Unterabschnittsuffixe haben über Abschnitte hinweg eine allgemeine Bedeutung:

Unterabschnitt Beschreibung
p Posix Spezifikationen
x X Fenstersystem Dokumentation

(Abschnitt 3 ist in der Regel die Ausnahme mit den vielen Suffixen für verschiedene Sprachen.)

Einige Versionen von Mann zwischen den formatierten Versionen der letzten Seiten. Eine Form ist die Katzenseite, einfach zum Pager zur Anzeige geleitet.

Layout

Alle Mannseiten folgen einem gemeinsamen Layout, das für die Präsentation auf einem einfachen optimiert ist ASCII Textanzeige, möglicherweise ohne irgendeine Form von Hervorhebungen oder Schriftsteuerung. Die vorhandenen Abschnitte können enthalten:[21]: Manuelle Struktur

NAME
Der Name des Befehls oder der Funktion, gefolgt von einer Einzeilenbeschreibung dessen, was er tut.
ZUSAMMENFASSUNG
Im Falle eines Befehls eine formale Beschreibung, wie man es ausführt und welche Befehlszeilenoptionen es erfordert. Für Programmfunktionen eine Liste der Parameter, die die Funktion und welche Header -Datei ihre Deklaration enthält.
BEZEICHNUNG
Eine Textbeschreibung der Funktionsweise des Befehls oder der Funktion.
Beispiele
Einige Beispiele für gemeinsame Verwendung.
SIEHE AUCH
Eine Liste verwandter Befehle oder Funktionen.

Andere Abschnitte können vorhanden sein, diese sind jedoch nicht gut standardisiert auf Menschenseiten. Häufige Beispiele sind: Optionen, Status, Rückgabewert, Umgebung, Fehler, Dateien, Autoren, Berichterstattung Fehler, Verlauf und Urheberrecht.

Authoring

Handbuchseiten können entweder im alten geschrieben werden man Makros, der neue doc Makros oder eine Kombination von beidem (mandoc).[22] Das man Makro -Set bietet minimal reicher Text Funktionen mit Anweisungen für die Titellinie, Abschnittsüberschriften, (fett, klein oder kursiv) Schriftarten, Absätze und Hinzufügen/Reduzieren der Eindrücke.[23] Desto neuer mdoc Die Sprache ist von Natur aus semantischer und enthält spezialisierte Makros für die meisten Standardabschnitte wie Programmnamen, Synopsis, Funktionsnamen und den Namen der Autoren. Diese Informationen können verwendet werden, um a zu implementieren Semantische Suche Für Handbücher nach Programmen wie z. Mandoc. Obwohl es auch Anweisungen zur direkten Kontrolle des Stylings umfasst, wird erwartet, dass die spezialisierten Makros die meisten Anwendungsfälle abdecken.[21] Sowohl die Mandoc- als auch die Groff -Projekte berücksichtigen mdoc Das bevorzugte Format für neue Dokumente.[24]

Obwohl Menschenseiten zum TROFF sind, wurde Text mit 10 Punkten angelegt AntiquaDiese Unterscheidung ist normalerweise umstritten, da Menschenseiten im Terminal (TTY) anstelle von auf Papier angelegt werden. Infolgedessen wird das "kleine Schriftart" -Makro selten verwendet.[25] Andererseits wird der Terminal durch das Terminal durch den mutigen und kursiven Text unterstützt ECMA-48und Groffs grotty emittiert sie wie angefordert, wenn es ein unterstützendes Terminal erkennt. Der BSD-Mandoc unterstützt jedoch nur einen mutigen und unterstrichenen (als Ersatz für kursiven) Text über die typewriter-Rückfläche-daner-Overstrike-Sequenz, die in ECMA-48 übersetzt werden muss less.[26][27]

Mannseiten sind normalerweise in englischer Sprache geschrieben, aber Übersetzungen in andere Sprachen sind möglicherweise auf dem System verfügbar. Die gnu man-db und der Mandoc man Es ist bekannt, dass es nach lokalisierten Handbuchseiten unter Subdirektorien sucht.[28][15]: Überblick[16]

Alternativen

Wenige Alternativen zu Mann haben mit der möglichen Ausnahme von viel Popularität genossen GNU -Projekt "die Info"System, ein frühes und einfaches Hypertext System. Es gibt auch einen Drittanbieter, der als bekannt ist TLDR -Seiten (TLDR) Das liefert einfache Beispiele für gemeinsame Anwendungsfälle, ähnlich wie a Cheatsheet.[29]

Außerdem einige Unix GUI Anwendungen (insbesondere diejenigen, die mit dem gebaut wurden Gnom und Kde Entwicklungsumgebungen) bieten jetzt Endbenutzerdokumentation in Html und beinhalten eingebettete HTML -Zuschauer wie z. jaulen zum Lesen der Hilfe in der Anwendung.

Siehe auch

Verweise

  1. ^ "Man (1) - Online -manuelle Dokumentationsseiten anzeigen". BSD Cross Referenz. Freebsd. Abgerufen 2019-04-01. Das Man Utility findet und zeigt Online -Manual -Dokumentationsseiten an.
  2. ^ a b c McIlroy, M. D. (1987). A Research Unix Reader: Annotierte Auszüge aus dem Programmierhandbuch, 1971–1986 (PDF) (Technischer Bericht). Cstr. Bell Labs. 139.
  3. ^ a b Darwin, Ian; Collyer, Geoffrey. "Unix Evolution: 1975-1984 Teil I - Vielfalt". Abgerufen 22. Dezember 2012. Ursprünglich veröffentlicht in Mikrosysteme 5(11), November 1984.
  4. ^ Fiedler, Ryan (Oktober 1983). "Das Unix -Tutorial / Teil 3: UNIX auf dem Mikrocomputer -Marktplatz". BYTE. p. 132. Abgerufen 30. Januar 2015.
  5. ^ "Git Commit 002A6339B1FE8F83F4808022A17E1AA379756D99". Abgerufen 22. November 2017.
  6. ^ "Git Commit 84BDE8D8A9A357BD372793D25746AC6B49480525". Abgerufen 22. November 2017.
  7. ^ "Git Commit B225D9E76FBB0A6A4539C0992FBA88C83F0BD37E". Abgerufen 25. September 2018.
  8. ^ ""Warum druckt Mann" Gimme Gimme Gimme "um 00:30?"". Abgerufen 22. November 2017.
  9. ^ Wright, Francis J. "Frau: Browse Unix Manual Pages" W.O. (ohne) Mann "". GNU. Abgerufen 3. August 2020.
  10. ^ Pali, Gabor, hrsg. (12. Mai 2013). "FreeBSD Quarterly Status Report, Januar-März 2013". Freebsd. Abgerufen 25. Dezember 2014.
  11. ^ Murenin, Konstantine A. (19. Februar 2013). "Ankündigung von Mdoc.su, kurze manuelle Seiten -URLs". [email protected] (Mailingliste). Abgerufen 25. Dezember 2014.
  12. ^ Murenin, Konstantin A. (23. Februar 2013). "Mdoc.su - Kurzhandbuch -Seiten -URLs für FreeBSD, OpenBSD, NetBSD und Dragonfly BSD". Abgerufen 25. Dezember 2014.
  13. ^ "Linux Man Pages online". Man7.org.
  14. ^ "Um". Mankier.
  15. ^ a b Mann (1)- -Linux Allgemeine Befehle Handbuch
  16. ^ a b c Mann (1)- -Freebsd Allgemeine Befehle Handbuch
  17. ^ "Handbuchseiten für die achte Ausgabe von Research Unix". Man.cat-V.org.
  18. ^ a b "UNIX -Programmierhandbuch - Einführung". www.bell-labs.com.3. November 1971.
  19. ^ "System V Release 4 Handbücher". BitSavers.trailing-eded.com.
  20. ^ "Lapack (L) - Linux Man Pages". www.systutorials.com. Abgerufen 2021-05-29.
  21. ^ a b mdoc (7)- -Freebsd Verschiedene Informationen Handbuch
  22. ^ Groff_TMAC (5)- -Linux Dateiformate Handbuch
  23. ^ Mann (7)- -Linux Verschiedenes Handbuch
  24. ^ "Groff Mission Statement - 2014". www.gnu.org. Gleichzeitig mit der Arbeit am Menschen (7) wird MDOC (7) aktiv unterstützt und deren Verwendung gefördert.
  25. ^ "Mann". Das GNU -TROFF -Handbuch. Abgerufen 31. Dezember 2019.
  26. ^ "Kursivschrift und Farbe in manuellen Seiten eines virtuellen Terminals von Nosh User-Space". jdebp.eu.
  27. ^ Mandoc (1)- -Freebsd Allgemeine Befehle Handbuch."Schriftstile werden mit der Verwendung von Coding Back-Sace-Codes angewendet ..."
  28. ^ "Befehlszeile - Linux -Man -Seiten in verschiedenen Sprachen". Fragen Sie Ubuntu.
  29. ^ "TLDR -Seiten". tdrl.sh.

Externe Links