Guide d'introduction à Debian GNU-Linux
Chapitre 16 Lire la documentation et obtenir de l'aide

16.1 Les sources de documentation

Sur un système Debian, vous pouvez trouver la documentation aux emplacements suivants:

• Pages de manuel, que l'on peut lire avec la commande man
• Pages info, que l'on peut lire avec la commande info
• Les répertoires de /usr/doc/paquets où paquet est le nom du paquet Debian[51]
• Le répertoire /usr/doc/HOWTO contient les HOWTOs du Projet Linux de Documentation, si vous avez installé les paquets les contenant.
• La plupart des commandes ont une option -h ou --help. Tapez le nom de la commande suivi d'une de ces options pour essayer.
• Le Projet de Documentation de Debian (http://www.debian.org/~elphick/ddp/) fournit aussi quelques manuels.
• La page d'assistance de Debian (http://www.debian.org/support/) possède sa FAQ et quelques autres documents. Vous pouvez aussi essayer le site oueb de Linux (http://www/linux.org).

Cette déroutante profusion de sources de documentations existe pour des tas de raisons. Par exemple, info est supposé remplacer le man mais man n'a toujours pas disparu à ce jour. Mais dans tous les cas, il est rassurant de savoir que tant de documentations existent !

Ainsi, où chercher pour obtenir de l'aide ? Voici quelques suggestions:

• Utilisez la page info ou l'option --help pour avoir un résumé rapide de la syntaxe et des options de la commande. Utilisez aussi la page de manuel si le programme n'a pas de page info.
• Utilisez la page info si le programme possède une documentation à ce format.
• Si cela ne donne rien, allez voir dans /usr/doc/nomdepaquet
• Utilisez les HOWTOs pour régler une chose particulière ou chercher une information sur un matériel particulier. Par exemple, l'Eternet-HOWTO regorge d'informations sur les cartes Ethernet et le PPP-HOWTO explique en détail comment configurer une liaison ppp.
• Utilisez les manuels du Projet de Documentation Debian pour les concepts inhérents et spécifiques à Debian.
• Si tout cela ne donne rien, demandez de l'aide à quelqu'un. Voir la partie 16.4 pour cela.

Comment utiliser les pages de manuel est expliqué à la partie 7.1. C'est très simple: appuyez sur la touche espace pour aller à la page suivante et appuyez sur q pour quitter le manuel. Utiliser info, visualiser les fichiers de /usr/doc et demander de l'aide à quelqu'un font l'objet des parties suivantes du chapitre.

16.2 Utiliser info

info est le visualiseur de documentation de GNU. Certains programmes fournissent leur documentation au format info et vous pouvez utiliser info pour la lire. Vous pouvez lancer le visualiseur en tapant simplement info ou en lui passant un argument comme ceci:

     info emacs

Vous pouvez obtenir aussi des informations sur info lui-même en appelant le tutoriel interne:

     info info

Maintenant, vous pouvez vous déplacer à l'aide des touches suivantes:

• flèches

  Pour déplacer le curseur au sein du document.

• m RET

  Sélectionne le choix d'un menu sous le curseur.

• u

  Pour « remonter » dans le document.

• n

  Pour aller à la page suivante.

• p

  Pour aller à la page précédente.

• s

  Pour rechercher quelque chose.

• g

  Pour aller à une page spécifique.

• q

  Quitter info

Vous remarquerez que la ligne supérieure de l'écran indique les pages next (suivantes), previous (précédentes) et up (supérieures) qui correspondent aux actions des touches n, p et u.

16.3 HOWTO

En plus de ses livres, le Projet de Documentation Linux a diffusé une série de petits documents décrivant comment configurer des aspects particuliers de GNU-Linux. Par exemple, le SCSI-HOWTO décrit les complications de l'utilisation du SCSI - une façon standard de communiquer avec des périphériques - sous GNU-Linux. De façon générale, les HOWTOs ont plus de détails techniques sur des configurations matérielles et sont souvent plus à jour que ce manuel.

Il y a des paquets Debian pour les HOWTOs. doc-linux-text contient l'ensemble des HOWTOs au format texte et doc-linux-html les contient (surprise!) au format html pour naviguer. Remarquez bien que Debian fournit des traductions de ces HOWTOs si l'anglais n'est pas votre langue maternelle. Debian a des paquets en allemand, français, espagnol, italien, japonais, coréen, polonais, suédois et chinois des HOWTOs. On les trouve généralement dans les paquets doc-linux-languagecode où languagecode est fr pour le français, es pour l'espagnol, etc... Si vous les avez installés, vous les trouverez dans /usr/doc/HOWTO. Quoi qu'il en soit, vous trouverez toujours les toutes dernières versions sur le réseau sur la page du LDP:

     http://metalab.unc.edu/LDP/

16.4 Aide personnalisée

L'emplacement correct[52] pour demander de l'aide sur Debian est la liste de distribution des utilisateurs de Debian à debian-user@list.debian.org (envoyer un courriel à debian-user@list.debian.org). Si vous savez vous servir d'IRC, vous pouvez utiliser le canal #debian sur irc.debian.org. Vous pouvez trouver de l'aide sur GNU-Linux en général dans la hiérarchie USENET comp.os.linux.*. Il est aussi possible d'embaucher des consultants pour fournir un service d'assistance garantie. Le site oueb de Debian (http://www.debian.org) fournit d'autres informations sur beaucoup de ces ressources.

Une nouvelle fois, ne contactez pas les auteurs (et le traducteur!) de ce livre pour obtenir de l'aide. Nous ne serons de toute façon certainement pas capables de répondre à votre problème spécifique. Si vous vous adressez à debian-user, vous recevrez quantité de messages de qualité, et qui plus est rapidement.

Restez toujours courtois et faîtes l'effort de lire la documentation. Rappelez-vous bien que Debian résulte d'un effort collectif de volontaires et que les personnes vous font une faveur en vous donnant un peu de leur temps pour vous aider. Beaucoup d'entre eux font payer ce même service plusieurs centaines de dollars pendant la journée.

Ce qu'il faut faire pour poser des questions

• Lire tout d'abord la documentation de base en premier. Les trucs comme les options des commandes et ce que fait une commande en fait partie. Cela inclut aussi les pages de manuel et la documentation au format info.
• Vérifier les documents HOWTOs si votre question concerne un réglage comme une connexion ppp ou Ethernet.
• Essayez d'être sûr que la réponse ne se trouve pas dans ce livre.
• N'ayez pas peur de demander, après avoir fait l'effort d'essayer de comprendre.
• N'ayez pas peur de demander des explications conceptuelles, des conseils sur tous les aspects que l'on ne trouve pas dans les documentations.
• Joignez toute information intéressante. Vous devez toujours mentionner la version de Debian que vous utilisez. Vous pouvez aussi mentionner le numéro de version de tout paquet pertinent. La commande dpkg -l nomdupaquet vous le fournit. Vous pouvez aussi signaler ce que vous avez tenté et ce qu'il est advenu. N'oubliez d'inclure les messages d'erreur complets et exacts, s'il y en a.
• Ne vous excusez pas d'être un nouveau sur Linux. Il n'y a pas de raison d'être un expert pour pouvoir utiliser GNU-Linux, pas plus qu'il est nécessaire d'être une mécanique pour conduire une automobile.
• Ne postez pas ou n'envoyez pas de courriel en HTML. Certaines versions de Netscape ou d'Internet Explorer postent par défaut en HTML plutôt qu'en texte. Beaucoup de gens vont carrément alors ignorer ces courriels car de nombreux lecteurs de courriels ont des difficultés à lire ce format. Il y a une préférence quelque part pour désactiver le support HTML.
• Soyez courtois. Rappelez-vous que Debian est un effort collectif de bénévoles et quiconque vous aide vous donne une partie de son temps libre.
• Renvoyez votre question à la liste si vous n'avez pas eu de réponse après quelques jours. Il y avait peut-être de nombreux messages et il est passé inaperçu. Ou peut-être que personne ne connaissait la réponse et si personne n'est capable de répondre la fois suivante, il s'agit d'une sacrée colle. Vous pourriez peut-être fournir plus d'informations la fois suivante.

16.5 Extraire des informations du système

Lorsque vous diagnostiquez un problème ou lorsque vous demandez de l'aide, vous aurez besoin d'extraire des informations de votre système. Voici quelques façons d'y parvenir:

• Examinez les fichiers placés dans /var/log
• Examinez la sortie du message de la commande dmesg
• Lancez la commande uname -a