2.1.1 man

Naredba man (kratica za "manual" = priručnik) je tradicionalan oblik online (izravne) dokumentacije na Unix i Linux operativnim sustavima. Posebno formatirane datoteke, tzv “man stranice” su napisane za najveću većinu naredbi i isporučuju se sa samim softverom. Izvršavanjem naredbe man neka_naredba prikazati će se man stranica željene naredbe, u našem primjeru to je izmišljena naredba neka_naredba.

Kao što se može i očekivati, količina man stranica može brzo narasti, postajući pretjerano zbunjujuća i komplicirana, čak i za naprednijeg korisnika. Zbog tog razloga, man stranice su grupirane u numerirane odjeljke. Ovaj sustav postoji dovoljno dugo da danas često vidimo oznaku man stranice uz ime naredbe, programa, ili čak i funkcije neke programske biblioteke.

Primjer:

Možda naiđete na referencu za man(1). Broj govori da je naredba “man” dokumentirana u odjeljku 1 (korisničke naredbe); možete zatražiti man stranicu za “man” u odjeljku 1 naredbom man 1 man. Preciziranje odjeljka u kojoj će man potražiti zadanu stranicu je korisno u slučaju više stranica s istim imenom.

Osim man(1) postoje i whatis(1) i apropos(1) naredbe, čija zajednička zadaća je olakšati nalaženje informacija u man sustavu.

Naredba whatis daje sažeti opis sistemske naredbe, pomalo u stilu šalabahtera.

Primjer:

% whatis whatis
whatis (1)  - pretražuje whatis bazu podataka za kompletnu riječ

Naredba apropos se koristi za nalaženje man stranice koja sadrži zadanu riječ.

Primjer:

% apropos wav
cdda2wav    (1)  - a sampling utility that dumps CD audio data into wav sound files
netwave_cs  (4)  - Xircom Creditcard Netwave device driver
oggdec      (1)  - simple decoder, Ogg Vorbis file to PCM audio file (WAV or RAW)
wavelan     (4)  - AT&T GIS WaveLAN ISA device driver
wavelan_cs  (4)  - AT&T GIS WaveLAN PCMCIA device driver
wvlan_cs    (4)  - Lucent WaveLAN/IEEE 802.11 device driver

Ako želite dodatne informacije o bilo kojoj od ovih naredbi, pročitajte njihove man stranice za detalje. ;)

2.1.2 Direktorij /usr/doc

Izvorni kod većine paketa koje izgrađujemo dolazi s nekim oblikom dokumentacije: README datoteke, upute za uporabu, datoteke s licencama i sl. Bilo koja vrsta dokumentacije koja dolazi sa izvornim kodom instalira se u /usr/doc direktorij. Svaki program će (najčešće) instalirati svoju dokumentaciju u obliku:

/usr/doc/$program-$verzija

$program je ime programa o kojem želite nešto pročitati, a $verzija je (očito) odgovarajuća verzija paketa instalirana na vaš sustav.

Na primjer, za pročitati dokumentaciju za naredbu man(1) potrebno je promijeniti direktorij (naredbom cd) u:

% cd /usr/doc/man-$verzija

Ako čitanje man stranice ne pomogne u specifičnom slučaju, /usr/doc direktorij trebao bi biti sljedeći korak.

2.1.3 KAKO i mini-KAKO

U najboljem duhu Open Source zajednice dolazimo do KAKO/mini-KAKO kolekcije. Ove datoteke su upravo ono što im ime govori - dokumenti i vodiči koji objašnjavaju kako nešto napraviti. Ako ste instalirali KAKO kolekciju, KAKO datoteke će biti instalirane u /usr/doc/Linux-HOWTOs, a mini-KAKO datoteke u /usr/doc/Linux-mini-HOWTOs.

U istoj seriji paketa uključena je i kolekcija FAQ, što je akronim za

Hrvatski: UPP - Učestalo Postavljana Pitanja

Ovi dokumenti su pisani u obliku "pitanje i odgovor" i odgovaraju (iznenađenje) na često postavljana pitanja. Mogu biti veoma korisni ako tražite brzo rješenje nekog problema. Ako ste prilikom instalacije instalirali FAQ kolekciju, naći ćete je instaliranu u /usr/doc/Linux-FAQs direktoriju.

Čitanje ovih datoteka je korisno u slučajevima kada niste sigurni kako nastaviti s nekom "zadaćom". One pokrivaju nevjerovatno širok spektar tema vrlo detaljno. Dobar materijal!