Ero sivun ”Dokumentaatio” versioiden välillä
Siirry navigaatioon
Siirry hakuun
ohjelmien aputoiminnot
LP (keskustelu | muokkaukset) p (w) |
LP (keskustelu | muokkaukset) (ohjelmien aputoiminnot) |
||
| Rivi 4: | Rivi 4: | ||
''Pääartikkeli [[Man]].'' | ''Pääartikkeli [[Man]].'' | ||
Man-sivut on | Man-sivut on Unixien sähköinen (ja haluttaessa paperinenkin) käsikirja (engl. <i>man</i>ual). | ||
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. | 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 ( | 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 == | == Info-sivut == | ||
''Pääartikkeli [[Info]].'' | ''Pääartikkeli [[Info]].'' | ||
GNU-projektin ohjelmista on usein man-sivun sijasta <tt>info</tt>-sivu, koska man-sivut koettiin liian rajoittuneiksi. Infosivut toimivat [[wikipedia:fi:hyperteksti|hyperteksti]]n tavoin, joten viitteiden käyttö on helpompaa ja esimerkiksi [[emacs]]in info-sivut ovat hyvin kattavat. Monen ohjelman kohdalla info-sivu kuitenkin on keskeneräinen. | [[wikipedia:fi:GNU|GNU-projektin]] ohjelmista on usein man-sivun sijasta <tt>info</tt>-sivu, koska man-sivut koettiin liian rajoittuneiksi. Infosivut toimivat [[wikipedia:fi:hyperteksti|hyperteksti]]n tavoin, joten viitteiden käyttö on helpompaa ja esimerkiksi [[emacs]]in info-sivut ovat hyvin kattavat. Monen ohjelman kohdalla info-sivu kuitenkin on keskeneräinen. | ||
Info-sivuja voi info-komennon lisäksi selailla esimerkiksi emacsilla ja joillakin www-selaimilla. | |||
== Ohjelmien aputoiminnot == | |||
Komentoriviohjelmat sisältävät yleensä lyhyen käyttöohjeen, joka tulostuu valitsimella <tt>-h</tt>, <tt>--help</tt> tai joskus <tt>-help</tt> (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 == | == Paketin dokumentaatio == | ||
| Rivi 18: | Rivi 30: | ||
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. | 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 (<tt>paketti-doc</tt> tms.), ja ohjekirja löytyy vasta tämän paketin asennuksen jälkeen. | Joskus, kun dokumentaatiota on paljon, se on eriytetty omaksi paketikseen (<tt>paketti-doc</tt> 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 <tt>README</tt>-tiedosto kuuluu usein tähän kategoriaan. | 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 <tt>README</tt>-tiedosto kuuluu usein tähän kategoriaan. | ||