Diskussion:Manpages
- Abschnitte der Handbuchseiten
1 Ausführbare Programme oder Shell-Befehle 2 Systemaufrufe (Kernel-Funktionen) 3 Bibliotheksaufrufe (Funktionen in Programmbibliotheken) 4 Spezielle Dateien (gewöhnlich in /dev) 5 Dateiformate und Konventionen, z. B. /etc/passwd 6 Spiele 7 Verschiedenes (einschließlich Makropaketen und Konventionen), z. B. man(7), groff(7), man-pages(7) 8 Befehle für die Systemverwaltung (in der Regel nur für root) 9 Kernel-Routinen [nicht Standard]
- Eine Handbuchseite besteht aus verschiedenen Abschnitten
Zu den gebräuchlichen Abschnittsnamen gehören BEZEICHNUNG, ÜBERSICHT, KONFIGURATION, BESCHREIBUNG, OPTIONEN, EXIT-STATUS, RÜCKGABEWERT, FEHLER, UMGEBUNGSVARIABLEN, DATEIEN, VERSIONEN, KONFORM ZU, ANMERKUNGEN, FEHLER, BEISPIEL, AUTOREN und SIEHE AUCH
Die folgenden Konventionen gelten für den Abschnitt ÜBERSICHT und können für andere Abschnitte als Leitfaden benutzt werden
Fettdruck genau wie angegeben eingeben Kursivdruck durch passendes Argument ersetzen [-abc] Ein oder mehrere Argumente innerhalb der [ ] sind optional -a|-b Durch | abgegrenzte Optionen können nicht zusammen benutzt werden Argument ..
- Das Argument kann wiederholt werden
[Ausdruck] ..
- Der gesamte Ausdruck innerhalb [ ] kann wiederholt werden
Die Darstellung ist vom Ausgabegerät abhängig
- So kann man im Allgemeinen Kursivschrift auf Terminals nicht darstellen und stattdessen den Text unterstreichen oder einfärben
Die Befehls- oder Funktionsdarstellung ist ein Muster, das zu allen möglichen Aufrufen passen sollte
- In manchen Fällen ist es ratsam, wie im Abschnitt ÜBERSICHT dieser Handbuchseite praktiziert, die verschiedenen, sich ausschließenden Aufrufe anzugeben