Obtener ayuda en la línea de comandos

Los usuarios de sistemas GNU/Linux disponemos de una herramienta indispensable, la línea de comandos. En este artículo vemos los métodos para obtener ayuda en la línea de comandos, referida a los comandos y otro software que utilicemos.

El empleo de la línea de comandos puede resultar intimidante al principio, ya que disponemos de muchos comandos y cada uno tiene varias opciones que son únicas y que necesitamos conocer para realizar tareas específicas. Por eso es tan importante la documentación cuando trabajamos con estos sistemas.

Sumario

• Obteniendo ayuda en línea de comandos
• Ayuda integrada en línea de comandos
• El parámetro –help
• Páginas man
• Páginas de información (Info Pages)
• El directorio /usr/share/doc/

La línea de comandos es una herramienta muy completa, y compleja en algunos casos. Cada comando tiene sus propias opciones únicas, por lo tanto, la documentación es clave cuando se trabaja con un sistemas GNU/Linux. Además del directorio /usr/share/doc/, que almacena la mayor parte de la documentación, disponemos de otras herramientas que también proporcionan información sobre el uso de los comandos. Vamos a ver los métodos para acceder a esa documentación para obtener ayuda.

Obteniendo ayuda en línea de comandos

Existe varios métodos para obtener ayuda dentro de la línea de comandos. man, help e info son solo algunos de ellos. En este artículo nos centraremos en man e info, ya que son las herramientas que más utilizamos para obtener ayuda.

Ayuda integrada en línea de comandos

El parámetro –help

Cuando ejecutamos un comando con el parámetro –help, la mayoría de los comandos, nos muestran algunas indicaciones sencillas sobre su uso. Y, aunque no todos los comandos proporcionan está opción, es una buena idea para un primer intento de dar con la opción que buscamos, y aprender más sobre el resto de sus parámetros. Con la opción –help, obtendremos unas instrucciones, a menudo muy breves, por ello analizaremos más en profundidad, otras fuentes de documentación.

Páginas man

Las man pages, abreviatura de «manual pages» o páginas de manual, son una forma de documentación sobre comandos, ficheros, llamadas al sistema, etc., en un sistema operativo GNU/Linux. Esta documentación está disponible en casi todos los sistemas operativos derivados de UNIX. Los ficheros que constituyen las páginas del manual se almacenan en la ruta /usr/share/doc.

Para acceder a estas páginas tenemos que utilizar el comando man.

A pesar de la amplia cantidad de temas que estos documentos pueden abordar, las páginas man, están diseñadas para ser independientes entre si, limitándose a hacer mención a otras páginas de manual cuando sea necesario. Y si no vienen con la instalación del sistema operativo, se instalarán cuando instales un determinado software, incluidos los comandos.

Para acceder a la página del manual de un comando, tenemos que preceder el comando en cuestión con la orden man y la sintaxis siguiente,

man [comando] [[sección] página …] …

Por ejemplo, para saber todo lo relacionado sobre el comando man basta con escribir en la terminal,

man man

Este comando abre la página del manual para man. Pero también puedes probar con cualquier otro comando, por ejemplo mkdir

man mkdir

Para navegar por la página del manual tenemos que usar las teclas de flecha arriba y abajo o la barra espaciadora. Para salir de la página del manual, tenemos que presionar la tecla Q.

Las páginas de man se organizan en categorías y están divididas en secciones. Analizamos su contenido.

Aunque muchas de estas secciones son opcionales, cada página de man está dividida en secciones, que pueden ser:

Y alguna sección más como: ESTADO DE SALIDA, VALOR DEVUELTO, ERRORES, ENTORNO, VERSIONES, CONFORME A, NOTAS y DEFECTOS.

Las páginas man están organizadas en categorías, numeradas del 1 al 9:

Aunque cada página de manual pertenece a una categoría, varias categorías pueden contener páginas de manual con el mismo nombre. Tomemos como ejemplo uno de los más claros, el comando passwd.

Este comando se utiliza para cambiar la contraseña de un usuario y lógicamente, tiene su página de manual. Como se trata de un comando de usuario, tiene su página de manual dentro de la categoría 1.

No obstante, además del comando passwd, en GNU/Linux, tenemos un fichero de base de datos de usuarios y contraseñas en la ruta /etc/passwd, que también tiene una página man que se llama passwd. Como este fichero es un fichero de configuración, pertenece a la categoría 5.

