Abi leidmine: man, --help ja info

Kui uus käsk ei tööta või selle mõte ei ole selge, siis esimene mõistlik reaktsioon ei ole juhuslik veebileht, vaid käsu enda abi.

Esimene abirada

Kui käsk on võõras, liigu tavaliselt selles järjekorras. Nii saad kõigepealt kohaliku, sinu süsteemi kohta käiva info.

Hea harjumus on otsida abi kõigepealt käsu enda dokumentatsioonist, mitte loota juhuslikule veebinäitele.

Tüüpilised algaja vead

• ehmatatakse ära, kui man “võtab terminali üle”
• arvatakse, et --help peab kõigil käskudel töötama täpselt sama moodi
• minnakse kohe veebi, kuigi kohalik abi annaks vastuse kiiremini

1. Käsu manuaal: man

Kõige tavalisem kuju on:

man ls

See avab käsu manuaali.

Mida seal teha saab

• Space liigub järgmise lehe peale
• b liigub tagasi
• /muster otsib tekstist
• q väljub

Näited

man ls
man grep
man less

Kui sa ei tea veel kõiki detaile, siis piisab alguses täiesti sellest, et loed manuaali alguse läbi ja otsid üles kõige tavalisemad valikud.

2. Lühike abi: --help

Paljud käsud toetavad lühikest abi kujul:

ls --help
grep --help

See on hea siis, kui tahad kiirelt näha:

• milliseid lippe käsk toetab
• milline on põhisüntaks
• mis järjekorras argumendid käivad

--help on eriti mugav siis, kui sa ei taha kohe pikka manuaali lugema minna.

3. Kui man puudub või --help ei tööta

Mõnes minimaalses süsteemis, konteineris või eriprogrammis võib juhtuda, et:

• man ei ole paigaldatud
• käsk ei tunne kuju --help
• abi tuleb hoopis mõne teise võtmega

Siis tasub liikuda nii:

1. proovi kõigepealt käsk --help
2. kui see ei tööta, vaata, kas dokumentatsioon või veateade vihjab kujule -h
3. kasuta whatis või apropos, et leida õige käsu nimi
4. kui vajadus jääb püsima, tule hiljem tagasi paketihalduri peatüki juurde ja paigalda puuduv dokumentatsioon

Oluline mõte on lihtne: kui üks abivõte ei tööta, siis see ei tähenda veel, et abi üldse puudub.

4. -h, --help ja -H ei ole sama asi

Kõik käsud ei kasuta samu võtmeid.

• --help on levinud GNU stiil
• -h tähendab mõnes käsus abi, mõnes käsus midagi muud
• -H tähendab sageli hoopis teist käitumist

Seepärast ei maksa eeldada, et -h on alati “help”.

Praktiline rusikareegel:

• proovi kõigepealt man käsk
• seejärel vaata käsk --help

5. Kui käsu nime ei mäleta

Mõnikord tead teemat, aga mitte käsku. Siis on abiks:

whatis ls
apropos archive

Vahe nende vahel

• whatis käsk annab ühe lühikirjelduse tuntud käsu kohta
• apropos sõna otsib märksõna järgi seotud käske

Näited:

whatis awk
apropos copy
apropos archive

6. GNU info-dokumendid

Mõne suurema GNU tööriistakogumi puhul kohtad ka käsku:

info coreutils

See ei ole alguses kõige tähtsam tööriist, aga hea on teada, et ta on olemas.

info on kõige kasulikum siis, kui:

• man tundub liiga lühike
• teema koosneb tervest tööriistaperest
• vajad sügavamat dokumentatsiooni

7. Väike praktiline rada

Kui sa ei mäleta, kuidas tar töötab, siis hea järjekord on:

man tar
tar --help
apropos archive

Siin:

1. man tar annab tervikpildi
2. tar --help näitab lühikest meeldetuletust
3. apropos archive aitab leida ka teisi samasse teemasse kuuluvaid käske

Minitest

1. Ava man less.
2. Kontrolli, kas käsk tar toetab kuju --help.
3. Leia apropos abil mõni pakkimisega seotud käsk.
4. Vaata käsu ls lühikirjeldust käsuga whatis.

Lisalugemine

Selle teema usaldusväärsemad viited leiad lisast Lisa E: usaldusväärsed viited ja lisalugemine.