En este artículo explicaré el modo correcto de utilización de las man pages ya que se trata de la primera fuente a consultar cuando tenemos algún problema con una herramienta del sistema operativo, es mas no haber leído la página de man correspondiente y haber preguntado online en foros o listas de correo se considera una falta de respeto e interés en muchos circulos de sysadmins.

Lo primero que debmos saber es que hay varias secciones:

1. General user commands
2. System calls and error numbers
3. C programming libraries
4. Devices and device drivers
5. File formats
6. Game instructions
7. Miscellaneous information
8. System maintenance commands
9. Kernel interfaces

Podemos consultar una descripción de cada sección de la siguiente manera:

man NÚMERO_SECCIÓN intro

Si queremos consultar la descripción de la sección 8. System maintenance commands sería:

Como ejemplo vamos a consultar la página de manual de la herramienta dhclient:

En la primera línea vemos:

DHCLIENT(8)             FreeBSD System Manager's Manual            DHCLIENT(8)

El número 8 indica que esta página de manual corresponde a comandos de administración del sistema:

8. System maintenance commands

Si no sabemos con certeza que página de manual buscar para un comando en concreto podemos ejecutar varios comandos:

• apropos: Buscará el patrón en las página de manual.
• whatis: Buscará la palabra exacta en las páginas de manual.

Las páginas de man se dividen en varias secciones:

• NAME: Nombre del programa o utilidad. Algunos programas tienen multiples nombres como vi por ejemplo: vi, ex, view
• SYNOPSIS: Lista posibles opciones y argumentos. Si ya estamos familiarizados con un programa pero no recordamos una opción esta cabecera nos resultará útil.
• DESCRIPTION: Contiene una breve descripción del programa, librería o feature. El contenido de esta sección variará dependiendo del programa, fichero o librería.
• OPTIONS: Muestra las opciones de línea de comandos y sus efectos.
• BUGS: Describe problemas conocidos con el código, en multitud de ocasiones podemos evitarnos dolores de cabeza con programas que están bugeados si leemos esta sección antes de buscar soluciones inexistentes.
• EXAMPLES: Son ejemplos de uso de los programas. Algunos programas son realmente complicados y un par de ejemplos sobre su uso arrrojan mas luz que una lista de opciones.
• HISTORY: Muestra cuando el comando o código fueron añadidos al sistema y si no forma parte de FreeBSD indicará su origen.
• SEE ALSO: Comandos, ficheros o librerías relacionadas con el comando consultado actualmente.