michl
/
BSA_AIS
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Hilfe Markdown eingefügt

Michael Schaar 2023-09-20 20:56:17 +02:00
parent d17eec5866
commit ddf282ab22
2 changed files with 828 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

826
Hilfe.md Normal file

@ -0,0 +1,826 @@
# Hilfe
```bash
help exit
```
exit: exit [n]
Beendet die aktuelle Shell.
Beendet die die aktuelle Shell mit dem Rückgabewert »N«. Wenn »N« nicht
angegeben ist, wird der Rückgabewert des letzten ausgeführten Kommandos
übernommen.
```bash
man man
```
MAN(1) Dienstprogramme für Handbuchseiten MAN(1)
BEZEICHNUNG
man - eine Oberfläche für die System-Referenzhandbücher
ÜBERSICHT
man [man Optionen] [[Abschnitt] Seite ...] ...
man -k [apropos Optionen] Regulärer_Ausdruck ...
man -K [man Optionen] [Abschnitt] Begriff ...
man -f [whatis Optionen] Seite ...
man -l [man Optionen] Datei ...
man -w|-W [man Optionen] Seite ...
BESCHREIBUNG
man ist das System-Anzeigeprogramm für die Handbuchseiten. Jedes an man
übergebene Argument Seite ist normalerweise der Name eines Programms
oder einer Funktion. Gefunden und angezeigt wird die Handbuchseite, die
auf jedes der Argumente passt. Wenn ein Abschnitt angegeben wird, sucht
man nur in diesem Abschnitt der Handbuchseiten. Ohne eine explizite An‐
gabe werden alle verfügbaren Abschnitte in einer festgelegten Reihen‐
folge durchsucht (siehe VOREINSTELLUNGEN) und nur die jeweils zuerst
gefundene Seite angezeigt, wenn die Seite in mehreren Abschnitten vor‐
kommt.
Die folgende Tabelle zeigt die Nummern der Abschnitte der Handbuchsei‐
ten und den Typ der dort zu findenden Seiten.
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)
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, FEH‐
LER, UMGEBUNGSVARIABLEN, DATEIEN, VERSIONEN, KONFORM ZU, ANMERKUNGEN,
FEHLER, BEISPIEL, AUTOREN und SIEHE AUCH.
Die folgenden Konventionen gelten für den Abschnitt ÜBERSICHT und kön‐
nen 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 op‐
tional.
-a|-b Durch | abgegrenzte Optionen können nicht zusammen be‐
nutzt 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 Allgemei‐
nen 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 verschie‐
denen, sich ausschließenden Aufrufe anzugeben.
BEISPIELE
man ls
Zeigt die Handbuchseite für den Begriff (das Programm) ls an.
man man.7
Zeigt die Handbuchseite für das Makropaket man aus Abschnitt 7 an.
Dies ist eine alternative Schreibweise für »man 7 man«.
man 'man(7)'
Zeigt die Handbuchseite für das Makropaket man aus Abschnitt 7 an.
Dies ist eine weitere alternative Schreibweise für "man 7 man".
Dies könnte beim Kopieren und Einfügen von Querverweisen in Hand‐
buchseiten bequemer sein. Beachten Sie, dass die Klammern normaler‐
weise in Anführungszeichen gesetzt werden müssen, um zu verhindern,
dass sie von der Shell interpretiert werden.
man -a intro
Zeigt nacheinander alle vorhandenen »intro«-Handbuchseiten an. Sie
können zwischen den aufeinander folgendenden Ausgaben der Seiten
abbrechen oder beliebige Seiten überspringen.
man -t bash | lpr -Pps
Formatiert die von Handbuchseite für bashin das Standardformat von
Troff oder Groff und schickt sie zum Drucker ps. Für Groff ist das
Standardausgabeformat gewöhnlich PostScript. Mit man --help können
Sie herausfinden, welcher Prozessor mit der Option -t verbunden
ist.
man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi
Dieser Befehl dekomprimiert und formatiert den Nroff-Quelltext der
Handbuchseite ./foo.1x.gz in eine geräteunabhängige (device-inde‐
pendent) dvi-Datei. Die Umleitung der Ausgabe ist notwendig, da die
Option -T ohne Anzeigeprogramm die Ausgabe zur Standardausgabe
schickt. Die Ausgabe kann mit einem Programm wie xdvi betrachtet
oder mit einem Programm wie dvips zu PostScript weiterverarbeitet
werden.
man -k printf
Sucht in den Kurzbeschreibungen und Namen der Handbuchseiten nach
dem als regulären Ausdruck angesehenen Schlüsselwort printf und
gibt alle Fundstellen aus. Diese Option entspricht apropos printf.
man -f smail
Sucht die durch smail angegebenen Handbuchseiten und gibt alle
Kurzbeschreibungen der gefundenen Seiten aus. Diese Option ent‐
spricht apropos printf.
ÜBERSICHT
Um dem Benutzer eine größtmögliche Flexibilität zu bieten, sind in man
viele Optionen verfügbar. Veränderungen können am Suchpfad, in der Rei‐
henfolge der Abschnitte, am Ausgabeprozessor sowie weiteren Verhaltens‐
weisen und Operationen vorgenommen werden. Dies wird weiter unten be‐
schrieben.
Wenn sie gesetzt sind, werden verschiedene Umgebungsvariablen für die
Festlegung der Arbeitsweise von man ausgewertet. Sie können die All‐
zweckvariable $MANOPT auf einen beliebigen Ausdruck im Befehlszeilen‐
format setzen. Bei der Zuweisung des Wertes an $MANOPT müssen Sie Leer‐
zeichen als Teil von Argumenten einer Option mit einem Backslash
(linksseitigem Schrägstrich) maskieren (schützen). man wertet diese Va‐
riable vor der eigenen Befehlszeile aus. Die Optionen, die ein Argument
benötigen, werden durch die gleichen Optionen in der Befehlszeile über‐
schrieben. Um alle in $MANOPT gesetzten Optionen zurückzusetzen, kann
als erste Befehlszeilen-Option -D angegeben werden. Dies ermöglicht
man, alle in $MANOPT gesetzten Optionen zu »vergessen«, obwohl diese
weiterhin gültig gewesen sein mussten.
Handbuchseiten werden normalerweise im Format nroff(1) in einem Ver‐
zeichnis wie /usr/share/man gespeichert. In einigen Installationen kann
es auch vorformatierte cat-Seiten geben, um die Performance zu verbes‐
sern. Siehe manpath(5) für Details dazu, wo diese Dateien gespeichert
sind.
Dieses Paket unterstützt Internationalisierung. Wenn auf Ihrem System
Handbuchseiten in Ihrer Muttersprache verfügbar sind, können Sie mit‐
tels Locale-Funktionen auf diese Seiten zugreifen. Falls Ihr System
nicht bereits automatisch vornimmt, muss um diese Unterstützung zu ak‐
tivieren, entweder in $LC_MESSAGES, $LANG oder anderen systemabhängigen
Umgebungsvariablen die gewünschte Sprache festgelegt werden. Die Spra‐
che wird normalerweise im POSIX- Format angegeben:
<Sprache>[_<Region>[.<Zeichensatz>[,<Version>]]]
Wenn die angeforderte Seite in Ihrer Locale verfügbar ist, wird sie an‐
stelle der (normalerweise in amerikanischem Englisch verfassten) Stan‐
dardseite angezeigt.
Wenn Sie diese Handbuchseiten und die Ausgaben der Hilfsprogramme gerne
in Ihrer Landessprache hätten, aber diese nicht vorfinden und Sie diese
beisteuern möchten, nehmen Sie bitte mit dem Betreuer dieser Software
Kontakt auf, der dann die Übersetzung koordiniert.
Individuelle Handbuchseiten werden normalerweise von den Betreuern des
Programms, der Funktion oder sonstigen Themas gepflegt und daher in
diesem Paket nicht enthalten. Wenn Sie der Meinung sind, dass eine
Handbuchseite fehlt oder unzureichend ist, melden Sie dies an die Be‐
treuer des fraglichen Pakets.
Informationen über weitere Funktionen und Erweiterungen, die für dieses
Handbuch-Anzeigeprogramm verfügbar sind, geben Ihnen die mit dem Paket
verteilten Dokumente.
VOREINSTELLUNGEN
Die Reihenfolge der zu durchsuchenden Abschnitte kann durch die Umge‐
bungsvariable $MANSECT oder durch die SECTION-Anweisung in /etc/man‐
path.config außer Kraft gesetzt werden. Folgende Reihenfolge ist vor‐
eingestelllt:
1 n l 8 3 2 3posix 3pm 3perl 3am 5 4 9 6 7
Die formatierte Handbuchseite wird mit Hilfe eines Anzeigeprogramms
dargestellt. Dieses kann auf verschiedene Arten angegeben werden oder
anderenfalls auf eine Voreinstellung ausgewichen werden (siehe die Op‐
tion -P für Details).
Die Filter werden in mehreren Schritten zusammengestellt: Zuerst wird
die Befehlszeilenoption -p oder die Umgebungsvariable $MANROFFSEQ un‐
tersucht. Wenn -p nicht benutzt wird und die Umgebungsvariable nicht
gesetzt ist, wird die Anfangszeile der Nroff-Datei nach einer Zeichen‐
kette für den Präprozessor untersucht. Um eine gültige Präprozes‐
sor-Zeichenkette zu enthalten, muss die erste Zeile
'\" <Zeichenkette>
ähneln, wobei Zeichenkette jede weiter unten unter -p beschriebene
Buchstabenkombination sein kann.
Wenn keine der obigen Methoden eine Filterinformation ergibt, wird ein
Satz von Standardwerten verwendet.
Aus den Filtern und dem Hauptformatierprogramm (Nroff oder [tg]roff mit
-t) wird eine Formatier-Pipeline gebildet und ausgeführt. Wenn alterna‐
tiv ein ausführbares Programm mandb_nfmt (oder mandb_tfmt mit -t) in
der Wurzel der Handbuchhierarchie existiert, wird dieses an Stelle der
Pipeline ausgeführt. Ihm wird die Handbuchquelldatei, die Zeichenkette
für den Präprozessor und wahlweise das durch die Argumente -T oder -E
festgelegte »Gerät« (tatsächlich ein Dateiformat oder ein Zeichensatz)
übergeben.
OPTIONEN
Optionen ohne Argumente, die entweder in der Befehlszeile, in $MANOPT
oder in beiden doppelt vorkommen, sind nicht schädlich. Für Optionen,
die ein Argument benötigen, überschreibt jedes Duplikat den vorherge‐
henden Wert.
Allgemeine Optionen
-C Datei, --config-file=Datei
Verwendung dieser benutzerspezifischen Konfigurationsdatei an
Stelle der Vorgabe ~/.manpath
-d, --debug
Ausgabe von Debug-Informationen
-D, --default
Diese Option wird normalerweise nur als die allererste angegeben
und setzt das Verhalten von man auf die Vorgabewerte zurück. Der
Zweck dieser Option ist es, vielleicht schon in der Umgebungsva‐
riablen $MANOPT gesetzte Optionen wieder aufzuheben. Alle Optio‐
nen, die -D folgen, haben wieder ihren normalen Effekt.
--warnings[=Warnmeldungen]
Aktiviert Groff-Warnmeldungen. Damit kann der Zustand der Hand‐
buch-Quelltexte geprüft werden. Warnmeldungen ist eine kommage‐
trennte Liste von Warnungen. Wird kein Wert vorgegeben, wird die
Voreinstellung »mac« angewendet (siehe den Punkt »warnings« in
info Groff für eine Liste verfügbarer Warnungen).
Haupt-Betriebsarten
-f, --whatis
Diese Option ist äquivalent zu whatis. Wenn die Handbuchseite
verfügbar ist, wird eine Kurzbeschreibung der gewünschten Hand‐
buchseite angezeigt. Zu Details siehe whatis(1).
-k, --apropos
Diese Option ist äquivalent zu apropos. Es werden die Kurzbe‐
schreibungen der Handbuchseiten nach Schlüsselwörtern durchsucht
und alle Treffer angezeigt. Zu Details siehe apropos(1).
-K, --global-apropos
Sucht den Text in allen Handbuchseiten. Dieses Vorgehen mit ro‐
her Gewalt (brute-force) wird wahrscheinlich einige Zeit dauern.
Daher sollten Sie, wenn möglich, einen Abschnitt angeben, um die
Anzahl der zu durchsuchenden Seiten zu reduzieren. Suchbegriffe
können einfache Zeichenketten (Voreinstellung) oder bei Verwen‐
dung der Option --regex reguläre Ausdrücke sein.
Beachten Sie, dass dies die Quellen der Handbuchseiten, nicht
den dargestellten Text, durchsucht und daher aufgrund von Kom‐
mentaren und ähnlichem in den Quelltexten falsche Treffer ent‐
halten kann. Durchsuchen des dargestellten Textes wäre viel
langsamer.
-l, --local-file
Aktiviert den »lokalen« Modus. Formatiert und zeigt lokale Hand‐
buchdateien an, anstatt die System-Handbuchsammlung zu durchsu‐
chen. Jedes Handbuchseiten-Argument wird als gültig formatierte
Nroff-Quelle interpretiert. Es werden keine Cat-Dateien er‐
stellt. Wenn eines der Argumente »-« ist, wird die Eingabe von
der Standardeingabe übernommen. Wenn diese Option nicht verwen‐
det wird und man die gewünschte Seite nicht findet, nimmt man
diese Option als angegeben an, betrachtet den Namen als Dateina‐
men und sucht nach einer exakten Übereinstimmung, bevor es eine
Fehlermeldung anzeigt.
-w, --where, --path, --location
Zeigt nicht die Handbuchseiten an, sondern gibt den Ort der
Nroff-Quelldatei aus, die formatiert werden würde. Wenn die Op‐
tion -a ebenfalls angegeben wird, dann werden die Orte aller
Quelldateien angegeben, die den Suchkriterien entsprechen.
-W, --where-cat, --location-cat
Zeigt nicht die Handbuchseiten an, sondern den Speicherort der
Cat-Dateien, die angezeigt würden. Wenn die Option -a ebenfalls
angegeben wird, dann werden die Orte aller vorformatierten
Cat-Dateien ausgegeben, die den Suchkriterien entsprechen.
Wenn sowohl -w als auch -W angegeben werden, dann werden sowohl
die Quelldatei als auch die Cat-Datei angegeben, durch Leerraum
getrennt. Falls -w, -W und -a zusammen angegeben werden, dann
wird dies für jeden möglichen Treffer ausgeführt.
-c, --catman
Diese Option ist nicht für den allgemeinen Gebrauch bestimmt und
sollte nur von dem Programm catman verwendet werden.
-R Kodierung, --recode=Kodierung
Anstatt die Seite wie üblich zu formatieren, wird der Quelltext
in die angegebene Kodierung umgewandelt und ausgegeben. Wenn Sie
die Kodierung der Quelldatei bereits kennen, können Sie auch di‐
rekt manconv(1) aufrufen. Diese Option ermöglicht Ihnen aber die
Umkodierung mehrerer Handbuchseiten ohne die ausdrückliche An‐
gabe der Kodierung jeder einzelnen Datei, wenn die Seiten schon
in einer zu den Handbuchhierarchien analogen Struktur instal‐
liert sind.
Ziehen Sie in Erwägung, man-recode(1) zu verwenden, anstatt meh‐
rere Handbuchseiten umzuwandeln, da dessen Benutzerschnittstelle
für Mehrfachumwandlungen entworfen wurde und daher viel schnel‐
ler sein kann.
Handbuchseiten finden
-L Locale, --locale=Locale
man wird in der Regel Ihre aktuelle Locale durch einen Aufruf
der C-Funktion setlocale(3) bestimmen, welche verschiedene Umge‐
bungsvariablen auswertet (darunter sind eventuell auch
$LC_MESSAGES und $LANG). Um den ermittelten Wert vorübergehend
außer Kraft zu setzen, können Sie man mit dieser Option eine Lo‐
cale vorgeben. Beachten Sie, dass dieser Wert erst wirksam wird,
wenn die Suche tatsächlich beginnt. Programm-Meldungen wie
Hilfe-Nachrichten werden immer in der zu Anfang ermittelten Lo‐
cale angezeigt werden.
-m system[,...], --systems=System[,...]
Wenn Ihr System auch auf die Handbuchseiten eines anderen Be‐
triebssystems zugreifen kann, können diese mit dieser Option
durchsucht werden. Um nach einer Handbuchseite aus der Handbuch‐
seiten-Sammlung von NewOS zu suchen, verwenden Sie die Option -m
NewOS.
Das angegebene System kann eine durch Kommata abgetrennte Auf‐
zählung von Betriebssystemnamen sein. Um auch die Handbuchseiten
des eigenen Betriebssystems zu durchsuchen, fügen sie den Sy‐
stemnamen man in die Argument-Zeichenkette ein. Diese Option
überschreibt die Umgebungsvariable $SYSTEM.
-M Pfad, --manpath=Pfad
Gibt die Verwendung eines alternativen Pfades vor. Standardmäßig
verwendet man von manpath abgeleiteten Code, um den Suchpfad zu
ermitteln. Diese Option überschreibt die Umgebungsvariable $MAN‐
PATH und sorgt dafür, das -m ignoriert wird.
Ein als Handbuch-Pfad festgelegter Pfad muss die Wurzel einer in
Abschnitte gegliederten Handbuchhierarchie sein. Das ist im
Handbuch von man-db (unter »The manual page system«) beschrieben
(für die Anzeige von Handbuchseiten außerhalb solcher Hierar‐
chien siehe die Option -l).
-S Liste, -s Liste, --sections=Liste
Mit der Liste, in der Sie Doppelpunkte oder Kommas als Trennzei‐
chen verwenden können, können sie eine bestimmte Suchreihenfolge
vorgeben. Diese Option setzt die Umgebungsvariable $MANSECT au‐
ßer Kraft. (Die Schreibweise -s ist kompatibel mit System V.)
-e Unter-Erweiterung, --extension=Unter-Erweiterung
Einige Systeme integrieren umfangreiche Handbuchseiten-Pakete,
wie z. B. Zubehör für das Tcl-Paket, in die normalen Abschnitte.
Für die Lösung des Problems zweier unterschiedlicher Handbuch‐
seiten mit gleichem Namen, wie exit(3), wurden früher alle
Tcl-Seiten dem Abschnitt l zugeordnet und mit einer speziellen
Endung versehen, in diesem Fall exit(3tcl). Dies erwies sich als
unglückliche Lösung. Diese Version von man ermöglicht es, die
Seiten in die richtigen Abschnitte einzuordnen und ihre.
exit(3tcl), anzufügen. Im Normalbetrieb zeigt man bevorzugt
exit(3) gegenüber exit(3tcl) an. Um diese Situation zu bewälti‐
gen, können Sie man die Zeichenkette Unter-Erweiterung überge‐
ben. Diese gibt an, in welchem Paket die Handbuchseite zu finden
ist. Im obigen Beispiel wird die Option -e tcl die Suche von man
auf Seiten mit der Erweiterung *tcl beschränken.
-i, --ignore-case
bei der Suche nach Handbuchseiten Groß- und Kleinschreibung
ignorieren (Voreinstellung)
-I, --match-case
Handbuchseiten-Suche unter Beachtung von Groß- und Kleinschrei‐
bung
--regex
Zeigt alle Seiten an, bei denen ein Teil der Namen oder der Be‐
schreibungen auf den als Argument übergebenen regulären Ausdruck
Seite passen, wie bei apropos(1). Gewöhnlich gibt es keinen be‐
gründeten Weg, um bei der Suche nach einem regulären Ausdruck
eine »beste« Seite zu bestimmen. Darum impliziert diese Option
-a.
--wildcard
Zeigt alle Seiten an, bei denen ein Teil der Namen oder der Be‐
schreibungen auf den als Argument übergebenen Shell-Platzhalter
(Wildcard) Seite passen, wie bei apropos(1) --wildcard. Das Ar‐
gument Seite muss mit dem gesamten Namen oder einem Abschnitt
der Beschreibung innerhalb von Wortgrenzen übereinstimmen. Ge‐
wöhnlich gibt es keinen begründeten Weg, um bei der Suche nach
einem Platzhalter eine »beste« Seite zu bestimmen. Darum impli‐
ziert diese Option -a.
--names-only
Wenn die Optionen --regex oder --wildcard zum Einsatz kommen,
wird wie bei whatis(1) nur in den Paketnamen und nicht in den
Beschreibungen gesucht, Ansonsten hat diese Option keine Auswir‐
kung.
-a, --all
Wird eine Handbuchseite in einem Abschnitt gefunden, so termi‐
niert man nach Anzeige dieser Seite. Wird diese Option angege‐
ben, werden alle passenden Handbuchseiten nacheinander ange‐
zeigt.
-u, --update
Diese Option veranlasst man, seine Zwischenspeicher-Datenbank
der installierten Handbuchseiten zu aktualisieren. Dies ist nur
in seltenen Fällen notwendig. Es ist normalerweise besser,
stattdessen den Befehl mandb(8) auszuführen.
--no-subpages
Standardmäßig versucht man, auf seiner Befehlszeile übergebene
Namenspaare als gleichwertig mit einem Namen, der einen Binde‐
strich oder einen Unterstrich enthält, zu interpretieren. Dies
unterstützt das verbreitete Muster von Programmen, die eine
Reihe von Unterbefehlen implementieren, sodass für den Aufruf
der entsprechenden Handbuchseiten eine ähnliche Syntax wie für
den Aufruf der Befehle genutzt werden kann. Zum Beispiel:
$ man -aw git diff
/usr/share/man/man1/git-diff.1.gz
Dieses Verhalten deaktivieren Sie mit der Option --no-subpages.
$ man -aw --no-subpages git diff
/usr/share/man/man1/git.1.gz
/usr/share/man/man3/Git.3pm.gz
/usr/share/man/man1/diff.1.gz
Steuerung der Ausgabeformatierung
-P Anzeigeprogramm, --pager=Anzeigeprogramm
Gibt an, welches Anzeigeprogramm verwendet werden soll. Stan‐
dardmäßig verwendet man pager, wobei auf cat ausgewichen wird,
falls pager nicht gefunden wurde oder nicht ausführbar ist.
Diese Option überschreibt die Umgebungsvariable $MANPAGER, wel‐
che wiederum die Umgebungsvariable $PAGER überschreibt. Die Op‐
tion wird nicht zusammen mit -f oder -k verwendet.
Der Wert kann ein einfacher Befehlsname oder ein Befehl mit Ar‐
gumenten sein. Er darf Shell-Maskierung (also linksseitige
Schrägstriche sowie einfache und doppelte Anführungszeichen)
enthalten. Er darf keine Pipelines verwenden, um mehrere Befehle
zu verbinden. Wenn Sie das benötigen, verwenden Sie ein Skript,
das die gewünschte Seite entweder als Argument erhält oder von
der Standardeingabe liest.
-r Eingabeaufforderung, --prompt=Eingabeaufforderung
Wenn eine aktuelle Version von less(1) als Anzeigeprogramm ver‐
wendet wird, versucht man, dort einige sinnvolle Optionen zu
setzen. Die Standard-Eingabeaufforderung ähnelt
Handbuchseite Name(Abschnitt) Zeile x
wobei Name die Handbuchseite bezeichnet, x die aktuelle Zeilen‐
numer und Abschnitt den Fundort bezeichnet. Diese Anzeige wird
durch Verwendung der Umgebungsvariable $LESS erreicht.
Die Option -r in Verbindung mit einer Zeichenkette setzt diese
Vorgabe außer Kraft. Wenn diese Zeichenkette $MAN_PN enthält,
wird dieser Text durch den Namen der Handbuchseite gefolgt von
der Abschnittsnummer, umgeben von »(« und »)«, ersetzt. Die Zei‐
chenkette für die Erzeugung der Voreinstellung könnte als
\ Manual\ page\ \$MAN_PN\ ?ltline\ %lt?L/%L.:
byte\ %bB?s/%s..?\ (END):?pB\ %pB\\%..
h gibt einen Hilfstext aus, q beendet das Programm
ausgedrückt werden.) Die dreizeilige Darstellung wurde nur der
besseren Lesbarkeit wegen gewählt. Was das bedeutet, steht in
der Handbuchseite von less(1). Da die Zeichenkette zuerst von
der Shell ausgewertet wird, müssen alle einfachen und doppelten
Anführungszeichen sowie der linksseitige Schrägstrich (Back‐
slash) durch einen vorangestellten Backslash geschützt werden.
Weitere Optionen für less(1) können nach einem geschützten $ am
Ende der Zeichenkette hinzugefügt werden. Die Standardwerte sind
hier -ix8.
Wie nachfolgend beschrieben, kann die Umgebungsvariable $MANLESS
zum Festlegen einer Vorgabe-Zeichenkette für die Eingabeauffor‐
derung verwendet werden, sofern in der Befehlszeile keine ange‐
geben wird.
-7, --ascii
Bei der Anzeige einer in reinem ascii(7) kodierten Handbuchseite
auf einem 7-Bit-Terminal oder -Terminal-Emulator können einige
Zeichen nicht korrekt angezeigt werden, wenn die latin1(7)-Gerä‐
tebeschreibung mit GNU Nroff benutzt wird. Diese Option ermög‐
licht die Anzeige von in reinem ascii kodierten Handbuchseiten
als ascii-Zeichen auf dem latin1-»Gerät«. Latin1-kodierter Text
wird nicht übersetzt. Die folgende Tabelle zeigt die Übersetzun‐
gen, die durchgeführt werden: Ein Teil davon kann nur dann rich‐
tig angezeigt werden, wenn das latin1-»Gerät« von GNU Nroff ver‐
wendet wird.
Beschreibung oktal latin1 ascii
──────────────────────────────────────────
Bindestrich 255 ‐ -
Aufzählungszei‐ 267 • o
chen (middle
dot)
Accent aigu 264 ´ '
Multiplikations‐ 327 × x
zeichen
Wenn die latin1-Spalte richtig angezeigt wird, kann das Terminal
für die Anzeige von latin1-Zeichen eingerichtet sein und diese
Option ist nicht notwendig. Wenn die Spalten latin1 und ascii
identisch sind, lesen Sie diese Seite schon mit dieser Option
oder man hat diese Seite nicht mit der latin1-Gerätebeschreibung
formatiert. Wenn die latin1-Spalte fehlt oder beschädigt ist,
müssen Sie möglicherweise die Handbuchseiten mit dieser Option
ansehen.
Diese Option wird ignoriert, wenn Sie die Optionen -t, -H, -T
oder -Z verwenden und kann nutzlos sein, wenn Sie eine andere
als die GNU-Version von Nroff verwenden.
-E Kodierung, --encoding=Kodierung
Erzeugt eine Ausgabe für eine vom Standard verschiedene Zeichen‐
kodierung. Aus Gründen der Abwärtskompatibilität kann Kodierung
ein Nroff-Gerät wie ascii, latin1 oder utf8 sowie eine richtige
Zeichenkodierung wie UTF-8 sein.
--no-hyphenation, --nh
Normalerweise wird Nroff automatisch Text an Zeilenumbrüchen
trennen, um damit den Text ohne übermäßige Abstände darzustel‐
len. Dazu trennt es auch Wörter, die keinen Bindestrich enthal‐
ten. Diese Option deaktiviert die automatische Silbentrennung.
Sie trennt nur Wörter, die bereits Bindestriche enthalten.
Wenn Sie eine Handbuchseite schreiben und einfach nur Nroff von
der falschen Trennung eines Wortes abhalten wollen, verwenden
Sie nicht diese Option. Lesen Sie stattdessen die Nroff-Dokumen‐
tation. Beispielsweise können Sie können durch das Einfügen von
»\%« in einem Wort diese Stelle als Trennstelle markieren oder
mit »\%« am Wortanfang das Wort als nicht trennbar kennzeichnen.
--no-justification, --nj
Normalerweise setzt Nroff den Text automatisch im Blocksatz.
Diese Option deaktiviert die Ausrichtung des Textes an der rech‐
ten Seite und bewirkt damit an der rechten Seite unterschiedli‐
che Leerräume (»ragged right«).
Wenn Sie eine Handbuchseite schreiben und Sie wollen einfach nur
Nroff vom Blocksatz bestimmter Absätze abhalten, verwenden Sie
nicht diese Option. Lesen Sie stattdessen die Nroff-Dokumenta‐
tion. Beispielsweise können Sie die Direktiven .».na.«, ».nf«,
».fi« und ».ad« verwenden, um zeitweise Ausrichten und Füllen zu
deaktivieren.
-p Zeichenkette, --preprocessor=Zeichenkette
Diese Option gibt die Reihenfolge an, in der die Präprozessoren
vor Nroff oder Troff/Groff aufgerufen werden. Nicht alle Instal‐
lationen verfügen über alle Präprozessoren. Einige der Präpro‐
zessoren und die Zeichen, die sie repräsentieren, sind: eqn (e),
grap (g), pic (p), tbl (t), vgrind (v), refer (r). Diese Option
überschreibt die Umgebungsvariable $MANROFFSEQ. Der Präprozessor
zsoelim wird immer als erster gestartet.
-t, --troff
Mit dieser Option wird groff -mandoc verwendet, um die Handbuch‐
seite zu formatieren und an die Standardausgabe zu liefern. In
Verbindung mit -H, -T oder -Z ist diese Option nicht erforder‐
lich.
-T[Gerät], --troff-device[=Gerät]
Diese Option wird dazu verwendet, um das Ausgabeformat von Groff
(oder möglicherweise Troff) für andere als das Standardausgabe‐
gerät anzupassen. Diese Option impliziert -t. Zu den verfügbaren
Ausgabeformaten (von Groff-1.17) gehören dvi, latin1, ps, utf8,
X75 und X100.X75 und X100.
-H[Browser], --html[=Browser]
Diese Option veranlasst Groff, eine HTML-Ausgabe zu erzeugen und
diese in einem Webbrowser anzuzeigen. Der Browser wird durch das
optionale Argument Browser ausgewählt. Fehlt es, wird er durch
die Umgebungsvariable $BROWSER oder Vorgaben beim Bau des Pro‐
gramms (in der Regel lynx) bestimmt. Diese Option impliziert -t
und wird nur mit GNU Troff arbeiten.
-X[dpi], --gxditview[=dpi]
Diese Option zeigt die Ausgabe von Groff mit dem Programm gxdit‐
view in einem Grafik-Fenster an. Mögliche Werte für dpi (dots
per inch) sind 75, 75-12, 100 oder 100-12 sein; Standard ist 75.
Die 12-Varianten verwenden eine 12-Punkt-Basisschrift. Diese Op‐
tion impliziert mit den »Geräten« X75, X75-12, X100 oder X100-12
jeweils -T.
-Z, --ditroff
Groff ruft Troff und anschließend den passenden Postprozessor
auf, um eine für das gewählte »Gerät« verwendbare Ausgabe zu er‐
zeugen. Wenn groff -mandoc Groff ist, wird diese Option an Groff
weitergereicht und verhindert den Gebrauch eines Postprozessors.
Diese Option impliziert -t.
Hilfe bekommen
-?, --help
Hilfetext anzeigen und beenden
--usage
zeigt eine kurze Anwendungszusammenfassung an und beendet das
Programm.
-V, --version
Versionsinformation anzeigen und beenden
EXIT-STATUS
0 erfolgreiche Programmausführung
1 Fehler beim Aufruf, in der Syntax oder in der Konfigurationsda‐
tei
2 betriebsbedingter Fehler
3 Ein Kind-Prozess gab einen von Null verschiedenen EXIT-Status
zurück.
16 Mindestens eine Seite/Datei oder ein Schlüsselwort gibt es nicht
oder es wurden keine Treffer dafür gefunden.
UMGEBUNGSVARIABLEN
MANPATH
Wenn $MANPATH gesetzt ist, wird ihr Wert als Suchpfad für die
Handbuchseiten benutzt.
MANROFFOPT
Jedes Mal, wenn man das Formatierungsprogramm aufruft (nroff,
troff oder groff), wird der Inhalt von $MANROFFOPT zur Befehls‐
zeile des Formatierungsprogramms hinzugefügt.
MANROFFSEQ
Wenn $MANROFFSEQ gesetzt ist, wird ihr Wert benutzt, um die Ab‐
folge der Präprozessoren zu bestimmen, die jede Handbuchseite
vor Nroff oder Troff durchläuft. Als Standard durchlaufen die
Seiten den Präprozessor tbl (t).
MANSECT
Wenn $MANSECT gesetzt ist, wird ihr Wert als eine durch Doppel‐
punkte gegliederte Liste von Abschnitten interpretiert und dazu
benutzt, die zu durchsuchenden Abschnitte und deren Reihenfolge
zu bestimmen. Die Vorgabe ist »1 n l 8 3 2 3posix 3pm 3perl 3am
5 4 9 6 7«, es sei denn, dies wird durch die SECTION-Anweisung
in /etc/manpath.config außer Kraft gesetzt.
MANPAGER, PAGER
Wenn $MANPAGER oder $PAGER gesetzt ist ($MANPAGER wird bevorzugt
verwendet), legt dieser Wert das Anzeigeprogramm für die Hand‐
buchseite fest. Standardmäßig wird pager verwendet, wobei auf
cat ausgewichen wird, falls pager nicht gefunden wurde oder
nicht ausführbar ist.
Der Wert kann ein einfacher Befehlsname oder ein Befehl mit Ar‐
gumenten sein. Er darf Shell-Maskierung (also linksseitige
Schrägstriche sowie einfache und doppelte Anführungszeichen)
enthalten. Er darf keine Pipelines verwenden, um mehrere Befehle
zu verbinden. Wenn Sie das benötigen, verwenden Sie ein Skript,
das die gewünschte Seite entweder als Argument erhält oder von
der Standardeingabe liest.
MANLESS
Wenn $MANLESS gesetzt ist, wird deren Wert als Zeichenkette für
die Festlegung einer Eingabeaufforderung für das Anzeigeprogramm
less verwendet, so als ob dieser Wert mit der Option -r überge‐
ben worden wäre (daher werden sonstige Vorkommen des Textes
$MAN_PN in der gleichen Weise expandiert). Wenn Sie beispiels‐
weise die Eingabeaufforderung unbedingt auf »Meine Eingabeauf‐
forderung« setzen wollen, setzen Sie $MANLESS auf ‘-PMeine Ein‐
gabeaufforderung’. Durch die Option -r wird diese Umgebungsva‐
riable außer Kraft gesetzt.
BROWSER
Wenn $BROWSER gesetzt ist, ist Wert eine durch Doppelpunkte ge‐
trennte Liste von Befehlen. Mit allen diesen Befehlen wird ver‐
sucht, einen Web-Browser für man --html zu starten. In jedem Be‐
fehl wird %s durch einen Dateinamen für die HTML-Ausgabe von
Groff, %% durch ein einzelnes Prozentzeichen und %c durch einen
Doppelpunkt (:) ersetzt.
SYSTEM Wenn $SYSTEM gesetzt ist, hat das die gleiche Wirkung wie die
Verwendung als Argument für die Option -m.
MANOPT Wenn $MANOPT gesetzt ist, wird der Wert dieser Variablen vor der
man-Befehlszeile ausgewertet. Es wird vorausgesetzt, das der
Wert im gleichen Format wie die Befehlszeile vorliegt. Da alle
anderen für man spezifischen Umgebungsvariablen auch als Be‐
fehlszeilenoptionen ausgedrückt und in $MANOPT aufgenommen wer‐
den können, ist zu erwarten, dass Sie obsolet werden. Übrigens
müssen alle Leerzeichen, die als Teil eines Arguments interpre‐
tiert werden sollen, geschützt werden.
MANWIDTH
Wenn $MANWIDTH gesetzt ist, wird ihr Wert als die Zeilenlänge
für die Formatierung der Handbuchseiten verwendet. Wenn sie
nicht gesetzt ist, werden die Handbuchseiten mit einer für das
aktuelle Terminal angemessenen Zeilenlänge angezeigt, die (bei
Verfügbarkeit) mit einem Aufruf von ioctl(2) oder dem Wert von
$COLUMNS bestimmt wurde. Scheitert alles Andere, werden 80 Zei‐
chen pro Zeile ausgegeben. Cat-Seiten werden nur dann gespei‐
chert, wenn die Standard-Formatierung verwendet werden kann,
also die Zeilenlänge zwischen zwischen 66 und 80 Zeichen liegt.
MAN_KEEP_FORMATTING
Wenn die Ausgabe nicht zu einem Terminal (zum Beispiel in eine
Datei oder eine Pipeline) geschickt wird, werden Formatierungs‐
zeichen verworfen, um das Ergebnis ohne Spezialwerkzeuge lesen
zu können. Ist aber $MAN_KEEP_FORMATTING auf einen nicht leeren
Wert gesetzt, werden diese Formatierungszeichen beibehalten.
Dies kann nützlich sein für Adapter, die man interpretieren und
Formatierungszeichen verarbeiten können.
MAN_KEEP_STDERR
Normalerweise werden bei der Ausgabe auf einem Terminal (in der
Regel mit einem Anzeigeprogramm) alle Fehlermeldungen der Forma‐
tierprogramme verworfen, um die Ausgabe des Anzeigeprogramms
nicht zu stören. Programme wie Groff produzieren häufig relativ
harmlose, hässliche Fehlermeldungen über typografische Probleme
wie schlechte Ausrichtung. Die Anzeige dieser Meldungen ist in
der Regel verwirrend, wenn sie zusammen mit der Handbuchseite
erfolgt. Einige Benutzer wollen sie trotzdem sehen. Setzen Sie
$MAN_KEEP_STDERR auf einen nicht leeren Wert, damit Fehlermel‐
dungen wie gewohnt angezeigt werden.
LANG, LC_MESSAGES
Abhängig von System und Implementierung werden entweder $LANG
oder $LC_MESSAGES oder beide nach Informationen zur aktuellen
Locale durchsucht. man wird (wenn möglich) seine Nachrichten in
dieser Locale anzeigen. Für genaue Details siehe setlocale(3).
DATEIEN
/etc/manpath.config
Konfigurationsdatei für Man-db
/usr/share/man
globale Handbuchhierarchie.
SIEHE AUCH
apropos(1), groff(1), less(1), manpath(1), nroff(1), troff(1), wha‐
tis(1), zsoelim(1), manpath(5), man(7), catman(8), mandb(8)
Für einige Pakete kann die Dokumentation in anderen Formaten verfügbar
sein, zum Beispiel info(1) oder HTML.
GESCHICHTE
1990, 1991 – John W. Eaton (jwe@che.utexas.edu) schrieb die erste Ver‐
sion.
23. Dez. 1992: Fehlerbereinigung durch Rik Faith (faith@cs.unc.edu)
,unterstützt durch Willem Kasdorp (wkasdo@nikhefk.nikef.nl).
30. April 1994 – 23. Februar 2000: Wilf (G.Wilford@ee.surrey.ac.uk) hat
mit der Hilfe von einigen wenigen engagierten Menschen dieses Paket
weiterentwickelt und gewartet.
30. Oktober 1996 – Februar 2000: Fabrizio Polacco <fpolacco@debian.org>
wartete und erweiterte mit Hilfe aus der gesamten Community dieses Pa‐
ket für das Debian-Projekt.
31. März 2001 – heute: Colin Watson <cjwatson@debian.org> entwickelt
und wartet man-db.
2.9.1 2020-02-25 MAN(1)
## Übungen
C 4.1 [!1] Schauen Sie sich die Handbuchseite zum Programm ls an. Benutzen Sie dafür das textbasierte Programm man und – falls vorhanden – den Konqueror-Browser.
C 4.2 [2] Welche Handbuchseiten auf Ihrem System beschäftigen sich (jedenfalls ihrem NAME-Abschnitt nach) mit Prozessen?
## HowTo und Weblinks
* https://wiki.ubuntuusers.de/man/ (Übung: Auf einer "Wegwerfmaschine ausprobieren")
* http://tldp.org/
* http://linux.org/
* http://linuxwiki.de/
* http://lwn.net/
* http://freecode.com/
* http://www.linux-knowledge-portal.org/
* http://www.freiesmagazin.de/
* https://ubuntuusers.de/
* https://wiki.ubuntuusers.de/Startseite/
## Kommandos in diesem Kapitel
```
apropos Zeigt alle Handbuchseiten mit dem angegebenen Stichwort im "NAME"-Abschnitt apropos (1)
groff Programm zur druckreifen Aufbereitung von Texten groff (1)
help Zeigt Hilfe für bash -Kommandos bash (1)
info Zeigt GNU-Info-Seiten auf einem Textterminal an info (1)
less Zeigt Texte (etwa Handbuchseiten) seitenweise an less (1)
man Zeigt Handbuchseiten des Systems an man (1)
manpath Bestimmt den Suchpfad für Handbuchseiten manpath (1)
whatis Sucht Handbuchseiten mit dem gegebenen Stichwort in der Beschreibung whatis (1)
```
## Zusammenfassung
* Interne Kommandos der Bash erklärt `help ⟨Kommando⟩`. Externe Kommandos unterstützen oft eine Option `--help`.
* Für die meisten Programme gibt es mit `man` abrufbare Handbuchseiten. `apropos` sucht in allen Handbuchseiten nach Stichwörtern, `whatis` nach den Namen von Kommandos.
* Info-Seiten sind für manche Programme eine Alternative zu Handbuchseiten.
* HOWTOs stellen eine problemorientierte Form der Dokumentation dar.
* Es gibt eine Vielzahl interessanter Linux-Ressourcen im World-Wide Web und USENET.

2
Home.md

@ -18,3 +18,5 @@ hinzu.
## Kapitel BSA ## Kapitel BSA
* [Keine Angst vor der Shell](Keine_Angst_vor_der_Shell) * [Keine Angst vor der Shell](Keine_Angst_vor_der_Shell)
* [Hilfe](Hilfe)