Dark Mode

Ves al contingut

Man (Unix)

De la Viquipedia, l'enciclopedia lliure
Man
Tipusutilitat UNIX
Fonts de codi

man es un programa dels sistemes Unix que es fa servir per a documentar altres programes. Per extensio, tambe es fa servir en els sistemes operatius basats en Unix com es ara el GNU/Linux. Aquest comandament es basa en groff.

Tot i esser el sistema mes emprat per a la documentacio en sistemes Unix, resulta mes util el comandament info, que te funcionalitats (com es ara els enllacos) que fan mes amigable el seu us i permet consultar documentacio relacionada.

Funcionament

[modifica]

man es un comandament que es fa servir des de la consola o terminal. La majoria d'aplicacions estan documentades en un arxiu man accessible amb el comandament

man [nom de l'aplicacio]

Per exemple, per saber com fer servir el comandament man cal escriure en la linia de comandament:

man man

i es mostrara tota la documentacio disponible.

Algunes aplicacions tenen la seva documentacio distribuida en seccions (vegeu mes endavant); en aquest cas, s'indicara les seccions disponibles amb missatges com man(1) i man(7) en el cas que hi hagi documentacio del comandament man de les seccions 1 i 7. Per accedir a una seccio concreta cal fer servir el comandament

man 3 printf

Seccions

[modifica]

Els manuals estan dividits en vuit seccions numerades, organitzades (segons la funcionalitat del programa documentat) de la seguent manera (en els sistemes operatius BSD, Unix i GNU/Linux):

Seccio Descripcio
1 Comandaments Generals
2 Crides al sistema
3 Biblioteques C de funcions
4 Fitxers especials (fitxers de dispositius, localitzat a /dev) i controladors de dispositius
5 Formats de fitxers i convencions
6 Jocs i salvapantalles
7 Divers
8 Comandes d'administracio del sistema i dimonis

En alguns sistemes tambe estan disponibles les seguents seccions:

Seccio Descripcio
0 Arxius de capcalera de la biblioteca estandard de C
9 Rutines del Kernel
n Tcl/Tk
x X Window System

Arxius man

[modifica]

Els arxius man son arxius de text que contenen la documentacio sobre el programa. De manera semblant als arxius HTML, en aquests arxius es fan servir etiquetes (un llenguatge de marques) que el programa man fa servir per mostrar en pantalla el text. Aqui teniu un exemple curt d'arxiu man:

>\n.SH USAGE\n<>\n.SH SEE ALSO\n<>\n.SH AUTHOR\n<>\n"}}">.SH NAME
<< aqui el nom del programa>>
.SH SYNOPSIS
<>
.SH "DESCRIPTION"
<
.SH OPTIONS
<>
.SH USAGE
<>
.SH SEE ALSO
<>
.SH AUTHOR
<>

Les marques de llenguatge tenen l'estructura <<.comanda>>. Algunes de les comandes son:

  • .SH text d'encapcalament crea una seccio amb el text com encapcalament.
  • .TP inicia una llista de codis d'error. En aquest cas, l'estructura es
>\n. I <>\n"}}">.TP
.B <>
. I <>
  • Diverses comandes de format del text: .B, .R, .I i .S per negreta, roman, italica i petita. Poden combinar-se per obtenir negreta amb italica (.BI) o d'altres combinacions.

Una vegada redactat l'arxiu, es comprimeix en un arxiu .gz que es el que fara servir l'ordre man per mostrar la documentacio en pantalla.

Hi ha programari que facilita la creacio dels arxius man, com es ara help2man.

Bibliografia

[modifica]
  • linuxmanpages.com. <<man>>, 1995. [Consulta: 10 desembre].
  • Jens Schweikhardt. <<THE LINUX MAN-PAGE-HOWTO>>, 2002. [Consulta: 14 desembre].
  • gnu.org. <<help2man>>. [Consulta: 14 desembre].

Enllacos externs

[modifica]

Viccionari