.\" Copyright 1992 Rickard E. Faith (faith@cs.unc.edu)
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" Modified Sun Jul 25 11:06:05 1993 by Rik Faith (faith@cs.unc.edu)
.\" Translated Wed Jun 19 10:03:10 1996 by Diego Novillo (diego@cs.ualberta.ca)
.\" Modified Sun Jun 23 1996 Miguel A. Sepulveda(angel@vivaldi.princeton.edu)
.\" Modified Mon May 11 1998 Jordi Gili(jordi@enterprise.udg.es)
.\" Translation revised Sat Jun 26 1999 by Juan Piernas <piernas@ditec.um.es>
.\"
.TH MAN 7 "25 Julio 1993" "Linux" "Manual del programador de Linux"
.SH NOMBRE
man \- macros para formatear pginas del manual
.SH SINOPSIS
.B groff \-Tascii \-man
.I fichero
\&...
.LP
.B groff \-Tps \-man
.I fichero
\&...
.LP
.B man
.RI [ seccin ]
.I ttulo
.SH DESCRIPCIN
Esta pgina del manual describe el paquete de macros
.BR "groff tmac.an" .
El programador debe usar este paquete de macros cuando escriba o porte
pginas del manual para Linux. Al ser bastante compatible con otras
versiones, portar pginas del manual no debera dar mayores problemas 
(con excepcin de la distribucin incluida en NET-2 BSD, que utiliza 
un paquete de macros totalmente distinto).

Para usar las pginas del manual del NET-2 BSD con
.B groff
simplemente se utiliza la opcin
.B \-mdoc
en vez de la opcin
.BR \-man .
De todas formas, se recomienda utilizar la opcin
.B \-mandoc
porque as detecta de forma automtica qu paquete de macros
se est utilizando.
.SH PREMBULO
La primera orden en una pgina de manual debera ser
.RS
.sp
.B \&.TH
.IR "ttulo seccin fecha fuente manual" ,
.sp
.RE
donde:
.RS
.TP 0.8i
.I ttulo
Es el ttulo de la pgina del manual (p.ej.,
.IR MAN ).
.TP
.I seccin
Es el nmero de seccin donde debera ir la pgina (p.ej.,
.IR 7 ).
.TP
.I fecha
Esta es la fecha de la ltima revisin (la fecha debera cambiarse cada
vez que se modifica la pgina, ya que sta es la forma mas genrica de
llevar un control de la versin.
.TP
.I fuente
Indica cual es la fuente de la orden.
.sp
Para ficheros binarios, se utilizan nombres como:
.IR GNU ", " NET-2 ", " "Distribucin SLS" ", " "Distribucin MCC" .
.sp
Para llamadas al sistema, se especifica la versin actual del ncleo:
.IR "Linux 0.99.11" .
.sp
Para llamadas a las bibliotecas, se especifica la fuente de la funcin:
.IR GNU ", " "BSD 4.3" ", " "Linux DLL 4.4.1" .
.TP
.I manual
Indica el ttulo del manual (p.ej.,
.IR "Manual del Programador de Linux" ).
.RE
.PP
Tradicionalmente, las secciones del manual se definen como las siguientes:
.RS
.TP 0.8i
.B 1 Comandos
Son rdenes que el usuario puede ejecutar desde el intrprete de comandos.
.TP
.B 2 Llamadas al sistema
Son funciones que el ncleo debe ejecutar.
.TP
.B 3 Llamadas a bibliotecas
La mayora de las funciones 
.IR libc ,
tales como
.BR qsort (3))
.TP
.B 4 Ficheros especiales
Ficheros que se encuentran en
.IR /dev )
.TP
.B 5 Formatos de ficheros y convenciones
El formato de
.I /etc/passwd
y otros ficheros legibles.
.TP
.B 6 Juegos
.TP
.B 7 Paquetes de macros y convenciones
Describe la distribucin estndard del sistema de ficheros, sta pagina
del manual y otras cosas.
.TP
.B 8 rdenes para la administracin del sistema
rdenes como
.BR mount (8),
que slo pueden ser ejecutadas por el usuario
.IR root .
.TP
.B 9 Rutinas del ncleo
Esta seccin del manual no es estndar y est includa
porqu el cdigo fuente del ncleo de Linux est libremente disponible bajo
la Licencia Pblica GNU y hay mucha gente trabajando y modificando el ncleo.
.RE
.SH TIPOS DE LETRA
Aunque el mundo UNIX tiene muchas convenciones arbitrarias para las
pginas del manual, la existencia de cientos de pginas del manual 
Linux definen nuestros estndares:
.IP
Para funciones, los argumentos siempre se especifican usando itlicas,
.IR "incluso en la seccin SINOPSIS" , 
mientras que el resto de la funcin se escribe en negrita:
.RS
.BI "int myfunction(int " argc ", char **" argv );
.RE
.IP
Los nombres de ficheros van siempre en letra itlica (p.ej.,
.IR "/usr/include/stdio.h" ),
excepto en la seccin SINOPSIS, donde los ficheros van en negrita 
(p.ej.,
.BR "#include <stdio.h>" ).
.IP
Las macros especiales que suelen ir en maysculas, van en negrita (p.ej.,
.BR MAXINT ).
.IP
Cuando enumeramos una lista de cdigos de error, estos van en negrita
(esta lista normalmente usa el macro
.BR \&.TP ).
.IP
Referencias a otras pginas del manual (o de algn tema dentro de la 
pgina actual) van en negrita.  Si se incluye el nmero de seccin 
del manual, se debe dar en tipo de letra romana, sin espacios (p.ej.,
.BR man (7)).

