Accéder à l'ensemble de la documentation locale sur Linux
Place à super man
Une installation par défaut du système d'exploitation Linux Ubuntu déploie sur votre poste plus de 65Mo de documentations compressées. La commande man [programme] vous permet d'accéder à environ 1% de cette documentation.
Comment accéder à l'ensemble de l'aide ?
Utilisation courante de man
man est une commande en ligne qui permet d'accéder à l'aide des différents programmes installés.
Par exemple, vous recherchez de la documentation sur l'outil de planification de tâche crontab. Vous ouvrez une console et exécutez la commande :
$ man crontab
CRONTAB(1) CRONTAB(1)
NAME
crontab - maintain crontab files for individual users (V3)
SYNOPSIS
crontab [ -u user ] file
crontab [ -u user ] { -l | -r [ -i ] | -e }
DESCRIPTION
crontab is the program used to install, deinstall or list the tables
used to drive the cron(8) daemon in Vixie Cron. Each user can have
their own crontab, and though these are files in
/var/spool/cron/crontabs, they are not intended to be edited directly.
(...)
Vous obtenez la documentation demandée : une description du programme, la liste de ses options, son comportement...
Pour autant, nul trace de la syntaxe du fichier de planification des tâches. La documentation serait-elle incomplète ? Non !
Regardez la rubrique SEE ALSO :
SEE ALSO
crontab(5), cron(8)
Les numéros entre parenthèses correspondent à des numéros de pages.
Comment accéder aux différentes pages d'aide man
La documentation de man est claire :
$ man man
(...)
DESCRIPTION
man is the system’s manual pager. Each page argument given to man is
normally the name of a program, utility or function. The manual page
associated with each of these arguments is then found and displayed. A
section, if provided, will direct man to look only in that section of
the manual. The default action is to search in all of the available
sections, following a pre-defined order and to **show only the first page**
found, even if page exists in several sections.
(...)
man n'affiche que la première page de l'aide par défaut, même s'il y en a plusieurs. Cette page est indiquée entre parenthèse après CRONTAB dans le 1er exemple.
Pour accéder à une page en particulier, il faut préciser le numéro de page en argument de la commande man. Le See also de la documentation de crontab nous renvoie vers la page 5.
La syntaxe est : man [numéro de page] programme
Dans une console, exécutez :
$ man 5 crontab
CRONTAB(5) CRONTAB(5)
NAME
crontab - tables for driving cron
(...)
EXAMPLE CRON FILE
# use /bin/bash to run commands, instead of the default /bin/sh
SHELL=/bin/bash
# mail any output to ‘paul’, no matter whose crontab this is
MAILTO=paul
#
# run five minutes after midnight, every day
5 0 * * * $HOME/bin/daily.job >> $HOME/tmp/out 2>&1
# run at 2:15pm on the first of every month -- output mailed to paul
15 14 1 * * $HOME/bin/monthly
# run at 10 pm on weekdays, annoy Joe
0 22 * * 1-5 mail -s "It’s 10pm" joe%Joe,%%Where are your kids?%
(...)
Toute la documentation sur la syntaxe du fichier de configuration crontab est bien là, exemple à l'appuie.
- Ajouter un commentaire
- 1229 lectures

