3. Preparación de páginas para man.
Aquí veremos cómo puede prepararse documentación sobre el uso de nuestros programas, es decir, cómo preparar los archivos para man.
Estos archivos se guardarán con la extensión 1, 2, o la que se corresponda con la sección en que deba ir nuestro programa y se copiarán en el directorio correspondiente (que debería ser por lo general /usr/man/manX donde X es el número de la sección que corresponda).
Todas las macros que vamos a explicar se documentan brevemente en man(7) y aquí explicaremos las más básicas que serán suficientes para preparar nuestro manual.
| Macro | Descripción |
| .TH | Es el encabezado del manual. Aquí se suele poner el nombre del comando en mayúsculas y su sección entre paréntesis. |
| .TB | Es el pie de página del manual. Aquí se incluye la numeración de página, la versión y otras cosas. |
Cada una de las macros del manual deberá ir en línea aparte y por ello la escritura puede parecer algo agobiante, pero con el uso uno se acostumbra.
Las marcas más habituales son:
| Macro | Descripción |
| .SH | Esta es cada una de las secciones del manual. Aparecerán en negrita y formará un párrafo aparte del texto siguiente. |
| .PP | Indica la aparición de un nuevo párrafo. Hace una separación de línea entre los dos párrafos. |
| .TP | Indica la aparición de una tabla de contenidos. La primer línea es la nombre y las siguientes la descripción. |
| .B | El texto a continuación estará en negrita. |
| .I | El texto a continuación estará en cursiva. |
| .R | El texto a continuación estará en normal. |
| .BI | La primera palabra será en negrita, la siguiente en cursiva y se irán alternando. Se pueden hacer combinaciones con B, I y R y en el orden que queramos. |
NOTA. Podemos poner las secciones que nos interesen y con los nombres que nos gusten. Aunque debería haber al menos tres secciones: NAME, SYNOPSIS y DESCRIPTION. También se puede poner en castellano: NOMBRE, SINOPSIS y DESCRIPCIÓN. También se suelen incluir secciones como FILES, BUGS o SEE ALSO.
En el Apéndice 2 tenemos un ejemplo de manual para man. Se trata de una parte del manual de groff en la que se incluyen los elementos principales.
3.3 Impresión de las páginas del manual.
Lo más fácil es coger el fichero de manual que se quiere imprimir (por ejemplo el groff.1 que se encuentra por lo general en /usr/man/man1) y ejecutar
$ groff -man groff.1 > groff.ps
El archivo groff.ps es el que estábamos buscando. Está en formato PostScript y podemos visualizarlo con el GhostView o, si nos parece bien, pasarlo a papel en nuestra impresora habitual.
En todo caso, siempre está el programa grog para decirnos qué opción es la más adecuada:
$ grog groff.1
groff -man groff.1