2. EL 6 ELS
  3. man
  4. man(1)

Scroll to navigation

man(1) General Commands Manual man(1)

NAAM

man - formatteer en vertoon documentatie bladzijden
manpath - geef het zoekpad voor documentatie bladzijden van de gebruiker weer

SYNTAX

man [-acdfhktwW] [-m systeem] [-p preprocessoren] [-C configuratiebestand] [-M pad] [-P pagineerprogramma] [-S lijst_van_hoofdstukken] [hoofdstuk] naam ...

BESCHRIJVING

man formatteert en vertoont bladzijden van de programma documentatie. Deze versie kent de MANPATH en (MAN)PAGER omgevingsvariabelen, zodat je je eigen collectie documentatiebladzijden en je eigen pagineerprogramma kunt gebruiken. Als het hoofdstuk is opgegeven, dan kijkt man alleen in dat hoofdstuk. Je kunt ook met omgevingsvariabelen of met programmaopties opgeven in welke volgorde de hoofdstukken moeten worden afgezocht, en welke preprocessoren de tekst moeten voorbewerken. Als naam een / bevat, dan wordt hij eerst geprobeerd als bestandsnaam, zodat opdrachten als man ./foo.5 of man /cd/foo/bar.1.gz mogelijk zijn.

OPTIES

