1.11 Localizar, leer y utilizar documentación de sistema, incluido man, info y archivos en /usr/share/doc

El sistema operativo Linux viene por default con un sin fin de documentación, manuales que nos dan apoyo a entender el funcionamiento de comandos, archivos de configuración, tareas de administración, llamada al sistema, entre otros, estos documentos nos apoyaran a un mejor entendimiento y funcionalidad del sistema, es por eso la importancia de destacar el tema y aprender a usar estas características.

man

Son los manuales que vienen con el sistema operativo, muy extenso como para convertirse en múltiples libros impresos, cada manual contiene información específica de archivos y para un mejor entendimiento este es dividido en secciones por tema.

Tipo de contenido

 

1 Comandos del usuario (ejecutables y programas de la shell)

2 Llamadas del sistema (rutinas del núcleo invocadas desde el espacio del usuario)

3 Funciones de la biblioteca (proporcionadas por bibliotecas de programas)

4 Archivos especiales (como archivos de dispositivos)

5 Formatos de archivos (para muchos archivos y estructuras de configuración)

6 Juegos (sección histórica destinada a programas increíbles)

7 Convenciones, estándares y páginas varias (protocolos, sistemas de archivos)

8 Comandos de administración del sistema y con privilegios (tareas de

mantenimiento)

9 API del núcleo de Linux (llamadas del núcleo internas)

 

Al ejecutar el siguiente comando obtendremos la ayuda que compete al comando man

 

Para la obtención de ayuda de cualquier tema o comando bastará con ejecutar, por ejemplo

 

PASSWD(1)                                              User utilities                                             PASSWD(1)

NAME

      passwd – update user’s authentication tokens

SYNOPSIS

      passwd [-k] [-l] [-u [-f]] [-d] [-e] [-n mindays] [-x maxdays] [-w warndays] [-i inactivedays] [-S] [–stdin] [user‐

      name]

DESCRIPTION

      The passwd utility is used to update user’s authentication token(s).

      This task is achieved through calls to the Linux-PAM and Libuser API.   Essentially, it initializes itself as a

      “passwd”  service with  Linux-PAM and utilizes configured password modules to authenticate and then update a user’s

      password.

 

Para poder diferenciar las secciones sobre un tema en específico, se identifican con un numero entre parentesis despues del tema por ejemplo passwd(1) especificará el comando como tal mientras que passwd(5) el archivo de configuración /etc/passwd.

 

man busca por orden configurado las secciones y muestra la primera que encuentre es por eso que a la ejecución de man passwd nos lleva inmediatamente a la sección 1, pero por ejemplo el tema passwd contiene sección 5 para el tema de archivos de configuración y podremos acceder de la siguiente forma

 

 

PASSWD(5)                                           Formatos de Fichero                                           PASSWD(5)

NOMBRE

      passwd – fichero de contraseñas

