Como documentarse en un sistema linux

Buscando Documentación en Linux

Introducción

En general, uno de los primeros problemas con los que se encuentra el novato en Linux es la desorientación a la hora de encontrar ayudas y documentos que traten algún tema específico, sobre todo de configuración o manejo de un programa específico.

En este documento trataremos los pasos a seguir a la hora de conseguir esa preciosa documentación.

1. man comando

En Unix existe un maravilloso comando llamado man que nos permite acceder a una página de documentación (página del MANual) normalmente sobre un comando, una llamada al sistema, una función de librería de C, de Perl, etc.

Por ejemplo, si queremos conocer al detalle la documentación sobre el uso y parámetros del comando 'ls' simplemente hacemos:
man ls

(Si usamos el entorno gráfico KDE podemos tener la página formateada de forma más elegante y con enlaces si en la barra del Konqueror escribimos man:ls, lo mismo se aplica a la documentación info más adelante.)

1. Aghhh, ¡está en inglés!

Vale, pues instala el paquete de tu distribución que contenga las páginas man en español (manpages-es en Debian, por ejemplo).

2. Aghhh, ¡esto sigue en inglés!

La vida es así, el inglés es el lenguaje de la ciencia en el siglo XX, para bien o para mal. Si tienes maña con el idioma y la página no está traducida, ¡tradúcela! Contribuye al proyecto del software libre ¡haz algo! Hay un proyecto de traducción de páginas man al castellano, puedes encontrar más información en http://lucas.hispalinux.es

3. Aghhh, ¡No hay página man!

No siempre hay página man para todas las cosas. Puedes probar con el comando apropos (APROPOSito) y algunas palabras claves: Esto te listará las páginas man relaccionadas con esas palabras clave.

4. Aghhh, ¡Esto está en español, pero parece chino!

Sí, las páginas man suelen ser la documentación que escribe el propio desarrollador, y estos no tienen por que ser escritores técnicos profesionales, por lo que en ocasiones (demasiadas, desgraciadamente), las páginas man tienen un estilo en exceso técnico y áspero.

Existen front-ends gráficos para el formato man como el xman o el tkman, que permiten navegar entre página pulsando con el puntero del ratón en las referencias.

Una última nota, el comando pinfo (si no está en tu distribución puedes conseguirlo de aquí) mostrará las páginas man mucho más bonitas y con enlaces ejecutándolo como pinfo -m (yo puesto en mi .bashrc: alias man='pinfo -m').

5. info comando (o pinfo comando)

Info es el formato de documentación del proyecto GNU. Es más flexible que las páginas man. Puede accederse a esta documentación desde el editor Emacs, pero como aquí no usamos guarrerías de esas, simplemente escribiremos 'info' desde la línea de comandos.

Esto nos presentará un índice de todos los documentos de los que disponemos en este formato. Por ejemplo:

File: dir Node: Top This is the top of the INFO tree This (the Directory node) gives a menu of major topics. Typing "d" returns here, "q" exits, "?" lists all INFO commands, "h" gives a primer for first-timers, "mTexinfo<Return>" visits Texinfo topic, etc. Or click mouse button 2 on a menu item or cross reference to select it. --- PLEASE ADD DOCUMENTATION TO THIS TREE. (See INFO topic first.) ---

In Debian Linux, Info dir' entries are added with the commandinstall-info'. Please refer to install-info(8) for usage details.

Menu: The list of major topics begins on the next line.

Development

  • Autoconf: (autoconf). Create source code

  • configuration scripts

  • automake: (automake). Making Makefile.in’s

  • Gdb: (gdb). The GNU debugger.

  • Gdb-Internals: (gdbint). The GNU debugger’s internals.

  • Gdbm: (gdbm). The GNU Database Routines.

  • gmp: (gmp). GNU Multiple Precision Arithmetic Library.

  • iostream: (iostream). The C++ input/output facility.

  • Ipc: (ipc). System V interprocess communication facilities

  • M4: (m4). The GNU m4 macro preprocessor.

  • Gettext: (gettext). GNU gettext utilities.

  • gettextize: (gettext)gettextize Invocation. Prepare a package for gettext.

  • Make: (make). The GNU make utility.

  • msgfmt: (gettext)msgfmt Invocation. Make MO files out of PO files.

