diff --git a/unix/aide.tml b/unix/aide.tml index dc1d3fe..cace7bc 100644 --- a/unix/aide.tml +++ b/unix/aide.tml @@ -18,102 +18,24 @@ savoir quelle commande utiliser pour faire telle chose Unix dispose aussi d'une aide abondante et très utile.

-

Aide rapide

- -

-Tout d'abord, il faut savoir que très souvent, les commandes ont un -petit fichier d'aide rudimentaire, qui vous renseignera sur la syntaxe -de la commande (pour savoir ce que fait exactement la commande, ou -pour compléter, c'est le rôle des pages de man). Il -y a plusieurs manières d'obtenir cette aide rudimentaire : -

- -

Options -h, -? et --help

- -

C'est un moyen simple pour obtenir un peu d'aide sur une -commande. Exemple :

- -
-earendil ~ $ mkdir --help
-usage: mkdir [-pv] [-m mode] directory ...
-
- -

-Ici, on vous indique que la commande mkdir admet les -options -p, -v, -m -<mode>, et que sinon c'est mkdir <nom du -fichier>. -

- -

-Attention, d'une part la syntaxe varie : une commande peut comprendre --h mais pas --help et -?, ou -inversement. Ensuite, ça ne marche pas toujours. Ainsi, si vous -essayez de demander de l'aide à la commande df (affiche -l'espace disque -disponible) : -

- -
-clipper ~ $ df -h
-Filesystem            Size  Used Avail Use% Mounted on
-/dev/dsk/c0t0d0s0     189M   92M   79M  54% /
-/dev/dsk/c0t0d0s4     754M  595M  106M  85% /usr
-/dev/dsk/c0t8d0s5     995M  467M  469M  50% /var
-
- -

-Pour df, l'option -h veut dire tout autre -chose... -

- -

L'option fantaisiste

- -

-Cette astuce consiste à donner une option complètement fantaisiste à -la commande. Celle-ci va réagir en disant que ce n'est pas comme ça -qu'on fait, et vous indiquera brièvement quelles sont les syntaxes -correctes possibles. Exemple : -

- -
-clipper ~ $ cal -xyz
-cal: illegal option -- x
-usage: cal [ [month] year ]
-
- -

-On utilise une option -xyz pour être sûr que ce n'est pas -une option existante. Ça marche : cal (petit programme qui affiche -le calendrier du mois) se plaint que cette syntaxe n'existe pas, et -vous indique ce qui est possible. -

-

Pages de man

-L'aide la plus précieuse, la plus complète et le plus importante, +L'aide la plus précieuse, la plus complète et la plus importante, c'est le manuel. Comme un livre, il est divisé en pages, chaque page correspondant à une commande ou à un concept précis. C'est pour cette raison qu'on parle de pages de man. Les pages de manuel se présentent comme un fichier texte : pas de liens, pas d'images, on ne peut pas cliquer. Il y a seulement un peu de mise en page. Bref, c'est plutôt austère ! C'est que les pages de man ne sont pas des tutoriels, -mais des références. +mais des références. Souvent cependant, s'il existe un manuel plus +complet, la fin de la page de man indique où le trouver.

Le principe est simple : pour lire l'aide correspondant à telle commande ou concept, c'est man commande.

-
-À l'ENS, il existe la commande fman qui fonctionne -exactement comme la commande man, mais qui permet d'obtenir -de la documentation en français. Attention : la documentation -française est généralement en retard sur la documentation anglaise, donc -vous n'aurez pas toujours les pages les plus à jour... -

Ainsi, pour obtenir des renseignements sur la commande man elle-même : @@ -362,6 +284,96 @@ gr <mot clef>. + +

Aide rapide

+ +

+Très souvent, les commandes ont un petit fichier d'aide rudimentaire, +qui vous renseignera sur la syntaxe de la commande (pour savoir ce que +fait exactement la commande, ou pour compléter, c'est le rôle des pages de man). Il y a plusieurs manières d'obtenir +cette aide rudimentaire : +

+ +

Options -h, -? et --help

+ +

C'est un moyen simple pour obtenir un peu d'aide sur une +commande. Exemple :

+ +
+earendil ~ $ mkdir --help
+usage: mkdir [-pv] [-m mode] directory ...
+
+ +

+Ici, on vous indique que la commande mkdir admet les +options -p, -v, -m +<mode>, et que sinon c'est mkdir <nom du +fichier>. +

+ +

+Attention, d'une part la syntaxe varie : une commande peut comprendre +-h mais pas --help et -?, ou +inversement. Ensuite, ça ne marche pas toujours. Ainsi, si vous +essayez de demander de l'aide à la commande df (affiche +l'espace disque +disponible) : +

+ +
+clipper ~ $ df -h
+Filesystem            Size  Used Avail Use% Mounted on
+/dev/dsk/c0t0d0s0     189M   92M   79M  54% /
+/dev/dsk/c0t0d0s4     754M  595M  106M  85% /usr
+/dev/dsk/c0t8d0s5     995M  467M  469M  50% /var
+
+ +

+Pour df, l'option -h veut dire tout autre +chose... +

+ +

L'option fantaisiste

+ +

+Cette astuce consiste à donner une option complètement fantaisiste à +la commande. Celle-ci va réagir en disant que ce n'est pas comme ça +qu'on fait, et vous indiquera brièvement quelles sont les syntaxes +correctes possibles. Exemple : +

+ +
+clipper ~ $ cal -xyz
+cal: illegal option -- x
+usage: cal [ [month] year ]
+
+ +

+On utilise une option -xyz pour être sûr que ce n'est pas +une option existante. Ça marche : cal (petit programme qui affiche +le calendrier du mois) se plaint que cette syntaxe n'existe pas, et +vous indique ce qui est possible. +

+ +

Manuels intégrés aux logiciels

+ +

De même (ou plutôt, en plus), les programmes avec une interface +graphique ou semi-graphique ont souvent une commande qui donne accès à +leur manuel. Par exemple, le lecteur de courrier électronique mutt +dispose d'une liste de commande accessible en appuyant sur +?, et flrn, un des logiciels pour lire forum a un guide de survie +accessible avec F1 et un manuel complet accessible avec +?. Les programmes faisant partie de KDE ont +presque toujours un menu Aide (ou Help) complètement à droite de leur +barre de menu, malheureusement, ce manuel lest souvent incomplet ou peu +à jour. Toujours sous KDE, avec certains logiciels, on peut afficher une +bulle d'aide détaillée sur un élément de l'interface en cliquant sur le +point d'interrogation en haut à droite de la fenêtre, puis sur l'élément +en question.

+

Pages info

@@ -387,11 +399,11 @@ documentation moins inportante.

-À l'ENS, le plus simple est d'utiliser le programme -pinfo, qui permet de naviguer dans les pages info. La -syntaxe est aussi simple que celle de man : pinfo -<commande>. Par exemple, pour obtenir les pages info de -pinfo lui-même : +Sur les machines sur lesquelles il est installé, le plus +simple est d'utiliser le programme pinfo, qui permet de +naviguer dans les pages info. La syntaxe est aussi simple que celle de +man : pinfo <commande>. Par exemple, +pour obtenir les pages info de pinfo lui-même : 

@@ -403,8 +415,44 @@ Sous KDE, vous pouvez aussi taper info:<commande>
 dans la barre d'adresse de Konqueror.
 

 
+
(La)TeX

+
+

+Les programmes liés à TeX et les packages LaTeX viennent souvent avec
+des documentations très complètes, mais elle est sous forme de fichiers
+pdf ou texte brut (ou d'autres formats variés), et n'est pas toujours
+facile à trouver au premier abord. Heureusement, la commande
+texdoc permet souvent de trouver instanément le bon
+document. Par exemple, pour obtenir l'aide du package LaTeX
+multicol, il suffit de faire
+

+
+
+trimaran ~ $ texdoc multicol
+

+
+

+Le programme texdoctk affiche un petit index de cette
+documentation.
+

+
+
Le reste&thsp;: /usr/share/doc/

+
+

+Parfois, un programme vient avec un manuel, des fichiers d'exemples, ou
+une autre sorte de documentation qui ne rentre pas dans les sources de
+documentation standard décrites ci-dessus. (Il peut y avoir les deux :
+ainsi, beaucoup de logiciels ont une page de man minimaliste qui renvoie
+à un manuel complet au format HTML ou PDF.) Cette documentation « non
+standard » se trouve habituellement dans les répertoires
+/usr/share/doc/nom du programme/
+ou encore
+/usr/share/doc/nom du programme-doc/.
+Pensez à regarder !
+

+
 
Auteur : Marie-Lan Nguyen. 
-Dernière modification : le .
+Dernière modification : le .