DESCRIPCIÓN

      Passwd es  un fichero de texto que contiene una lista de las cuentas del sistema, proporcionando para cada cuenta

      cierta información útil como el identificador (ID) de usuario, el ID de grupo, el directorio `home’,  el intérprete

      de órdenes,  etc. Con frecuencia, también contiene la contraseña cifrada de cada cuenta.  Este fichero debe tener

      permiso de lectura para todos (muchas utilidades, como ls(1), lo usan para traducir el número  de identificador de

      usuario (UID) al nombre del usuario), pero sólo el superusuario debe poder escribirlo.

 

La estructuración de los manuales contiene subsecciones como Nombre, Descripción, Observaciones, Opciones de comandos, Ejemplos, Ficheros, Véase también , entre otras, esto ayuda al a organización de la información para un mejor entendimiento, al principio siempre estará la selección del tema en la cual estamos posicionados

 

Cuales son las secciones que contiene el tema passwd, o bien un tema en específico

 

passwd (5)           – fichero de contraseñas

passwd (1)           – update user’s authentication tokens

openssl-passwd (1ssl) – compute password hashes

 

 

shadow (3)           – encrypted password file routines

shadow (5)           – shadowed password file

Cómo navegar dentro de man

 

Comando Resultado

Spacebar Avanzar (abajo) una pantalla

PageDown Avanzar (abajo) una pantalla

PageUp Retroceder (arriba) una pantalla

DownArrow Avanzar (abajo) una línea

UpArrow Retroceder (arriba) una línea

d Avanzar (abajo) la mitad de una pantalla

u Retroceder (arriba) la mitad de una pantalla

/string Avanzar (abajo) para buscar string en la página de manual

n Repetir la búsqueda anterior hacie adelante del man

N Repetir la búsqueda anterior más atrás (arriba)

g Ir al inicio de la página del manual

G Ir al final de la página del manual

q Salir de man y regresar al aviso de la shell de comandos

 

Palabras claves

Podemos buscar palabras claves dentro de lo manuales del sistema, por ejemplo si quisiéramos saber las secciones de los temas que contengan la palabra xfs, lo haremos se la siguiente forma

 

 

attr (1)             – extended attributes on XFS filesystem objects

filesystems (5)      – Linux filesystem types: ext, ext2, ext3, ext4, hpfs, iso9660, JFS, minix, msdos, ncpfs nfs, ntfs, pro…

fs (5)               – Linux filesystem types: ext, ext2, ext3, ext4, hpfs, iso9660, JFS, minix, msdos, ncpfs nfs, ntfs, pro…

fsck.xfs (8)         – do nothing, successfully

 

Y ya podríamos entrar a una seccion especifica.

 

 

Lo anterior es gracias a un índice generado con el comando mandb ejecutado únicamente con el usuario root

 

man 8 mandb (para mayor información)

 

GNU info / pinfo

Como parte del proyecto GNU se crea info, y de esta manera darle una definición de documentación general, sin bien man resulta muy útil como información formal pero no tan útil como documentación general, aquí la información es estructurada en nodos mediante hipervínculos, lo cual permite realizar análisis más minuciosos de comandos y conceptos complejos, resulta en ocasiones que info contiene información más detallada que man, para acceder a la información usamos los comandos info o bien pinfo, la diferencia entre estos radica que pinfo se diseñó para coincidir con las teclas de navegación de modo texto lynx, además del uso de colores entre otras funcionales, me atrevo a decir que es la versión mejorada de info

 

 

Cómo navegar dentro de pinfo/info

PageDown o Space Avanzar (abajo) una pantalla

PageUp o b Retroceder (arriba) una pantalla

d Mostrar el directorio de temas

Avanzar (abajo) la mitad de una pantalla

u Mostrar el nodo principal de un tema

INICIO Mostrar la parte superior (arriba) de un tema

Retroceder (arriba) la mitad de una pantalla

DownArrow Avanzar (abajo) al siguiente hipervínculo

Enter Abrir el tema en la posición del cursor

Avanzar (abajo) una línea

UpArrow Retroceder (arriba) al hipervínculo anterior

Retroceder (arriba) una línea

/string Buscar un patrón

n Mostrar siguiente nodo (capítulo) en tema

/ luego Enter Repetir la búsqueda anterior más adelante (abajo)

p Mostrar nodo anterior (capítulo) en tema

Repetir la búsqueda anterior más atrás (arriba)

q Salir del programa

 

ejemplos

 

Lectura de documentación en /usr/share/doc

En las nuevas instalaciones de programas, estos crean archivos de documentación para poder apoyarnos en el manejo de sus características esta información es almacenada en el directorio /usr/share/doc/nombre_del_paquete y es una extensión de información de los manuales de man y pinfo.

 

En las mejores prácticas primero se consulta el man posterior si no encontramos la soluciona a nuestras dudas usamos pinfo y al final usaremos la documentación ubicada en /usr/share/doc/nombre_del_paquete

 

Existen paquetes que en necesario instalar otro paquete (rpm) para poder tener informacion, esto lo podemos saber mediante el siguiente comando

 

 

Complementos cargados:product-id, search-disabled-repos, subscription-manager

This system is not registered with an entitlement server. You can use subscription-manager to register.

Paquetes disponibles

gnome-getting-started-docs.noarch                             3.22.0-1.el7     base

gnome-user-docs.noarch                                               3.22.0-1.el7 base

gtk2-devel-docs.x86_64                                                2.24.31-1.el7 base

kernel-doc.noarch                                                           3.10.0-862.el7 base

libstdc++-docs.x86_64                                                    4.8.5-28.el7 base

libvirt-docs.x86_64                                                          3.9.0-14.el7 base

. . .

 

@franklinux

Deja un comentario