Provided by:
man-db_2.6.1-2_i386 
NOMBRE
man - una interfaz de los manuales de referencia electronicos
SINOPSIS
man [-c|-w|-tZT dispositivo] [-adhu7V] [-m sistema[,...]] [-L locale]
[-p cadena] [-M ruta] [-P paginador] [-r prompt] [-S lista] [-e
extension] [[secci'on] pagina ...] ...
man -l [-7] [-tZT dispositivo] [-p cadena] [-P paginador] [-r prompt]
fichero ...
man -k [-M ruta] palabra_clave ...
man -f [-M ruta] pagina ...
DESCRIPCI'ON
man es el paginador del manual del sistema. Las p'aginas usadas como
argumentos al ejecutar man suelen ser normalmente nombres de programas,
utiles o funciones. La p'agina de manual associada con cada uno de esos
argumentos es buscada y presentada. Si la llamada da tambien la
secci'on, man buscara solo en dicha secci'on del manual. Normalmente, la
busqueda se lleva a cabo en todas las secciones de manual disponibles
segun un orden predeterminado, y solo se presenta la primera p'agina
encontrada, incluso si esa p'agina se encuentra en varias secciones.
La siguiente tabla muestra los numeros de secci'on del manual y los
tipos de paginas que contienen.
1 Programas ejecutables y guiones del interprete de ordenes
2 Llamadas del sistema (funciones servidas por el nucleo)
3 Llamadas de la biblioteca (funciones contenidas en las bibliotecas
del sistema)
4 Ficheros especiales (se encuentran generalmente en /dev)
5 Formato de ficheros y convenios p.ej. I/etc/passwd
6 Juegos
7 Paquetes de macros y convenios p.ej. man(7), groff(7).
8 Ordenes de admistracion del sistema (generalmente solo son para
root)
9 Rutinas del nucleo [No es estandar]
n nuevo [obsoleto]
l local [obsoleto]
p publico [obsoleto]
o viejo [obsoleto]
Una p'agina de manual tiene varias partes.
Estas estan etiquetadas como NOMBRE, SINOPSIS, DESCRIPCI'ON, OPCIONES,
FICHEROS, V'EASE TAMBI'EN, BUGS, y AUTOR.
En la seccion SINOPSIS se siguen los siguientes convenios que pueden
servir de guia para otras secciones.
texto en negrita debe teclear esto exactamente.
texto en cursiva reemplace esto por el argumento apropiado.
[-abc] uno o todos los argumentos entre corchetes son
opcionales.
-a|-b las opciones separadas por | no pueden usarse
conjuntamente.
argumento ... argumento es repetible.
[expresi'on] ... la expresi'on entre corchetes completa es repetible.
El ejemplo del empleo de la orden o funcion debe recogera todos los
posibles usos. En algunos casos es recomendable ilustrar algunos usos
exclusivos como se puede ver en la SINOPSIS de esta pagina de manual.
EJEMPLOS
man ls
Presenta la pagina de manual del elemento (programa) ls.
man -a intro
Presenta, secuencialmente, todas las paginas de intro disponibles
en el manual. Entre pagina y pagina se puede decidir saltar a la
siguiente o salir del paginador completamente.
man -t alias | lpr -Pps
Formatea la pagina de manual referenciada por `alias', generalmente
una pagina de manual de tipo shell, usando el formato
predeterminado troff o groff y redirige la salida a la impresora
llamada ps. La salida predeterminada de groff generalmente es
PostScript. man --help deberia informarle de que procesador esta
siendo usado con la opcion -t
man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi
Esta orden descomprime y formatea el fichero fuente nroff de la
pagina de manual ./foo.1x.gz y lo convierte en un fichero con
formato independiente de dispositivo (dvi). Es necesario usar la
redireccion pues la opcion -T dirige la salida al stdout sin
paginador. La salida puede verse mediante un programa como xdvi o
puede incluso convertirse al formato PostScript usando un programa
como dvips.
man -k printf
Busca la palabra clave printf entre las descripciones breves y las
paginas de manual y presenta todas las que casen.
man -f smail
Busca las paginas de manual referenciadas por smail e imprime la
descripcion breve de las que encuentre.
DESCRIPCI'ON DETALLADA
Existen muchas opciones en man cuyo objeto es dar la mayor flexibilidad
posible al usuario. Se puede cambiar la ruta, el orden de las
secciones, el procesador de salida y otras propiedades y operaciones
descritas a continuacion.
Si se activan, varias variables de entorno son interrogadas para
determinar el modo en que opera man. Se puede activar la variable
`conjunta' $MANOPT asignandole cualquier cadena en formato de linea de
ordenes con la excepcion de que cualquier espacio en un argumento ha de
ser precedido de `\'. man analizara $MANOPT antes de analizar su
propia linea de ordenes. Aquellas opciones que tengan argumentos, se
pueden cambiar si se incluyen al invocar man. Para desactivar todas
las opciones activas en $MANOPT, basta usar -D como primera opcion en
la linea de ordenes. Esto hace que man `olvide' las opciones de $MANOPT
aunque el contenido de la variable tiene que ser de todos modos el
correcto.
Los utiles de paginas de manual incluidos en el paquete man-db hacen
uso extenso de caches 'indices de las bases de datos. Estos caches
contienen informacion sobre donde se encuentra cada una de las paginas
del manual en el sistema de ficheros y lo que contiene el whatis (breve
descripcion de una linea de la pagina de manual). Uno de los cometidos
de man es asegurarse de que los caches son siempre consistentes. Las
bases de datos cache permiten obviar el uso de software que actualice
las bases de datos tipo texto whatis tradicionales, e incrementan la
velocidad de ejecucion de man si se compara con lo que tardaria si
tuviese que buscar todo el sistema de ficheros cada vez que necesitase
encontrar la pagina de manual adecuada.
Cuando man no encuentra un fichero 'indice de la base de datos creado
por mandb para una jerarquia de paginas de manual dada, se efectuara
una busqueda pero sera necesario usar expansion de caracteres comodin
para buscar dentro de dicha jerarquia.
Si whatis o apropos no encuentran un fichero 'indice intentaran extraer
la informacion de una base de datos whatis tradicional.
Estos utiles permiten el uso de ficheros fuente nroff comprimidos (con
extensiones .Z, .z y .gz). Es posible utilizar cualquier extension
para las paginas comprimidas pero es necesario conocer esta informacion
durante la compilacion. Tambien, de forma predeterminada, cualquier
pagina cat generada, se comprime utilizando gzip. Cualquier jerarquia
de paginas de manual `global' como /usr/man o /usr/X11R6/man puede
utilizar cualquier directorio como raiz de su jerarquia de paginas cat.
De forma tradicional, se acostumbra a almacenarlas bajo la misma
jerarquia que las man, pero por razones del tipo de las mencionadas en
el Est'andar del Sistema de Ficheros Linux (FSSTND), puede ser mas
apropiado almacenarlas en otros lugares.
Si precisa mas detalles de como se hace, por favor, refierase a la
pagina de manpath(5). Si lo que quiere es enteder las razones,
refierase al estandar.
Este paquete tiene sorporte internacional. Las paginas en lengua nativa
pueden accederse (si se encuentran disponibles) mediante el uso de las
funciones locale . Para usarlo, debe bien activar las variables
$LC_MESSAGES, $LANG o cualquier variable de entorno del sistema
asignandoles el valor correspondiente a su idioma, generalmente usando
el formato especificado por el estandar POSIX 1003.1 :
<idioma>[_<territorio>[.<conjunto-de-caracteres>[,<versi'on>]]]
Si la pagina deseada esta disponible en sus informaciones locale, se
presentara en vez de la pagina estandar (generalmente en ingles
americano).
Este paquete tambien incorpora el soporte de catalogos de mensajes
internacionales y es activado del mismo modo, siempre y cuando este
disponible. En el caso de que las paginas de manual y los catalogos de
mensajes que acompanan este paquete no esten disponibles en su lengua
nativa y si quisiese colaborar en su traduccion, por favor pongase en
contacto con el autor que actua de coordinador.
Si necesita mas informacion sobre otras caracteristicas y extensiones
disponibles con este paginador de manual, por favor refierase a los
documentos que se suministran con este paquete.
VALORES PREDETERMINADOS
man busca las paginas del manual deseadas en los 'indices bases de datos
cache. Si la `busqueda' es infructuosa, se ejecuta una comprobacion de
la consistencia de la base de datos cache para asegurarse de que el
cache refleja fielmente el sistema de ficheros. Generalmente no es
necesario ejecutar mandb una vez que se ha creado el cache inicial
salvo que este quede corrompido.
Una vez se localice una pagina de manual, se intenta determinar si
existe una pagina relativa preformateada `cat' mas reciente que el
fichero nroff. En caso afirmativo, esta pagina (generalmente) se
descomprime y se presenta mediante el paginador. Este paginador puede
bien especificarse de uno de los diversos modos o bien se usara el
predeterminado (ver opcion -P para mas detalles). Si no existe pagina
cat, o si es mas antigua que el fichero nroff, este ultimo es filtrado
y presentando de forma inmediata.
Si se puede generar un fichero cat (existe un directorio cat relativo y
tiene los permisos apropiados), man comprimira y almacenara el fichero
en segundo plano.
Los filtros son descifrados de diversos modos. Primeramente, se intenta
usar el valor de la opcion de la linea de ordenes -p o el contenido de
la variable de entorno $MANROFFSEQ. Si no se ha usado -p ni tampoco se
ha activado la variable de entorno, la primera linea del fichero en
formato nroff es analizada en busca de una cadena de preprocesador.
Para que esta linea contenga una cadena de preprocesador valida, su
aspecto debe asemejarse a
'\" <cadena>
donde cadena puede ser cualquier combinacion letras descritas para la
opcion -p mas abajo.
Si ninguno de los metodos anteriores proporciona informacion de
filtrado, se usa el conjunto predeterminado.
Se genera una tuberia compuesta por los filtros y el formateador
primario (nroff o [tg]roff con -t) y se ejecuta. Alternativamente, si
existe en la raiz del arbol man, un programa ejecutable mandb_nfmt (o
mandb_tfmt con -t) sera este el que se ejecute. Los argumentos que
recibira son la pagina de manual fuente, la cadena de preprocesador y,
de forma opcional el dispositivo que se especifique mediante el
argumento -T .
OPCIONES
La duplicacion de opciones sin argumento tanto en la linea de ordenes,
en $MANOPT, o en ambos, no tiene ningun efecto danino. Para aquellas
opciones que requieren un argumento, cada duplicado sobreescribe el
valor anterior del argumento.
-l, --local-file
Activa el modo `local'. Formatea e imprime las paginas de manual
locales en vez de buscarlas entre la coleccion de manuales del
sistema. Cada pagina de manual argumento se supone fichero
fuente en formato nroff. No se genera un fichero cat. Si se
anade '-' a la lista de argumentos, se toma la entrada del
stdin.
-L locales, --locale=locales
man normalmente determina su estado de locales actual mediante
una llamada a la funcion de la biblioteca C setlocale(3) que
interroga varias variables de entorno, entre otras $LC_MESSAGES
y $LANG. Para sobreescribir temporalmente el valor determinado,
puede usar esta opcion y suplir la cadena de locales
directamente a man. Es necesario notar que el cambio no tendra
lugar hasta que comience la busqueda propiamente dicha. Salidas
como el mensaje de ayuda siempre aparecen segun los locales
determinados inicialmente.
-D, --default
Esta opcion se usa generalmente la primera y restaura el
comportamiento de man al modo predeterminado. Se usa para
restaurar las opciones modificadas mediante $MANOPT. Cualquier
opcion que siga a -D producira el efecto usual.
-M ruta, --manpath=ruta
Especifica una ruta de manual alternativa. De forma
predeterminada, man utiliza codigo derivado de manpath para
determinar la ruta de busqueda. Esta opcion sobreescribe el
valor de la variable de entorno $MANPATH y hace que la opcion -m
sea ignorada.
-P paginador, --pager=paginador
Especifica que paginador de salida se ha de usar. De forma
predeterminada, man usa pager-s. Esta opcion sobreescribe el
valor de la variable de entorno $PAGER y no se puede usar a la
vez que -f o -k.
-r prompt, --prompt=prompt
Si se usa una version reciente del paginador less , man
intentara fijar el prompt y alguna de sus opciones de forma
inteligente. El prompt predeterminado sera
P'agina de Manual nombre(secci'on) l'inea x
donde nombre denota el nombre de la pagina de manual, secci'on
denota la seccion en la que se ha encontrado dicha pagina y x,
el renglon actual. Esto se consigue usando la variable de
entorno $LESS.
Si se suministra una cadena mediante la opcion -r se
sobreescribe este comportamiento predeterminado. La cadena
puede contener el texto $MAN_PN que se convertira en el nombre
de la pagina de manual presentada y su seccion rodeada de `(' y
`)'. Asi, la cadena que produce el comportamiento predeterminado
se podria expresar como
\ P'agina\ de\nual\ \$MAN_PN\ ?ltl'inea\ %lt?L/%L.:
byte\ %bB?s/%s..?\ (END):?pB %pB\\%..
La cadena se presenta en dos lineas para facilitar su lectura
solamente. Para entender su significado por favor vea la pagina
de manual de less(1). La cadena de prompt es evaluada primero
por la shell. Todas las dobles comillas comillas invertidas y
barras invertidas del prompt deben ser precedidas de `\'. Si se
termina la cadena de prompt con `\$', se podran anadir
posteriormente mas opciones de less. De forma predeterminada
man usa las opciones -ix8 .
-7, --ascii
Si esta viendo una pagina de manual en codigo ascii(7) puro o en
una terminal o emulador de terminal de 7 bits, algunos
caracteres puede que no se impriman correctamente si usa el
descriptor de dispositivo latin1(7) con GNU nroff. Esta opcion
permite que las paginas en puro ascii puedan ser presentadas en
ascii en un dispositivo latin1 . No traducira ningun texto en
latin1 . La siguiente tabla explica las traducciones que se
realizan.
Descripcion Octal latin1 ascii
------------------------------------------------
guion de continuacion 255 - -
marcador (punto medio) 267 o o
acento agudo 264 ' '
signo de multiplicar 327 x x
Si la columna de latin1 se imprime correctamente, su terminal
puede ser usada con el conjunto latin1 de caracteres y esta
opcion no es necesaria. Si las columnas latin1 y ascii son
identicas, esta leyendo la pagina usando esta opcion o bien man
no ha formateado la pagina usando la descripcion de dispositivo
latin1 . Si la columna latin1 no existe o esta mal impresa, es
posible que necesite esta opcion.
Esta opcion es ignorada cuando se usa a la vez que -t, -T o -Z y
puede ser completamente inutil si el nroff usado es distinto del
de GNU.
-S lista, --sections=lista
Lista es un compendio de secciones separadas por "dos puntos"
que determina el orden en el que se consultan las secciones del
manual. Esta opcion sobreescribe el valor de la variable de
entorno $MANSECT.
-a, --all
Por defecto, man termina despues de presentar la pagina de
manual que considera mas apropiada de entre las encontradas. Si
usa esta opcion, forzara a man a presentar todas las paginas de
manual cuyos nombres respondan a los criterios de la busqueda.
-c, --catman
Esta opcion no es de uso general y deberia ser usada unicamente
por el programa catman .
-d, --debug
En vez de presentar paginas de manual, imprime informacion de
depurado.
-e sub-extensi'on, --extension=sub-extensi'on
Algunos sistemas como por ejemplo el paquete Tcl incorporan
grandes paquetes de paginas de manual a la jerarquia principal.
Para evitar tener dos paginas con un mismo nombre como por
ejemplo exit(3), las paginas de Tcl han sido por lo general
asignadas a la seccion l. Esta solucion es desafortunada y
actualmente es posible poner las paginas en la seccion correcta
y asignarles una `extension' especifica, en este caso,
exit(3tcl). En condiciones normales, man preferira presentar
exit(3) a exit(3tcl). Para solventar esta situacion y evitar
tener que saber a que seccion pertenece la paguina requerida, es
posible darle a man una extension sub-extension indicando a que
paquete tiene que pertenecer dicha pagina. Asi con el ejemplo
anterior, basta suministrar la opcion -e tcl a man para que se
restrinja la busqueda a paginas que tengan *tcl como extension.
-f, --whatis
Es equivalente a whatis. Presenta una breve descripcion tomada
de la pagina de manual cuando esta esta disponible. Vease
whatis(1) para mas detalles.
-h, --help
Imprime un mensaje de ayuda y termina.
-k, --apropos
Es equivalente a apropos. Realiza una busqueda de palabras
clave entre las descripciones breves de las paginas de manual y
presenta las paginas identificadas. Vease apropos(1) para mas
detalles.
-m sistema[,...], --systems=sistema[,...]
Si este sistema tiene acceso a las paginas de manual de otro
sistema operativo, se puede activar su busqueda mediante esta
opcion. Para buscar en las paginas de NuevoSO, use la opcion -m
NuevoSO. El sistema especificado puede ser una lista de nombres
de sistemas operativos separada por comas. Para incluir el
sistema operativo nativo en la busqueda basta incluir man como
nombre de sistema en la lista de argumentos.
El valor de esta opcion sobreescribe el contenido de la variable
del entorno $SYSTEM.
-p cadena, --preprocessor=cadena
Especifica la secuencia de preprocesadores a ejecutar antes de
nroff o troff/groff. No todas las instalaciones tienen el
conjunto completo de preprocesadores. Algunos de los
preprocesadores y de las letras usadas para designarlos son: eqn
(e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). El
valor de esta opcion sobreescribe al contenido de la variable
del entorno $MANROFFSEQ. zsoelim es ejecutado siempre en primer
lugar.
-u, --update
Los caches de los 'indices de las bases de datos son acutalizados
`sobre la marcha', es decir, no es necesario que mandb se
ejecute periodicamente para mantener la consistencia. Si la
pagina que busca no se encuentra en los caches o si se emplea la
opcion -a , man automaticamente comprobara la consistencia de
los directorios para asegurar que los caches son una
representacion fiel del sistema de ficheros. Para forzar una
comprobacion de consistencia de los `inodos' anterior a la
busqueda, use la opcion -u.
-t, --troff
Usa groff -mandoc para formatear las paginas de manual y
escribirlas en el stdout. Esta opcion es innecesaria en
conjuncion con -T o -Z.
-T dispositivo, --troff-device [=dispositivo]
Esta opcion permite cambiar la salida generada por groff (o
incluso la de troff) de forma que sea mas apropiada para un
dispositivo diferente del predeterminado. Implica la opcion -t.
Posibles ejemplos (incluidos en Groff-1.17) son, dvi, latin1,
ps, utf8, X75 y X100.
-Z, --ditroff
groff ejecuta troff y usa un post-procesador para generar la
salida apropiada para el dispositivo seleccionado. Si groff
-mandoc es groff, esta opcion se pasa a groff evitando el uso de
un post-procesador. Implica la opcion -t.
-w, --where, --location
En vez de imprimir las paginas de manual, solo imprime el/los
lugar(es) en los que se encuentran los ficheros que serian
formateados o impresos. Si se trata de un fichero cat, se
imprime tambien la situacion del fichero fuente nroff.
-V, --version
Imprime la version y el autor.
ESTADO DE SALIDA
0 La ejecucion del programa ha terminado con exito.
1 Error de uso, sintaxis o del fichero de configuracion.
2 Error operacional.
3 Un proceso hijo ha terminado con estatus no-nulo.
16 Al menos una de las/los paginas/ficheros/palabras clave no
existe o no ha producido ninguna identificacion positiva.
ENTORNO
MANPATH
Si se activa $MANPATH, su valor determina cual es la ruta de
busqueda para las paginas del manual.
MANROFFSEQ
Si se activa $MANROFFSEQ, su valor determina el conjunto de
preprocesadores que filtran cada pagina de manual. La lista
predeterminada de preprocesadores depende del sistema.
MANSECT
Si se activa $MANSECT, su valor es una lista de secciones
delimitadas por "dos puntos" que permite determinar que
secciones de manual se usan en la busqueda y en que orden.
PAGER Si se activa $PAGER, su valor determina el nombre del programa
usado para presentar la pagina de manual. El sistema, de forma
predeterminada, usara pager -s .
SYSTEM Si se activa $SYSTEM, tiene el mismo efecto que la opcion -m
cadena donde cadena es el contenido de la variable $SYSTEM.
MANOPT Si se activa $MANOPT, se analiza antes que la linea de ordenes
de man , suponiendose que el formato es similar. Como quiera que
todas las demas variables de entorno especificas de man pueden
expresarse como argumentos de la linea de ordenes y pueden por
tanto ser incluidas en $MANOPT, se espera que se vuelvan
obsoletas. N.B.: Todos los espacios que formen parte del
argumento de una opcion deben ir precedidos de `'.
LANG, LC_MESSAGES
Dependiendo del sistema y la implementacion, una o ambas $LANG y
$LC_MESSAGES son usadas para determinar los mensajes locales que
se van a usar. man imprime los mensajes en dichos locales (si
estan disponibles). Vease setlocale(3) para mas detalles.
FICHEROS
/etc/manpath.config
fichero de configuracion de man-db.
/usr/man
Una jerarquia global de paginas de manual
/usr/man/index.(bt|db|dir|pag)
Cache de 'indice de base de datos global tradicional.
/var/catman/index.(bt|db|dir|pag)
Cache del 'Indice de base de datos alternativo o conforme al
FSSTND.
/usr/man/mandb_nfmt
Ejemplo de un guion opcional nroff de formateo por jerarquia.
/usr/man/mandb_tfmt
Ejemplo de un guion opcional [tg]roff de formateo por jerarquia
para usar con -t.
V'EASE TAMBI'EN
mandb(8), manpath(1), manpath(5), apropos(1), whatis(1), catman(8),
less(1), nroff(1), troff(1), groff(1), zsoelim(1), setlocale(3),
man(7), ascii(7), latin1(7), FSSTND.
HISTORIA
1990, 1991 - Escrito originalmente por John W. Eaton
(jwe@che.utexas.edu).
23 de Diciembre de 1992: Rik Faith (faith@cs.unc.edu) subsano unos
errores mediante las correcciones proporcionadas por Willem Kasdorp
(wkasdo@nikhefk.nikef.nl).
30 de Abril de 1994 - 23 de Febrero de 2000: Wilf.
(G.Wilford@ee.surrey.ac.uk) ha ido desarrollando y manteniendo este
paquete con la ayuda de algunas personas con gran dedicacion.
Traduccion realizada por Luis F. Gonzalez (luisgh@cogs.susx.ac.uk)