Las rdenes usadas para seleccionar distintos tipos de letra son las
siguientes:
.TP 0.8i
.B \&.B
Negrita
.TP
.B \&.BI
Negrita alternndose con itlica
.TP
.B \&.BR
Negrita alternndose con romana
.TP
.B \&.I
Itlica
.TP
.B \&.IB
Itlica alternndose con negrita
.TP
.B \&.IR
Itlica alternndose con romana
.TP
.B \&.RB
Romana alternndose con negrita
.TP
.B \&.RI
Romana alternndose con itlica
.TP
.B \&.SB
Pequea alternndose con negrita
.TP
.B \&.SM
Pequea
.LP
Tradicionalmente, cada rden puede tener seis argumentos como mximo,
pero la versin de GNU no tiene esa limitacin.  Los argumentos se
delimitan por espacios.  Si el argumento contiene espacios, se deben
usar comillas dobles.  Todos los argumentos se imprimen uno al lado del
otro sin espacios entre medio, de esta forma, la orden
.B \&.BR
se puede usar para especificar una palabra en negrita seguido por un signo
de puntuacin en romano.
.SH SECCIONES
Las secciones se empiezan con
.B \&.SH
seguido del encabezamiento. Si el nombre contiene espacios y aparece en
la misma linea que el
.BR \&.SH ,
entonces se debe poner el encabezamiento dentro de comillas dobles.
Los encabezamientos tradicionales que se incluyen son:
NOMBRE, SINOPSIS, DESCRIPCIN, OPCIONES, FICHEROS, VASE TAMBIN, DIAGNSTICOS,
ERRORES, y AUTOR.  El nico encabezamiento obligatorio es el
.IR NOMBRE ,
que debe incluir una descripcin breve del programa en la linea siguiente al
encabezamiento:
.RS
.sp
\&.SH NOMBRE
.br
ajedrez \\- el juego de ajedrez
.sp
.RE
Es muy importante respetar este formato, ntese que despus del nombre de la
rden hay una barra invertida antes del guin. Esta sintaxis la utiliza
el programa
.BR makewhatis (8)
para crear una base de datos de descripciones breves para las rdenes
.BR whatis (1)
y
.BR apropos (1).
.SH "OTRAS MACROS"
Otras macros que se pueden utilizar:
.TP
.B \&.DT
Tabuladores por omisin
.TP
.B \&.HP
Empezar sangrado pendiente
.TP
.B \&.IP
Empezar un prrafo con una etiqueta pendiente.  Tiene el mismo efecto que
.BR \&.TP ,
con la excepcin que la etiqueta est en la misma linea, pero no en la
siguiente.
.TP
.B \&.LP
Lo mismo que
.BR \&.PP .
.TP
.B \&.PD
Establece la distancia entre prrafos al valor dado por el argumento
.TP
.B \&.PP
Empieza un nuevo prrafo
.TP
.B \&.RE
Finaliza un sangrado relativo (prrafo sangrado)
.TP
.B \&.RS
Comienza sangrado relativo (prrafo sangrado)
.TP
.B \&.SS
Subencabezamiento (igual que
.BR \&.SH ,
pero usado para subsecciones)
.TP
.B \&.TP
Comienza un prrafo con una etiqueta pendiente. La etiqueta est 
en la siguiente linea.  Esta rden es parecida a
.BR \&.IP .
.LP
.SH FICHEROS
.I /usr/local/lib/groff/tmac/tmac.an
.br
.I /usr/man/whatis
.SH "VASE TAMBIN"
.BR groff (1),
.BR man (1),
.BR whatis (1),
.BR apropos (1),
.BR makewhatis (8)