¿Cómo usar la documentación y herramientas de ayuda en Linux?

En Linux no hay espacio para la memorización absoluta. Los comandos tienen decenas de opciones, los archivos de configuración cambian entre versiones y cada distribución tiene sus particularidades.

Por eso, la verdadera destreza del administrador no está en saberse todo de memoria, sino en saber dónde y cómo buscar la información de manera rápida y efectiva.

12.1. Introducción: la importancia de saber encontrar respuestas

Durante el examen LFCS, tendrás acceso a las páginas de manual (man), a la ayuda integrada de los comandos (--help) y a la documentación del sistema.

Aprovechar estas herramientas puede marcar la diferencia entre resolver una tarea con éxito o quedarse atascado. En este capítulo aprenderás a utilizar todas las fuentes de documentación disponibles en un sistema Linux.

12.2. man como manual de referencia

El comando man (manual) muestra la documentación de referencia de comandos, archivos de configuración, llamadas al sistema y funciones de biblioteca. Es la fuente más completa y fiable, aunque a veces resulte densa.

12.2.1. Estructura básica

man [sección] término

Si no se especifica la sección, man muestra la primera entrada que encuentra. Las secciones estándar son:

Ejemplo: passwd tiene página en la sección 1 (comando) y en la sección 5 (formato del archivo). Para ver el archivo de configuración:

man 5 passwd

12.2.2. Navegación dentro del manual

Una vez abierta la página, se usa un paginador (normalmente less). Teclas útiles:

• /patrón: buscar hacia adelante.
• ?patrón: buscar hacia atrás.
• n / N: siguiente/anterior coincidencia.
• g: inicio, G: final.
• q: salir.

12.2.3. Búsqueda en las páginas de manual

• man -k palabra: busca en las descripciones cortas (equivalente a apropos).
• man -f palabra: busca títulos exactos (equivalente a whatis).

man -k partition   # lista páginas relacionadas con particiones
whatis lvcreate    # descripción breve
apropos lvm        # búsqueda más amplia

12.2.4. Opciones útiles

• man -w comando: muestra la ruta del archivo de la página.
• man -a comando: muestra todas las páginas de todas las secciones, una tras otra.
• man -H comando: intenta abrir en el navegador web (si está configurado).

12.2.5. Actualizar la base de datos de man

En algunas distribuciones se usa mandb o makewhatis para regenerar la base de datos que usan whatis y apropos. Normalmente se ejecuta automáticamente tras instalar paquetes, pero si no encuentras una página recién instalada:

sudo mandb

12.3. info ofrece documentación más estructurada

El sistema info (basado en texinfo) ofrece documentación hipertextual con nodos y menús navegables. Suele ser más extensa que man y cubre principalmente herramientas del proyecto GNU.

• Ejecutar: info comando (ej. info coreutils).
• Navegación básica: teclas como n (siguiente nodo), p (anterior), u (subir), q (salir), Enter sobre enlaces.
• Si info no está disponible, se puede instalar el paquete texinfo o usar pinfo (navegador alternativo con más color).

En la práctica, muchos comandos redirigen su info a man o duplican contenido. Sin embargo, para herramientas como diff, sed, grep, la página info puede ser mucho más detallada.

12.4. Ayuda integrada: --help

La mayoría de comandos ofrecen un resumen rápido de opciones con:

comando --help

O en algunos casos -h o -?. Ejemplos:

tar --help | less
grep --help

Es especialmente útil para recordar la sintaxis básica sin salir del terminal. No reemplaza a man, pero es inmediato.

12.5. whatis y apropos – Búsquedas rápidas

whatis palabra: muestra una descripción de una sola línea de la página de manual que coincide exactamente.

whatis ls
# ls (1) - list directory contents

apropos palabra: busca la palabra en los nombres y descripciones de todas las páginas. Ideal cuando no recuerdas el nombre exacto del comando.

apropos partition
# fdisk (8), gdisk (8), parted (8), etc.

Ambos dependen de la base de datos generada por mandb.

12.6. Documentación en /usr/share/doc/

Muchos paquetes instalan documentación adicional (README, ejemplos, changelog, FAQ) en /usr/share/doc/nombre_paquete/. Ahí puedes encontrar:

• Archivos de configuración de ejemplo.
• Guías rápidas.
• Notas de versión.
• Scripts de ejemplo.

Por ejemplo, la configuración de ejemplo de Samba suele estar en /usr/share/doc/samba/.

Se puede explorar con ls y leer con less:

ls /usr/share/doc/openssh-*/
less /usr/share/doc/openssh-*/README.Debian

