Man

Vimin man-sivun alkupäätä.

man-komennolla saat esille ohjelman ohjeita sisältävän manuaalisivun, yleensä englanninkielisenä.

Man-sivut

Man-sivut on jaettu kahdeksaan eri kategoriaan, jotka ovat seuraavat:

1. Yleiset komennot
2. Järjestelmäkutsut
3. C-kirjaston funktiot
4. Erikoistiedostot (yleensä /dev-hakemiston laitetiedostoja)
5. Tiedostomuodot
6. Pelit
7. Sekalaista
8. Järjestelmänhallinnan komennot ja demonit eli taustaprosessit

Man-sivut ovat järjestelmän käyttöohjeita, ja lähes jokainen ohjelma sisältää oman man-sivunsa. Sivujen selailu onnistuu komennolla man ohjelman_nimi. Myös monien ohjelmointikielien funktioille on omat man-sivunsa (esim. man printf). Tämä komento siis näyttää man-sivun halutusta aiheesta. Man-komento ei suinkaan ole ainoa millä man-sivuja voidaan selata, on olemassa myös mm. apropos- ja whatis-työkalut, jotka on suunnattu lähinnä man-sivujen etsimiseen.

Man-sivut ovat hyvin loogisia rakenteeltaan, yleensä ne sisältävät järjestyksessään seuraavat osiot: ohjelman nimi (name), mahdolliset valitsimet (synopsis), ohjelman kuvaus (description), ohjelman asetukset (options), ohjelman tiedostot (files), ja katso myös (see also), tiedot virheraportointia varten (bugs) ja tiedot tekijöistä (author). Nämä voivat myös esiintyä eri nimillä, osa niistä voi puuttua tai niitä voi olla enemmän. Mutta nämä ovat man-sivujen standardiosiot. Voit tulkita niitä seuraavasti:

• Name on ohjelman nimi sekä lyhyt kuvaus ohjelmasta, jota yllämainitut työkalut käyttävät hakuun ja löytyneiden sivujen kuvaamiseen.
• Synopsis kertoo, mitä valitsimia voidaan lisätä komennon perään ja pääasiallisesti sen, kuinka niitä käytetään. Synopsis-osiossa on erikoismerkintöjä, joilla on oma tarkoituksensa optioiden selittämisessä. Esimerkiksi komento man man näyttää jotakuinkin seuraavaa:

man   [-c|-w|-tZ]  [-H[browser]] ...

Lihavoitu osa tekstistä kertoo meille, että se tulee kirjoittaa juuri tuolla tavalla – pienillä ja isoilla kirjaimilla on väliä. Alleviivattu teksti taas tulee korvata vihjeen mukaisella argumentilla. Tässä tapauksessa argumentti on browser (selain), joka voidaan korvata esimerkiksi Konquerorilla. |-merkit taas kertovat, ettei näitä samojen sulkujen sisässä olevia argumentteja voi käyttää yhtäaikaisesti.

• Description on pidennetty kuvaus ohjelmasta ja lyhyt kertomus sen toiminnasta ja erikoispiirteistä.
• Options kertoo tarkasti jokaisen erillisen valitsimen toiminnan sekä selittää, kuinka ja missä tilanteessa niitä tulisi käyttää.
• Files näyttää komentoon liittyvien tärkeiden tiedostojen (esimerkiksi asetustiedostot) sijainnit hakemistopuussa.
• See Also näyttää muut man-sivut, joista voi olla hyötyä komennon kanssa ja sellaiset man-sivut, joihin on man-sivulla viitattu.
• Bugs ei suinkaan kerro mitä virheitä ohjelmassa on, vaan osoitteen johon virheraportteja voidaan lähettää.
• Authors kertoo ohjelman tekijät ja mahdollisesti valmistumisajankohdan

Nyt osaamme siis tulkita man-sivuilta löytyviä tietoja. Seuraavaksi siirrymmekin sitten edistyksellisempiin ominaisuuksiin kuten sivujen hakemiseen.

Käyttö

Avataan zsh-komentotulkin man-sivu:

man zsh

Joskus eri kategorioissa saattaa olla samannimisiä komentoja. Tällöin man-komennolla on kerrottava halutun kategorian numero. Esimerkiksi komento

man 1 echo

avaa eri man -sivun kuin komento

man 3 echo

Pelkkä komento

man echo 

avaa sivun echo(1), koska tämä on yleisemmin käytetty komento tai joissakin komennon versioissa pyytää käyttäjää tarkentamaan, minkä eri man-sivuista hän haluaa nähtäväkseen. Sen onko samalla nimellä useita eri man-sivuja, saa selville whatis-komennolla (jollei komento sitä itse kerro).

Man-sivua ei välttämättä aina löydy sille komennolle tai ainakaan sillä nimellä, mitä etsitään. Ei paniikkia, man-sivut sisältävät hyvät hakuominaisuudet. Man-sivujen hakeminen tapahtuu komennolla man -k haettava_sana. Se kutsuu komentoa apropos, joten voit myös käyttää muotoa apropos haettava_sana ja saat saman tuloksen. Otetaan esimerkki komennon bzip2 man-sivun hakemisesta:

man -k bzip2

Komento suorittaa haun järjestelmän man-sivujen otsaketiedoista, tässä tapauksessa kaikista joihin sisältyy merkkijono bzip2. Tuloste näyttää tältä (vain osa tulosteesta):

bunzip2 [bzip2]      (1)  - a block-sorting file compressor, v1.0.2
bzcat [bzip2]        (1)  - decompresses files to stdout
bzcmp [bzdiff]       (1)  - compare bzip2 compressed files
bzdiff               (1)  - compare bzip2 compressed files

Rivien muotoilu on seuraava: Ohjelman nimi (kategorian numero) - kuvaus.

Aproposin ja man -k:n haku perustuu whatisin tietokantaan.

Joskus samalla ohjelmalla on useampia man-sivuja eri kategorioissa. Kokeillaan esimerkiksi avata komennon foo man-sivu (tällaista ei siis ole oikeasti):

man foo
foo(3) – Foo-funktio
foo(1) – Foo-komento

Jolloin foo-komennon man-sivun näkisimme komennolla

man 1 foo

Katso myös

• Info
• Dokumentaatio