Interactuando con el bash man page.

La mayoría de las distribuciones de GNU/Linux incluyen un manual de los comandos, así como las vastas utilerías incluías en la distribución. Si estás en contacto con sistemas GNU/Linux debes familiarizarte con los manuales en línea de comandos. La información que brindan es invaluable, especialmente cuando estás buscando alguna opción de un comando habitual o intentas comprender un comando por completo nuevo.
El comando man es provee acceso a la ayuda mencionada, misma que está instalada en el sistema de archivos, por tanto, no es necesaria una conexión activa a Internet. Es lo más elemental. La forma más sencilla de utilizarlo es escribir en el prompt la palabra man seguida del nombre del comando.
$ man comando
Es importante decir que el manual de los comandos desplegado en bash no es un ‘paso a paso’ ni tampoco es la documentación más extensiva que podemos encontrar. Es una referencia rápida para utilizar los comandos y utilitarias en el menor tiempo posible con una breve explicación de los puntos más importantes a considerar tanto en su ejecución como en su interpretación.
Cuando se despliega la ayuda en la terminal, son visualizadas por los pagers. Un pager es la utilidad que permite navegar entre la documentación. La tecla con la que se navega es con space. Para recorrer línea a línea se usa la tecla enter o las flechas de desplazamiento.
En caso de querer salir de la documentación, se presiona la tecla ‘q’.
Como era de esperarse, la ayuda en CLI también tiene su manual, el cual se consulta de manera idéntica a los demás comandos.
$ man man
La estructura de la documentación es similar en casi todos los comandos y utilerias.
Nombre. Despliega el nombre del comando y una descripción sucinta.
Sinopsis. Muestra la sintaxis del comando.
Configuración. Provee información de la configuración.
Descripción. Describe el comando de manera general.
Opciones. Describe las opciones que tiene el comando (banderas).
Estatus de terminación. Define los códigos de terminación.
Valores de retorno. Describe los valores de retorno del comando.
Errores. Provee información sobre errores.
Ambiente. Describe las variables de ambiente utilizadas.
Archivos. Describe los archivos utilizados por el comandos.
Versiones. Muestra la versión del comando.
Bugs. Provee información para reportar errores en el comando.
Ejemplo. Muestra algunas maneras de utilizar el comando con sus banderas.
Autores. Muestra la información de los desarrolladores del comando.
Derechos de autor. Despliega los derechos de autor del código del comando.
Ver también. Es información de comandos similares.
Cabe señalar que no todos los comandos en GNU/Linux tienen manual o no siguen la convención antes mencionada.
También existen la secciones del manual, las cuales se dividen en los siguientes propósitos. Si no se especifica un número se utiliza la entrada 1.
1 Programas ejecutables y guiones del intérprete de órdenes
 2 Llamadas del sistema (funciones servidas por el núcleo)
 3 Llamadas de la biblioteca (funciones contenidas en las bibliotecas del sistema)
 4 Ficheros especiales (se encuentran generalmente en /dev)
 5 Formato de ficheros y convenios p.ej. I/etc/passwd
 6 Juegos
 7 Paquetes de macros y convenios p.ej. man(7), groff(7).
 8 Órdenes de admistración del sistema (generalmente solo son para root)
 9 Rutinas del núcleo [No es estándar]
 n nuevo [obsoleto]
 l local [obsoleto]
 p público [obsoleto]
 o viejo [obsoleto]
Para ingresar a las siguientes secciones se indica el número antes del comando. Por ejemplo.
$ man 2 syscall
La manera más rápida de ubicar el man page de un comando que no sabemos a ciencia cierta su nombre, es por medio de:
$ man -k criterio
Por ejemplo
$ man -k sort
Por supuesto que no es la única manera de obtener información, al menos hay dos más: con el comando info y con la bandera help de cada comando.

Comentarios

Entradas populares de este blog

Análisis de conexiones TIME_WAIT

Agregar un usuario a un grupo secundario

Pluging de HAProxy para Collectd.