Dokumentaatio

Kohteesta Linux.fi
Loikkaa: valikkoon, hakuun

Useimmista komennoista, keskeisistä tiedostoista, järjestelmäkutsuista yms. on manuaalisivu, jossa komento ja sen käyttö kuvaillaan, GNU-projektin ohjelmilla on info-sivut ja jokaisesta paketista on yleensä ainakin jotakin tietoa hakemistossa /usr/share/doc/paketti, usein jopa kattava ohjekirja.

Man-sivut[muokkaa]

Pääartikkeli Man.

Man-sivut on Unixien sähköinen (ja haluttaessa paperinenkin) käsikirja (engl. manual). Sivuilla kuvaillaan komennot, järjestelmä- ja ohjelmakirjastokutsut, keskeiset asetustiedostot yms. mahdollisimman täsmällisesti, mutta usein käyttäjän oletetaan tuntevan se aihepiiri, johon komento liittyy. Siksi man-sivut voivat aloittelijalle tuntua kryptisiltä. Kun niihin tottuu, ne ovat hyvinkin arvokkaita.

Perinteisen Unixin osalta man-sivut ovat kattavat, mutta monet myöhemmät projektit (GNU, työpöytäympäristöt, graafiset www-selaimet jne.) ovat kirjoittaneet dokumentaationsa muihin muotoihin ja niitten osalta man-sivut saattavat olla tynkiä tai puuttua kokonaan.

Info-sivut[muokkaa]

Pääartikkeli Info.

GNU-projektin ohjelmista on usein man-sivun sijasta info-sivu, koska man-sivut koettiin liian rajoittuneiksi. Infosivut toimivat hypertekstin tavoin, joten viitteiden käyttö on helpompaa ja esimerkiksi emacsin info-sivut ovat hyvin kattavat. Monen ohjelman kohdalla info-sivu kuitenkin on keskeneräinen. Joskus paketin info-sivut ovat eri paketissa, joko niiden koon tai lisenssin takia.

Info-sivuja voi info-komennon lisäksi selailla esimerkiksi emacsilla ja joillakin www-selaimilla.

Ohjelmien aputoiminnot[muokkaa]

Komentoriviohjelmat sisältävät yleensä lyhyen käyttöohjeen, joka tulostuu valitsimella -h, --help tai joskus -help (tai kun komentoa kutsuu virheellisesti):

ohjelma --help

Sama toimii joillakin graafisilla ohjelmilla.

Graafisissa ohjelmissa saattaa olla valikosta avattava ohjekirja (joka joskus asennetaan eri pakettina ja joka usein avautuu erilliseen selainohjelmaan). Yleensä pääsee heti oikeaan kohtaan ohjekirjaa, mutta ei aina.

Joissakin ohjelmissa (emacs, lyx) on myös "kurssi" (tutorial), jolla suhteellisen nopeasti oppii ohjelman käytön perusteet.

Paketin dokumentaatio[muokkaa]

Hakemistossa /usr/share/doc/paketti on sekalaista tietoa ohjelmapaketista, kuten lisenssi, kääntämisohjeet, muutosloki sekä usein kattavampi ohjekirja, esimerkkejä ohjelman käytöstä, malleja asetustiedostoiksi jne. Hakemiston sisältö ei ole standardoitu kuin joidenkin tiedostojen osalta, mutta ainakin suurempien ohjelmistopakettien kohdalla kannattaa katsoa löytyisikö ohjekirjaa.

Joskus, kun dokumentaatiota on paljon, se on eriytetty omaksi paketikseen (paketti-doc tms.), ja ohjekirja löytyy vasta tämän paketin asennuksen jälkeen. Projektin kotisivulta (joka usein kerrotaan esim. README-tiedostossa, muuten hakumoottorit auttavat) saattaa myös löytyä arvokasta tietoa.

Osa hakemistosta löytyvästä tiedosta on tarkoitettu ohjelmaa uudelle alustalle kääntävälle tai sopeuttavalle, mikä saattaa olla hyvinkin hämäävää. Varsinkin README-tiedosto kuuluu usein tähän kategoriaan.

Tietoa verkosta[muokkaa]

Vaikeammissa tapauksissa voit etsiä tietoa mm:

Myös kaupallista tukea on saatavilla monesta paikasta. Pyri olemaan looginen, testaa, kokeile ja ihmettele. Tieto tulee monesti kokemuksen kautta. Google "virheilmoitus" voi monesti ratkaista asian nopeasti.