Ero sivun ”Man” versioiden välillä

Siirry navigaatioon Siirry hakuun
208 merkkiä lisätty ,  8. marraskuuta 2015
p
{{DISPLAYTITLE:{{lcfirst:{{PAGENAME}}}}}}
(vähän lisää materiaalia Raja-anturasta tekijän luvalla)
p ({{DISPLAYTITLE:{{lcfirst:{{PAGENAME}}}}}})
 
(7 välissä olevaa versiota 5 käyttäjän tekeminä ei näytetä)
Rivi 1: Rivi 1:
{{DISPLAYTITLE:{{lcfirst:{{PAGENAME}}}}}}
[[Kuva:man.vim.jpg|200px|right|thumb|[[Vim]]in man-sivun alkupäätä.]]
[[Kuva:man.vim.jpg|200px|right|thumb|[[Vim]]in man-sivun alkupäätä.]]
Man-komennolla saat esille ohjelman [[Dokumentaatio|ohjeita]] sisältävän manuaalisivun.  
'''man'''-komennolla saat esille ohjelman [[Dokumentaatio|ohjeita]] sisältävän manuaalisivun, yleensä englanninkielisenä.  


== Man-sivut ==
== Man-sivut ==
Rivi 7: Rivi 8:
#Järjestelmäkutsut
#Järjestelmäkutsut
#C-kirjaston funktiot
#C-kirjaston funktiot
#Erikoistiedostot (yleensä /dev:in laitetiedostoja)
#Erikoistiedostot (yleensä <tt>/dev</tt>-hakemiston laitetiedostoja)
#Tiedostomuodot
#Tiedostomuodot
#Pelit
#Pelit
Rivi 13: Rivi 14:
#Järjestelmänhallinnan komennot ja [[demoni]]t eli taustaprosessit
#Järjestelmänhallinnan komennot ja [[demoni]]t 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 <tt>man ohjelman_nimi</tt>. Myös monien ohjelmointikielien funktioille on omat man-sivunsa (esim. <tt>man printf</tt>). 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 järjestelmän käyttöohjeita, ja lähes jokainen ohjelma sisältää oman man-sivunsa. Sivujen selailu onnistuu komennolla <tt>man ohjelman_nimi</tt>. Myös monien ohjelmointikielien funktioille on omat man-sivunsa (esim. <tt>man printf</tt>). 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 kytkimet (''synopsis''), ohjelman kuvaus (''description''), ohjelman asetukset (''options''), ohjelman tiedostot (''files''), katso myös (''see also''), tiedot virheraportointia varten (''bugs'') ja Atiedot tekijästä (''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 "standardit" osiot. Voit tulkita niitä seuraavasti:
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 ohjelmaan, siihen ei ole sen kummallisempaa lisättävää.
*''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ä kytkimiä 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 <tt>man man</tt> näyttää jotakuinkin seuraavaa:
*''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 <tt>man man</tt> näyttää jotakuinkin seuraavaa:
  '''man'''  ['''-c'''|'''-w'''|'''-tZ''']  ['''-H'''[<u>browser</u>]] ...
  '''man'''  ['''-c'''|'''-w'''|'''-tZ''']  ['''-H'''[<u>browser</u>]] ...
