Man: Difference between revisions

From ICO wiki
Jump to navigationJump to search
No edit summary
No edit summary
 
(31 intermediate revisions by one other user not shown)
Line 1: Line 1:
Laura Laane A21
Käsk ''man'' on üks tähtsamaid käske Linuxi käsureal. Seda kasutatakse vormindamiseks ja  ''man'' online lehtede kuvamiseks. Selle abil on võimalik lugeda abiinfot nii süsteemikäskude, häälestusfailide kui ka suuremate programmide kohta.  
Käsk ''man'' on üks tähtsamaid käske Linuxi käsureal. Seda kasutatakse vormindamiseks ja  ''man'' online lehtede kuvamiseks. Selle abil on võimalik lugeda abiinfot nii süsteemikäskude, häälestusfailide kui ka suuremate programmide kohta.  
Iga Linuxi käsu ja peaaegu iga rakenduse jaoks on ''man'' fail.
Iga Linuxi käsu ja peaaegu iga rakenduse jaoks on ''man'' fail.[http://lynchjim.com/doc/kde/HTML/et/kubuntu/cli/man-help.html]


== Süntaks ==  
== Süntaks ==  


Et lugeda manuaalikehekülge mingi Unix'i käsu kohta on süntaks järgmine:
Et lugeda manuaalilehekülge mingi Unix'i käsu kohta on süntaks järgmine: [http://www.techonthenet.com/unix/basic/man.php]
{|style="background:lightyellow;width:500px;margin:3px;border:1px solid lightgrey" align=centre
| style="padding:0px 0px 0px 80px;font-family:courier;font-size:8pt;" | man [suvandid] [ [sektsioonid] teemad]
|}


man [options] [ [section] subjects]
== Man lehtede peamised suvandid ==
 
 
== Man lehtede peamised sektsioonid ==




Line 17: Line 15:
|+  
|+  
|-
|-
! Sektsioon !! tähendus
! Suvand !! tähendus
|-
|-
| -d || Vigade kõrvaldamiseks(debug)
| -d || Vigade kõrvaldamiseks(debug)
Line 37: Line 35:




== Man käsuga seotud suvandid ==
== Man käsuga seotud sektsioonid [http://viki.pingviin.org/Man] ==
Man käsuga saadav info on jagatud sisu järgi erinevatesse sektsioonidesse.
 
{| class="wikitable"
{| class="wikitable"
|+  
|+  
|-
|-
! Suvand !! tähendus
! Sektsioon !! tähendus  
|-
|-
| 1 || Kasutaja käsud   
| 1 || Kasutaja käsud   
|-
|-
| 2 || Süsteemsed kutsungid
| 2 || Süsteemsed kutsungid  
|-
|-
| 3 || Alamfunktsioonid
| 3 || Alamfunktsioonid  
|-
|-
| 4 || Seadmed
| 4 || Seadmed  
|-
|-
| 5 || Failide vorminugd
| 5 || Failide vorminugd  
|-
|-
| 6 ||  Mängud
| 6 ||  Mängud  
|-
|-
| 7 ||  Muud
| 7 ||  Muud  
|-
|-
| 8 ||  Süsteemid administreerimine
| 8 ||  Süsteemid administreerimine  
|-
|-
| 9 ||  Kernel
| 9 ||  Kernel  
|-
|-
| n || Uus
| n || Uus  
|-
|-
| l ||  Kohalik
| l ||  Kohalik  
|-
|-
| p ||  Avalik
| p ||  Avalik  
|-
|-
| o ||  Vana
| o ||  Vana
|}
Mõne käsu jaoks on olemas mitu erinevat manuaalilehekülge. Et leida endale sobiv tuleks käsku täpsustada sektsiooni numbriga.
Näiteks
{|style="background:lightyellow;width:500px;margin:3px;border:1px solid lightgrey" align=centre
| style="padding:0px 0px 0px 80px;font-family:courier;font-size:8pt;" | man kill
|}  on manuaalilehekülg käsu kill kohta
{|style="background:lightyellow;width:500px;margin:3px;border:1px solid lightgrey" align=centre
| style="padding:0px 0px 0px 80px;font-family:courier;font-size:8pt;" | man -s 2 kill
|}  on manuaalilehekülg käsu kill kohta sektsioonis 2.
Kui on kirjas man(3), siis number sulgudes näitab, millises manuaali sektsioonis viidatu paikneb.
== man lehekülje tüüpilised allosad [http://man7.org/linux/man-pages/man7/man-pages.7.html#section_dir] ==
Man lehtedel on ka oma kindel sisemine ülesehitus. Tüüpilise man lehekülje allosad (alati ei pruugi neid kõiki olemas olla): 
{| class="wikitable"
|+
|-
! osa !! kirjeldus
|-
|NAME || man-lehe nimi.
|-
|SYNOPSIS || Lühiülevaade käsu või funktsiooni kasutajaliidesest
|-
|CONFIGURATION || konfiguratsiooni detailid seadmele. See osa on tavaliselt ainult 4. sektsioonil.
|-
|DESCRIOTION || Annab täpsema ülevaate millega on tegu. Siin on ära toodud ka erinevad võimalused
|-
|OPTIONS || kirjeldab käsurea võimalusi, mida saab kasutada. See osa on tavaliselt ainult 1. ja 8. sektsiooni lehtedel.
|-
|EXIT STATUS || nimekiri kõigist võimalikest programmist väljumise tingimustest ja põhjustest. See osa on tavaliselt ainult 1. ja 8. sektsioonis.
|-
|ERRORS || Sektsioonide 2 ja 3 jaoks. Nimekiri väärtustest, mis võivad põhjustada vigasid.
|-
|ENVIRONMENT || Loetelu kõigist keskkonna muutujatest, mis mõjutavad programmi.
|-
|FILES || Loetelu kõigist failidest mida programm kasutab, näiteks konfiguratsiooni failid, startup failid ja failid mida programm
otseselt kasutab.
|-
|VERSIONS || Lühike ülevaade Linuxi kernelist või glibc versioonist, kus programm või funktsioon loodi või oluliselt muudeti.
|-
|BUGS || Loetelu piirangutest, teadaolevatest defektidest või ebamugavustest.
|-
|REPORTING BUGS || kellele vigadest teatada
|-
|EXAMPLE || Pakub mõne näite kirjeldamaks kuidas funktsiooni, faili või käsku kasutada.
|-
|AUTHORS || nimekiri dokumentatsiooni või programmi autoritest.
|-
|SEE ALSO || leheküljed, mida huvi korral lisaks veel vaadata
|-
|COPYRIGHT || man lehe ja programmi õigused
|}
|}


Line 88: Line 143:
1. Näitamaks informatisooni grep käsust:
1. Näitamaks informatisooni grep käsust:


man grep  
{|style="background:lightyellow;width:500px;margin:3px;border:1px solid lightgrey" align=centre
| style="padding:0px 0px 0px 80px;font-family:courier;font-size:8pt;" | man grep  
|}


2. Ainult oma süsteemi man failide pealkirjade otsimiseks:
2. Ainult oma süsteemi man failide pealkirjade otsimiseks:
 
{|style="background:lightyellow;width:500px;margin:3px;border:1px solid lightgrey" align=centre
man -f kde
| style="padding:0px 0px 0px 80px;font-family:courier;font-size:8pt;" | man -f kde
|}


3. man failidest konsooli otsimiseks:
3. man failidest konsooli otsimiseks:


man -k konsole
{|style="background:lightyellow;width:500px;margin:3px;border:1px solid lightgrey" align=centre
| style="padding:0px 0px 0px 80px;font-family:courier;font-size:8pt;" | man -k konsole
|}


4. „Kasutajakäskude sissejuhatuse“kuvamiseks :
4. „Kasutajakäskude sissejuhatuse“kuvamiseks :


man intro  
{|style="background:lightyellow;width:500px;margin:3px;border:1px solid lightgrey" align=centre
| style="padding:0px 0px 0px 80px;font-family:courier;font-size:8pt;" | man intro
|}


See on lühike sissejuhatus Linuxi käsurea kasutamisest.  
See on lühike sissejuhatus Linuxi käsurea kasutamisest.  
Line 106: Line 168:
5. Abi informatsioon mkdir käsu kohta:
5. Abi informatsioon mkdir käsu kohta:


man mkdir  
{|style="background:lightyellow;width:500px;margin:3px;border:1px solid lightgrey" align=centre
| style="padding:0px 0px 0px 80px;font-family:courier;font-size:8pt;" | man mkdir  
|}


6. Et kuvada manuaalilehekülg cp käsu kohta:
6. Et kuvada manuaalilehekülg cp käsu kohta:


man cp
{|style="background:lightyellow;width:500px;margin:3px;border:1px solid lightgrey" align=centre
| style="padding:0px 0px 0px 80px;font-family:courier;font-size:8pt;" | man cp
|}


7. man käsu manuaalilehekülje printimiseks:  
7. man käsu manuaalilehekülje printimiseks:  


man -t man  
{|style="background:lightyellow;width:500px;margin:3px;border:1px solid lightgrey" align=centre
 
| style="padding:0px 0px 0px 80px;font-family:courier;font-size:8pt;" | man -t man
|}
8. ls manuaal lehekülje kuvamiseks:  
8. ls manuaal lehekülje kuvamiseks:  
 
{|style="background:lightyellow;width:500px;margin:3px;border:1px solid lightgrey" align=centre
Man ls
| style="padding:0px 0px 0px 80px;font-family:courier;font-size:8pt;" | man ls
|}


9. Näitab kõiki saadaval olevaid manuaal lehekülgi mis sisaldavad manuali.  
9. Näitab kõiki saadaval olevaid manuaal lehekülgi mis sisaldavad manuali.  
Line 139: Line 208:
| style="padding:0px 0px 0px 80px;font-family:courier;font-size:8pt;" | man --help
| style="padding:0px 0px 0px 80px;font-family:courier;font-size:8pt;" | man --help
|}
|}
11. Crontabi failivormingute manuaali vaatamiseks:
{|style="background:lightyellow;width:500px;margin:3px;border:1px solid lightgrey" align=centre
| style="padding:0px 0px 0px 80px;font-family:courier;font-size:8pt;" | man 5 crontab
|}
== Alternatiivid ==
Kuigi kõigil olulisematel käskudel on olemas oma ''man'' lehekülg siis mõnikord pole neid näiteks piisavalt uuendatud, siis on kasulik kasutada ka alternatiive. Näiteks info-lehekülgi. ''info'' on programm dokumentatsiooni lugemiseks. Kui on saadaval nii info- kui ka man-leheküljed, on esimesed arvatavasti uuemad. Enamik rakendusi pakub siiski vaid ainult üht või teist, mitte mõlemat. [http://docs.kde.org/development/et/kde-runtime/khelpcenter/khelpcenter.pdf]
Veel võimalusi:
Manuaalilehekülgedelt süsteemikäskude ja võtmesõnade kohta info otsimiseks on olemas käsud:
''whatis'' -otsib täielikke sõnu
''apropos'' -leiab ka alamsõnu
Enamus käske tunnistab parameetrit --help. Selle abil kuvatakse lühiülevaade käsust ja tema parameetritest.
näiteks: ''ls --help'' -Käsu ''ls'' lühikirjedus ja parameetrid. [https://courses.cs.ut.ee/MTAT.08.006/2013_spring/uploads/Main/loeng1.2013k.pdf]
Kindlasti on kasulik kasutada ka erinevaid otsingumootoreid nagu näiteks kõigile tuntud http://www.google.com/
Ise arvan, et kui osata ''man''i kasutada ja teada, mida sealt otsida on see kiirem ja efektiivsem kui näiteks veebist otsima hakata.
== Kokkuvõte ==
Man-leheküljed on UNIX'i standardsed manuaalileheküljed, mida on kasutatud juba aastaid paljudes operatsioonisüsteemides. Need on väga põhjalikud ja seetõttu üks parimatest kohtadest kust hankida infot UNIX'i käskude ja rakenduste kohta.
Kui veidi uurida ning endale süsteem selgeks teha, on man-lehekülg hea nii alagatele õppimisel, kui ka näiteks elukutselistel administraatoritel nende tööülesannete täitmisel.
== Kasutatud materjal ==
1. http://lynchjim.com/doc/kde/HTML/et/kubuntu/cli/man-help.html
2. http://www.techonthenet.com/unix/basic/man.php
3. http://viki.pingviin.org/Man
4. http://linux.about.com/od/commands/l/blcmdl1_man.htm
5. https://en.wikipedia.org/wiki/Man_page#Manual_sections
6. http://publib.boulder.ibm.com/infocenter/pseries/v5r3/index.jsp?topic=/com.ibm.aix.cmds/doc/aixcmds3/man.htm
7. http://www.linfo.org/man.html
8. http://man7.org/linux/man-pages/man7/man-pages.7.html#section_dir
9. http://docs.kde.org/development/et/kde-runtime/khelpcenter/khelpcenter.pdf
10. https://courses.cs.ut.ee/MTAT.08.006/2013_spring/uploads/Main/loeng1.2013k.pdf
----
Laura Laane A21
01.01.2014

Latest revision as of 20:48, 2 January 2014

Käsk man on üks tähtsamaid käske Linuxi käsureal. Seda kasutatakse vormindamiseks ja man online lehtede kuvamiseks. Selle abil on võimalik lugeda abiinfot nii süsteemikäskude, häälestusfailide kui ka suuremate programmide kohta. Iga Linuxi käsu ja peaaegu iga rakenduse jaoks on man fail.[1]

Süntaks

Et lugeda manuaalilehekülge mingi Unix'i käsu kohta on süntaks järgmine: [2]

man [suvandid] [ [sektsioonid] teemad]

Man lehtede peamised suvandid

Suvand tähendus
-d Vigade kõrvaldamiseks(debug)
-F MANPATH kataloogide otsimiseks
-f files esitab kokkuvõtte iga faili jaoks.
-k keywords näitab ridu mis sisaldavad antud sõna
-F näitab ainult esimest sobivat rida
-w või --path näitab faili asukohta
-h prindib üherealise abisõnumi ja väljub
-c näitab manuaali informatisooni kasutades programmi cat


Man käsuga seotud sektsioonid [3]

Man käsuga saadav info on jagatud sisu järgi erinevatesse sektsioonidesse.

Sektsioon tähendus
1 Kasutaja käsud
2 Süsteemsed kutsungid
3 Alamfunktsioonid
4 Seadmed
5 Failide vorminugd
6 Mängud
7 Muud
8 Süsteemid administreerimine
9 Kernel
n Uus
l Kohalik
p Avalik
o Vana


Mõne käsu jaoks on olemas mitu erinevat manuaalilehekülge. Et leida endale sobiv tuleks käsku täpsustada sektsiooni numbriga. Näiteks

man kill

on manuaalilehekülg käsu kill kohta

man -s 2 kill

on manuaalilehekülg käsu kill kohta sektsioonis 2.

Kui on kirjas man(3), siis number sulgudes näitab, millises manuaali sektsioonis viidatu paikneb.

man lehekülje tüüpilised allosad [4]

Man lehtedel on ka oma kindel sisemine ülesehitus. Tüüpilise man lehekülje allosad (alati ei pruugi neid kõiki olemas olla):

osa kirjeldus
NAME man-lehe nimi.
SYNOPSIS Lühiülevaade käsu või funktsiooni kasutajaliidesest
CONFIGURATION konfiguratsiooni detailid seadmele. See osa on tavaliselt ainult 4. sektsioonil.
DESCRIOTION Annab täpsema ülevaate millega on tegu. Siin on ära toodud ka erinevad võimalused
OPTIONS kirjeldab käsurea võimalusi, mida saab kasutada. See osa on tavaliselt ainult 1. ja 8. sektsiooni lehtedel.
EXIT STATUS nimekiri kõigist võimalikest programmist väljumise tingimustest ja põhjustest. See osa on tavaliselt ainult 1. ja 8. sektsioonis.
ERRORS Sektsioonide 2 ja 3 jaoks. Nimekiri väärtustest, mis võivad põhjustada vigasid.
ENVIRONMENT Loetelu kõigist keskkonna muutujatest, mis mõjutavad programmi.
FILES Loetelu kõigist failidest mida programm kasutab, näiteks konfiguratsiooni failid, startup failid ja failid mida programm

otseselt kasutab.

VERSIONS Lühike ülevaade Linuxi kernelist või glibc versioonist, kus programm või funktsioon loodi või oluliselt muudeti.
BUGS Loetelu piirangutest, teadaolevatest defektidest või ebamugavustest.
REPORTING BUGS kellele vigadest teatada
EXAMPLE Pakub mõne näite kirjeldamaks kuidas funktsiooni, faili või käsku kasutada.
AUTHORS nimekiri dokumentatsiooni või programmi autoritest.
SEE ALSO leheküljed, mida huvi korral lisaks veel vaadata
COPYRIGHT man lehe ja programmi õigused

man käsuga seotud failid

1. /etc/manpath.config

man-db konfiguratsiooni fail

2. /usr/share/man

globaalne manuaal lehekülje hierarhia.

3. /usr/share/man/index.(bt|db|dir|pag)

traditsiooniline globaalse indeksiga andmebaasi vahemälu

Näited

1. Näitamaks informatisooni grep käsust:

man grep

2. Ainult oma süsteemi man failide pealkirjade otsimiseks:

man -f kde

3. man failidest konsooli otsimiseks:

man -k konsole

4. „Kasutajakäskude sissejuhatuse“kuvamiseks :

man intro

See on lühike sissejuhatus Linuxi käsurea kasutamisest.

5. Abi informatsioon mkdir käsu kohta:

man mkdir

6. Et kuvada manuaalilehekülg cp käsu kohta:

man cp

7. man käsu manuaalilehekülje printimiseks:

man -t man

8. ls manuaal lehekülje kuvamiseks:

man ls

9. Näitab kõiki saadaval olevaid manuaal lehekülgi mis sisaldavad manuali.

man -a intro

10. vormindab manuaal lehekülje viidates 'alias' ja suunab selle läbi toru printerisse nimega ps.

man -t alias | lpr -Pps

Peaaegu kõik käsud tunnistavad võtit -h (või --help), mis annab käsu lühikese kasutusjuhendi ja selle võtmed ning seejärel väljub käsuviipa. Selle nägemiseks trüki:

man -h

või

man --help

11. Crontabi failivormingute manuaali vaatamiseks:

man 5 crontab

Alternatiivid

Kuigi kõigil olulisematel käskudel on olemas oma man lehekülg siis mõnikord pole neid näiteks piisavalt uuendatud, siis on kasulik kasutada ka alternatiive. Näiteks info-lehekülgi. info on programm dokumentatsiooni lugemiseks. Kui on saadaval nii info- kui ka man-leheküljed, on esimesed arvatavasti uuemad. Enamik rakendusi pakub siiski vaid ainult üht või teist, mitte mõlemat. [5]

Veel võimalusi:

Manuaalilehekülgedelt süsteemikäskude ja võtmesõnade kohta info otsimiseks on olemas käsud: whatis -otsib täielikke sõnu apropos -leiab ka alamsõnu

Enamus käske tunnistab parameetrit --help. Selle abil kuvatakse lühiülevaade käsust ja tema parameetritest.

näiteks: ls --help -Käsu ls lühikirjedus ja parameetrid. [6]

Kindlasti on kasulik kasutada ka erinevaid otsingumootoreid nagu näiteks kõigile tuntud http://www.google.com/

Ise arvan, et kui osata mani kasutada ja teada, mida sealt otsida on see kiirem ja efektiivsem kui näiteks veebist otsima hakata.

Kokkuvõte

Man-leheküljed on UNIX'i standardsed manuaalileheküljed, mida on kasutatud juba aastaid paljudes operatsioonisüsteemides. Need on väga põhjalikud ja seetõttu üks parimatest kohtadest kust hankida infot UNIX'i käskude ja rakenduste kohta.

Kui veidi uurida ning endale süsteem selgeks teha, on man-lehekülg hea nii alagatele õppimisel, kui ka näiteks elukutselistel administraatoritel nende tööülesannete täitmisel.

Kasutatud materjal

1. http://lynchjim.com/doc/kde/HTML/et/kubuntu/cli/man-help.html

2. http://www.techonthenet.com/unix/basic/man.php

3. http://viki.pingviin.org/Man

4. http://linux.about.com/od/commands/l/blcmdl1_man.htm

5. https://en.wikipedia.org/wiki/Man_page#Manual_sections

6. http://publib.boulder.ibm.com/infocenter/pseries/v5r3/index.jsp?topic=/com.ibm.aix.cmds/doc/aixcmds3/man.htm

7. http://www.linfo.org/man.html

8. http://man7.org/linux/man-pages/man7/man-pages.7.html#section_dir

9. http://docs.kde.org/development/et/kde-runtime/khelpcenter/khelpcenter.pdf

10. https://courses.cs.ut.ee/MTAT.08.006/2013_spring/uploads/Main/loeng1.2013k.pdf



Laura Laane A21

01.01.2014