7.1. Dokumentasjonskilder
Før du kan forstå hva som egentlig skjer når det er et problem, må du vite den teoretiske rolle for hvert program som er involvert i problemet. For å gjøre dette er den beste refleksen å konsultere programmenes dokumentasjon; men siden det er mye dokumentasjon som kan være spredt vidt og bredt, bør du vite alle stedene der den kan finnes.
Manualsider, trass sin kortfattede stil, inneholder mye viktig informasjon. Vi vil raskt gå over kommandoen for å vise dem. Bare skriv inn
man manualside — manualsiden har som regel samme navn som den kommandoen man søker dokumentasjon om. For eksempel, for å lære om mulige alternativer for kommandoen
cp, ville man skrevet
man cp i ledeteksten (se sidefelt
DET GRUNNLEGGENDE Skallet, en kommandolinjetolk).
Manualsider dokumenterer ikke bare programmer som er tilgjengelige fra kommandolinjen, men også oppsettsfiler, systemkall, C-biblioteksfunksjoner, og så videre. Noen ganger kan navnene kollidere. For eksempel heter skallets read-kommando det samme som systemkallet read. Derfor er manualsider organisert i nummererte deler:
kommandoer som kan utføres fra kommandolinjen;
systemkall (funksjoner som tilbys av kjernen);
biblioteksfunksjoner (tilbys av systemets biblioteker);
enheter (på Unix-lignende systemer, disse er spesialfiler, vanligvis plassert i /dev/-katalogen);
oppsettsfiler (formater og konvensjoner);
spill;
sett med makroer og standarder;
kommandoer for systemadministrasjon;
kjernerutiner.
Det er mulig å spesifisere hvilken seksjon manualsiden du er ute etter befinner seg i: For å vise dokumentasjonen for read-systemkallet må du skrive man 2 read. Når ingen seksjon er uttrykkelig angitt, vil den første seksjonen som har en manualside med det riktige navnet bli vist. Dermed viser man shadow frem shadow(5) fordi det ikke er noen manualside for shadow i seksjonene 1 til og med 4.
Hvis du ikke vet navnene på kommandoene, kommer selvfølgelig ikke manualen til å være til stor nytte for deg. Dette er hensikten med apropos-kommandoen, som hjelper deg å utføre et søk i manualsidene, eller mer spesifikt i de korte beskrivelsene. Hver manualside begynner egentlig med en linjes sammendrag.apropos returnerer en liste med manualsider der oppsummeringen har med de forespurte søkeord(ene). Med gode valg av søkeord, vil du finne navnet på kommandoen du trenger.
Eksempel 7.1. Finne cp med apropos
$ apropos "copy file"
cp (1) - copy files and directories
cpio (1) - copy files to and from archives
gvfs-copy (1) - Copy files
gvfs-move (1) - Copy files
hcopy (1) - copy files from or to an HFS volume
install (1) - copy files and set attributes
ntfscp (8) - copy file to an NTFS volume.
The
man command is not the only means of consulting the manual pages, since
khelpcenter and
konqueror (by KDE) and
yelp (under GNOME) programs also offer this possibility. There is also a web interface, provided by the
man2html package, which allows you to view manual pages in a web browser. On a computer where this package is installed, use this URL:
Dette verktøyet krever en vevtjener. Dette er årsaken til at du bør velge å installere denne pakken på en av tjenermaskinene dine: Alle brukere av det lokale nettverket kan ha nytte av denne tjenesten (inkludert ikke-Linux-maskiner), og dette vil tillate deg å unngå å sette opp en HTTP-tjener på hver arbeidsstasjon. Hvis tjenermaskinen også er tilgjengelig fra andre nettverk, kan det være ønskelig å begrense tilgangen til denne tjenesten til brukere i det lokale nettverket.
Last but not least, you can view all manual pages available in Debian (even those that are not installed on your machine) on the
manpages.debian.org service. It offers each manual page in multiple versions, one for each Debian release.
GNU-prosjektet har skrevet håndbøker for de fleste av sine programmer i info-format: Det er grunnen til at mange manualsider refererer til tilsvarende info-dokumentasjon. Dette formatet gir noen fordeler, men standardprogrammet for å vise disse dokumentene (det kalles info) er også litt mer komplisert. Du gjør lurt i å bruke pinfo i stedet (fra pinfo-pakken).
info-dokumentasjonen har en hierarkisk struktur, og hvis du vil benytte pinfo uten parametre, vil den vise en liste over nodene som er tilgjengelig på første nivå. Vanligvis bærer noder navnet på de tilsvarende kommandoer.
Ded hjelp av
pinfo navigerer en lett mellom disse nodene ved å bruke piltastene. Alternativt kan du også bruke en grafisk nettleser, som er mye mer brukervennlig. Nok en gang,
konqueror og
yelp virker; i tillegg tilbyr
info2www et webgrensesnitt.
Merk at info-systemet ikke er egnet for oversetting, til forskjell fra man-sidesystemet. info-dokumenter er dermed nesten alltid på engelsk. Men når du spør pinfo-programmet om å vise en ikke-eksisterende info-side, vil den falle tilbake på man-siden med samme navn (hvis den eksisterer), som kan være oversatt.
7.1.3. Spesifikk dokumentasjon
Hver pakke inneholder sin egen dokumentasjon. Selv de minst godt dokumenterte programmene har vanligvis en README-fil som inneholder noe interessant og/eller viktig informasjon. Denne dokumentasjonen er installert i /usr/share/doc/pakke/-mappen (der pakke representerer navnet på pakken). Hvis dokumentasjonen er særlig stor, bør den ikke legges inn programmets hovedpakke, men bør heller legges i en egen pakke som vanligvis har navnet pakke-doc. Hovedpakken anbefaler generelt denne dokumentasjonspakken, slik at den er enkel å finne.
/usr/share/doc/pakke/-mappen inneholder også noen filer fra Debian som utfyller dokumentasjon ved å angi pakkenes særegenheter eller forbedringer sammenlignet med en tradisjonell installasjon av programvaren.README.Debian-filen indikerer også alle de tilpasninger som er gjort i samsvar med Debians regler. changelog.Debian.gz-filen tillater brukeren å følge endringene som er gjort i pakken over tid: Det er svært nyttig å prøve å forstå hva som har endret seg mellom to installerte versjoner som ikke opptrer likt. Til slutt er det noen ganger NEWS.Debian.gz-filen som dokumenterer større endringer i programmet som direkte kan angå administratorene.
I de fleste tilfellene har fri programvare nettsteder som brukes til å distribuere dem, og bringe sammen fellesskapet av utviklere og brukere. Disse nettstedene er ofte fylt med relevant informasjon i ulike former: Offisiell dokumentasjon, FAQ (Frequently Asked Questions), e-postlister, etc. Problemer du kan møte har gjerne vært gjenstand for mange spørsmål allerede, og FAQ, eller listearkivet, kan ha en løsning for det. Et godt grep på søkemotorer vil vise seg svært verdifullt når en trenger relevante sider raskt (ved å begrense søket til et Internett-domene, eller underdomene øremerket for programmet). Hvis søket returnerer for mange sider, eller hvis resultatene ikke samsvarer med hva du søker, kan du legge til søkeordet debian for å begrense resultatene, og fokusere på relevant informasjon.
If you do not know the address for the software's website, there are various means of getting it. First, check if there is a
Homepage field in the package's meta-information (
apt show package). Alternately, the package description may contain a link to the program's official website. If no URL is indicated, look at
/usr/share/doc/package/copyright. The Debian maintainer generally indicates in this file where they got the program's source code, and this is likely to be the website that you need to find. If at this stage your search is still unfruitful, consult a free software directory, such as FSF's Free Software Directory, or search directly with a search engine, such as Google, DuckDuckGo, Yahoo, etc.
Du ønsker kanskje også å sjekke wikien til Debian, et samarbeidsnettsted der hvem som helst, selv vanlige besøkende, kan bidra med forslag direkte via sine nettlesere. Den er like mye brukt av utviklere som utformer og spesifiserer sine prosjekter, som av brukere som deler sin kunnskap ved å skrive dokumenter sammen.
7.1.5. Veiledninger (HOWTO)
En «howto» er et dokument som beskriver, konkret og trinnvis, «hvordan» nå et forhåndsdefinert mål. Målene det dekker er relativt variert, men ofte av teknisk karakter, for eksempel sette opp IP-maskering, oppsett av programvare-RAID, installere en Samba-tjener, etc. Disse dokumentene forsøker ofte å dekke alle sannsynlige problemer som kan oppstå under implementeringen av en gitt teknologi.
Mange slike veiledere styres av Linux Documentation Project (LDP), hvis nettside har alle disse dokumentene:
Slike dokumentene bør tas med en klype salt. De er ofte flere år gamle og den informasjonen de inneholder er noen ganger foreldet. Dette fenomenet er enda hyppigere for oversettelsene, ettersom oppdateringene hverken er systematiske eller kommer samtidig med offentliggjøringen av en ny versjon av originaldokumentene. Dette er en del av gleden av å jobbe i et frivillig miljø, og uten begrensninger …
