MAN

man(1) permette di consultare da terminale il "Manuale di programmazione UNIX". Nella prima edizione il manuale era diviso in 7 sezioni (o paragrafi o capitoli):

• I. Commands
• II. System calls
• III. Subroutines
• IV. Special files
• V. File formats
• VI. User-maintained programs
• VII. Miscellaneous

FreeBSD usa invece questa suddivisione:

• 1. User commands.
• 2. System calls and error numbers.
• 3. Functions in the C libraries.
• 4. Device drivers.
• 5. File formats.
• 6. Games and other diversions.
• 7. Miscellaneous information.
• 8. System maintenance and operation commands.
• 9. Kernel developers.

similmente per quanto riguarda le manpage di Linux:

• 1. User commands (intro only)
• 2. System calls
• 3. Libc calls
• 4. Devices (e.g., hd, sd)
• 5. File formats and protocols (e.g., wtmp, /etc/passwd, nfs)
• 6. Games (intro only)
• 7. Conventions, macro packages, etc. (e.g., nroff, ascii)
• 8. System administration (intro only)
• 9. Kernel internal routines

Ogni sezione è ulteriormente suddivisa in varie voci, ad es. la I contiene una voce per ogni comando pensato per essere invocato direttamente dall'utente.

$ man man

$ man mail

$ man printf

$ man 3 printf

$ man printf 3 printf

$ man LS

$ man ls

Ogni voce viene indicata da un nome seguito dal numero di sezione a cui appartiene tra parentesi. Questo è importante perché vi sono spesso voci con lo stesso nome in sezioni diverse, ad es. comandi che permettono di utilizzare una system call con lo stesso nome del comando:

$ man chmod

$ man 2 chmod

$ man -w rmdir
/usr/share/man/man1/rmdir.1.gz

$ man -w 2 rmdir
/usr/share/man/man2/rmdir.2.gz

Le manpage hanno di solito un formato comune (anche se non obbligatorio): sono divise in paragrafi. I più comuni sono:

Convenzioni usate nella sezione SYNOPSIS:

• - precede un argomento flag
• i letterali (ad es. i nomi dei comandi) vanno digitati così come sono
• un argomento chiamato file si riferisce ad un nome di file
• un argomento chiamato string si riferisce ad una stringa di testo
• [ ] racchiudono un argomento opzionale
• ... indicano la possibile ripetizione del prototipo del precedente argomento
• | indica una scelta tra alternative esclusive

Gli argomenti tipo file o string ecc. sono spesso sottolineati o resi in inverso e i letterali in grassetto.

Segue un esempio della manpage di echo(1) di FreeBSD:

ECHO(1)                 FreeBSD General Commands Manual                ECHO(1)

NAME
     echo - write arguments to the standard output

SYNOPSIS
     echo [-n] [string ...]

DESCRIPTION
     The echo utility writes any specified operands, separated by single blank
     (` ') characters and followed by a newline (`\n') character, to the stan-
     dard output.

     The following option is available:

     -n    Do not print the trailing newline character.  This may also be
           achieved by appending `\c' to the end of the string, as is done by
           iBCS2 compatible systems.

     Some shells may provide a builtin echo command which is similar or iden-
     tical to this utility.  Consult the builtin(1) manual page.

DIAGNOSTICS
     The echo utility exits 0 on success, and >0 if an error occurs.

SEE ALSO
     builtin(1), csh(1), printf(1), sh(1)

STANDARDS
     The echo utility is expected to be IEEE Std 1003.2 (``POSIX.2'') compati-
     ble.

FreeBSD 4.5                      July 22, 1993                     FreeBSD 4.5

Versioni storiche del manuale:

$ man -a printf

$ man -k number | grep -i line

addr2line(1)     - convert addresses into file names and line numbers
nl(1)            - line numbering filter
random(6)        - random lines from a file or random numbers

$ apropos fortran

f77(1), g77(1) - GNU project Fortran Compiler (v0.5.24)

$ apropos whatis
apropos(1), whatis(1) - search the whatis database
makewhatis(1)            - create whatis database
makewhatis.local(8), catman.local(8) - start makewhatis or catman
for local file systems

$ whatis whatis
apropos(1), whatis(1) - search the whatis database
makewhatis(1)            - create whatis database