Før du kan forstå hva som egentlig skjer når det er et problem, må du vite den teoretiske rollen til hvert program som er involvert i problemet. Den beste refleksen for å gjøre dette er å sjekke programmenes dokumentasjon; men siden det er mye dokumentasjon og den 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, levert av
man-db-pakken. 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 argumenter til kommandoen
cp, ville man skrevet
man cp ved ledeteksten (se sidefelt
DET GRUNNLEGGENDE Skallet, en kommandolinjetolk).
Manualsider dokumenterer ikke bare kommandoer og programmer tilgjengelige fra kommandolinjen, men også oppsettfiler, systemkall, 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:
- 1
kommandoer som kan utføres fra kommandolinjen;
- 2
systemkall (funksjoner som tilbys av kjernen);
- 3
biblioteksfunksjoner (tilbys av systemets biblioteker);
- 4
enheter (på Unix-lignende systemer er disse spesialfiler, vanligvis plassert i /dev/-katalogen);
- 5
oppsettsfiler (formater og konvensjoner);
- 6
spill;
- 7
sett med makroer og standarder;
- 8
kommandoer for systemadministrasjon;
- 9
kjernerutiner.
Det er mulig å spesifisere hvilken del manualsiden du er ute etter befinner seg i: For å vise dokumentasjonen for read-systemkallet må du skrive man 2 read. Når ingen del er uttrykkelig angitt, vil den første delen 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 delene 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
cp (1posix) - copy files
cpio (1) - copy files to and from archives
exec (1posix) - execute commands and open, close, or copy file descriptors
install (1) - copy files and set attributes
ntfscp (8) - copy file to an NTFS volume.
man-kommandoen er ikke den eneste muligheten til å bruke manualsidene, ettersom
khelpcenter og
konqueror (hos KDE) og
yelp (i GNOME)-programmene også ofte tilbyr denne muligheten. Det er også en nettside, levert av
man2html-pakken, som lar deg å vise manualsider i en nettleser. På en datamaskin der denne pakken er installert, kan du bruke denne nettadressen (etter å ha fulgt instruksjonene i
/usr/share/doc/man2html/README.Debian):
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 på det lokale nettverket.
Sist, men ikke minst, kan du se alle manualsider som er tilgjengelige i Debian (selv de som ikke er installert på maskinen din) på
manpages.debian.org-tjenesten. Den tilbyr hver manalside i flere versjoner, en for hver Debian-utgivelse.
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.
Ved 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-pakken tilbyr også et nettgrensesnitt.
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.
Mappen
/usr/share/doc/pakke/ 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å administrator (se
Seksjon 6.7.2, «Å håndtere problemer etter en oppgradering»).
In most cases, free software programs have websites that are used to distribute it and to bring together the community of its developers and users. These sites are frequently loaded with relevant information in various forms: official documentation,
FAQ (Frequently Asked Questions), mailing list archives, etc. Problems that you may encounter have often already been the subject of many questions; the FAQ or mailing list archives may have a solution for it. A good mastery of search engines will prove immensely valuable to find relevant pages quickly (by restricting the search to the Internet domain or sub-domain dedicated to the program). If the search returns too many pages or if the results do not match what you seek, you can add the keyword
debian to limit results and target relevant information.
Hvis du ikke vet adressen til programvarens hjemmeside, er det ulike måter å få tak i den på. Først, sjekk om det er et
Homepage-felt i pakkens metainformasjon (
apt show pakke). Alternativt kan pakkebeskrivelsen ha med en lenke til programmets offisielle hjemmeside. Hvis ingen nettadresse er angitt, sjekk
/usr/share/doc/pakke/copyright. I denne filen indikerer vanligvis Debians vedlikeholdere hvor de fikk programmets kildekode, og dette er trolig det nettstedet du trenger å finne. Hvis det på dette stadiet i søket ikke vises resultater, sjekk med en katalog over fri programvare, for eksempel FSFs Free Software Directory, eller søk direkte med en søkemotor, f.eks. SearX, YaCy, osv.
You might also want to check the Debian wiki, a collaborative website where anybody, even new visitors, can make suggestions directly from their browsers. It is used equally by developers who design and specify their projects, and by users who share their knowledge by writing documents collaboratively.
7.1.5. Veiledninger (HOWTO)
HOWTO er et dokument som beskriver, konkret og trinnvis, «hvordan» en når et forhåndsdefinert mål. Målene det dekker er relativt varierte, men ofte av teknisk karakter, for eksempel oppsett av IP-maskering, programvare-RAID, installasjon av Samba-tjener, osv. Disse dokumentene forsøker ofte å dekke alle sannsynlige problemer som kan oppstå under implementeringen av en gitt teknologi.
Many such tutorials are managed by the Linux Documentation Project (
LDP), whose website hosts all of these documents:
Debian tilbyr også veiledninger til sine brukere:
All these documents should be taken with a grain of salt. They are often several years old; the information they contain is sometimes obsolete. This phenomenon is even more frequent for their translations, since updates are neither systematic nor instant after the publication of a new version of the original documents. Further many tutorials nowadays are provided by bloggers, sharing their individual solution with the interested reader. They often lack important information, i.e. the reason why some configuration has been chosen over another, or why some option has been enabled or disabled. Because blogging and creating personal websites made it so easy to share, many of these often short tutorials exist, but only a few are actively maintained and well-kept. This can make it hard to find the "right" one for you. This is all part of the joys of working in a volunteer environment and without constraints…
