El manual en línea. Documentación de UNIX, Linux y GNU

Esta sección y la siguiente introducen los diferentes mecanismos de documentación que existen en UNIX y Linux. Es muy importante moverse con agilidad entre ellos, ya que representan una ayuda valiosa para cualquier usuario de UNIX.

Cualquier sistema UNIX tiene incorporado un manual en línea que siempre resulta accesible desde cualquier terminal.

Si en algún momento necesita información sobre la sintaxis de una orden o sobre un determinado programa, el manual en línea debería ser siempre la primera fuente de información y consulta.

En realidad el manual en línea consiste en una colección de archivos almacenados en el disco que contiene la documentación de las órdenes UNIX.

Para acceder al manual en línea sólo tiene que teclear la palabra man desde la línea de órdenes indicando el tema sobre el que quiere ayuda. Por ejemplo, si teclea:

$ man ls

obtendrá la primera página del manual para la orden ls.

NAME
       ls - list directory contents

SYNOPSIS
       ls [OPTION]... [FILE]...

DESCRIPTION
       List  information  about  the FILEs (the current directory by default).
       Sort entries alphabetically if none of -cftuvSUX nor --sort  is  speci‐
       fied.

       Mandatory  arguments  to  long  options are mandatory for short options
       too.

       -a, --all
              do not ignore entries starting with .

       -A, --almost-all
              do not list implied . and ..

       --author
              with -l, print the author of each file

       -b, --escape
              print C-style escapes for nongraphic characters

       --block-size=SIZE
              scale   sizes   by   SIZE   before   printing    them.     E.g.,
              `--block-size=M'  prints sizes in units of 1,048,576 bytes.  See
              SIZE format below.

       -B, --ignore-backups
              do not list implied entries ending with ~

       -c     with -lt: sort by, and show, ctime (time of last modification of
              file  status  information)  with -l: show ctime and sort by name
              otherwise: sort by ctime, newest first

Puede decirse que la orden man es la más importante de todas las órdenes UNIX ya que permite conocer los detalles de cualquier otra orden. Incluso puede obtener ayuda sobre cómo usar el propio manual tecleando:

$ man man

Como curiosidad debe saber que en las primeras versiones de UNIX, cuando éste era un producto exclusivo de los laboratorios Bell de AT&T, la numeración para las versiones del sistema operativo coincidía precisamente con el número de edición del manual. Así por ejemplo se habla de UNIX Quinta Edición, UNIX sexta edición, etc.

IMPORTANTE: Aunque actualmente existen mucha documentación dedicada a UNIX, algunos son específicos para las versiones de distintos fabricantes, sólo hay un manual en línea. Lo que quiere decir que esté en el sistema que esté siempre tendrá disponible el manual en línea en el que realiza sus consultas. Así cuando alguien dice que va a utilizar el manual para buscar ayuda sobre alguna orden todo el mundo sabe que está haciendo uso de la orden man.

Existe una versión del manual específica para el sistema de ventanas X.Windows:

x-man

Los contenidos mostrados por este programa son exactamente los mismos que los que produce la orden man; las únicas diferencias se refieren al aspecto visual, ya que emplea distintos tipos de letra, lo cual le da una apariencia mucho más agradable.

La organización del manual en línea es realmente como la de una gran enciclopedia, con gran cantidad de entradas colocadas siguiendo un orden alfabético y con un término por cada orden.

Sin embargo, las páginas del manual no se encuentran numeradas, es decir, no podría por ejemplo ir a la página 3 del libro, y tampoco existe una tabla de contenidos o un índice.

La información del manual se encuentra organizada de otra manera, empleando distintas capas más apropiadas para la utilidad que se le supone.

Tradicionalmente el manual se encuentra dividido en 8 secciones, mostradas a continuación: