Manuales y páginas de ayuda en Linux

Sin duda ya sabrás que hay unas cuantas herramientas en GNU/Linux, que nos pueden servir para obtener información, en formato de manuales o páginas de ayuda. La más popular es man, pero existen otras como ahora veremos.

Quizás te puede interesar el programa de podcast que he grabado sobre este asunto:

Manuales y páginas de ayuda en Linux

Los sistemas like-UNIX, como es el caso de GNU/Linux, son famosos por la gran cantidad de comandos disponibles, cada uno de ellos  a su vez tienen una gran cantidad de posibilidades, a través del uso de parámetros y opciones. Por suerte la consola de comandos nos lo pone un poco más fácil, ya que tras escribir los primeros dígitos de un comando, apretando la teclado del tabulador, nos completará el nombre de este, además se puede utilizar el mismo método para completar rutas de directorios.

Prácticamente, todos los comandos y archivos de configuración en GNU/Linux ,van acompañados de una página en el manual. Dicho manual esta accesible a través del comando man, que muestra con detalle todas las funciones de un ítem. Para utilizar el manual, en su modo básico, solo hemos de escribir el comando man, más el nombre del comando del que queremos obtener información.

Aunque man es el más popular, también podemos utilizar el comando info. Utilizando este comando podemos obtener información igualmente de los comandos, pero en formato más breve. Por normal general su información se obtiene desde /usr/share/info

Las páginas del manual se suelen dividir en su organización en nombre, sinopsis, descrición, opciones, archivos y otra información adicional. También podemos realizar búsquedas por nombre, utilizando el comando apropos. Este comando devuelve una breve descripción a cada resultado encontrado y el nombre del respectivo comando o fichero.

En cambio, con el comando whatis, se nos muestra información que hace referencia a la sección del manual, donde se encuentra el comando indicado. Para cada recurso del manual localizado, este muestra una breve descripción.

Las secciones del manual

El manual esta dividido en secciones, que son las siguientes:

  • Sección 1: Programas disponibles para el usuario.
  • Sección 2: Rutinas del sistema Unix y C
  • Sección 3: Rutinas de bibliotecas del lenguaje C
  • Sección 4: Archivos especiales (dispositivos /dev)
  • Sección 5: Convenciones y formatos de archivos.
  • Sección 6: Juegos
  • Sección 7: Diversos (macros textuales,  entre otras)
  • Sección 8: Procedimientos administrativos (daemons, etc)

Para acceder a una sección específica, el número de la sección precede al nombre del objeto. Por ejemplo para acceder al manual de tar en la sección 5, ya que tar esta presente en dos secciones, en la 1 y en la 5:

[davidochobitst@turbolinux ~]# whatis tar
tar (1)              - manual page for tar 1.26
tar (5)              - format of tape archive files

Y buscamos en la sección del manual que nos interesa:

man 5 tar

Por defecto, los archivos de los manuales se almacenan en /usr/man y en /usr/share/man. Aunque esto puede varias y se puede cambiar, modificando las variables de entorno.

Otros documentos de ayuda

El conjunto de proyectos de GNU suelen incluir todo tipo de documentación, como FAQ (preguntas y respuestas), Readme, ChangeLog y manuales de usuario y administrador. Pueden estar en diversos formatos, como por ejemplo, ASCII, HTML, LateX o postscript. Generalmente se encuentra en /usr/share/doc

Imprimir los manuales

Es bastante fácil imprimir las páginas del manual, simplemente se ha de redirigir la salida del comando man a un archivo o comando de impresión.

Para no perder el formato, podemos utilizando la herramienta groff, de la siguiente manera:

zcat /usr/share/man/man1/cat.1.gz | groff -man -Tps > cat.ps

O si directamente queremos imprimir:

zcat /usr/share/man/man1/cat.1.gz | groff -man -Tps |lpr

Recordad que hace un tiempo os explique como utilizar el servidor de impresión cups.

También se pueden consultar las páginas de man vía web,  que es lo que yo he hecho para realizar esta entrada:

Man page of man

Man page of info