Antes de que pueda entender lo que realmente está pasando cuando hay un problema, necesita saber el rol que cumple en teoría cada programa involucrado en el problema. Para hacerlo, lo mejor que puede hacer es consultar su documentación; pero ya que dichos documentos son numerosos y muy dispersos debe saber todos los lugares donde puede encontrarlos.
Las páginas de manual, aunque de estilo escueto, contienen gran cantidad de información esencial. Repasaremos rápidamente el programa para verlas, proporcionado por el paquete
man-db. Simplemente ejecute
man página_de_manual — la página de manual generalmente tiene el mismo nombre que el programa sobre el que busca documentación. Por ejemplo, para aprender sobre las opciones posibles de
cp utilizaría
man cp en una terminal (revise el recuadro
VOLVER A LOS CIMIENTOS La consola, un intérprete de línea de órdenes).
Las páginas de manual no sólo documentan órdenes y programas en la línea de órdenes, también archivos de configuración, llamadas de sistema, funciones de bibliotecas y más. A veces pueden coincidir ciertos nombres. Por ejemplo, la orden de la consola read tiene el mismo nombre que la llamada de sistema read. Es por eso que las páginas de manual están organizadas en secciones numeradas:
- 1
órdenes que pueden ser ejecutadas desde la línea de órdenes;
- 2
llamadas de sistema (funciones proporcionadas por el núcleo);
- 3
funciones de biblioteca (proporcionadas por las bibliotecas del sistema);
- 4
dispositivos (en Unix éstos son archivos especiales generalmente ubicados en el directorio /dev/);
- 5
archivos de configuración (formatos y convenciones);
- 6
juegos;
- 7
conjuntos de «macros» y estándares;
- 8
órdenes de administración del sistema;
- 9
rutinas del núcleo.
Es posible especificar la página del manual que está buscando: para visualizar la documentación de la llamada de sistema read utilizaría man 2 read. Cuando no se especifique una sección explícitamente, se mostrará la primera sección que posea una página de manual con el nombre pedido. Por lo tanto, man shadow mostrará shadow(5) porque no hay páginas de manual para shadow en las secciones 1 a 4.
Por supuesto, si no sabe el nombre del programa, el manual no le será de mucha utilidad. Éste es el propósito del programa apropos que le ayuda a buscar en las páginas de manual, más específicamente en sus descripciones cortas. Cada página de manual comienza esencialmente con un resumen de una línea. apropos devuelve una lista de las páginas de manual que mencionan en su resumen la palabra clave pedida (o todas las ingresadas). Si las selecciona correctamente encontrará el nombre del programa que necesita.
Ejemplo 7.1. Encontrar cp con apropos
$ apropos "copy file"
cp (1) - copiar archivos y directorios
cp (1posix) - copiar archivos
cpio (1) - copiar archivos hacia y desde archivos
exec (1posix) - ejecuta comandos y abre, cierra o copia descriptores de archivos
install (1) - copiar archivos y establecer atributos
ntfscp (8) - copia el archivo a un volumen NTFS.
El programa
man no es la única forma de consultar las páginas de manual ya que los programas
khelpcenter y
konqueror (de KDE) y
yelp (en GNOME) también ofrecen esta funcionalidad. Existe también una interfaz web provista por el paquete
man2html que le permite ver las páginas de manual en un navegador web. En un equipo donde esté instalado este paquete, utilice la siguiente URL después de seguir las instrucciones en
/usr/share/doc/man2html/README.Debian:
Esta herramienta necesita un servidor web. Es por esto que si debería elegir instalar este paquete en uno de sus servidores: todos los usuarios de la red local se beneficiarán de este servicio (incluyendo máquinas que no tienen Linux) y le evitará tener que configurar un servidor HTTP en cada estación de trabajo. Si puede acceder a su servidor desde otras redes podría desear restringir el acceso a este servicio sólo a los usuarios de la red local.
Por último, pero no menos importante, puede ver todas las páginas de manual disponibles en Debian (incluso aquellas que no están instaladas en su máquina) en el servicio
manpages.debian.org. Ofrece cada página de manual en múltiples versiones, una para cada publicación de Debian.
El proyecto GNU escribió manuales para la mayoría de sus programas en el formato info; es por esto que muchas páginas de manual hacen referencia a la documentación info correspondiente. El formato tiene ciertas ventajas, pero el programa por defecto para visualizar estos documentos (llamado info) es también ligeramente más complejo. En vez de éste se le recomienda usar pinfo (del paquete pinfo).
La documentación info tiene una estructura jerárquica y si ejecuta pinfo sin parámetros mostrará una lista de los nodos disponibles en el primer nivel. Generalmente los nodos tienen el nombre del programa correspondiente.
En la orden
pinfo la navegación se controla con las teclas del cursos. Puede utilizar, alternativamente, un navegador gráfico que es mucho más amigable. Nuevamente,
konqueror y
yelp funcionan; el paquete
info2www también provee una interfaz web.
Note que el sistema info, a diferencia del sistea de páginas man, no permite traducciones. Los documentos info estarán, por lo tanto, siempre en inglés. Sin embargo, cuando le pida a pinfo una página info que no exista, éste buscará la página de man con el mismo nombre (si es que existe) y ésta puede que sí esté traducida.
7.1.3. Documentación específica
Cada paquete incluye su propia documentación. Aún los programas menos documentados generalmente tienen un archivo README que contiene información interesante y/o importante. Esta documentación se instala en el directorio /usr/share/doc/paquete/ (donde paquete representa el nombre del paquete). Si la documentación es particularmente grande puede no estar incluida en el paquete principal del programa sino que puede haber sido separada a un paquete dedicado que generalmente es llamado paquete-doc. El paquete principal por lo general recomendará el paquete de documentación para que pueda encontrarlo fácilmente.
El directorio
/usr/share/doc/paquete/ también contiene algunos archivos provistos por Debian que completan la documentación especificando las particularidades o mejoras del paquete comparándolo con una instalación tradicional del software. El archivo
README.Debian también indica todas las adaptaciones que se realizaron para cumplir con la Normativa Debian. El archivo
changelog.Debian.gz le permite al usuario seguir las modificaciones realizadas al paquete con el tiempo: es muy útil intentar entender lo que cambió entre dos versiones instaladas que no tienen el mismo comportamiento. Por último, a veces habrá un archivo
NEWS.Debian.gz que documentará los cambios importantes en el programa que podrían interesar al administrador (véase
Sección 6.7.2, “Manejo de problemas tras una actualización”).
En la mayoría de los casos, los programas de software libre tienen sitios web que se utilizan para distribuirlo y reunir la comunidad de desarrolladores y usuarios. Estos sitios generalmente están llenos de información relevante en varias formas: documentación oficial, preguntas frecuentes
FAQ (Frequently Asked Questions), listas de correo, etc. Los problemas que podría tener ya han sido objeto de varias preguntas; los FAQ o los archivos de las listas de correos pueden tener una solución. Dominar los motores de búsqueda será de gran valor para encontrar las páginas relevantes rápidamente (restringiendo la búsqueda al dominio o subdominio de Internet dedicado al programa). Si la búsqueda devuelve demasiados resultados o éstos no coinciden con lo que desea, puede agregar la palabra clave
debian para limitar los resultados y obtener información relevante.
Si no conoce la dirección del sitio web del software hay varias formas de obtenerla. Primero, revise si hay un campo
Homepage entre la metainformación del paquete (
apt show paquete). La descripción del paquete también podría contener un enlace al sitio oficial del programa. Si no se indica una URL, revise
/usr/share/doc/paquete/copyright. El desarrollador Debian generalmente indica en este archivo de dónde obtuvo el código fuente del programa y es probable que sea el sitio web que busca. Si en esta etapa de su búsqueda aún no obtuvo resultados, consulte un directorio de software libre como el Directorio de Software Libre de la FSF o busque directamente con un motor de búsqueda como DuckDuckGo, Yahoo, etc.
También podría desear revisar la wiki de Debian, un sitio web colaborativo donde cualquiera, incluso simples visitantes, pueden hacer sugerencias directamente desde sus navegadores. Lo usan tanto desarrolladores para diseñar y especificar sus proyectos como usuarios para compartir su conocimiento escribiendo documentos colaborativos.
7.1.5. Tutoriales (HOWTO)
Un HOWTO es un documento que describe, en términos concretos y paso a paso, «cómo» (en inglés «how to») llegar a un objetivo predefinido. Los objetivos cubiertos son relativamente variados pero generalmente de naturaleza técnica; por ejemplo: configurar «IP Masquerading», instalar un servidor Samba, etc. Estos documentos generalmente intentan cubrir todos los problemas potenciales que podrían ocurrir durante la implementación de una tecnología dada.
Many such tutorials are managed by the Linux Documentation Project (
LDP), whose website hosts all of these documents:
Debian también ofrece tutoriales a sus usuarios:
Todos estos documentos deberían tomarse con pinzas. Generalmente tienen varios años; la información que contienen a veces está obsoleta. Este fenómeno es aún más frecuente para sus traducciones ya que las actualizaciones no son ni sistemáticas ni instantáneas luego de la publicación de nuevas versiones de los documentos originales. Además, muchos tutoriales los proporcionan hoy blogueros, que comparten su solución individual con el lector interesado. Normalmente carecen de información importante, es decir, la razón por la que se ha elegido una configuración en vez de otra o por qué alguna opción se ha habilitado o deshabilitado. Porque crear blogs y páginas web propias lo hace fácil de compartir, existen muchos de estos tutoriales normalmente cortos, pero solo unos pocos se mantienen activamente bien cuidados. Esto puede dificultar que encuentres el «bueno» para ti. Todo esto es parte de la alegría de trabajar en un entorno de voluntarios y sin limitaciones…
