complété aide.tml : texdoc(tk), manuels accessibles depuis l'interface des

logiciels, /usr/share/doc

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.
 </p>
 
-<h2><a name="help">Aide rapide</a></h2>
-
-<p>
-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 <a href="#man">pages de man</a>). Il
-y a plusieurs manières d'obtenir cette aide rudimentaire :
-</p>
-
-<h3>Options <code>-h</code>, <code>-?</code> et <code>--help</code></h3>
-
-<p>C'est un moyen simple pour obtenir un peu d'aide sur une
-commande. Exemple :</p>
-
-<pre>
-<span class="prompt">earendil ~ $</span> mkdir --help
-usage: mkdir [-pv] [-m mode] directory ...
-</pre>
-
-<p class="continue">
-Ici, on vous indique que la commande <code>mkdir</code> admet les
-options <code>-p</code>, <code>-v</code>, <code>-m
-&lt;mode&gt;</code>, et que sinon c'est <code>mkdir &lt;nom du
-fichier&gt;</code>.
-</p>
-
-<p>
-Attention, d'une part la syntaxe varie : une commande peut comprendre
-<code>-h</code> mais pas <code>--help</code> et <code>-?</code>, ou
-inversement. Ensuite, ça ne marche pas toujours. Ainsi, si vous
-essayez de demander de l'aide à la commande <code>df</code> (affiche
-l'<a href="&url.tuteurs;unix/place_disque.html">espace disque</a>
-disponible) :
-</p>
-
-<pre>
-<span class="prompt">clipper ~ $</span> 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
-</pre>
-
-<p class="continue">
-Pour <code>df</code>, l'option <code>-h</code> veut dire tout autre
-chose...
-</p>
-
-<h3>L'option fantaisiste</h3>
-
-<p>
-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 :
-</p>
-
-<pre>
-<span class="prompt">clipper ~ $</span> cal -xyz
-cal: illegal option -- x
-usage: cal [ [month] year ]
-</pre>
-
-<p class="continue">
-On utilise une option <code>-xyz</code> pour être sûr que ce n'est pas
-une option existante. Ça marche : <a
-href="divers.html"><code>cal</code></a> (petit programme qui affiche
-le calendrier du mois) se plaint que cette syntaxe n'existe pas, et
-vous indique ce qui est possible.
-</p>
-
 <h2><a name="man">Pages de man</a></h2>
 
 <p>
-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 <dfn>pages de man</dfn>. 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.
 </p>
 
 <p>
 Le principe est simple : pour lire l'aide correspondant à telle
 commande ou concept, c'est <code>man commande</code>.</p> 
 
-<div class="ens">
-À l'ENS, il existe la commande <code>fman</code> qui fonctionne
-exactement comme la commande <code>man</code>, 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...
-</div>
 
 <p>Ainsi, pour obtenir des renseignements sur la
 commande <code>man</code> elle-même :
@@ -362,6 +284,96 @@ gr
 &lt;mot clef&gt;</code>.
 </div>
 
+
+<h2><a name="help">Aide rapide</a></h2>
+
+<p>
+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 <a
+  href="#man">pages de man</a>). Il y a plusieurs manières d'obtenir
+cette aide rudimentaire :
+</p>
+
+<h3>Options <code>-h</code>, <code>-?</code> et <code>--help</code></h3>
+
+<p>C'est un moyen simple pour obtenir un peu d'aide sur une
+commande. Exemple :</p>
+
+<pre>
+<span class="prompt">earendil ~ $</span> mkdir --help
+usage: mkdir [-pv] [-m mode] directory ...
+</pre>
+
+<p class="continue">
+Ici, on vous indique que la commande <code>mkdir</code> admet les
+options <code>-p</code>, <code>-v</code>, <code>-m
+&lt;mode&gt;</code>, et que sinon c'est <code>mkdir &lt;nom du
+fichier&gt;</code>.
+</p>
+
+<p>
+Attention, d'une part la syntaxe varie : une commande peut comprendre
+<code>-h</code> mais pas <code>--help</code> et <code>-?</code>, ou
+inversement. Ensuite, ça ne marche pas toujours. Ainsi, si vous
+essayez de demander de l'aide à la commande <code>df</code> (affiche
+l'<a href="&url.tuteurs;unix/place_disque.html">espace disque</a>
+disponible) :
+</p>
+
+<pre>
+<span class="prompt">clipper ~ $</span> 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
+</pre>
+
+<p class="continue">
+Pour <code>df</code>, l'option <code>-h</code> veut dire tout autre
+chose...
+</p>
+
+<h3>L'option fantaisiste</h3>
+
+<p>
+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 :
+</p>
+
+<pre>
+<span class="prompt">clipper ~ $</span> cal -xyz
+cal: illegal option -- x
+usage: cal [ [month] year ]
+</pre>
+
+<p class="continue">
+On utilise une option <code>-xyz</code> pour être sûr que ce n'est pas
+une option existante. Ça marche : <a
+href="divers.html"><code>cal</code></a> (petit programme qui affiche
+le calendrier du mois) se plaint que cette syntaxe n'existe pas, et
+vous indique ce qui est possible.
+</p>
+
+<h2>Manuels intégrés aux logiciels</h2>
+
+<p>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 <code>mutt</code>
+dispose d'une liste de commande accessible en appuyant sur
+<code>?</code>, et <code>flrn</code>, un des logiciels pour lire <a
+  href="&url.tuteurs;/internet/forum">forum</a> a un guide de survie
+accessible avec <code>F1</code> et un manuel complet accessible avec
+<code>?</code>. 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.</p>
+
 <h2>Pages info</h2>
 
 <p>
@@ -387,11 +399,11 @@ documentation moins inportante.
 
 
 <p>
-À l'ENS, le plus simple est d'utiliser le programme
+Sur les machines sur lesquelles il est installé, le plus
-<code>pinfo</code>, qui permet de naviguer dans les pages info. La
+simple est d'utiliser le programme <code>pinfo</code>, qui permet de
-syntaxe est aussi simple que celle de <code>man</code> : <code>pinfo
+naviguer dans les pages info. La syntaxe est aussi simple que celle de
-&lt;commande&gt;</code>. Par exemple, pour obtenir les pages info de
+<code>man</code> : <code>pinfo &lt;commande&gt;</code>. Par exemple,
-<code>pinfo</code> lui-même :
+pour obtenir les pages info de <code>pinfo</code> lui-même :
 </p>
 
 <pre>
@@ -403,8 +415,44 @@ Sous KDE, vous pouvez aussi taper <code>info:&lt;commande&gt;</code>
 dans la barre d'adresse de Konqueror.
 </p>
 
+<h2>(La)TeX</h2>
+
+<p>
+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
+<code>texdoc</code> permet souvent de trouver instanément le bon
+document. Par exemple, pour obtenir l'aide du package LaTeX
+<code>multicol</code>, il suffit de faire
+</p>
+
+<pre>
+<span class="prompt">trimaran ~ $</span> texdoc multicol
+</pre>
+
+<p class="continue">
+Le programme <code>texdoctk</code> affiche un petit index de cette
+documentation.
+</p>
+
+<h2>Le reste&thsp;: <code>/usr/share/doc/</code></h2>
+
+<p>
+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
+<code>/usr/share/doc/<em>nom du programme</em>/</code>
+ou encore
+<code>/usr/share/doc/<em>nom du programme</em>-doc/</code>.
+Pensez à regarder !
+</p>
+
 <div class="metainformation">Auteur : Marie-Lan Nguyen. 
-Dernière modification : le <date value="$Date: 2007-09-02 12:27:35 $" />.
+Dernière modification : le <date value="$Date: 2008-12-24 18:39:44 $" />.
 </div>
 
 </body>