Como encontrar documentación dentro de mi propio sistema GNU/Linux

Muchos de los que llegan nuevos al mundo GNU/Linux se ven llenos de dudas e incapaces de encontrar respuesta rápida a sus inquietudes, en ocasiones ni siquiera disponen de una conexión a través de la cual poder acceder a algún foro de soporte y terminan finalmente con la idea de que Linux es muy difícil para ellos.

La mayoría de los que se ven en esta situación ignoran de que nuestro propio sistema contiene buena parte de las respuestas a nuestras inquietudes iniciales. Existe esencialmente tres fuentes de documentación en un sistema GNU/Linux: páginas  de manual (man pages), páginas de información (info pages ) y manuales de aplicaciones empaquetadas en /usr/share/doc.

En este artículo detallaremos cada una de estas fuentes.


Páginas de manual

Las páginas del manual o ”man pages” son las clásicas formas de documentación de referencia en Linux y Unix. Idealmente, puede buscar ayuda en las páginas del manual para cualquier comando, archivo de configuración o rutinas de librería.

En la práctica, Linux es un software libre, y algunas páginas a  no han sido escritas o muestran sus años. No obstante, las páginas del manual son el primer lugar a buscar cuando usted necesita ayuda. Para acceder a las  páginas de manual, solo escriba man seguido del tema a indagar.

Un paginado será iniciado , por lo que presionará q cuando termine de leer. Por ejemplo, para buscar información acerca del comando ls, escribiría:

$ man ls

Conociendo las partes de las páginas del manual puede ser útil saltar rápido a a la información que necesita, encontrará las siguientes secciones en la página del manual (Cuadro 1):

Cuadro 1: Páginas del Manual

NAME Nombre y descripción del comando
SYNOPSIS Como usar el comando
DESCRIPTION Explicación en profundidad del funcionamiento del comando
EXAMPLES Sugerencias de como usar el comando
SEE ALSO Temas relacionados (Usualmente en las páginas del manual)

Secciones de las páginas del manual

Los archivos que comprenden las páginas del manual están almacenadas en /usr/share/man (o en /usr/man en algunos sitemas viejos ). Dentro de ese directorio, encontrará que las páginas del manual están organizadas dentro de las siguientes secciones (Cuadro 2).

Cuadro 2: Secciones de las páginas  del manual

man1 Programas de usuario
man2 Llamadas a sistema
man3 Funciones de librerías
man4 Archivos especiales
man5 Formato de archivos
man6 Juegos
man7 Miscelánea

Páginas del manual múltiples

Algunos temas existen en más de una sección. Para demostrar esto, vamos a usar el comando whatis, el cual muestra todas las páginas del manual disponibles para este tema:

$ whatis printf
printf (1) - format and print data
printf (3) - formatted output conversion

En este caso, man printf estaría en la página de la sección 1 (Programas de usuario). Si escribiéramos un programa en C, estaríamos más interesados en la página de la sección 3 (Library functions). Usted puede llamar una cierta sección de páginas del manual especificándola en la línea de comandos, por lo que para preguntar por printf, podremos escribir:

$ man 3 printf

Encontrando la página del manual correcta

Algunas veces es difícil encontrar algunas páginas de manual sobre un tema dado. En ese caso, podría usar man -k para buscar la sección NAME de las páginas del manual. Sepa que ́esta es una búsqueda de subcadena, por lo que algo como man -k ls le daría muchas salidas, aquí hay un ejemplo usando una palabra más específica:

$ man -k whatis
whatis (1)           - imprime descripciones de páginas de manual

Todo sobre apropos

El ejemplo anterior nos trajo unos puntos más. Primero, el comando apropos es exactamente equivalente a man -k, (De hecho, les daré un secreto. Cuando corren man -k en realidad corre apropos detrás de escena).


La línea de código MANPATH

Pasamos ahora al segundo tipo de documentación que encontraremos en nuestro sistema GNU/Linux. Por defecto, el programa man busca las páginas del manual en /usr/share/man, /usr/local/man, /usr/X11R6/man y posiblemente /opt/man. algunas veces puede encontrar lo que necesita agregando un camino adicional al camino de búsqueda. Siendo así, solamente edite /etc/man.conf en un editor de texto y agregue una línea como la siguiente:

MANPATH /opt/man

De aquí en adelante, cualquier página del manual en el directorio /opt/man será encontrado. Recuerde que necesita correr nuevamente makewhatis para agregar estas nuevas páginas del manual en la base de datos de whatis.


GNU info

Uno de los defectos de las páginas  del manual, es que no soportan hipertexto por lo que no se puede saltar fácilmente de una página a otra. Los amigos del GNU reconocen este defecto, así que ellos inventaron otro formato de documentación:  las páginas ”info”.

Muchos de los programas GNU vienen con extensa documentación en el formato de páginas info. Puede comenzar a leer páginas info con el comando info:

De esta manera traeremos un índice de todas las páginas info disponibles en el sistema. Puede moverse en ellos con las teclas de flechas, seguir ”links” (indicados con una estrella) usando la tecla Enter y para salir presionando q. Las teclas están basadas en Emacs, por lo que debería serle fácil navegar si esta familiarizado con ese editor.

Para más información con el uso de info, lea su página  info. Debe ser capaz de navegarlas usando las teclas mencionadas anteriormente:

$ info info

/usr/share/doc

Hay una  última fuente que puede ayudarlo dentro del sistema Linux. Muchos programas vienen equipados con documentación adicional en otros formatos: texto, PDF, PostScript, HTML, por nombrar algunos.

Eche un vistazo en /usr/share/doc (/usr/doc en sistemas viejos). Encontrará una larga lista de directorios, cada uno de los cuales viene con las aplicaciones en su sistema. Buscando a través de esta documentación puede a menudo revelar algo interesante, tales como tutoriales o documentación técnica adicional. Un chequeo rápido revela un montón de material disponible para leer:

$ cd /usr/share/doc
$ find . -type f | wc -l

En otros artículos nos referiremos a fuentes externas de documentación como El Proyecto de Documentación Linux (LDP), las listas de correos y los grupos de noticias.

Fuente: Artículo tomado de GUTL y escrito Por Maikel Llamaret Heredia. Links: http://blog.desdelinux.net, http://www.raybenjamin.com, http://forum.codecall.net, http://www.linfo.org http://www.esdebian.org


elav

elav: Blog Personal / Twitter / G+ / Usuario de ArchLinux. Informático, melómano, blogger y diseñador web. Administrador y Fundador de DesdeLinux.net.


11 comentarios en “Como encontrar documentación dentro de mi propio sistema GNU/Linux

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos necesarios están marcados *

Puedes usar las siguientes etiquetas y atributos HTML: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

Current ye@r *

  1. Buen articulo, muy útil, e indispensable. Gracias.

    Solo una pregunta, ¿Hay alguna manera de poner en español las paginas de manual, o las páginas Info?

    Saludos a todos.

    1/11
  2. Muy Amable Elav. :D Gracias.

    3/11
  3. de esos artículos que se vuelven indispensables. agregado a mis marcadores. desconocía la myor parte de la información, y ahora resulta que era justo lo que necesitaba para aclarar una duda que tengo en Chakra. Gracias Elav

    4/11
  4. ¡Buen artículo! Este tipo de publicaciones siempre van muy bien para tirar de ellas en un momento dado.

    Gracias. :-)

    5/11
  5. Espectacular!!!
    Este artículo debería ser parte de los artículos bases para una sección “Nuevo en GNU+Linux / BSD” o similar.

    6/11
    • Aunque hay usuarios clásicos -especialmente los provenientes del palo Slackware- que prefieren una salida en consola monocromática, a mi me resulta especialmente práctico usar el paginador ‘most’ por la forma en que destaca en colores las distintas secciones de las páginas de manual:
      http://i.imgur.com/trXGgUQ.png

      Otra característica de most es que puede usarse como visor simple de archivos binarios.
      Para usarlo como el paginiador predeterminado (por ejemplo en reemplazo de more o less) podemos setear la variable global:
      export PAGER=/usr/bin/most
      tanto para cada usuario por del sistema por separado -incluído r00t- como para todos los usuarios de forma global.

      11/11
  6. Faltaría agregar cómo buscar una palabra dentro del propio «man» o «info». Podemos encontar esa ayuda cuando estamos dentro de ellos, presionando «h».

    Por ejempo en «man» podemos buscar una palabra con “/” y luego usar “n” o “N” para buscar hacia adeante o atrás, respectivamente.

    En «info» buscamos con “s” y luego hacia adelante con “}” y atrás con “{“

    7/11
  7. Firefox 17.0GNU/Linux
    ferchometalferchometal

    Excelente documentacion, gracias.

    8/11
  8. Interesante, solo suelo utilizar el comando “man” a secas, no conocia la opción de seleccionar páginas y demás opciones. Como siempre buen post y buena información.

    10/11

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos necesarios están marcados *

Puedes usar las siguientes etiquetas y atributos HTML: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

Current ye@r *