Linux nos proporciona el comando MAN que nos permite recordar cuales son todas las opciones de un comando.
Este comando tiene una estructura en el directorio /usr/share/man donde podemos ver la siguiente estructura:
root@maquina:/usr/share/man# ls -lh total 300K drwxr-xr-x 5 root root 4,0K may 25 2012 cs drwxr-xr-x 5 root root 4,0K mar 30 2014 da drwxr-xr-x 5 root root 4,0K may 25 2012 de drwxr-xr-x 10 root root 4,0K mar 30 2014 es drwxr-xr-x 4 root root 4,0K mar 30 2014 fi drwxr-xr-x 5 root root 4,0K may 25 2012 fr drwxr-xr-x 3 root root 4,0K mar 30 2014 gl drwxr-xr-x 5 root root 4,0K may 25 2012 hu drwxr-xr-x 5 root root 4,0K mar 30 2014 id drwxr-xr-x 5 root root 4,0K may 25 2012 it drwxr-xr-x 5 root root 4,0K may 25 2012 ja drwxr-xr-x 5 root root 4,0K mar 30 2014 ko drwxr-xr-x 2 root root 36K dic 5 17:04 man1 drwxr-xr-x 2 root root 20K mar 30 2014 man2 drwxr-xr-x 2 root root 88K sep 5 2017 man3 drwxr-xr-x 2 root root 4,0K mar 30 2014 man4 drwxr-xr-x 2 root root 12K dic 5 17:03 man5 drwxr-xr-x 2 root root 4,0K mar 30 2014 man6 drwxr-xr-x 2 root root 20K mar 30 2018 man7 drwxr-xr-x 2 root root 20K dic 5 17:03 man8 drwxr-xr-x 2 root root 4,0K ago 1 2016 man9 drwxr-xr-x 5 root root 4,0K mar 30 2014 nl drwxr-xr-x 5 root root 4,0K may 25 2012 pl drwxr-xr-x 5 root root 4,0K mar 30 2014 pt drwxr-xr-x 5 root root 4,0K mar 30 2014 pt_BR drwxr-xr-x 5 root root 4,0K dic 11 2012 ru drwxr-xr-x 4 root root 4,0K mar 30 2014 sl drwxr-xr-x 5 root root 4,0K may 25 2012 sv drwxr-xr-x 5 root root 4,0K mar 30 2014 tr drwxr-xr-x 5 root root 4,0K may 25 2012 zh_CN drwxr-xr-x 5 root root 4,0K mar 30 2014 zh_TW
Dentro podemos ver que tenemos directorios de lenguajes y la estructura de directorios de man1 a man9. Si entramos dentro del lenguaje que seleccionemos, veremos que la estructura man1 a man8 se replica.
En esta estructura se aloja la documentación para las diferentes secciones del comando.
root@maquina:/usr/share/man/es# ls -lh total 84K drwxr-xr-x 2 root root 4,0K dic 18 2017 man1 drwxr-xr-x 2 root root 16K mar 30 2014 man2 drwxr-xr-x 2 root root 44K mar 30 2014 man3 drwxr-xr-x 2 root root 4,0K mar 30 2014 man4 drwxr-xr-x 2 root root 4,0K sep 5 2017 man5 drwxr-xr-x 2 root root 4,0K mar 30 2014 man6 drwxr-xr-x 2 root root 4,0K mar 30 2014 man7 drwxr-xr-x 2 root root 4,0K sep 5 2017 man8
Las secciones van del 1 al 8 y tienen el siguiente propósito:
| SECCIÓN | FUNCIÓN |
|---|---|
| 1 | Documentación de comandos generales |
| 2 | Documentación de llamadas al sistema |
| 3 | Documentación de bibliotecas de funciones |
| 4 | Documentación de ficheros especiales |
| 5 | Documentación de formatos de ficheros |
| 6 | Documentación de juegos y salvapantallas |
| 7 | Miscelánea. |
| 8 | Documentación de comandos de administración del sistema |
Sintaxis del comando man
La sintaxis es sencilla. Solo tenemos que hacer de la siguiente forma:
man seccion_a_consultar comando_o_fichero
La sección es opcional y de no aparecer se utiliza siempre la 1. En los resultados de pantalla se especifica entre paréntesis la sección a la que estamos accediendo.
root@maquina:/usr/share/man/es# man pwd
PWD(1) User Commands PWD(1)
NAME
pwd - print name of current/working directory
Con el siguiente ejemplo, vemos sobre el comando passwd que también existe como fichero, como nos devuelve el comando man la página de documentación en diferentes secciones:
man passwd man 5 passwd
En el primer caso vemos cual es la funcionalidad del comando y en el segundo caso vemos como es el formato del fichero y como está estructurado y en que consiste cada campo.
root@ns5:/usr/share/man/es# man 5 passwd
PASSWD(5) File Formats and Conversions PASSWD(5)
NAME
passwd - the password file
DESCRIPTION
/etc/passwd contains one line for each user account, with seven fields delimited by colons (“:â€). These fields are:
· login name
· optional encrypted password
· numerical user ID
· numerical group ID
· user name or comment field
· user home directory
· optional user command interpreter