Cómo consultar documentación en la terminal: man, --help e info paso a paso

Introducción

En el día a día de cualquier desarrollador o administrador de sistemas, saber dónde encontrar la información de una herramienta es tan importante como saber usarla. En entornos Unix‑like, tres recursos principales nos permiten acceder a la documentación directamente desde la línea de comandos:

• man (manual pages)
• --help (ayuda rápida del propio comando)
• info (documentación en formato hipertexto)

En este tutorial vas a ver cómo invocar cada uno, qué tipo de salida esperar y algunos trucos para sacarle el máximo provecho.

1. El comando man

1.1 ¿Qué es?

man es la abreviatura de manual y muestra las páginas de manual (man pages) que describen el uso, opciones y ejemplos de los comandos instalados en el sistema.

1.2 Sintaxis básica

man <nombre_del_comando>

1.3 Ejemplos prácticos

1.3.1 man ls

$ man ls

La salida abre el visor less con una página que incluye secciones típicas:

• NAME – nombre y breve descripción.
• SYNOPSIS – sintaxis del comando.
• DESCRIPTION – explicación más detallada.
• OPTIONS – listado de banderas (e.g. -a, -l).
• EXAMPLES – casos de uso comunes.

1.3.2 Navegación dentro de man

• Espacio: avanza una página.
• b: retrocede una página.
• /texto: busca la cadena texto.
• n: repite la búsqueda hacia adelante.
• q: sale del visor.

1.4 Buscar páginas por palabra clave

man -k <palabra>

Ejemplo:

$ man -k copy

Mostrará todas las páginas que contengan copy en su nombre o descripción.

2. La bandera --help

2.1 ¿Cuándo usarla?

Muchos binarios incluyen una salida de ayuda corta que muestra la sintaxis esencial y las opciones más usadas. Es ideal para una referencia rápida sin abrir todo el manual.

2.2 Sintaxis típica

<nombre_del_comando> --help

Algunos comandos aceptan también -h como alias.

2.3 Ejemplo: ls --help

$ ls --help

Salida esperada (truncada):

Usage: ls [OPTION]... [FILE]...
List information about the FILEs (the current directory by default).

  -a, --all                do not ignore entries starting with .
  -l                       use a long listing format
  -h, --human-readable     with -l, print sizes in human readable format
  --color[=WHEN]           colorize the output; WHEN can be 'always',
                           'auto' (default if omitted), or 'never'
  -? --help                display this help and exit

Obsérvese que la salida está diseñada para ser leída rápidamente: muestra la usage, una breve descripción y las opciones más relevantes.

2.4 Tips útiles

• Combina --help con grep para filtrar una opción específica:

  $ ls --help | grep "--human"
  

• Algunos comandos usan -? en vez de --help; prueba ambos.

3. El comando info

3.1 ¿Qué es info?

info muestra la documentación en formato Info, una estructura de árbol navegable que permite enlaces internos, similar a la documentación de GNU.

3.2 Sintaxis básica

info <nombre_del_comando>

Si el comando no tiene una página de info, info delegará a man.

3.3 Ejemplo: info coreutils 'ls invocation'

$ info coreutils 'ls invocation'

Se abre el visor info en la sección Invocación de ls, donde encontrarás:

• Explicación detallada de cada opción.
• Información sobre variables de entorno (e.g. LC_COLLATE).
• Enlaces a secciones relacionadas (por ejemplo, Sorting).

3.4 Navegación en info

• Enter o Space: avanza.
• Backspace: retrocede.
• n / p: nodo siguiente / nodo anterior.
• u: sube un nivel en el árbol.
• q: sale.
• s: busca una cadena.

3.5 Ventajas frente a man

• Hipervínculos internos que facilitan saltar entre conceptos.
• Estructura jerárquica que permite profundizar sin perder el contexto.
• Actualizaciones más frecuentes en paquetes GNU.

4. Mejores prácticas

1. Empieza con --help para un vistazo rápido; si necesitas más detalle, abre man.
2. Usa info cuando el tema sea extenso o requiera ejemplos paso a paso.
3. Guarda la salida en un archivo si vas a compartirla:

   $ ls --help > ayuda_ls.txt
   $ man grep | col -b > man_grep.txt
   

   (col -b elimina los caracteres de formato).
4. Combina con grep/awk para filtrar la información que realmente te interesa.
5. Configura tu pager (PAGER=less -S) si prefieres evitar el ajuste de línea automática.

5. Conclusión

Dominar man, --help e info te permite resolver dudas al instante, sin abandonar la terminal. Cada herramienta tiene su nicho: --help para respuestas inmediatas, man para referencias completas y estructuradas, e info para documentación profunda y enlazada. Practicá invocando los comandos mostrados y verás cómo tu productividad en la línea de comandos se dispara.