Geef aan welk configuratiebestand gebruikt moet worden. Als deze optie niet is opgegeven, dan wordt /etc/man.config gebruikt. (Voor een beschrijving van dit bestand, zie man.conf(5).)
Geef de lijst van directories waarin gezocht moet worden. Als deze optie niet is opgegeven, dan wordt de omgevingsvariabele MANPATH gebruikt. En als er niet zo'n omgevingsvariabele is, dan wordt de standaardlijst gevonden door /etc/man.config te raadplegen. Een lege deelstring in MANPATH wordt vervangen door de standaardlijst.
Geef aan welk pagineerprogramma gebruikt moet worden. Als deze optie niet is opgegeven, dan wordt het programma vermeld in de omgevingsvariabele MANPAGER of, als deze niet bestaat, PAGER gebruikt. Is er ook niet zo'n omgevingsvariabele, dan wordt /usr/bin/less -is gebruikt.
Deze lijst is een lijst van hoofdstukken, door dubbele punten van elkaar gescheiden, waarin gezocht wordt. Als deze optie niet is opgegeven, dan wordt de omgevingsvariabele MANSECT gebruikt.
Normaal zal man termineren na het vertonen van de eerste documentatie bladzijde die hij vindt. Deze optie zegt dat alle bladzijden over naam vertoond moeten worden.
Formatteer de bron bladzijde, zelfs als er een recente voorgeformatteerde bladzijde bestaat. Dit kan nuttig zijn als die bladzijde geformatteerd was voor een scherm met een andere breedte, of als de voorgeformatteerde bladzijde niet deugt.
Vertoon de bladzijden niet echt, maar vertel gedetailleerd wat gedaan wordt - deze optie is alleen nuttig om fouten op te sporen.
Als by -d, maar vertoon de bladzijden ook.
Voer het programma whatis uit.
Druk een hulptekst af.
Voer het programma apropos uit.
Zoek de opgegeven tekst in *alle* handboekbladzijden. Pas op: dit kan lang duren! (Op mijn machine kost dit bijvoorbeeld een minuut voor elke 500 pagina's.) Het helpt om een sectie op te geven.
Gebruik een andere collectie documentatiebladzijden, afhankelijk van de opgegeven systeemnaam.
Geef aan welke preprocessoren de tekst moeten voorbewerken voordat deze aan nroff of troff gevoerd wordt. Enige preprocessoren, en de letters waarmee ze aangeduid worden, zijn: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Niet elke installatie zal al deze programma's hebben. Als deze optie niet is opgegeven, dan wordt de omgevingsvariabele MANROFFSEQ gebruikt.
Gebruik /usr/bin/groff -Tps -mandoc om de bladzijde te formatteren, en stuur het resultaat naar stdout. De uitvoer van /usr/bin/groff -Tps -mandoc moet mogelijk nog door een of ander filter gestuurd worden voordat hij afgedrukt kan worden.
Vertoon geen documentatie, maar druk de padnamen af van de bestanden waarin documentatie gevonden werd. Als geen naam opgegeven is, dan: druk het zoekpad af. Als manpath een link is naar man, dan is "manpath" equivalent met "man --path".
Als -w, maar druk alleen de padnamen af, zonder additionele informatie. Dit komt van pas in opdrachten zoals man -aW man | xargs ls -l

VOORGEFORMATTEERDE BLADZIJDEN

Man probeert om geformatteerde bladzijden te bewaren, om de volgende keer dat ze nodig zijn tijd te sparen. Gewoonlijk worden de geformatteerde versies van de bladzijden uit DIR/manX bewaard in DIR/catX, maar andere afbeeldingen van man directories naar cat directories kunnen in /etc/man.config worden aangegeven. Geformatteerde bladzijden worden niet bewaard als het bijbehorende cat directory niet bestaat.

Het is mogelijk om man suid te maken, met eigenaar man. Als dan een cat directory eigenaar man heeft, en mode 0755 (alleen door man beschrijfbaar), en de geformatteerde bladzijden hebben eigenaar man en mode 0644 of 0444 (alleen beschrijfbaar door man, of helemaal niet beschrijfbaar), dan kan geen gewone gebruiker de geformatteerde bladzijden wijzigen of andere bestanden opslaan in dat directory. Als man niet suid is, dan moet een cat directory waar voor alle gebruikers geformatteerde bladzijden geschreven moeten kunnen worden mode 0777 hebben.

De optie -c laat man een pagina opnieuw formatteren, zelfs als een recente geformatteerde pagina bestaat.

OMGEVINGSVARIABELEN

Als MANPATH een waarde heeft, dan wordt deze waarde als zoekpad gebruikt.
Als MANROFFSEQ een waarde heeft, dan wordt deze waarde gebruikt om te bepalen door welke preprocessoren de tekst bewerkt moet worden. Standaard wordt tbl gebruikt.
Als MANSECT een waarde heeft, dan wordt deze waarde gebruikt om te bepalen in welke hoofdstukken gezocht wordt.
Als MANWIDTH een waarde heeft, dan geeft deze waarde aan hoeveel kolommen de uitvoer breed moet zijn. Vooral bij heel brede schermen geven veel mensen er de voorkeur aan het aantal kolommen tot 80 of 100 te beperken.
Als MANPAGER een waarde heeft, dan wordt deze waarde gebruikt als naam van het te gebruiken pagineerprogramma. Zo niet, dan wordt de waarde van PAGER gebruikt. Bestaat deze ook niet, dan wordt /usr/bin/less -is gebruikt.
Als LANG een waarde heeft, dan bepaalt deze de naam van een onderdirectory waar man eerst in zoekt. Bijvoorbeeld, na `LANG=nl man 1 iets' zal man eerst in .../nl/man1/iets.1 zoeken, en als dat niet bestaat, dan in .../man1/iets.1. Hierbij is ... een directory uit het zoekpad.
De omgevingsvariabelen NLSPATH en LC_MESSAGES (of, als deze niet bestaat, LANG) spelen een rol bij het vinden van de versie in de opgegeven taal van de mededelingen (voornamelijk foutmeldingen) die man produceert. (Maar de Engelse teksten zijn meegecompileerd, en hoeven niet uit een bestand gehaald te worden.) Programma's als col(1) die door man aangeroepen worden, gebruiken ook LC_CTYPE.
PATH wordt gebruikt bij het construeren van het standaard zoekpad van man.
SYSTEM wordt gebruikt als standaard naam bij de optie -m.

ZIE OOK

apropos(1), whatis(1), less(1), groff(1).

FOUTEN

De -t optie werkt alleen als een troff-achtig programma geinstalleerd is.
Als je \255 of <AD> ziet knipperen waar afbreekstreepjes hadden moeten staan, zet dan `LESSCHARSET=latin1' in je omgeving.

2 September 1995