Provided by:
manpages-es_1.55-10_all 
NOMBRE
mdoc -- Guia de referencia rapida para el paquete de macros -mdoc
SINOPSIS
groff -mdoc ficheros ...
DESCRIPCI'ON
El paquete -mdoc es un conjunto de macros basadas en contenido y basadas
en dominio que se utilizan para formatear las paginas de manual de BSD.
Los nombres de las macros y sus significados estan listados mas abajo
para una referencia rapida; para una explicacion mas detallada sobre como
utilizar el paquete, vease el tutorial mdoc.samples(7).
Notese que este no es el paquete de macros habitual para la documentacion
de Linux, aunque se utiliza para la documentacion de bastantes programas
de uso extendido; vease man(7).
Las macros se describen en dos grupos, el primero incluye las macros del
diseno estructural y fisico de la pagina. El segundo contiene las macros
de manual y de dominio de texto general que diferencian al paquete -mdoc
de otros paquetes de formateo en troff.
DOMINIO DE ESTRUCTURA DE P'AGINA
Macros de T'itulo
Para crear una pagina de manual valida, se requieren estas tres macros,
en este orden:
.Dd Mes dia, a~no Fecha del documento.
.Dt TITULO_DEL_DOCUMENTO [secci'on] [vol'umen]
Titulo, en mayusculas.
.Os SISTEMA_OPERATIVO [versi'on/revisi'on] Sistema Operativo (BSD).
Macros de Dise~no de P'agina
Cabeceras de seccion, saltos de parrafo, listas y visualizaciones.
.Sh Cabeceras de Seccion. Cabeceras validas, en orden de presentacion:
NOMBRE Seccion de nombre, debe incluir las macros '.Nm' o
'.Fn', y '.Nd'
SINOPSIS Utilizacion.
DESCRIPCI'ON Descripcion general, debe incluir opciones y
parametros.
VALOR DEVUELTO Llamadas a funciones de las secciones dos y tres.
ENTORNO Describe las variables de entorno.
FICHEROS Ficheros asociados al tema.
EJEMPLOS Ejemplos y sugerencias.
DIAGN'OSTICOS Normalmente utilizada para los diagnosticos del
interfaz de dispositivo de la seccion cuatro.
ERRORES Manejo de errores y senales de las secciones dos y
tres.
V'EASE TAMBI'EN Referencias cruzadas y citas.
CONFORME A Conformidad a estandares, si viniera al caso.
HISTORIA Si no se puede aplicar un estandar, se debe mostrar
la historia del asunto.
FALLOS Defectos y advertencias.
otros Cabeceras personalizadas que se pueden anadir a la
discrecion de autor.
.Ss Cabeceras de subseccion.
.Pp Salto de Parrafo. Espacio vertical (una linea).
.D1 (D-one) Display-one. Sangrar y visualizar una linea de texto.
.Dl (D-ell) Display-one literal. Sangrar y visualizar una linea de
texto literal.
.Bd Begin-display block. Comenzar un bloque de visualizacion.
Opciones de visualizacion:
-ragged Sin justificado (bordes desiguales).
-filled Justificado.
-literal Texto o codigo literal.
-file nombre Leer el fichero nombrado y visualizar.
-offset cadena Desplazamiento de visualizacion. Valores de
cadena aceptables:
left Alinear el bloque a la izquierda (por
defecto).
center Aproximar al margen central.
indent Seis espacios de anchura constante
(una tabulacion).
indent-two Dos tabulaciones.
right Alinea el bloque a la izquierda a 2
pulgadas de la derecha.
xxn Donde xx es un numero entre 4n y 99n.
Aa Donde Aa es un nombre de macro
invocable.
cadena Se usa la anchura de cadena.
.Ed End-display. Finalizar visualizacion (se corresponde con .Bd).
.Bl Begin-list. Crear listas o columnas. Opciones:
Tipos de lista
-bullet Lista de puntos
-item Lista sin etiquetar
-enum Lista enumerada
-tag Lista etiquetada
-diag Lista de diagnostico
-hang Lista con etiquetas colgantes
-ohang Lista con etiquetas sobresalientes
-inset Lista con etiquetas insertadas o seguidas
Parametros de lista
-offset (Todas las listas.) Vease '.Bd begin-display' mas
arriba.
-width (Solo listas -tag y -hang.) Vease '.Bd'.
-compact (Todas las listas.) Suprime las lineas en blanco.
.El End-list. Final de lista.
.It List item. Elemento de lista.
MACROS DE MANUAL Y DE DOMINIO DE TEXTO GENERAL
Las macros de manual y de dominio de texto general son especiales en el
sentido de que la mayoria de ellas se analizan o interpretan (`parse') en
busqueda de macros invocables, por ejemplo:
.Op Fl s Ar fichero
Produce [-s fichero]
En este ejemplo, la macro de cierre de opcion '.Op' se analiza y llama a
la macro de contenido invocable 'Fl' que opera en el argumento 's' y
luego llama a la macro de contenido invocable 'Ar' que opera en el
argumento 'fichero'. Algunas macros pueden ser invocables pero no
interpretadas y viceversa. Estas macros se indican en las columnas
interpretadas e invocables que aparecen mas abajo.
Si no se indica lo contrario, las macros de dominio de manual comparten
una sintaxis comun.
.Va argumento [ . , ; : ( ) [ ] argumento ... ]
Nota: Los caracteres de puntuacion de apertura y cierre solo se reconocen
como tales cuando aparecen uno a uno. La cadena '),' no se reconoce como
una puntuacion y se mostrara con un espacio en blanco al principio y con
cualquiera que sea la fuente usada por la macro invocadora. La lista de
argumentos '] ) ,' se reconoce como tres caracteres de puntuacion
secuenciales y no se muestra un espacio en blanco entre los caracteres y
el argumento previo (si hay alguno). El significado especial de un
caracter de puntuacion puede eliminarse con la cadena '\&'. Por ejemplo,
la siguiente cadena,
.Ar fichero1 , fichero2 , fichero3 ) . produce fichero1,
fichero2, fichero3).
Macros de Dominio de Manual
Nombre Analizada Llamable Descripci'on
Ad Si Si Direccion. (Esta macro puede quedar
obsoleta.)
An Si Si Nombre del Autor.
Ar Si Si Argumento en linea de ordenes.
Cd No No Declaracion de configuracion (solo para la
seccion cuatro).
Cm Si Si Modificador de argumento en linea de
ordenes.
Dv Si Si Variable definida (codigo fuente).
Er Si Si Numero de error (codigo fuente).
Ev Si Si Variable de entorno.
Fa Si Si Argumento de funcion.
Fd Si Si Declaracion de funcion.
Fn Si Si Llamada a funcion (Tambien .Fo y .Fc).
Ic Si Si Orden interactiva.
Li Si Si Texto literal.
Nm Si Si Nombre de orden.
Op Si Si Opcion (tambien .Oo y .Oc).
Ot Si Si Tipo de funcion en estilo antiguo (solo
Fortran).
Pa Si Si Ruta o nombre de fichero.
St Si Si Estandares (-p1003.2, -p1003.1 o -ansiC)
Va Si Si Nobre de variable.
Vt Si Si Tipo de variable (solo Fortran).
Xr Si Si Referencia cruzada a pagina de manual.
Macros de Dominio de Texto General
Nombre Analizada Llamable Descripci'on
%A Si No Referencia al autor.
%B Si Si Referencia al titulo del libro.
%C No No Referencia al lugar de publicacion
(ciudad).
%D No No Referencia a la fecha.
%J Si Si Referencia al titulo de la revista.
%N No No Referencia al numero del articulo.
%O No No Referencia a informacion opcional.
%P No No Referencia al(los) numero(s) de pagina.
%R No No Referencia al nombre del informe.
%T Si Si Referencia al titulo del articulo.
%V No No Referencia al volumen.
Ac Si Si Cierre de comillas de angulo.
Ao Si Si Apertura de comillas de angulo.
Ap Si Si Apostrofo.
Aq Si Si Comillas de angulo
At No No AT&T UNIX
Bc Si Si Cierre de corchete.
Bf No No Comienzo de modo de fuente.
Bo Si Si Apertura de corchete.
Bq Si Si Corchetes.
Bx Si Si BSD.
Db No No Depurar (la opcion por defecto es "off")
Dc Si Si Cierre de comillas dobles.
Do Si Si Apertura de comillas dobles.
Dq Si Si Comillas dobles.
Ec Si Si Cierre de la cadena de entrecomillado.
Ef No No Fin de modo de fuente.
Em Si Si Acento (ingles tradicional).
Eo Si Si Apertura de la cadena de entrecomillado.
Fx No No Sistema operativo FreeBSD
No Si Si Texto normal (no-op).
Ns Si Si Sin espacio.
Pc Si Si Cierre de parentesis.
Pf Si No Cadena prefijo.
Po Si Si Apertura de parentesis.
Pq Si Si Parentesis.
Qc Si Si Cierre de dobles comillas rectas.
Ql Si Si Literal entrecomillado.
Qo Si Si Apertura de dobles comillas rectas.
Qq Si Si Dobles comillas rectas.
Re No No Fin de referencia.
Rs No No Comienzo de referencia.
Rv No No Valores devueltos (solo secciones dos y
tres).
Sc Si Si Cierre de comillas simples.
So Si Si Apertura de comillas simples.
Sq Si Si Comillas simples.
Sm No No Modo de espacio (la opcion por defecto es
"on")
Sx Si Si Referencia cruzada a seccion.
Sy Si Si Simbolico (ingles tradicional).
Tn Si Si Nombre de tipo o marca (mayusculas
pequenas).
Ux Si Si UNIX
Xc Si Si Cierre de lista de argumentos extendida.
Xo Yes Yes Apertura de lista de argumentos extendida.
Los nombres de macro que acaban en 'q' entrecomillan los elementos
restantes de la lista de argumentos. Los nombres de macro que acaban en
'o' comienzan un entrecomillado que puede ocupar mas de una linea de
entrada y se cierra con el nombre de macro correspondiente acabado en
'c'. Las macros de cierre pueden estar anidadas y estan limitadas a ocho
argumentos.
Nota: las macros para las listas de argumentos extendidas ('.Xo', '.Xc')
y las macros de cierre de funcion ('.Fo', '.Fc') son irregulares. Las
macros para las listas extendidas se usan cuando el numero de argumentos
de la macro excederian la limitacion de troff de nueve argumentos.
Las macros UR (comenzar una referencia a hipertexto URI/URL), UE
(terminar la referencia), y UN (identificar un destino para una
referencia) tambien estan disponibles. Vease man(7) para mas informacion
sobre estas macros.
CONFIGURACI'ON
Para la configuracion especifica del paquete de macros, vease el archivo
/usr/src/share/tmac/README.
FICHEROS
tmac.doc Macros de dominio de manual y de texto general.
tmac.doc-common Macros estructurales comunes y definiciones.
tmac.doc-nroff Fichero de estilo nroff dependiente de la instalacion
local.
tmac.doc-ditroff Fichero de estilo troff dependiente de la instalacion
local.
tmac.doc-syms Definiciones especiales (como la macro de estandares).
V'EASE TAMBI'EN
mdoc.samples(7), man(7)