require(".zlconfig.php"); require("$webroot/cabecera.php"); ?> $navIdx->Asignar("groff_indice.php","Índice"); $navIzq->Asignar("groff_ap1.php","Apéndice 1"); $navDer->Asignar("groff_ap3.php","Apéndice 3") ?>
$graf_titulo = "$base_grafs/docs_head.png" ?> require("$webroot/titulos.php") ?>
.ig \"-*- nroff -*-
Aquí incluyo comentarios sobre el manual para quien quiera editarlo.
..
.de TQ
.br
.ns
.\" Este es el macro mm para la parte superior de la página.
.TP \\$1
..
.TH MIMANUAL 1 "14 Enero 2000" "Mimanual Versión 0.01"
.SH NAME
mimanual \- ejemplo de manual para man
.SH SYNOPSIS
.B mimanual
[
.B \-parámetros
]
[
.BI \-a uno
]
[
.BI \-b otro
]
.IR otros \|.\|.\|.\|
]
.SH DESCRIPTION
.B mimanual
es un ejemplo de uso de
.B man
para la preparación rápida de los manuales de nuestras aplicaciones.
Tenemos muchas opciones:
.TP
.B sangrados
sangran el texto uno o varios niveles
.TP
.B listas
para preparar listas de elementos
.TP
.B otros
y en general la organización habitual de un manual.
.PP
Se puede escribir cualquier cantidad de párrafos que se quiera
para explicar el manual. Estos se separarán con la macro .PP
hasta que se llegue a una sección nueva.
.PP
Pensad que lo que se pretende es preparar un manual conciso y
fácil de leer y no un documento imprimible, que para eso ya
tenemos groff.
.SH RECORDAD
Los caracteres \-, \\ y algún otro más deberán ir precedidos
del carácter '\\' (recordad nroff). Así
.PP
\-\c
hemos escrito \\\-
.br
\\\c
hemos escrito \\\\
.PP
Y así con todos lo caracteres especiales.
.PP
Por último os recuerdo que para poner los acentos no debemos utilizar
nada especial salvo tener el lenguaje adecuado en el sistema:
.PP
.B LANG\c
='spanish.iso88591'
.SH AUTHOR
José Luis Cardeñosa Barbero (card@posta.unizar.es)
.SH "OTROS COMENTARIOS"
.LP
Se pueden añadir tantas secciones como se quiera, con los
títulos que sean necesarios. Aquellos títulos que consten de
más de dos palabras, deberán ir entrecomillados como se puede
ver en este ejemplo.
.LP
Si se quiere que en una sección aparezcan varios párrafos,
estos deberán separarse con la macro .LP (recordar las
sección de macros
.IR mm .
.LP
Y aquí se enuentra todo lo necesario para crear páginas del
manual sin necesidad de muchas complicaciones.
.SH DISPONIBILIDAD
Como podeis observar, he cambiado AVAILABILITY por DISPONIBILIDAD.
.SH "VER TAMBIEN"
.BR grog (1),
.BR troff (1),
.BR etc.