1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
|
'\" t
.\" ** The above line should force tbl to be a preprocessor **
.\" Man page for man
.\"
.\" Copyright (C), 1994, Graeme W. Wilford. (Wilf.)
.\" Deutsche bersetzung von Anke Steuernagel und Nils Magnus
.\"
.\" You may distribute under the terms of the GNU General Public
.\" License as specified in the file COPYING that comes with the man
.\" distribution.
.\"
.\" Sat Oct 29 13:09:31 GMT 1994 Wilf. (G.Wilford@ee.surrey.ac.uk)
.\"
.TH man 1 "12 Juli 1995" "2.3.10" "Dienstprogramme fr Benutzer"
.LO 1
.SH NAME
man \- Programm zum Einsehen der Online-Manuale
.SH SYNTAX
.\" Die allgemeine Kommandozeile
.\".TP \w`man\ `u
.B man
.RB [\| \-acdhwutZV \|]
.RB [\| \-m
.IR System \|[\|,.\|.\|.\|]\|]
.RB [\| \-L
.IR locale \|]
.RB [\| \-p
.IR Zeichenkette \|]
.RB [\| \-M
.IR Pfad \|]
.RB [\| \-P
.IR Pager \|]
.RB [\| \-r
.IR Prompt \|]
.RB [\| \-T
.IR Format \|]
.RB [\| \-S
.IR Liste \|]
.RB [\| \-e
.IR Erweiterung \|]
.RI [\|[\| Abschnitt \|]
.IR Seite \ .\|.\|.\|]\ .\|.\|.
.\" The --local command line
.br
.B man
.B \-l
.RB [\| \-tZ \|]
.RB [\| \-p
.IR Zeichenkette \|]
.RB [\| \-P
.IR Pager \|]
.RB [\| \-r
.IR Prompt \|]
.RB [\| -T
.IR Format \|]
.I Datei
\&.\|.\|.
.\" The apropos command line
.br
.B man
.B \-k
.I Schlsselwort
\&.\|.\|.
.\" The whatis command line
.br
.B man
.B \-f
.I Seite
\&.\|.\|.
.SH BESCHREIBUNG
.B man
ist der Manualbrowser des Systems. Jedes Argument
.I Seite
ist normalerweise der Name eines Programmes oder einer
Funktion. Gefunden und angezeigt wird die
.I Manualseite,
die auf alle Argumente pat. Wenn ein
.IR Abschnitt
angegeben wird, sucht
.B man
nur in diesem
.I Abschnitt
der Manualseiten. Ohne Angabe eine explizite Angabe werden alle verfgbaren
.IR Abschnitte
in einer vorher definierten Reihenfolge durchsucht.
Wenn die
.I Seite
in mehreren
.IR Abschnitten
vorkommt, wird nur die jeweils erste
.I Seite
angezeigt, die gefunden wird.
Die folgende Tabelle zeigt die Nummern der
.I Abschnitte
der Manualseiten gefolgt vom Typ der dort zu findenden Seiten.
.TS
tab (@);
l l.
1@Ausfhrbare Programme oder Shellbefehle
2@Systemaufrufe (Kernelfunktionen)
3@Bibliotheksaufrufe (Funktionen in System-Bibliotheken)
4@Spezielle Dateien (gewhnlich in \fI/dev\fR)
5@Dateiformate und Konventionen, z. B. \fI/etc/passwd\fR
6@Spiele
7@Makropakete und Konventionen, z. B. \fBman\fR(7), \fBgroff\fR(7)
8@Systemadministrationsbefehle (in der Regel nur fr root)
9@Kernelroutinen [\|Nicht Standard\|]
n@neu [\|veraltet\|]
l@lokal [\|veraltet\|]
p@ffentlich [\|veraltet\|]
o@alt [\|veraltet\|]
.TE
Eine Manualseite besteht aus mehreren Teilen. Die blichen
Bezeichnungen sind u. a.
.BR NAME ,
.BR SYNTAX ,
.BR BESCHREIBUNG ,
.BR OPTIONEN ,
.BR DATEIEN ,
.BR SIEHE\ AUCH ,
.BR FEHLER ,
und
.BR AUTOR .
Die folgenden Konventionen gelten fr den Abschnitt
.B SYNTAX
und knnen fr andere Abschnitte als Anleitung benutzt werden.
.TS
tab (@);
l l.
\fBbold text\fR@Literale Angaben wie in der Anzeige.
\fIitalic text\fR@Ersetzen durch passendes Argument.
[\|\fB\-abc\fR\|]@Ein oder mehrere Argumente innerhalb der [ ] sind optional.
\fB\-a\|\fR|\|\fB\-b\fR@Optionen, die durch | abgegrenzt sind, knnen nicht zusammen benutzt werden.
\fIArgument\fB .\|.\|.@\fIArgument\fR kann wiederholt werden.
[\|\fIAusdruck\fR\|]\fB .\|.\|.@\fRgesamter \fIAusdruck\fR\ innerhalb [ ] kann wiederholt werden.
.TE
Die Befehls- oder Funktionsbeispiele sind Muster, die auf alle mglichen
Aufrufe passen sollten. In manchen Fllen ist es ratsam, die verschiedenen
sich ausschlieenden Aufrufe zu illustrieren, wie es im
.B SYNTAX
Abschnitt dieser Manualseite gezeigt ist.
.SH BEISPIELE
.TP \w'man\ 'u
.BI man \ ls
zeigt die Manualseite fr das Programm
.IR ls
an.
.TP
.BI man\ \-a \ intro
zeigt alle vorhandenen
.I intro
Manualseiten an. Mit (q)uit ist es mglich, das aufeinanderfolgendende
Anzeigen der Seiten abzubrechen oder mit (s)kip eine Seite zu berspringen.
.TP
\fBman \-t \fIalias \fR|\fI lpr -Pps
Formatiert die Manualseite, die sich auf
.RI alias
bezieht, in das Default
.B troff
oder
.B groff
Format und schickt es an den Drucker
.IR ps .
Die Defaultausgabe fr
.B groff
ist Postscript. Das Default fr
.B troff
\- ditroff, bentigt weitere Bearbeitung durch grops, bevor es von einem
Postscriptdrucker gedruckt werden kann.
.B man \-\-help
sollte zu bestimmen helfen, welcher Prozessor an die
.B \-t
Option gebunden ist.
.TP
.BI man\ \-l\ \-T dvi\ ./foo.1x.gz \ >\ ./foo.1x.dvi
Dieser Befehl formatiert die komprimierte nroff-Manualseite
.I ./foo.1x.gz
in eine
.B device independent (dvi)
Datei. Diese Datei wird zuerst dekomprimiert, bevor sie durch passende Filter
und Programme bearbeitet wird. Die Umlenkung ist notwendig, da die
.B \-T
Option die Ausgabe unformatiert an die
.B Standardausgabe
schickt. Die Ausgabe kann mit einem Programm wie
.B xdvi
betrachtet oder mit einem Programm wie
.BR dvips
in Postscript weiterverarbeitet werden.
.TP
.BI man\ \-k \ printf
Sucht die Kurzbeschreibungen und die Namen der Manualseiten zum
.I Schlsselwort
.IR printf
und gibt alle Treffer aus.
.TP
.BI man\ \-f \ smail
Sucht die Manualseiten, die sich auf
.I smail
beziehen und gibt alle gefundenen Kurzbeschreibungen aus.
.SH UEBERSICHT
Um dem Benutzer eine grtmgliche Flexibilitt zu bieten, sind in
.B man
viele Optionen verfgbar. Vernderungen knnen am Suchpfad, in der
Reihenfolge der Abschnitte oder am Ausgabeprozessor vorgenommen werden. Andere
Verhaltensweisen und Operationen sind weiter unten beschrieben.
Um die Arbeitsweise von
.BR man
zu bestimmen, werden verschiedene Umgebungsvariablen benutzt. Mit
dieser Version ist es mglich, die Variable
.RB $ MANOPT
auf einen Ausdruck im Kommandozeilenformat zu setzen. Es gibt folgende
Ausnahme: Da jede Option in
.RB $ MANOPT
von Leerzeichen eingeschlossen ist, mssen Leerzeichen, die Teil eines
Argumentes sind, gequotet werden.
.B man
bearbeitet diese Variable vor der eigenen Kommandozeile. Die Optionen, die ein
Argument bentigen, knnen durch die gleichen Optionen in der Kommandozeile
berschrieben werden.
Um alle Optionen zurckzusetzen, die in
.RB $ MANOPT
gesetzt werden, kann
.B \-D
als initiale Kommandozeilen-Option angegeben werden.
Dies erlaubt
.B man
alle Optionen zu `berschreiben', die in
.RB $ MANOPT
gesetzt werden, obwohl diese weiterhin gelten. Damit wird die grtmgliche
Flexibilitt fr einen Benutzer erzeugt, der
.B man
auf seine eigenen Bedrfnisse anpassen will, ohne zahllose
Optionen bei der Suche einer Manualseite einzugeben.
Die Hilfsprogramme, die im
.B man_db-
Paket zusammengefat sind, machen umfassenden Gebrauch von
.I Indexdatenbanken.
Diese Zwischenspeicher enthalten Informationen ber den Ort und
die zugehrige
.I whatis
Information (einzeilige Kurzbeschreibung der Manualseite), sowie darber,
wo sich eine Manualseite im Dateisystem befindet. Eine Aufgabe von
.B man
ist die Konsistenzsicherung der Datenbank. Die Datenbanken verhindern die
Notwendigkeit einer manuellen Bearbeitung zur Aktualisierung der
.I whatis-
Textdatenbank und erlauben
.B man
schneller zu arbeiten, als bei der Suche nach der passenden
Manualseite im gesamten Dateisystem.
Wenn
.B man
keine von
.B mandb
erstellte
.I Indexdatenbank
zu einer speziellen Manualhierarchie finden kann, wird dennoch nach der
gewnschten Manualseite gesucht. In diesem Fall ist es jedoch wieder ntig,
nach der alten Methode alle in Frage kommenden Verzeichnisse zu durchsuchen
(sog. globbing). Wenn
.B whatis
oder
.B apropos
keine
.I Indexdatenbank
finden knnen, versucht es die Information aus der
.I whatis-
Datenbank zu beziehen.
Auch anwenderspezifische Manualhierarchien werden whrend der Benutzung in
.I Indexdatenbanken
zusammengefat.
Die Hilfsprogramme untersttzen komprimierte nroff-Quelldateien,
die normalerweise die Erweiterung
.BR .Z ", " .z " oder " .gz
besitzen. Jede andere Erweiterung kann untersttzt werden, wenn sie zur
bersetzungszeit bekannt ist. Als Default werden alle cat-Seiten mit
.BR gzip
komprimiert. Jede globale Manualhierarchie wie
.I /usr/man
oder
.I /usr/X11R6/man
kann jedes Verzeichnis als cat-Seiten-Hierarchie besitzen.
blicherweise werden cat-Seiten unter der gleichen Hierarchie wie die
Manualseiten gespeichert. Allerdings kann es aus Grnden, die im
.BR "Linux File System Standard (FSSTND)"
erlutert sind, besser sein, sie an anderer Stelle zu speichern.
Details, wann dies der Fall ist, beschreibt
.BR manpath (5).
Fr Details, warum dies empfohlen wird, siehe den
.BR "Linux File System Standard (FSSTND)" .
Dieses Paket untersttzt internationale Anpassungen (sog. NLS-Support, Native
Language Support). Durch den Gebrauch von
.I locale
Funktionen ist es mglich, Manualseiten der Landessprache zu verwalten, wenn
sie auf dem System vorhanden sind. Um diese Untersttzung zu aktivieren, mu
man entweder in
.RB $ LC_MESSAGES ,
.RB $ LANG
oder anderen systemabhngigen Umgebungsvariablen die gewnschte Sprache
einstellen. Die Sprache wird normalerweise in dem durch
.B POSIX 1003.1
definierten Format angegeben:
.\"
.\" Need a \c to make sure we don't get a space where we don't want one
.\"
.RI < Sprache >[\|\c
.B _\c
.RI < Region >\|[\|\c
.B .\c
.RI < Zeichensatz >\|[\|\c
.B ,\c
.RI < Version >\|]\|]\|]
Wenn die angeforderte Seite in der
.IR locale
vorhanden ist, wird sie anstelle der Standardseite (normalerweise in
amerikanischem Englisch) angezeigt. Darber hinaus werden auch Sammlungen von
landessprachlichen Systemmeldungen untersttzt und auf dieselbe Weise
aktiviert - ebenfalls unter der Vorraussetzung, da die bersetzten
Meldungen vorliegen. Wer diese Manualseiten und die Ausgaben der
Hilfsprogramme gerne in seiner Landessprache htte, aber diese nicht
vorfindet, ist aufgefordert, eine bersetzung anzufertigen und sie dem Autor
zuzusenden, damit sptere Versionen davon profitieren knnen.
Die anderen Eigenschaften und Erweiterungen von
.B man
sind in den beiliegenden Dokumenten beschrieben. Einen umfassenden Einblick
in die
.B mandb
zugrundeliegenden Konzepte sind in der Dokumentation
.I man_db-2.3 - the database cached manual pager suite
beschrieben. Die Dokumentation sollte auf denselben Server wie das
.B mandb-
Paket selbst zu finden sein.
.SH NORMALEINSTELLUNGEN
.B man
sucht nach der gewschten Manualseite in der
.I Indexdatenbank.
Wenn die Suche fehlschlgt, wird ein Konsistenztest durchgefhrt, um die
korrekte Wiedergabe des Dateisystems zu sichern. Nachdem die Datenbanken
erzeugt wurden, ist es i. A. nicht notwendig,
.B mandb
zu starten, es sei denn, die Datenbank wurde verflscht.
Wenn eine Manualseite gefunden wurde, wird getestet, ob dazu bereits eine
vorformatierte cat-Seite existiert und diese neuer als die nroff-Datei ist.
In diesem Fall wird die vorformatierte Datei
dekomprimiert und mit einem Browser angezeigt. Die Auswahl des Browsers kann
auf unterschiedliche Weise erfolgen (fr Details siehe
.B \-P
Option).
Wenn keine cat-Seite gefunden wird oder wenn sie lter als die nroff-Datei
ist, wird die nroff-Datei durch diverse Programme gefiltert und
entweder sofort angezeigt oder zuerst als komprimierte cat-Datei gespeichert
und dann angezeigt.
Eine cat-Datei wird erzeugt, wenn ein relatives cat-Verzeichnis existiert und
.B man
dort das Schreibrecht hat.
Die Filter werden in mehreren Schritten zusammengestellt: Zuerst wird
die Kommandozeilen-Option
.B \-p
oder die Umgebungsvariable
.RB $ MANROFFSEQ
untersucht. Wenn
.B \-p
nicht benutzt wird und die Umgebungsvariable nicht gesetzt ist, wird die
Anfangszeile der nroff-Datei nach einer Zeichenkette fr den Prprozessor
untersucht. Eine solche Prprozessor-Zeichenkette mu folgendes Aussehen
haben:
.B '\e"
.RB < Zeichenkette >
wobei
.B Zeichenkette
jede Kombination von Buchstaben sein kann, die unter Option
.B \-p
weiter unten beschrieben sind.
Wenn keine der obigen Methoden eine Filter-Information enthlt, wird
.B tbl
als Default verwendet.
Als primrer Formatierer wird entweder
.BR nroff ,
.B troff
oder
.B groff
gestartet.
.\" ********************************************************************
.SH OPTIONEN
Eine Argumentoption, die entweder in der Kommandozeile, in
.RB $ MANOPT
oder in beiden doppelt vorkommt , ist nicht schdlich. Fr Optionen,
die ein Argument bentigen, berschreibt jedes Duplikat den
vorhergehenden Wert.
.TP
.B \-l, \-\-local-file
Aktiviert den lokalen Modus. Formatiert und zeigt lokale Manualdateien an,
anstatt die System-Manualsammlung zu durchsuchen. Jedes
Manualseiten-Argument wird als nroff-Quelle im richtigen Format
interpretiert. Komprimierte nroff-Quelldateien mit einer untersttzten
Kompressions-Erweiterung werden von
.B man
dekomprimiert, bevor sie ber den blichen Filter angezeigt werden. Es wird
keine cat-Datei erzeugt. Wenn eines der Argumente `\-' ist, wird die Eingabe
von der Standardeingabe bernommen.
.TP
.BI \-L\ locale ,\ \-\-locale= locale
Normalerweise bestimmt
.B man
die aktuelle
.B locale
durch einen Aufruf der C Funktion
.B setlocale (3),
die diverse Umgebungsvariablen, darunter u. U.
.RB $ LC_MESSAGES
und
.RB $ LANG
untersucht.
Diese Funktion kann dazu verwendet werden, kurzzeitig den so gefundenen Wert
zu berschreiben. Dazu kann diese Option mit einer Zeichenkette, die die
temporre
.B locale
enthlt, angegeben werden. Man beachte, da dieser Effekt
erst beim konkreten Suchen der Seite in Erscheinung tritt. Daher werden
Ausgaben wie die Hilfeseite immer in der ursprnglichen Sprache ausgegeben.
.TP
.B \-D, \-\-default
Diese Option wird normalerweise nur als allererste angegeben und setzt das
Verhalten von
.B man
in allen Belangen wieder zum Normalverhalten zurck. Der Zweck dieser Option
ist es, Optionen wieder rckgngig zu machen, die bereits in der
Umgebungsvariable
.RB $ MANOPT
gesetzt sind. Alle Optionen, die
.B \-D
folgen, haben wieder ihren gewohnten Effekt.
.TP
.BI \-M\ Pfad ,\ \-\-manpath= Pfad
Ermglicht es, einen alternativen Manualpfad anzugeben. Normalerweise
verwendet
.B man
dieselben Methoden wie in
.B manpath,
um den Suchpfad zu ermitteln. Diese Option berschreibt die Umgebungsvariable
.RB $ MANPATH.
.TP
.BI \-P\ Pager ,\ \-\-pager= Pager
Gibt an, welcher Pager verwendet wird. Die Normaleinstellung ist
.BR "exec /usr/bin/pager -s" .
Diese Option berschreibt die Umgebungsvariable
.RB $ PAGER
und wird nicht in Zusammenhang mit
.B \-f
oder
.BR \-k
verwendet.
.TP
.BI \-r\ Prompt ,\ \-\-prompt= Prompt
Wenn eine hinreichend neue Version von
.B less
als Pager verwendet wird, versucht
.B man
dort einige sinnvolle Optionen zu setzen. Die Eingabeaufforderung in der
letzten Zeile sieht in dem Fall so aus:
.B \ Manual page\c
.IB \ name ( sec )\c
.BI \ line \ x,
wobei
.I name
die Manualseite bezeichnet, die gerade angezeigt wird,
.I sec
der Abschnitt ist, in dem sie gefunden wurde, und
.IR x
die aktuelle Zeilennummer ist.
Diese Anzeige wird durch Verwendung der Umgebungsvariable
.RB $ LESS
erreicht.
Man beachte, da einzelne Bezeichnungen sich bei der Verwendung von
landessprachlichen Meldungen ndern knnen.
Die Option
.B \-r
ermglicht es, durch Angabe einer Formatierungszeichenkette, das
Ausgabeformat selbst zu bestimmen. Wenn diese Zeichenkette
.B $MAN_PN
enthlt, wird dieser Text durch den Namen der Manualseite gefolgt von der
Abschnittsnummer in runden Klammern ersetzt. Die Zeichenkette, die im
Normalfall verwendet wird ist:
.B \e\ Manual\e\ page\e\ \e$MAN_PN\e\ ?ltline\e\ %lt?L/%L.:
.br
.B byte\e\ %bB?s/%s..?\e\ (END):?pB\ %pB\e\e%..
Die zweizeilige Darstellung wurde nur der besseren Lesbarkeit wegen
gewhlt. Nhere Informationen liefert
.BR less (1).
Da die Zeichenkette zuerst vom Kommandointerpreter ausgewertet wird, mssen
entsprechende Zeichen durch einen Backslash geschtzt werden. Weitere
Optionen fr
.B less
knnen nach einem geschtzten $ am Ende der Zeichenkette hinzugefgt
werden. Der Default ist hier
.B \-ix8.
.TP
.BI \-S\ Liste ,\ \-\-sections= Liste
Eine durch Doppelpunkte getrennte Liste von Abschnitten definiert bei
Benutzung dieser Option die Reihenfolge, in der die Abschnitte durchsucht
werden. Diese Option berschreibt die Umgebungsvariable
.RB $ MANSECT.
.TP
.B \-a, \-\-all
Wird eine Manualseite in einem Abschnitt gefunden, so terminiert
.B man
nach Anzeige dieser Seite. Wird jedoch diese Option angegeben, so werden alle
passenden Manualseiten nacheinander angezeigt.
.TP
.B \-c, \-\-catman
Diese Option berprft nur, ob die zur angegebenen Manualseite passende
cat-Seite aktuell ist und erzeugt ggf. eine neue. Es wird dabei nichts
angezeigt.
.TP
.B \-d, \-\-debug
Bei dieser Option werden keine Manualseiten angezeigt, sondern nur
eine Menge von Diagnoseinformation.
.TP
.BI \-e\ Erweiterung ,\ \-\-extension= Erweiterung
Einige Systeme enthalten groe Pakete an Manualseiten, wie z. B. in dem
.B Tcl
Paket, die in die normalen Manualabschnitte integriert werden. Um
beispielsweise das Problem zweier unterschiedlicher Manualseiten mit gleichem
Namen, wie
.BR exit (3),
zu lsen, wurden frher alle
.B Tcl
Seiten dem Abschnitt
.BR l
zugeordnet. Dieses erwies sich als keine gute Lsung. Bei dieser Version von
.B man
ist es mglich, die Seiten in die richtigen Abschnitte einzuordnen und ihrem
Seitennamen eine spezifische Erweiterung, hier z. B.
.BR exit (3tcl)
anzuhngen. Unter normalen Umstnden zeigt
.B man
bevorzugt
.BR exit (3)
gegenber
.BR exit (3tcl)
an. Um dieses Verhalten umzukehren, ist
.B man
die Zeichenkette
.I Erweiterung
zu bergeben, die angibt, in welchem Paket die Manualseite zu finden ist. Im
obigen Fall beschrnkt
.B man
seine Suche auf Seiten mit der Erweiterung
.BR *tcl,
wenn es mit
.B \-e\ tcl
aufgerufen wurde. Die Suche wird dabei in allen Abschnitten durchgefhrt.
.TP
.B \-f, \-\-whatis
Diese Option ist das quivalent zu
.BR whatis .
Es wird eine Kurzbeschreibung der gewnschten Manualseite angezeigt, wenn
sie gefunden wurde. Zu Details siehe
.BR whatis (1).
Mit dieser Option ist nur eine Standardsuche mglich. Verbesserte
Suchmglichkeiten bieten die Optionen von
.B whatis.
.TP
.B \-k, \-\-apropos
Diese Option ist das quivalent zu
.BR apropos .
Es werden die Kurzbeschreibungen zu allen Manualseiten nach dem angegebenen
Stichwort durchsucht. Zu Details siehe
.BR apropos (1).
Mit dieser Option ist nur eine Standardsuche mglich. Verbesserte
Suchmglichkeiten bieten die Optionen von
.B apropos.
.PP
.B \-m
.I System\c
.RB \|[\|,.\|.\|.\|]\| ,
.BI \-\-systems= System\c
\|[\|,.\|.\|.\|]
.RS
Wenn auch Manualseiten von einem anderen Betriebssystem installiert
sind, so kann auf sie mit dieser Option zugegriffen werden. Um
beispielsweise die Manualseiten von NewOS zu durchsuchen, mu
.B "\-m NewOS"
angegeben werden.
Das angegebene
.I System
kann eine durch Kommata abgetrennte Aufzhlung von Betriebssystemnamen
sein. Die normalen Seiten werden durch den Betriebssystemnamen
.B man
angesprochen. Diese Option berschreibt die Umgebungsvariable
.RB $ SYSTEM.
.RE
.TP
.BI \-p\ Zeichenkette ,\ \-\-preprocessor= Zeichenkette
Diese Option gibt die Reihenfolge an, in der die Prprozessoren vor
.B nroff
oder
.BR troff / groff
abgearbeitet werden. Nicht alle Installationen haben notwendigerweise alle
Prprozessoren. Einige der Prprozessoren und die Zeichen, um sie zu
reprsentieren, sind:
.BR eqn " (" e ),
.BR grap " (" g ),
.BR pic " (" p ),
.BR tbl " (" t ),
.BR vgrind " (" v ),
.BR refer " (" r ).
Diese Option berschreibt die Umgebungsvariable
.RB $ MANROFFSEQ.
Der Prprozessor
.B zsoelim
wird immer als erster gestartet.
.TP
.B \-u, \-\-update
Die
.I Indexdatenbanken
werden immer whrend des laufenden Betriebes auf neuestem Stand gehalten, was
insbesondere bedeutet, da
.B mandb
nicht bentigt wird, um sie konsistent zu halten. Wenn die ausgewhlte
Manualseite nicht im Index gefunden wurde oder die
.B \-a
Option verwendet wurde, macht
.B man
einen Konsistenztest auf Verzeichnisebene, um sicherzustellen, da der Index
immer noch eine gltige Reprsentation der Manualseiten im Dateisystem
darstellt. Wenn dieser Test auf Inode-Ebene durchgefhrt werden soll, mu
man die Option
.BR \-u
benutzen.
.TP
.B \-t, \-\-troff
Mit dieser Option wird
.I "/usr/bin/groff -mandoc"
verwendet, um die Manualseite zu formatieren und an die Standardausgabe
zu liefern. Im Zusammenhang mit
.B \-T
oder
.BR \-Z
ist diese Option nicht ntig.
.PP
.BI \-T\ Format ,\ \-\-troff-device
.RI [\| =Format \|]
.RS
Diese Option wird dazu verwendet, um das Ausgabeformat von
.B groff
(oder mglicherweise
.BR troff )
zu ndern. Diese Option impliziert die Angabe von
.BR \-t .
Verfgbare Ausgabeformate (von Groff-1.09) beinhalten
.BR dvi ", " latin1 ,
.BR X75 " und " X100 .
.RE
.TP
.B \-Z, \-\-ditroff
Das traditionelle
.B troff
erzeugt ditroff.
.B groff
startet zunchst
.B troff
und leitet danach dessen Ausgabe an einen fr das gewhlte Ausgabeformat
geeigneten Postprozessor weiter. Wenn
.I "/usr/bin/groff -mandoc"
.BR groff
ist, zwingt diese Option
.B groff
dazu, traditionelles
.B troff
zu emulieren und impliziert
.BR \-t ,
andernfalls wird es ignoriert.
.TP
.B \-w, \-\-where, \-\-location
Zeigt nicht die Manualseiten, sondern die Position der Dateien im
Dateisystem an, die formatiert oder angezeigt wrden. Wenn die Datei eine
cat-Seite ist, wird auch der Ort ihrer nroff-Quelldatei angezeigt.
.TP
.B \-h, \-\-help
Zeigt einen Hilfstext an.
.TP
.B \-V, \-\-version
Zeigt Programmversion und Autor an.
.SH UMGEBUNG
.\".TP \w'MANROFFSEQ\ \ 'u
.TP
.B MANPATH
Wenn
.RB $ MANPATH
gesetzt ist, wird dessen Wert als Suchpfad fr die Manualseiten benutzt.
.TP
.B MANROFFSEQ
Wenn
.RB $ MANROFFSEQ
gesetzt ist, wird dessen Wert benutzt, um die Abfolge der Prprozessoren zu
bestimmen, die jede Manualseite vor
.B nroff
oder
.BR troff
durchluft.
Als Default durchlaufen die Seiten den
.BR tbl " (" t )
Prprozessor.
.TP
.B MANSEC
Wenn der Wert von
.RB $ MANSEC
eine durch Doppelpunkte getrennte Liste von Abschnitten ist,
wird dieser Wert dazu benutzt, um die zu durchsuchenden Abschnitte und
deren Reihenfolge zu bestimmen.
.TP
.B PAGER
Wenn
.RB $ PAGER
gesetzt ist, wird dieses Programm zur Anzeige benutzt. Default ist
.B "exec /usr/bin/pager -s".
.TP
.B SYSTEM
Wenn
.RB $ SYSTEM
gesetzt ist, hat dies den gleichen Effekt wie die Option
.B \-m
.I System
wobei
.I System
als Inhalt der Umgebungsvariable
.RB $ SYSTEM
benutzt wird.
.TP
.B MANOPT
Wenn
.RB $ MANOPT
gesetzt ist, wird der Wert dieser Variablen vor der
.B man
Kommandozeile durchsucht und abgearbeitet. Wie auch alle
anderen Umgebungsvariablen, die als Kommandozeilen-Optionen ausgedrckt
werden knnen, ist es mglich, den Inhalt von
.RB $ MANOPT
durch die Kommandozeile zu berschreiben.
Alle Leerzeichen, die Teil eines Argumentes sind, mssen gequotet werden.
.TP
.BR LANG , " LC_MESSAGES"
Abhngig von System und Implementation werden entweder
.RB $ LANG
oder
.RB $ LC_MESSAGES
oder beide nach der gegenwrtigen
.I locale
Information durchsucht.
.B man
wird (wenn mglich) seine Nachrichten in dieser
.I locale
anzeigen. Fr Details
siehe
.BR setlocale (3).
.SH DATEIEN
.TP
.I /etc/manpath.config
Die Manualkonfigurationsdatei.
.TP
.I /usr/\|.\|.\|.\|/man
Globale Manualhierarchien.
.TP
.I /var/catman/\|.\|.\|.\|/index.(bt|db|dir|pag)
Die
.B FSSTND
complianten globalen
.I Indexdatenbanken.
.SH "SIEHE AUCH"
.BR mandb (8),
.BR manpath (1),
.BR manpath (5),
.BR apropos (1),
.BR whatis (1),
.BR catman (8),
.BR less (1),
.BR nroff (1),
.BR troff (1),
.BR groff (1),
.BR zsoelim (1),
.BR setlocale (3).
.SH FEHLER
Die Option
.B \-t
funktioniert nur, wenn ein troff-hnliches Programm installiert ist.
Die Option
.B \-e
funktioniert momentan nur in Manualhierarchien, fr die mit
.B mandb
eine
.I Indexdatenbank
erzeugt wurde.
Manualseiten, die die erweiterte Darstellung im Zusammenhang mit der Option
.B \-e
untersttzen, drfen keinen Punkt beinhalten, denn sonst
werden diese Seiten als fehlerhaft zurckgewiesen.
.SH GESCHICHTE
1990, 1991 \- Originale geschrieben von John W. Eaton (jwe@che.utexas.edu).
23. Dez. 1992: Fehlerbereinigung durch Rik Faith (faith@cs.unc.edu)
untersttzt durch Willem Kasdorp (wkasdo@nikhefk.nikef.nl).
Zwischen dem 30. April 1994 und dem 12 Juli 1995 hat Wilf
(G.Wilford@ee.surrey.ac.uk) unter Mithilfe von einigen wenigen engagierten
Menschen dieses Paket entwickelt und weitergefhrt.
Die deutsche bersetzung wurde von
Anke Steuernagel (a_steuer@informatik.uni-kl.de) und
Nils Magnus (magnus@informatik.uni-kl.de) angefertigt.
Fr persnliche Wrdigungen und Zustze siehe Quelltexte.
|