Man (Unix)
omul este o comandă care mai Unix si Unix- ului de operare sisteme au, pentru a afișa așa-numitele pagini man (prescurtarea de la „pagini manual“) sau pagini manual, ceea ce reprezintă o documentație on - line extensivă folosită de aproape toate distribuțiile GNU / Linux .
Istorie
Manualul programatorului UNIX a fost publicat pentru prima dată pe 3 noiembrie 1971 [1] . Cu toate acestea, paginile manuale nu au fost disponibile online până la cea de -a șaptea ediție UNIX din 1979 . La acea vreme, disponibilitatea documentației online prin intermediul sistemului de pagini de manual era văzută ca un mare pas înainte. În zilele noastre, practic fiecare aplicație de linie de comandă Unix vine cu propria sa pagină manuală , iar absența lor este percepută în general ca o indicație a unui software de calitate scăzută. Unele proiecte, cum ar fi Debian , se îngrijorează și despre scrierea paginilor de manual pentru acele programe și comenzi care nu le au.
Caracteristici
Fiecare pagină manual este un document explicativ al unei comenzi, funcții sau format de fișier sau mai multe, care descrie pe scurt subiectul și poate conține referințe la alte pagini.
Diversele pagini manual sunt grupate în secțiuni omogene după tipul de subiect acoperit (de exemplu, există o secțiune pentru comenzile utilizatorului, una pentru apeluri de sistem , una pentru formate de fișiere de configurare și altele).
Locație
Paginile manual sunt de obicei disponibile în limba engleză, deși traducerile sunt disponibile pentru unele sisteme.
Sintaxă
Pentru a accesa o pagină manuală puteți utiliza comanda într-un shell de text
man page_name
de exemplu „ man ftp ”.
În mod tradițional, referirea la o pagină manuală este exprimată folosind notația „ nume_pagină ( secțiune ) ”, de exemplu ftp (1) sau socket (2) .
Același nume de pagină manuală poate apărea în mai multe secțiuni ale manualului: acest lucru se întâmplă atunci când numele unui apel de sistem , comandă de utilizator sau pachet macro are același nume și, prin urmare, intră în conflict unul cu celălalt. Două exemple sunt man (1) și man (7) , sau exit (1) și exit (3) .
Sintaxa pentru accesarea paginilor man dintr-o secțiune a manualului, alta decât cea implicită, variază între diferitele implementări ale man : în majoritatea sistemelor Unix și Unix , inclusiv Linux și diverse sisteme BSD , este utilizată pentru a indica secțiunea mai întâi. a numelui paginii. De exemplu, sintaxa pentru a citi pagina referitoare la printf (3) este:
man 3 printf
Există, de asemenea, o pagină pentru comanda man , care este vizibilă prin comanda man .
Secțiunile manualului
Setul de pagini man este de obicei organizat în opt secțiuni numerotate de la 1 la 8. De exemplu, pe Unix BSD și Linux :
| Secțiune | Descriere |
|---|---|
| 1 | Comenzi generale |
| 2 | Apeluri de sistem |
| 3 | Funcții standard de bibliotecă C. |
| 4 | Fișiere speciale (de obicei blochează dispozitivele și dispozitivele de caractere găsite în directorul / dev ) și driverele |
| 5 | Format fișier și convenții |
| 6 | Jocuri și salvatoare de ecran |
| 7 | Diverse |
| 8 | Comenzi și demoni de administrare a sistemului |
UNIX System V folosește o schemă de numerotare similară, cu excepția secțiunii 4, care este pentru formatele de fișiere, a secțiunii 5, care conține diverse, și a secțiunii 7, care este pentru fișierele speciale.
Unele sisteme au, de asemenea, câteva dintre următoarele secțiuni disponibile:
| Secțiune | Descriere |
|---|---|
| 0 | Fișier antet bibliotecă standard C |
| 9 | Rutina nucleului |
| n | Comenzi și cuvinte cheie în limbajul Tcl / Tk |
| X | Sistemul X Window |
Secțiunile sunt împărțite în continuare în subsecțiuni folosind un sufix cu o singură literă, cum ar fi subsecțiunea 3C pentru apelurile de bibliotecă C și subsecțiunea 3M pentru biblioteca de matematică. O consecință a acestui fapt este că paginile din secțiunea 8 (pentru comenzile de administrare a sistemului) se referă uneori la subsecțiunea 1M din secțiunea de comenzi generale.
Alte sufixe au un sens general între secțiuni:
| Subsecțiune | Descriere |
|---|---|
| p | Specificații POSIX |
| X | documentație pentru sistemul X Window |
Aspect
Toate paginile man urmează un aspect comun, care este optimizat pentru prezentarea textului simplu în ASCII - posibil fără nici o formă de evidențiere sau verificare a fontului. Următoarele titluri de secțiune sunt aproape întotdeauna prezente și sunt întotdeauna în această ordine:
- NUME - Numele comenzii sau funcției, urmat de o scurtă descriere pe o singură linie a ceea ce face comanda.
- SINOPSI - În cazul unei comenzi, oferă o descriere a modului de executare și a opțiunilor pe care le puteți specifica. Pentru funcțiile de programare există o listă a parametrilor necesari și în care fișier antet sunt definiți. Pentru utilizatorii experimentați, aceasta poate fi toată documentația de care au nevoie.
- DESCRIERE - O descriere textuală a modului în care funcționează comanda sau funcția.
- EXEMPLE - Câteva exemple de utilizare mai frecventă
- VEZI ȘI - O listă de comenzi sau funcții similare sau conexe.
Alte secțiuni pot fi, de asemenea, prezente, dar nu sunt bine standardizate. Exemple obișnuite sunt: OPȚIUNI, STARE DE IEȘIRE, MEDIU, BUGURI CUNOSCUTE, FIȘIERE, AUTOR, BUGURI DE RAPORTARE și DREPT DE AUTOR.
Format
Formatul utilizat pentru scrierea unei pagini man este cel al sistemului troff , cu o structură de pachete macro (orientată către aspect) sau alternativ mdoc (orientată către semantică). Acest lucru face posibilă obținerea de versiuni PostScript sau PDF , sau diferite alte formate, dintr-o pagină, atât pentru vizualizare, cât și pentru tipărire (deși majoritatea utilizatorilor preferă în continuare interfața textuală pentru viteza de consultare).
Alternative
Deși au fost create de-a lungul timpului alternative la sistemul de pagini man , puține dintre ele s-au bucurat de o popularitate comparabilă, cu posibila excepție a sistemului de informații al proiectului GNU , care este un prim sistem de hipertext cu care se documentează oficial proiectul.
În ciuda popularității paginilor manual , faptul de a furniza o pagină individuală pentru fiecare aplicație, împreună cu alte defecte datorate efortului de a menține sistemul de management simplu, au motivat dezvoltarea unor sisteme alternative de documentare, dintre care unul este, de exemplu, sistemul de informații menționat anterior.
Până în prezent, majoritatea aplicațiilor Unix echipate cu GUI și, în special, cele realizate pentru shell-urile grafice GNOME și KDE , furnizează documentația utilizatorului final în HTML sau alte sisteme de hipertext și pot porni automat vizualizatorii necesari pentru a-l putea consulta. .
Notă
- ^ (EN) Ken Thompson; Dennis M. Ritchie, Manualul programatorului Unix , pe cm.bell-labs.com , 3-11-1971. Adus 22/05/2008 (arhivat din original la 18 mai 2008) .
Elemente conexe
linkuri externe
- Pagina manuală Linux , pe die.net .
- Arhive de pagini de manuale în italiană , traducere prin proiectul ILDP, coordonată de PLUTO
Colecții de pagini de manual
- (EN) a paginilor manualului NetBSD de pe man.netbsd.org.
- ( EN ) Pagini manuale UNIX on-line , pe unixhelp.ed.ac.uk . Adus la 26 februarie 2007 (arhivat din original la 30 iunie 2007) .
- ( EN ) Pagini Man Linux , pe man.he.net .
- ( RO ) Pagini Man Hypertext Debian , vizualizator pagini man Debian , dintre care multe sunt disponibile și în italiană
- ( RO ) Unix Man Pages / Linux Man Pages Arhivat 15 iulie 2007 la Internet Archive , conține mii de pagini man pentru multe versiuni de Unix și Linux
- ( EN ) Pagini Man Hypertext FreeBSD , pe freebsd.org .
- ( EN ) Pagini de manual OpenBSD , pe openbsd.org .
- ( EN ) Paginile manualului DragonFlyBSD , la leaf.dragonflybsd.org .
- ( EN ) Manualul Planului 9 - Volumul 1 , la plan9.bell-labs.com .
