1. december

Manualsider

SSLUG's julekalender 2001 vil hver dag præsentere et (eller flere sammenhørende) (små)programmer der hver for sig, men specielt i kombination kan gøre det daglige arbejde ved en UNIX/Linux-maskine lettere og sjovere. Dagens kommando kan bruges når man gerne vil vide noget mere om et program, og der kan i månedens løb blive god brug for den, derfor præsenterer vi nu:

1. december - man

'man' er primært et program til at læse systemets on-line-manual, den simpleste måde at bruge det på, er (hvis man f.eks. vil lære noget om programmet mutt):

man mutt

Man kan bladre i manualsiden med piletasterne, PageUp og PageDown, og man afslutter ved at trykke 'q'. Der findes også andre programmer der kan læse manualsider, f.eks. er der nogen der roser konqueror for at være god til det.

Nogle manualsider er ret lange, og det er ikke altid sjovt at læse dem på skærmen. Heldigvis er det nemt at lave en PostScript-fil som det oftest er nemt at skrive ud, man tilføjer bare et -t, og omdirigerer uddata til en fil:

man -t mutt > mutt.ps

Manualsider er opbygget af en række afsnit, hvilke afhænger meget af programmet og manualsidens forfatter, de fleste begynder dog med følgende afsnit.

NAME:
En kort (oftest kun en enkelt linie) beskrivelse af programmet.
SYNOPSIS:
En meget præcis (og en gang imellem næsten ulæselig) beskrivelse af programmets syntaks.
DESCRIPTION:
En uddybende beskrivelse af hvad programmet kan.

En af de væsentligste dele af mange manualsider er afsnittet "OPTIONS" der indeholder en gennemgang af alle kommandolinietilvalg.

De fleste manualsider indeholder mod slutningen afsnittet "SEE ALSO" der indeholder henvisninger til andre manualsider og andre dokumenter der måske er interessante.

Der er ret mange manualsider på et gennemsnitligt Linuxsystem (jeg har knap 4.700), og det er ikke altid nemt at vide hvilken man skal have fat i. Heldigvis kan man søge i de korte beskrivelse med kommandoen apropos (eller 'man -k'), hvis man f.eks. vil søge efter ordet "circle", bruger man bare:

  apropos circle

eller
  man -k circle

Manualsiderne er inddelt i forskellige sektioner alt efter typen af hvad de beskriver. Standardsektionerne er:

  1. Programmer,
  2. Systemkald (funktioner der ligger i kernen),
  3. Bibliotekskald (funktioner der kommer fra systembiblioteker),
  4. Specielle filer (filer i /dev),
  5. Filformater og konventioner f.eks. /etc/passwd,
  6. Spil og andet sjov,
  7. Macropakker og konventioner,
  8. Systemadministratorkommandoer (almindeligvis kun for root).

I nogle tilfælde findes der manualsider med samme navn i flere sektioner, f.eks. er der en manualside ved navn "man" i både sektion 1 og sektion 7. Den i sektion 1 handler om programmet man, mens den i sektion 7 handler om at skrive manualsider. Som standard viser 'man' kun den første den finder. Hvis man vil have fat i en anden er man nødt til at specificere hvilken sektion 'man' skal kigge i, det gør man ved at sætte nummeret på sektionen ind mellem 'man' og programmets navn. Hvis man f.eks. havde lyst til at skrive sin egen manualside, burde man nok starte med at læse:

man 7 man

Den almindelig måde at henvise til en manualside, er man sektionsnummeret i parentes lige bagefter, f.eks. man(1) og man(7).

På nogle systemer er der installeret et antal humoristiske manualsider, f.eks. er sex(6) kendt blandt de fleste der har brugt UNIX i lang tid. Hvis du har lyst til at kigge så husk også at tjekke condom(1) og celibacy(1). (På Debian ligger disse i pakken "funny-manpages", hvordan man finder dem på andre distributioner kan jeg desværre ikke hjælpe med.)

Behøver jeg nævne at man kan lære mere om 'man' ved at læse manualsiden, som man får ved at skrive:

man man