----Info: (dir)Top, 190 lines * --Top--Welcome to Info version 4.0. Type C-h for help, m for menu item.

(etc).

Para saltar a uno simplemente situamos el cursor sobre uno de los títulos (marcados con asteriscos) y pulsamos intro, ya que el formato info permite hiperenlaces (diferentes a los del HTML).

Si desplazamos el cursor a la parte inferior y automaticamente avanzará una pantalla hacia abajo.

Además, como nos indica la cabecera de este índice principal pulsando '?' podemos obtener una ayuda sobre los comandos. Básicamente:

  • 'n': Ir a la siguiete página de este nodo de documentación ("nodo").
  • 'p': Ir a la página previa de este nodo.
  • 'u': Moverse al nivel superior a este nodo.
  • 'TAB': Mover el cursor al siguiente hiperenlace de este nodo.
  • 'INTRO': Seguir el hiperenlace sobre el que se situa el cursor.
  • 's'o '/' : Buscar una cadena recursivamente en este nodo y los inferiores.

Si escribimos 'info comando' nos llevará directamente al nodo de documentación en formato info sobre ese comando. Si no existe, nos mostrará la página man.

Normalmente la documentación en formato info está mejor escrita y más estructurada. Un consejo para los programadores de C: No os perdaís del 'info libc'

También existen front-end gráficos para el info, por ejemplo el tkinfo.

Un último truquillo: Si redirigimos la salida del info a un archivo (info libc > libc.txt) nos creará un archivo de texto listo para imprimir.

Como en el punto anterior, también podemos utilizar el comando pinfo (sin parámetros) para ver las páginas info con colorines y navegándolas de una forma más sencilla.

5. /usr/doc/comando

En el directorio /usr/doc (o /usr/share/doc) tenemos TONELADAS de información sobre la mayoría de los programas instalados. Esta documentación puede ser tan escueta como un simple README y una nota de copyright o tan extensa como megas y megas de documentación en formato HTML o PostScript (entre otros).

Normalmente en el caso de que sólo sea un README casi siempre podemos encontrar una URL del programa donde podemos encontrar más información sobre el mismo.

Además, en algunas distribuciones el acceso a la documentación HTML disponible está centralizado mediante un comando para que podamos acceder a ella comodamente. Por ejemplo en Debian el comando es "dhelp".

6. La URL del programa

Como ya se ha comentado siempre podemos ir a la página del programa y casi seguro que ahí tenemos documentación de sobra sobre el mismo.

7. Los HOWTOS y los MINI-HOWTOS (Lease COMOS y MINI-COMO)

Los HOWTOS son un clásico de documentación de Linux. Tratan temas tan variados como la utilización de un programa en concreto, la conexión a internet, la instalación de Linux en un portatil, etc., etc., etc.

Suelen ser documentos más o menos extensos, que explican al detalle todos los pasos a dar de forma concreta y concisa.

También existen mini-howtos que son documentos más pequeños.

Si tenemos instalados los paquetes adecuados, también tendremos HOWTOs traducidos al castellano (COMOs). Todos los HOWTOS actualizados los podremos encontrar en http://www.ldp.org, y los COMOs en http://lucas.hispalinux.es

8. http://groups.google.com

Es muy probable que la duda que tengas la haya tenido otro antes que tú, y la haya preguntado en alguno de los múltiples foros de Linux o Unix en Usenet. En esta página puedes indicar un asunto de búsqueda.

Si hablas español (y hablas español), busca primero poniendo en el cajoncito de búsqueda:

es.comp.os.linux asunto

Si no encuentras nada, y no se te da mal el inglés prueba con:

linux asunto.

9. Grupos de Linux en Usenet

Existen muchos grupos de Linux en Usenet. Por ejemplo, en españa tenemos es.comp.os.linux.instalacion, es.comp.os.linux.misc, es.comp.os.linux.redes, y es.comp.os.linux.programación. Están llenos de gente dispuesta a ayudar, pero asegúrate de ceñirte al grupo adecuado para tu pregunta, y leerte la FAQ que se envia periodicamente a los mismos antes de preguntar.

Sobre todo no mandes tu pregunta a varios grupos o puedes cabrear a alguien (a mi seguro).

Suerte.

Contents