03 Documentacion Busqueda y Consulta de Comandos

Documentación, Búsqueda y Consulta de Comandos

Tabla de Contenidos

• Documentación de Comandos
• Búsqueda de Comandos
• Consulta de Comandos
• Documentación Adicional del Sistema
  • Directorios Comunes de Documentación
• Recursos Recomendados
  • Documentación de Comandos
  • Más Tipo de Documentación
• Referencias

Documentación de Comandos

Los comandos desarrollados para sistemas Unix y Unix-like, como Linux, por lo general proporcionan documentación que puede incluir información sobre su propósito, sintaxis, opciones, ejemplos y más. A continuación, se listan algunos comandos utilizados para consultar dicha documentación:

Comando	Descripción	Ejemplo
-h --help	Muchos comandos proporcionan la opción -h o --help. Estas opciones muestran información básica de uso, incluyendo la sintaxis y las opciones disponibles	cal -h cal --help
man comando	Muestra el man page del comando. Se busca en orden por sección: 1, 8, 6, 2, 3, 5, 7, 4, 9, 3p (este orden puede variar según el sistema)	man ls
man [sección] comando	Muestra el man page correspondiente a una sección específica. Útil cuando el mismo nombre existe en varias secciones	man 3 printf
info comando	Muestra el info document del comando. Suele ser más extenso y estructurado que las man pages	info mkdir
help comando	Muestra ayuda sobre los comandos internos (built-in) de Bash. Es una utilidad propia del shell, no un ejecutable independiente	help cd
run-help comando	Comando equivalente de help, pero para Zsh	run-help cd
tldr comando	Muestra el tldr-page del comando. Los tldr-pages son help pages mantenidos por la comunidad para herramientas CLI). Básicamente muestra una breve descripción y ejemplos de uso del comando	tldr grep tldr tldr

Note

El comando tldr no viene preinstalado. Puedes instalar tldr o tealdeer, la implementación de tldr escrita en Rust (mucho más rápida y eficiente).

Búsqueda de Comandos

A veces no recordamos el nombre exacto de un comando. En esos casos, podemos buscar por palabras clave en las man pages utilizando las siguientes herramientas:

Comando	Descripción	Ejemplo
apropos palabra	Busca la palabra clave en los encabezados (headers) de las man pages (nombre y descripción breve)	apropos network
apropos -f palabra	Muestra únicamente las entradas cuyo nombre coincide exactamente con la palabra dada	apropos -f grep
man -k palabra	Sinónimo de apropos	man -k passwd
whatis palabra	Sinónimo de apropos -f	whatis grep
man -f palabra	Sinónimo de whatis	man -f ls

Note

En sistemas modernos, apropos, whatis, man -k y man -f hacen uso de una base de datos de los manuales, que puede actualizarse con mandb.

Consulta de Comandos

Además de ver documentación, también es útil identificar qué tipo de comando se está usando, o dónde se encuentra su ejecutable. Para eso existen:

Comando	Descripción	Ejemplo
type comando	Indica el tipo del comando: si es interno (built-in), función, alias o ejecutable externo	type ls
which comando	Muestra la ruta completa del ejecutable que se ejecutaría (según el $PATH)	which python
whereis comando	Muestra las ubicaciones del binario, el código fuente y las man pages (si existen) del comando	whereis ls
whereis -b comando	Muestra la ubicación del binario del comando	whereis -b ls
whereis -m comando	Muestra la ubicación de las man pages del comando	whereis -m ls
whereis -s comando	Muestra la ubicación del binario del comando	whereis -s ls

Documentación Adicional del Sistema

En la mayoría de los sistemas Unix y Unix-like, como Linux, podemos encontrar documentación adicional en los directorios /usr/share/doc y /usr/doc. Esta documentación, por lo general, incluye archivos README (e.g., README.md, README, readme.txt), archivos de changelog que documentan cambios entre versiones, ejemplos de configuración, guías de uso específicas del paquete, archivos de licencia y, en algunos casos, documentación completa en formatos HTML o PDF.

Toda esta documentación es típicamente usada por administradores de sistemas para aprender cómo configurar servicios de software complejo. Sin embargo, algunas veces los usuarios comunes pueden encontrar documentación útil.

Directorios Comunes de Documentación

Directorio	Descripción
/usr/share/doc/	Ubicación estándar en sistemas modernos (FHS). Contiene documentación de paquetes instalados
/usr/doc/	Directorio legacy usado en sistemas antiguos. Algunos sistemas mantienen enlaces simbólicos a /usr/share/doc/
/usr/share/man/	Man pages organizadas por sección
/usr/share/info/	Documentación en formato Info
/usr/local/share/doc/	Documentación de software instalado localmente (no por el gestor de paquetes)

Recursos Recomendados

Documentación de Comandos

• Manned.org ― Colección de man pages de varias distros de Linux, BSD, etc., y man pages correspondientes para varias versiones de los programas (package versions)
• Linux.die.net ― Man pages de Linux
• Tldr Pages
• Arch Linux Wiki ― Man pages
• Arch Linux Wiki - Info documents

Más Tipo de Documentación

• Die.net ― Documentación de Linux
• Linux Docs ― Documentación para entusiastas de Linux
• Linux Docs ― HOWTOs ― Documentación de cómo hacer varias cosas en Linux
• Arch Linux Wiki ― Wiki con una extensa documentación con soporte para varios idiomas. Puede ser útil incluso para usuarios de otras distros

Referencias

• GoalKicker (s.f.). Section 1.4: Basic Linux Utilities. Linux Notes for Professionals (pp. 4-5). https://goalkicker.com/LinuxBook

• Shotts, W. (2019). Working With Commands. The Linux Command Line (2nd ed., pp. 38-48). No Starch Press.

• NetDevGroup (s.f.). Getting Help. https://portal.netdevgroup.com/learn/fb477d77-7adb-4d85-8db3-72f500f60315/eng5GheM93/?xid=eyJpZCI6Imx0aTFwMy1sYXVuY2gtZjhiZDFmNTgtNzM4NS00ZmJjLTk2YTgtODc0NmEwMDY3YmVlIiwiY29udGV4dF9pZCI6ImZiNDc3ZDc3LTdhZGItNGQ4NS04ZGIzLTcyZjUwMGY2MDMxNSIsInJvbGUiOiJTIiwidXNlcl9pZCI6IjZiYzBiM2NkYmY1MDRhMTViZDU1NTUyODcwNGFkMjgyIn0:1udtAB:pzr7aYnkXVrQFxh5MvDGcR_NUXal2ev8SHzx_WkO3H8

• Akamai (s.f.). whereis Command. Operating Systems Fundamentals. https://www.coursera.org/learn/akamai-operating-systems/lecture/CxahC/whereis-command