Manual-sider via man

Fra Debianguiden
Skift til: Navigation, Søgning

En af de store fordele ved Linux som operativ system er, at det er fuldstændigt gennem-dokumenteret. Det betyder at det altid er muligt at finde dokumentation om et emne. Dette afsnit handler om et dokumentations system kaldet 'man', der findes på alle Linux systemer.

Kommandoen 'man' er grænsefladen til en mængde nyttig information. "man" er en forkortelse for "manual". Næsten alle programmer du har installeret har sin egen såkaldte man-page. Denne side indeholder en beskrivelse af den givne kommando og en gennemgang af brugen og mulige argumenter til den. Derudover indeholder manpage-kartoteket også information om mange andre ting (se kategorier nedenfor) men hovedvægten i dette afsnit vil være på bruger kommandoer. Fordelen (og ulempen) ved denne dokumentations form er, at den er meget kompakt. Man skal nok gå hen og blive forvirret første gang man løber ind i sådan en. Formålet med denne del af vores "lille" Debian intro er at give et overblik over hvordan disse sider skal bruges.

For at se kommandoens 'ls' manpage skriver du fx:

bruger@debian:~$ man ls
De ni kategorier af manpages (taget fra "man man")
Nummer Beskrivelse
(1) Executable programs or shell commands
(2) System calls (functions provided by the kernel)
(3) Library calls (functions within system libraries)
(4) Special files (usually found in /dev)
(5) File formats and conventions (eg /etc/passwd)
(6) Games
(7) Macro packages and conventions (eg man(7), groff(7) )
(8) System administration commands (usually only for root)
(9) Kernel routines [Non standard]

En manpage indeholder flere dele:

<row>
Strukturen af en man-page
Sektion Indhold
'NAME' Kommandoens navn og en kort beskrivelse
'SYNOPSIS' Indeholder en opsummering af samtlige parametre til kommandoen. Denne del virker ved første øjekast ret voldsom og svær at finde rundt i. Nedenfor er en hurtig forklaring af hvad alle tegnene betyder:

'Fed tekst' skriv præcist hvad der står kursiv erstat med passende argument '[-abc]' en eller flere af argumenterne i [ ] kan bruges '-a|-b' | betyder eller - den ene ELLER den anden, og ikke begge (XOR for programmørerne derude ;) 'argument' ... argument kan gentages ['udtryk'] hele udtrykket i [ ] kan gentages

Fx ses i første linie i SYNOPSIS af "man man":

''''man [-c|-w|-tZT device]''''

Dette betyder, at kommandoen "'man'" kan køres med enten parameteren "'-c'" eller "'-w'" eller "'-tZT'", men ikke med flere af dem samtidigt.

'DESCRIPTION' Her er en beskrivelse af kommandoen og evt. lidt om dens anvendelse
'EXAMPLES' Denne del indeholder som navnet antyder eksempler på brug af kommandoen
'OPTIONS' Her er en gennemgang af alle de under SYNOPSIS angivne parametre
'FILES' En liste over alle for kommandoen relevante filer
'SEE ALSO' Andre manpages med relevant information i forbindelse med denne kommando
'BUGS' Ja, hvis der er nogen kendte bugs står de her
'AUTHOR' Forfatters/maintainers navn og evt. email-adresse

I øvrigt henvises til man's egen manpage - "'man man'"

For at lukke man ned igen, trykkes q