Linux manual pages

Definitivamente, luego de haber entrado en el mundo de Slackware Linux, Los ‘man pages’ (páginas de manual) y Google serán tus mejores amigos; y más que eso, tu Shaman y tu Guía, respectivamente.

Relmente no tenía tiempo para escribir hoy, estoy algo atareado por cuestiones laborales, y me senté un rato en mi PC a descansar, hasta que de pronto… ‘tucutú’ , el horrible sonidito de aMSN indicando que alguien me ha hablado.

Sin mucho ánimo, muevo mi brazo hasta alcanzar el mouse, le doy click a la … ventanita esta!, pensando que es algo importante (puesto que mi estado esta en ‘away’) y de pronto: alguien preguntandome algo que estoy ultra seguro que Google en su inmensa sabiduría ha respondido ya de muchas maneras.

Mi respuesta fue simple:
RTFM! (Read The F—-ng Manual) , lo cual no me ayudo mucho, pero me desahogó…

En esta ocasion vamos a tratar de entender unos cuantos tips de nuestro gran amigo ‘man’ (manual).

Si escribimos en consola:

# man man

Estaremos llamando el manual del manual pages, el cual muestra algo como esto:

NOMBRE
       man - formatea y despliega las paginas online del manual

SINOPSIS
       man  [-acdfFhkKtwW]  [--path]  [-m  system]  [-p  texto]
            [-C config_file] [-M pathlist] [-P pager] [-B navegador]
            [-H htmlpager] [-S section_list] [section] nombre ...

DESCRIPCIÓN
       man formatea y despliega las paginas online del manual.  si
       le especificas la sección, man unicamente buscará en esa
       sección del manual.
       nombre , normalmente es el nombre de la página
       del manual, la cual es típicamente el nombre del comando,
       función, o archivo. Sin embargo, si el nombre contiene una
       barra (slash, '/'), entonces man lo interpretara como la
       especificacion de un archivo,
       de modo que puedes hacer:
       man ./foo.5 o incluso man /cd/foo/bar.1.gz.

Entre otras cosas…

1. Todos los parametros que esten incluidos en llaves, indican que son opcionales, y no es explicitamente necesario indicar uno o más de ellos. Ej.

[-acdfFhkKtwW]  [--path]  [-m  system]

me parece que esa sintaxis es un estandar de documentación, puesto que incluso la documentación de muchas otras cosas usan este formato. (ej. PHP, PERL, C, etc. etc.)

2. Los parametros que no aparezcan dentro de llaves, son obligatorios. Ej.
nombre

3. Una sinopsis es una definicion resumida y generalizada acerca de algo, los detalles de todos los parametros opcionales y obligatorios, son descritos mas abajo, de modo que tendras que desplazarte a travez de toda la pagina del manual para poder entender cierta documentacion.

4. Los manuales siempre hacen refencia a otras paginas de manual, diciendo algo como:

SEE ALSO
       apropos(1), whatis(1), less(1), groff(1), man.conf(5).

En este caso (y muy pertinentemente, hacen referencia a la pagina numero (1) del comando ‘apropos’, el cual es bastante util buscando en diferentes paginas de manual.

5. Cuando veas algo como man.conf(5), quiere decir que debes buscar en la pagina (5), del manual:

man 5 man.conf

6. Para saber cuales paginas de manual hablan acerca de cierto termino, usamos ‘apropos’, ej:

apropos ssh

nos desplegara (entre otras cosas) algo como esto:

hfssh                (1)  - Tcl interpreter with HFS extensions
ssh                  (1)  - OpenSSH SSH client (remote login program)
ssh-add              (1)  - adds RSA or DSA identities to the authentication agent
ssh-agent            (1)  - authentication agent
ssh-copy-id          (1)  - install your identity.pub in a remote machine's authorized_keys
ssh-keygen           (1)  - authentication key generation, management and conversion
ssh-keyscan          (1)  - gather ssh public keys
ssh-keysign          (8)  - ssh helper program for host-based authentication
ssh_config           (5)  - OpenSSH SSH client configuration files
sshd                 (8)  - OpenSSH SSH daemon
sshd_config          (5)  - OpenSSH SSH daemon configuration file

indicando el nombre y numero de la pagina de manual que hace referencia al termino que estuvimos buscando, para visualizar, hacemos igual que como hicimos anteriormente:

# man 5 ssh_config
# man 8 sshd
# man 1 ssh-keygen

7. Si no te gusta leer man pages en consola, puedes abrir konqueror y poner algo como esto en la barra de direcciones:

man:/cp
Para ver el manual del comando cp , por ejemplo, y asi sucesivamente.

8. Es cierto que no es lo mas sencillo del mundo entender man pages, pero tambien es cierto que no es lo mas dificil. Simplemente lee con detenimiento, sin desesperarte y trata de no pasar por alto nada, por mas elemental que parezca.

Entender y familiarizarte con ‘man’ te van a economizar tiempo, y sobre todo, podras evitar algunas de estas respuestas:
RTFM (Read the F—-ng Manual)
RTMFM (Read The Mother F—-ng Manual)
JFGI (Just F—-ng Google It)
STFW (Search the F—-ng Web)
Entre otros…

Espero que este articulo te haya ayudado a comprender e interesarte mas por ‘man’, a la vez que te ayude a invitar a otros a usar Google cuando piensan que eres una enciclopedia online en MSN.

NOTA:
Ayudar al otro implica que logre su propósito. Si ese otro no se interesa en aprender o investigar, es porque su principal propósito es permanecer en ignorancia, así que no le des la respuesta a sus preguntas, y estarás ayudandolo igualmente