Cómo Obtener Ayuda en Linux: man, info, --help y Documentación Online

Para obtener ayuda en Linux es muy fácil. Linux tiene un conjunto de manuales que pueden ser utilizados por los usuarios y administradores para consultar información sobre los comandos en busca de ayuda.

Linux posee algunos canales de ayuda al usuario, tales como:

• Ayuda de los comandos, con la opción "--help";
• Páginas de información con el comando "info";
• Documentación del sistema en "/usr/share/doc";
• Manuales a través del comando "man";

Ayuda de los Comandos

La mayoría de los comandos posee una pequeña ayuda a través de la opción "--help", que trae un pequeño manual:

$ free --helpUsage: free [options]Options: -b, --bytes         show output in bytes -k, --kilo          show output in kilobytes -m, --mega          show output in megabytes -g, --giga          show output in gigabytes     --tera          show output in terabytes     --peta          show output in petabytes -h, --human         show human-readable output     --si            use powers of 1000 not 1024 -l, --lohi          show detailed low and high memory statistics -t, --total         show total for RAM + swap -s N, --seconds N   repeat printing every N seconds -c N, --count N     repeat printing N times, then exit -w, --wide          wide output     --help     display this help and exit -V, --version  output version information and exit

Utilizando las Páginas Info

Una fuente interesante de consulta son las páginas info. Esta documentación fue desarrollada por el proyecto GNU y cubre gran parte de las herramientas del proyecto.

Para tener acceso a esta documentación, es necesario utilizar el comando info seguido del nombre del comando deseado. Vea un ejemplo, digitando el comando en el shell:

# info test

El info posibilita la navegación entre los tópicos relacionados. Para navegar en el info, basta encontrar un "enlace" que está formado por el símbolo "*" y una palabra y presionar la tecla enter.

Para pasar a la siguiente página del contenido, digite "N" (Next) y, para volver, digite "P" (Previous). La tecla "q" sale del info.

El comando info sin ningún argumento lista todas las páginas existentes. 

# info

Encontrando la Documentación en /usr/share/doc

El directorio /usr/share/doc posee gran parte de la documentación de una distribución Linux y diversos aplicativos en forma de HOWTOS, FAQs, archivos README, guías de instalación y manuales de usuario.

El subdirectorio /usr/share/doc/howto posee casi 2000 páginas de documentación detallando paso a paso diversas tareas.

Vea un ejemplo:

3Dfx-HOWTO.htmlAI-Alife-HOWTO.htmlAcer-Laptop-HOWTO.htmlAlpha-HOWTO.htmlBash-Prog-Intro-HOWTO.htmlBenchmarking-HOWTO.html

Este tipo de documentación es útil cuando no se sabe cómo comenzar una determinada tarea o qué herramientas deben ser utilizadas.

En el subdirectorio /usr/share/doc/packages pueden encontrarse información sobre casi todos los paquetes de software instalado en el sistema. Esta información puede incluir archivos con contenidos distintos como README, INSTALL, CHANGES, INFO, FAQ, etc.

No siempre los how-tos pueden estar instalados en la distribución, y su ruta puede ser diferente.

Manual de los Comandos con el man

$ man [sesión] comando

El comando man ofrece un manual de varios comandos de GNU Linux, así como manual de otros programas de terceros. El man ofrece una interfaz simplificada para que los programadores ofrezcan un manual de sus programas.

Las páginas de manual acompañan a casi todos los programas GNU/Linux y pueden ser instaladas de acuerdo con el idioma elegido, si está disponible en la distribución.

La información del man se conoce como "Páginas del Man" y traen una descripción básica de comandos y detalles sobre el funcionamiento de sus opciones. 

Una página de manual se visualiza en forma de texto único con desplazamiento vertical. También documenta parámetros usados en algunos archivos de configuración. 

Secciones del Man

Los documentos del manual están divididos en secciones de acuerdo con el tema abordado. Las secciones están numeradas de 1 a 9, a continuación:

1. Programas ejecutables o comandos de shell;
2. Llamadas del Sistema (funciones proporcionadas por el Kernel);
3. Llamadas de Biblioteca (funciones proporcionadas por las bibliotecas);
4. Archivos especiales, especialmente aquellos ubicados en /dev;
5. Formatos de archivos y convenciones;
6. Juegos;
7. Paquetes Macro;
8. Comandos administrativos;
9. Rutinas del kernel.

Es posible que una misma palabra pueda referenciar a una función de programación, comando o archivo de configuración. De esta manera es importante saber en cuál sección encontraremos la documentación deseada.

Cada página del manual está dividida en partes:

• NAME: Nombre del ítem buscado con una descripción corta;
• SYNOPSIS: Descripción completa del uso y sintaxis;
• DESCRIPTION: Descripción breve de las funcionalidades;
• OPTIONS: Descripción de cada opción y argumentos;
• FILES: Una lista de archivos importantes;
• SEE ALSO: Una lista de ítems relacionados con el buscado;
• BUGS: Descripción de posibles problemas con el ítem;
• AUTHOR: Lista de personas responsables del ítem.

Para acceder al manual, el comando es man seguido del ítem buscado. Como opción, el número de la sección puede ser pasado como parámetro.

$ man passwd

En este ejemplo el man visualiza el manual del comando passwd, perteneciente a la sección 1.

$ man 5 passwd

Ya en este ejemplo el man mostrará el manual del archivo /etc/passwd.

La navegación dentro de las páginas de manual se hace usando las teclas: 

• q Sale de la página de manual;
• PageDown o f Desplaza 25 líneas hacia abajo;
• PageUP o w Desplaza 25 líneas hacia arriba; 
• FlechaArriba o k Desplaza 1 línea hacia arriba; 
• FlechaAbajo o e Desplaza 1 línea hacia abajo;
• r Redibuja la pantalla (refresh);
• p o g Inicio de la página; 
• h Ayuda sobre las opciones de la página de manual; 
• s Guarda la página de manual en formato texto en el archivo especificado.

Conclusión

Si deseas obtener ayuda de algún comando en Linux, la manera más fácil es utilizar el comando "man" para leer el manual del comando deseado.

Aprende mucho más sobre Linux en nuestro curso en línea. Puedes realizar la matrícula aquí. Si ya tienes una cuenta, o quieres crear una, simplemente ingresa o crea tu usuario aquí.

¿Te gustó? Comparte