12.7. whereis y locate – Encontrar archivos relacionados

• whereis comando: localiza el binario, las fuentes y las páginas de manual de un comando.

whereis ls
# ls: /usr/bin/ls /usr/share/man/man1/ls.1.gz

• locate patron: busca archivos en todo el sistema usando una base de datos actualizada (updatedb). Es rapidísimo.

locate passwd | less

Si el archivo es reciente, habrá que actualizar la base: sudo updatedb.

which comando: muestra la ruta exacta del ejecutable que se invoca (según $PATH).

which python3
# /usr/bin/python3

12.8. help para comandos internos de Bash

Muchos comandos como cd, alias, export, for son propios del shell y no tienen página de manual externa. Se documentan con:

help comando
help for
help alias

Para ver todos los comandos internos: help.

12.9. Documentación del kernel y pseudo-sistemas de archivos

• /proc y /sys contienen información en tiempo real sobre el kernel y el hardware. Algunos archivos son legibles por humanos y contienen documentación en sus primeras líneas.
• El kernel mismo tiene documentación en el paquete linux-doc o en /usr/src/linux/Documentation/ cuando se compila.
• Para parámetros del kernel, sysctl -a y luego sysctl -d variable muestra descripciones.

12.10. Otras fuentes de ayuda

12.10.1. Comandos type y command

• type comando: muestra cómo interpreta el shell un nombre (alias, función, builtin, archivo externo).
• command -v comando: similar, más portable.

12.10.2. tldr (Too Long; Didn’t Read)

Herramienta de terceros que muestra ejemplos prácticos resumidos de los comandos más habituales. Se instala con:

sudo apt install tldr   # o tldr-py, tldr-go

Uso: tldr tar → muestra ejemplos directos. Muy útil si no necesitas la exhaustividad de man. En el examen no estará disponible, pero en tu aprendizaje diario acelera mucho.

12.10.3. Recursos en línea (contexto real)

Aunque no accesibles en el examen, en el trabajo real es bueno conocer:

• https://explainshell.com: desglosa comandos complejos.
• https://wiki.archlinux.org: excelente documentación técnica, válida para muchas distribuciones.
• https://www.kernel.org/doc/: documentación oficial del kernel.

12.11. Ejercicios prácticos

1. Exploración de secciones man:

   • Busca la página de crontab de la sección 1 y de la sección 5. Compáralas.
   • Usa man -k para encontrar todas las páginas relacionadas con “firewall”. Elige una y estúdiala.

2. Uso de --help:

   • Compara la salida de tar --help, man tar y info tar. ¿Cuál prefieres para un vistazo rápido? ¿Cuál para detalles sobre opciones oscuras?

3. whatis y apropos:

   • Ejecuta whatis awk y apropos awk. ¿Cuál te da más resultados? ¿Por qué?
   • Si whatis no muestra nada para un comando recién instalado, ¿qué harías?

4. Documentación en /usr/share/doc:

   • Explora la documentación de nginx (o apache2) en /usr/share/doc. Encuentra ejemplos de configuración.

5. whereis y which:

   • Averigua dónde está el binario y el manual de useradd. Luego con which confirma la ruta exacta.
   • ¿Hay varios binarios con el mismo nombre en diferentes rutas? Usa which -a.

6. Internos de Bash:

   • Comprueba si echo es un builtin o un ejecutable externo con type echo. Haz lo mismo con ls.
   • Ejecuta help test y man test. Compara.

7. Navegación info:

   • Entra en info coreutils. Intenta moverte entre nodos (n, p, u, Enter). Sal con q.

8. Búsqueda con locate:

   • Localiza todos los archivos con la palabra fstab. Actualiza la base de datos antes si es necesario.

12.12. Resumen y consejos para LFCS

• man es tu salvavidas: apréndete las secciones principales (1, 5, 8) y practica la búsqueda (/) y la navegación. En el examen, perder 2 minutos leyendo man te puede ahorrar 10 de errores.
• Combina --help para sintaxis y man para profundidad.
• apropos y whatis son ideales cuando no recuerdas el nombre del comando.
• Explora /usr/share/doc cuando necesites ejemplos de configuración.
• No te fíes solo de la memoria: incluso los administradores más veteranos consultan constantemente las ayudas del sistema.
• La habilidad de buscar y entender documentación no solo es parte del examen, es la base del aprendizaje continuo en Linux.

Has aprendido a aprovechar al máximo los recursos de documentación integrados. En el próximo capítulo abordaremos la configuración y solución de problemas del gestor de arranque GRUB, una pieza crítica para el inicio del sistema y otro objetivo del temario LFCS.