Ayuda y documentación en Linux

Introducción

Uno de los grandes pilares de Linux es que la documentación viene incluida en el propio sistema. No necesitas buscar en internet para entender cómo funciona un comando: las herramientas de ayuda están disponibles en la terminal en todo momento.

Cada comando, herramienta o servicio suele tener al menos una forma de documentación asociada. Conocer dónde y cómo buscarla te hace independiente y más eficiente como usuario o administrador del sistema.

man

man (de manual) es la herramienta de documentación más importante de Linux. Cada página de manual describe en detalle un comando: su sintaxis, opciones, comportamiento y ejemplos.

Las páginas están organizadas en secciones numeradas:

  • 1 -> Comandos de usuario
  • 2 -> Llamadas al sistema
  • 3 -> Funciones de biblioteca
  • 5 -> Formatos de archivos
  • 8 -> Comandos de administración

Ejemplos de uso:


$ man ls              # manual del comando ls
$ man 5 passwd        # sección 5: formato del archivo /etc/passwd
$ man -k "copy file"  # busca páginas relacionadas con "copy file"
      

Cuando entramos dentro de la pagina si queremos salir debemos pulsar en q y podemos movernos con las flechas del teclado.

Podemos buscar con /terminodebusqueda y pulsar n para encontrar el siguiente resultado. De una manera muy similar a como lo hacemos en vim.

info

info es un sistema de documentación más moderno que man, desarrollado por el proyecto GNU. Presenta el contenido en forma de nodos navegables, similar a una página web con hipervínculos, lo que lo hace ideal para documentación larga y estructurada.

Muchas herramientas GNU —como grep, awk o bash— tienen páginas info más completas que sus páginas man.

Ejemplos de uso


  $ info ls             # documentación de ls en formato info
  $ info bash           # documentación completa de bash
  $ info coreutils      # documentación de todas las utilidades GNU
      

Dentro de info: Tab para saltar entre enlaces, Enter para seguirlos, l para volver atrás, q para salir.

whatis

whatis muestra una línea de descripción del comando, extraída directamente de su página man. Es útil cuando no recuerdas exactamente para qué sirve un comando y solo necesitas una pista rápida.

Ejemplo de uso


  $ whatis ls
  $ whatis cp mv rm
      

Si whatis no encuentra resultados, prueba ejecutar sudo mandb para actualizar la base de datos de manuales.

/usr/share/doc/- Documentación adicional de paquetes

Este directorio contiene documentación instalada junto con cada paquete del sistema: archivos README, CHANGELOG, licencias, ejemplos de configuración y guías específicas. Es especialmente útil para servicios y aplicaciones complejas como nginx, openssh o postgresql.

Ejemplo de uso


  $ ls /usr/share/doc/
      

Los archivos .gz se pueden leer sin descomprimir usando zcat o zless.

Transferencia de archivos: scp, rsync

Índice de la sección

Índice del curso