I Linux og Unix er der nutildags desværre lidt af et rod med flere forskellige formater af brugsanvisninger:
man-formatet er det officielle system til brugsanvisninger på Unix.
info-formatet blev på et tidspunkt lavet af GNU-projektet, da de ikke var tilfredse med mulighederne i man-formatet.
HTML-formatet bliver også jævnligt brugt til brugsanvisninger.
Postscript- og PDF-formaterne bliver typisk brugt til brugsanvisninger der skal se pæne ud på tryk.
Derudover har GNU-projektet en regel om at man ved at køre et program med kommandolinjetilvalget -h eller --help, kan få en kort vejledning i brugen af programmet.
Eksempel 2-1. Kommandolinjetilvalget --help
Vi kan for eksempel prøve at få en kort vejledning i hvordan man bruger programmet man:
[tyge@hven ~]$ man --help
man, version 1.5k
usage: man [-adfhktwW] [section] [-M path] [-P pager] [-S list]
[-m system] [-p string] name ...
a : find all matching entries
c : do not use cat file
d : print gobs of debugging information
[...]
Programmet skriver typisk ikke noget om hvad det er beregnet til, men giver blot en liste med de vigtigste kommandolinjetilvalg, som en påmindelse til den erfarne bruger der ikke lige kan huske om det hedder man -p et-eller-andet eller man -P et-eller-andet[2].
I de følgende afsnit vil vi gennemgå, hvordan man får adgang til at læse brugsanvisninger i de ovennævnte formater.
Hvis brugsanvisningen til et program, for eksempel mutt, findes i man-formatet (det er desværre aldrig til at vide før man prøver), så vil kommandoen:
[tyge@hven ~]$ man muttstarte brugsanvisningsvisningsprogrammet man med brugsanvisningen til mutt åbnet. Man kommer ud af man ved at taste q. Mellemrumstasten bringer én en side længere ned i brugsanvisningen, linjeskift en linje længere ned i brugsanvisningen og b en side længere op i brugsanvisningen. Et tryk på h bringer den interne hjælp i programmet frem.
Af andre programmer der kan vise brugsanvisninger i man-formatet kan KDE's filhåndtering og browser, Konqueror, nævnes.
man-systemet er beregnet til at give brugeren en kort men brugbar (ofte er den desværre kun kort) introduktion til kommandoen. En brugsanvisning i man-systemet består typisk af:
et afsnit med kommandoens navn og en beskrivelse på én linje,
en samlet liste med alle kommandoens mulige tilvalg,
en længere beskrivelse af hvad kommandoen bruges til,
en detaljeret beskrivelse af alle kommandolinjetilvalgene,
en beskrivelse af hvordan forskellige systemvariable påvirker programmet,
henvisninger til andre relevante kommandoer og
en liste med kendte fejl i programmet (hvorfor retter folk dem ikke bare?),
man bruger typisk programmet less til at vise brugsanvisningerne, så hvis du sætter dig ind i, hvordan man flytter rundt i en tekst, når du bruger less, så ved du samtidig også hvordan man gør det i man.
Brugsanvisningerne på et unix-system er kategoriseret i forskellige afsnit:
Om at bruge programmer.
Om at skrive programmer der snakker med styresystemet.
Om at skrive programmer.
Om specielle filer på systemet.
Om filformater.
Om spil.
Om konventioner og forskelligt andet.
Om systemadministrationskommandoer.
Hvis du bare skriver:
[tyge@hven ~]$ man infoså gennemgår man kategorierne i nummerorden indtil det finder en brugsanvisning om »info«. Det vil typisk være brugsanvisningen til programmet info, der findes i afsnit 1. Hvis du derimod har brug for beskrivelsen af filformatet »info«, så ved du at det er afsnit 5 der er interessant og kan i stedet for skrive:
[tyge@hven ~]$ man 5 info
Henvisninger til brugsanvisninger i man-systemet skrives i tekst typisk »navn(afsnit)«. Så hvis der står at man bør læse »info(5)« er det beskrivelsen af filformatet »info« (som man kan få frem med kommandoen man 5 info) der menes. Mens der med »info(1)« menes at man bør læse beskrivelsen af programmet »info« (som man kan få frem med kommandoen man 1 info).
Der findes en introduktion til hvert afsnit af brugsanvisningerne i man-systemet. Den hedder »intro«. Hvis du vil vide hvilke slags oplysninger du kan finde i afsnit 6 skriver du for eksempel:
[tyge@hven ~]$ man 6 intro
Unix-programmet man er meget praktisk at kende for at lære at bruge de mange parametre, der ofte findes til programmerne. Som eksempel kan du se dokumentationen for man-programmet ved at skrive man man på en kommandolinje.
NAME man - format and display the on-line manual pages manpath - determine user's search path for man pages SYNOPSIS man [-acdfhkKtwW] [-m system] [-p string] [-C config_file] [-M path] [-P pager] [-S section_list] [section] name ... DESCRIPTION man formats and displays the on-line manual pages.
Dette viser, at brugeren kan skrive man PROGRAMNAVN og få yderligere funktionalitet ved at tilføje ekstra flag, såsom man -w PROGRAMNAVN, som viser, hvilken fil der indeholder brugsanvisningen.
Tip: Med gvim (eller vi improved) kan du stille cursoren på et ord og trykke stort K for at se, om der er en man-page for pågældende ord.
"Synopsis" viser hvordan programmet bruges. Det, der vises i kantet parentes, er valgfrie parametre.
"Options"-afsnittet opremser alle de muligheder, programmet har. Du har allerede set, at ls har et tilvalg -l, men programmet har faktisk mange andre. Der findes generelt to typer muligheder: Den korte, startende med en bindestreg -a, og den lange med to bindestreger --all.
Det er ikke altid til at huske, hvad en kommando præcist hedder i Linux. Du sidder f.eks. og kan ikke huske, hvad en bestemt kommando hedder, men du kan huske, at den har noget med »web« at gøre. Til at lede alle man-siderne igennem har du kommandoen apropos:
[tyge@hven ~]$ apropos web Galeon [galeon] (1) - gecko-based GNOME web browser LWP (3pm) - The World-Wide Web library for Perl LWP::RobotUA (3pm) - A class for Web Robots alevtd (1) - webserver for videotext pages groff_www (7) - groff macros for authoring web pages lynx (1) - a general purpose distributed information browser for the World Wide Web pooltype (1) - display a WEB pool file tangle (1) - translate WEB to Pascal tie (1) - merge or apply WEB change files weave (1) - translate WEB to TeX webcam (1) - capture images and upload them to a webserver using ftp webcollage (1) - decorate the screen with random images from the web
Der kan være mange steder i man-systemet, hvor et ord indgår. Som du kan se, får du en kort beskrivelse med, som kan få dig til at huske, hvilket program du leder efter. Beskrivelsen er den, som står sammen med programmets navn øverst i brugsanvisningen.
Desværre leder apropos kun i man-systemet, så hvis et program kun har brugsanvisninger i info- eller HTML-format, så vil apropos ikke finde dem.
Det er også muligt at omdanne brugsanvisninger i man-systemet til HTML-filer med følgende kommando:
[tyge@hven ~]$ man2html /usr/man/man5/procmailrc.5 > procmailrc.html [tyge@hven ~]$ man2html /sti/manpage.[1. .9] > /sti/manpage.html
| [1] |
Og nogle gange vil de forskellige formater indeholde forskellige oplysninger, eller de samme oplysninger i forskellig detaljeringsgrad. |
| [2] |
Hvis man bruger Zsh, kan --help dog langt hen ad vejen erstattes med kreativ brug af tabulatortasten, da Zshs kommandofuldendelsessystem giver en del af de samme oplysninger. |