Lexicon Linux — Anatomia unei pagini de om
Publicat: 2016-11-01
Biți scurti: Paginile de manual și documentația software-ului pot fi destul de groase și dificile pentru orice începător fără convențiile criptice legate de orice tip de paranteză și paranteză. Aici, vom încerca să reducem complexitatea paginilor de manual Linux și să le facem mai ușor de înțeles.
NUME
Mai întâi este titlul numelui, iar asta o rezumă. Această secțiune include numele utilitarului, precum și o scurtă descriere.
REZUMAT
Există diferite grade de lizibilitate de la o pagină de manual la o pagină de manual, dar un lucru este sigur, partea cea mai grea este de obicei descifrarea unui rezumat păros. Există mai multe convenții pentru a indica informațiile necesare pentru orice comandă dată. Aceste convenții constau din diferite paranteze și paranteze, precum și din alte forme de notație. Toate aceste convenții diferite pot fi extrem de confuze pentru un începător și descurajatoare pentru cineva care are experiență, dar nu este versat în arta manualelor. Mai jos vom împărți galimatia în reguli digerabile.
| încurajat | Tastați exact așa cum se arată. |
| cursiv sau subliniat | Înlocuiți cu argumentul adecvat. |
| [-abcxyz] | Toate steagurile dintre paranteze drepte sunt opționale. |
| -a | -b | Opțiunile separate prin conducte nu pot fi utilizate împreună. |
| <obligatoriu> | Argument obligatoriu, de obicei găsit în descrierile opțiunilor. |
| {da nu} | Opțiuni limitate, doar cele specificate vor funcționa. |
| … | Argumentele urmate de elipse pot fi repetate. |
Aceste reguli sunt destul de simple, dar devin mai dificile și chiar intimidante atunci când sunt folosite în definiții lungi de funcții, mai ales când sunt imbricate. Deci, vom arunca o privire la unele cuibări de mai jos pentru a construi ceea ce am defalcat.
tar {A|c|d|r|t|u|x}[GnSkUWOmpsMBiajJzZhPlRvwo] [ ARG …]
Comanda tar are multe opțiuni. Vedem numele comenzii tar în aldine, deoarece ar trebui să fie introdus așa cum se arată. Apoi vedem bretelele deschise cu opțiuni separate prin țevi care indică faptul că suntem limitați la acestea și trebuie să alegem doar una. Urmează steaguri opționale, putem folosi orice număr, totuși, s-ar putea să nu funcționeze toate împreună, citirea în continuare a paginii de manual va face lumină asupra eventualelor conflicte potențiale de opțiuni. Și, în sfârșit, avem argumentul repetabil, în cazul tar, acesta pentru fișierul (fișierele) cu care operați.
su [opțiuni] [-] [ utilizator [ argument …]]
Din nou, vedem su bold pentru că este numele comenzii. În al doilea rând, vedem că nu sunt de fapt specificate steaguri, doar că sunt opționale. În al treilea rând, există un singur steag care este specificat, dar și acesta este opțional. În sfârșit, vedem un argument opțional care este repetabil în interiorul unui argument opțional. Acum, ceea ce părea foarte misterios are mai mult sens.
whois [{-h|–host } HOST ] [{-p|–port} PORT ] [-abBcdGHKlLmMrRx] [-g SOURCE:FIRST-LAST ] [-i ATTR [, ATTR ]…] [-s SOURCE [, SURSA ]…] [-T TIP [, TIP ]…] [–verbose] OBIECTUL
Acesta este unul deosebit de dens. Copiați-l în editorul dvs. de text preferat și adăugați câteva spații suplimentare acolo dacă vă ajută să îl citiți. După ce ați scanat peste aceasta, ar trebui să începeți să vedeți câteva modele. Porțiunile gazdă și port folosesc aceeași formatare pentru forma scurtă și lungă a opțiunii, urmată de argumentul pentru acea opțiune, în timp ce ambele sunt ele însele opționale. Apoi vedem șirul de steaguri opționale. Următorul element despre surse de la prima la ultima este sintaxa așteptată de whois, care este explicată mai târziu în pagina de manual. Acum vedem acest triplet de steaguri opționale care iau fie un singur argument, fie argumente opționale repetate, acesta este genul de combinare a convențiilor care poate fi foarte greu de înțeles pe deplin la început. În cele din urmă, există opțiunea verbosă și obiectul (gazdă/domeniul).
Și așa se citește un sinopsis al paginii de manual. Există alte câteva convenții, dar sunt mult prea obscure pentru a fi acoperite în acest articol.
DESCRIERE
Acesta este, în general, locul în care este subliniată utilizarea prevăzută a programului sau utilitarului. Unele manuale vor fi mult mai detaliate la acest titlu decât altele.
OPȚIUNI
Vă amintiți toate acele steaguri și diferite argumente care ar putea fi opționale sau obligatorii? Aici li se explică toate. Există, de obicei, informații bune aici și deseori aici veți găsi convenția <argument>, care indică faptul că un semnal dat necesită un argument corespunzător. Uneori veți descoperi că opțiunile vor fi în porțiunea de descriere deoarece nu există o regulă strictă care să definească paginile de manual, doar convenții și voința de a respecta standardele.
EXEMPLE
Aceasta este una dintre cele mai utile piese care, din păcate, nu este inclusă în toate manualele. Veți descoperi, de asemenea, că cantitatea de informații și numărul de exemple variază semnificativ și nu toate exemplele ajută efectiv la utilizarea comenzii.
În plus, veți găsi în mod regulat secțiuni pentru autor, informații despre drepturile de autor, raportarea erorilor și a se vedea, de asemenea, (apropos).
Dincolo de aceasta, există secțiunile definite formal ale paginilor de manual, așa cum sunt definite mai jos.
| 1 | Programe executabile sau comenzi shell |
| 2 | Apeluri de sistem (funcții furnizate de nucleu) |
| 3 | Apeluri de bibliotecă (funcții în bibliotecile de programe) |
| 4 | Fișiere speciale (se găsesc de obicei în /dev) |
| 5 | Formate de fișiere și convenții de exemplu /etc/passwd |
| 6 | Jocuri |
| 7 | Diverse (inclusiv pachete macro și convenții), de exemplu man(7), groff(7) |
| 8 | Comenzi de administrare a sistemului (de obicei numai pentru root) |
| 9 | Rutine kernel (nu se găsesc în mod normal pe Linux) |
Multe comenzi nu au manuale în mai mult de o secțiune, dar pentru cele care au sau pentru unele care ar putea fi denumite ambiguu, puteți specifica secțiunea ca în exemplul de mai jos.
Comenzile nu sunt singurele lucruri care au manuale, așa cum puteți vedea din secțiunile disponibile. Apelurile de sistem, fișierele de configurare și dispozitivele speciale pot avea, la fel de probabil, o pagină de manual corespunzătoare. Cantitatea de informații despre o instalare tipică Linux doar în paginile de manual este uimitoare și același lucru se aplică și altor sisteme de operare open source asemănătoare UNIX.
Dacă descoperiți că pagina de manual nu este suficientă și tot nu înțelegeți o comandă, verificați întotdeauna online pentru că mulți oameni oferă explicații mai amănunțite ale anumitor instrumente, dar, de asemenea, multe distribuții au propriile pagini de manual pentru diferite pachete software. Odată ce ați constatat că vă simțiți confortabil cu o bucată de software, dar încă simțiți că manualul este lipsit, puteți oricând să contribui scriindu-vă propriul proiect și depunând-o la proiectul respectiv. Documentația este adesea partea cea mai neglijată a proiectelor software, așa că, chiar dacă nu poți scrie cod, poți scrie manuale, articole Wiki și tutoriale pentru a-i ajuta pe alții.
Acum că știi anatomia unei pagini de manual, nu mai ai nicio scuză decât să faci RTFM (și asta e să citești manualul gratuit pentru cei sub 18 ani) ;)
Citește și: Lexicon Linux: Utilizați comanda Watch pentru a rula o comandă la fiecare X secunde