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 command install-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 programad