Lihavoitu osa tekstistä kertoo meille että se teksti tulee kirjoittaa juuri tuolla tavalla - pienillä ja isoilla kirjaimilla on väliä. Alleviivattu teksti taas meidän tulee korvata vihjeen mukaisella argumentilla. Tässä tapauksessa argumentti on browser (selain), joka voidaan korvata esim. [[Konqueror]]illa. |-merkit taas kertovat ettei näitä samojen sulkujen sisässä olevia argumentteja voi käyttää yhtäaikaisesti.  
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 <tt>browser</tt> (selain), joka voidaan korvata esimerkiksi [[Konqueror]]illa. |-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ä.
*''Description'' on pidennetty kuvaus ohjelmasta ja lyhyt kertomus sen toiminnasta ja erikoispiirteistä.
*''Options'' kertoo tarkasti jokaisen erillisen kytkimen toiminnan sekä selittää, kuinka ja missä tilanteessa niitä tulisi käyttää.
*''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 (esim. asetustiedostot) sijainnit [[Linuxin hakemistorakenne|hakemistopuussa]].
*''Files'' näyttää komentoon liittyvien tärkeiden tiedostojen (esimerkiksi asetustiedostot) sijainnit [[Linuxin hakemistorakenne|hakemistopuussa]].
*''See Also'' näyttää muut man-sivut, joista voi olla hyötyä komennon kanssa ja sellaiset man-sivut, joihin on man-sivulla viitattu.
*''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ää.
*''Bugs'' ei suinkaan kerro mitä virheitä ohjelmassa on, vaan osoitteen johon virheraportteja voidaan lähettää.
*''Authors'' kertoo ohjelman tekijät ja mahdollisesti valmistumisajankohdan
*''Authors'' kertoo ohjelman tekijät ja mahdollisesti valmistumisajankohdan
   
   
Nyt osaamme siis tulkita man-sivuilta löytyviä tietoja. Seuraavaksi siirrymmekin sitten edistyksellisemmisiin ominaisuuksiin kuten sivujen hakeminen.
Nyt osaamme siis tulkita man-sivuilta löytyviä tietoja. Seuraavaksi siirrymmekin sitten edistyksellisempiin ominaisuuksiin kuten sivujen hakemiseen.


== Käyttö ==
== Käyttö ==
Avataan [[zsh]]-[[komentotulkki|komentotulkin]] man-sivu:
  man zsh
  man zsh
Avaa [[zsh]]-[[komentotulkki|komentotulkin]] man-sivun.


Joskus eri kategorioissa saattaa olla samannnimisiä komentoja. Tällöin man-komennolla on kerrottava haluttavan kategorian numero. Esimerkiksi komento
Joskus eri kategorioissa saattaa olla samannimisiä komentoja. Tällöin man-komennolla on kerrottava halutun kategorian numero. Esimerkiksi komento
  man 1 echo
  man 1 echo
avaa eri man -sivun kuin komento
avaa eri man -sivun kuin komento
Rivi 41: Rivi 42:
Pelkkä komento
Pelkkä komento
  man echo  
  man echo  
avaa sivun echo(1), koska tämä on yleisemmin käytetty komento. Sen onko samalla nimellä useita eri man-sivuja saa selville [[whatis]]-komennolla.
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 loistavat hakuominaisuudet - tai oikeastaan [[bash]]-komentokehote ja man-ohjelma sisältävät, sillä bashin tuntemuksella voi parantaa hakuominaisuuksia huomattavasti. Man-sivujen hakeminen tapahtuu komennolla <tt>man -k haettava_sana</tt>. Se kutsuu komentoa [[apropos]], joten voit myös käyttää muotoa <tt>apropos haettava_sana</tt> ja saat saman tuloksen. Otetaan esimerkki komennon [[bzip2]] man-sivun hakemisesta:


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 <tt>man -k haettava_sana</tt>. Se kutsuu komentoa [[apropos]], joten voit myös käyttää muotoa <tt>apropos haettava_sana</tt> ja saat saman tuloksen. Otetaan esimerkki komennon [[bzip2]] man-sivun hakemisesta:
  man -k bzip2
  man -k bzip2
Suorittaa haun järjestelmän man sivujen otsaketiedoista, tässä tapauksessa kaikista joihin sisältyy merkkijono [[bzip2]].
Komento suorittaa haun järjestelmän man-sivujen otsaketiedoista, tässä tapauksessa kaikista joihin sisältyy merkkijono [[bzip2]].
Komennnon tuloste näyttää tältä: (vain osa tulosteesta)
Tuloste näyttää tältä (vain osa tulosteesta):
  bunzip2 [bzip2]      (1)  - a block-sorting file compressor, v1.0.2
  bunzip2 [bzip2]      (1)  - a block-sorting file compressor, v1.0.2
  bzcat [bzip2]        (1)  - decompresses files to stdout
  bzcat [bzip2]        (1)  - decompresses files to stdout
Rivi 65: Rivi 65:
== Katso myös ==
== Katso myös ==
*[[Info]]
*[[Info]]
*[[Dokumentaatio]]


[[Luokka:Komentorivin perustyökalut]]
[[Luokka:Komentorivin perustyökalut]]
[[Luokka:Ohjeet]]
[[Luokka:Ohjeet]]
[[Luokka:Ohjelukijat]]
[[pl:man]]
10 147

muokkausta

Navigointivalikko