Por defecto, sin indicar la categoría, man passwd muestra la primera página man disponible, en este caso passwd(1).

Cuando se hace referencia a una página de manual determinada, tendrás que añadir la categoría al nombre de la página de manual, como en passwd(1) o passwd(5) para identificar la página de manual respectiva. Por ejemplo, ejecuta,

man 5 passwd

Ya sabemos como navegar por una página man y como volver a la línea de comandos. Este comportamiento se produce porque, internamente, man utiliza el comando less para mostrar el contenido de la página.

less nos permite buscar texto dentro de una página man. Por ejemplo, para encontrar la palabra «optional» podemos teclear /optional e iniciará una búsqueda hacia adelante desde el punto en el que se encuentra en la página, o ?optional para iniciar una búsqueda hacia atrás. Verás resaltados los resultados coincidentes desde la primera ocurrencia. Para saltar a la siguiente, presiona la tecla N.

Si necesitas encontrar más información sobre estas características adicionales del comando less, presiona la tecla H, y se mostrará un menú con toda la información.

Algunas distribuciones ofrecen páginas html con documentación de los comandos. Por ejemplo el Manual de man de Ubuntu. O la página Manpages of manpages in Debian bookworm de Debian. Pero te aseguro que es más fácil y rápido usar las herramientas que exponemos.

Páginas de información (Info Pages)

La herramienta Info es un programa independiente, parte de la Distribución Texinfo, que se utiliza para visualizar ficheros de texto en una terminal.

Esta herramienta es muy práctica para obtener ayuda en la línea de comandos, mientras trabajamos con un sistema GNU/Linux. Son las llamadas páginas de información (info pages). Las páginas info suelen ser más detalladas que las páginas de manual y están formateadas en hipertexto, similar a las páginas web en Internet.

Las páginas info se pueden mostrar así:

info man

En Debian 12 no está disponible esta opción. La han sustituido por un manual de referencia.

Lo vemos con Ubuntu

Para cada página de información, info lee un fichero que está estructurado en nodos individuales dentro de un árbol. Cada nodo contiene un tema simple. El comando info maneja hipervínculos que nos permiten movernos por el documento. Puedes seguir un enlace presionando «enter» habiendo colocado el cursor sobre uno de los asteriscos principales (los enlaces aparecen subrrayados).

Similar a man, la herramienta info también provee comandos de navegación de página. Puedes obtener más información sobre estos comandos presionando ? en la página de info. Estas herramientas te ayudarán a moverte por la página más fácilmente, así como a comprender cómo acceder a los nodos y moverte dentro del árbol.

También puedes consultar el manual de info

man info

El directorio /usr/share/doc/

Como ya hemos comentado más arriba, el directorio /usr/share/doc/ almacena la mayoría de la documentación de cada comando que utilice el sistema. Este directorio contiene un directorio exclusivo para la mayoría de los paquetes instalados. El nombre de cada directorio suele ser el nombre del paquete, y en ocasiones incluye su versión.

Estos directorios incluyen un fichero README o readme.txt que contiene la documentación básica del paquete. El directorio también puede contener otros ficheros de documentación, como el registro de cambios «changelog» que incluye el historial del programa en detalle o ejemplos de ficheros de configuración para el paquete específico.

La información dentro del fichero README varía de un paquete a otro, dependiendo de la voluntad de su autor. Todos los ficheros están escritos en texto plano, por lo tanto, se pueden leer con tu editor de texto preferido. El número exacto de ficheros y sus tipos dependerán del paquete determinado.

Te recomiendo consultar algunos de los directorios para obtener una descripción general de sus contenidos.

Como puedes ver tienes información para casi todo. Con un poco de paciencia encontrarás soluciones para trabajar con tu sistema GNU/Linux. Buscando en esta documentación podrás encontrar, en ocasiones, algo interesante, como tutoriales o documentación técnica adicional.

Y si no lo encontrases, siempre podrás acudir a fuentes externas de documentación como El Proyecto de Documentación Linux «LDP», las listas de correos, los grupos de noticias y la información que ofrecen las distintas distribuciones.

Si tienes algún comentario que hacer sobre este artículo, al pie del post tienes un formulario para hacerlo.

Si quieres contactar conmigo por cualquier otro asunto relacionado con el sitio, en la página de contacto, tienes un formulario más adecuado.

Y para suscribirte y recibir las novedades publicadas, tienes un enlace en pie de la página o desde aquí mismo.