LinuxParty

Las páginas del manual de UNIX y consecuentemente de Linux, son ficheros de texto que contienen secuencias de control y cadenas de texto. Las secuencias de control son interpretadas por el procesador de texto "troff" ("groff" es el procesador equivalente a troff para el proyecto GNU)

Las páginas del manual están divididas en secciones estándar que se almacenan en directorios estándar. Por ejemplo en la sección 3 estarán las funciones de bibliotecas.

A continuación podemos ver una plantailla donde se describe la forma que tiene un fichero del manual.

Ahora crearemos como ejemplo un fichero del manual al que llamaremos "caracola.1", lo puedes crear con kwrite, gedit, joe, vim, o tu procesador de texto plano preferido.

---

.TH Caracola  nombre de la función/orden/programa y sección
.SH NAME
Orden de la función Descripción de la orden/función/programa
Breve descripción de la función, orden o programa.
.SH SYNOPSIS
.B Nombre de la orden
Opciones de la función (orden o programa) (caso de función)
.SH DESCRIPTION
Descripción detallada de las ordenes y sus opciones.
en el caso de una función se deben describir los parámetros de la interfaz
Los parámetros se introducen con la opción .PP
.PP
Este es un párrafo nuevo.
Las nuevas líneas se introducen con .br
.br
Esta es una nueva línea
.SH FILES
Los ficheros que necesita la orden/función Por ejemplo la orden passwd(1)
utiliza el fichero /etc/passwd.
.SH SEE ALSO
Referencia a documentos afines, incluyendo otras páginas del manual.
.SH BUGS
Detalles sorprendentes (no siempre tienen que ser problemas)
.SH AUTHOR
Nombre del autor del programa, se suele incluir su nombre y la dirección de
contacto, el email, normalmente.

---

En realidad, el programa man es una interfaz con el programa groff y cuando ejecutamos una orden como "man fopen", la orden que realmente se ejecuta es:

groff -man /usr/man/man1/fopen.1 | more

Ahora copiaremos nuestro ejemplo en: /usr/man/man1, por ejemplo si es en Unix, yo en mi Fedora Linux, lo voy a copiar a:

cp caracola.1 /usr/share/man/es/man1/

Y ejecutamos la orden:

man caracola