Home Page

Chapitre Suivant , Précédent , Début du manuel , Table des matières générale


Chapitre 6

Documentation

La Red Hat contient plusieurs centaines de pages de documentation pour vous aider à apprendre à utiliser le système. Cette documentation (pages du man, ...) couvre tous les aspects de Linux. De plus, la Red Hat contient aussi les documentations issues du Projet de Documentation Linux.

6 1 L'aide en ligne

Si vous cherchez des renseignements sur les différentes commandes ou sur les messages d'erreurs, utilisez en priorité votre système.

6 1.1 Les pages du man

La plupart des commandes disponibles sur votre système possèdent un page de 'man' associée. Si, par exemple, vous rencontrez des problèmes avec la commande ls, utilisez le man. La commande man suivie de ls, vous affichera la page du man associée à ls. Cette page est visualisée grâce au programme less, dont les principales commandes sont : Il n'est pas toujours facile de consulter les pages du man sur écran. Si vous avez une imprimante, vous avez la possibilité de les imprimer. Si votre imprimante n'est pas une imprimante Postscript, vous pouvez utilisez la commande suivante pour imprimer la page au format ASCII :

man COMMAND | groff -mandoc -Tascii | lpr

Si votre imprimante est une imprimante Postscript utilisez :

man COMMAND | groff -mandoc | lpr

Dans les deux cas, remplacez COMMAND par le nom de la commande dont vous vous voulez imprimer la page. Il se peut, que pour une seule commande plusieurs pages soient disponibles. Elles sont classées de la façon suivante :

Section Contenu ------- ------------------------- 1 commandes utilisateurs 2 appels systèmes 3 appels librairies 4 périphériques 5 formats de fichiers 6 jeux 7 commandes complémentaires 8 commandes systèmes 9 noyau

Si vous voulez obtenir de l'aide sur la commande swapon, utilisez : man swapon. La page affichée (issue de la section 2) concerne la fonction swapon utilisée en langage C. Il y a de grandes chances pour que vous souhaitiez obtenir la page man consacrée à la commande système swapon (section 8), pour cela utilisez : man 8 swapon. Cette situation s'explique par le fait que le man retourne la première page consacrée à la commande.

Vous pouvez aussi effectuer une recherche de chaîne. Utilisez la commande man -k suivie de la chaîne à rechercher. Vous devez vous assurer que la base de données a été crée, si ce n'est pas le cas utilisez la commande :

/usr/sbin/makewhatis /usr/man /usr/X11R6/man


Note : cette opération doit être effectuée par l'utilisateur root.

Le résultat de la commande man -k swapon est :

# man -k swapon swapon, swapoff (2) - start/stop swapping to file/device swapon, swapoff (8) - enable/disable devices and files for paging and swapping

Vous pouvez voir que plusieurs pages issues des sections 2 et 8 sont consacrées à swapon (et dans ce cas à swapoff).

6 1.2 Documentation des packages

La plupart des packages contiennent des fichiers README et des fichiers de documentation. Nous avons décidé de les installer dans un sous-répertoire de /usr/doc. Le nom du sous-répertoire dépend du package, il est de la forme nom_de_package-version- numéro_de_release. La documentation du package tin, version 1.22, release 2 sera stockée dans /usr/doc/tin-1.22-2.

La plupart du temps ces documentations sont au format ASCII. Pour les visualiser, utiliser la commande more ou less suivie du nom de fichier. Si vous voulez savoir s'il existe une documentation pour une commande spécifique ou pour un fichier dont vous ne connaissez pas le package d'origine, utilisez :

rpm -qdf /etc/sendmail.cf

Cette commande retourne la documentation du package contenant le fichier /etc/sendmail.cf (consultez le HOWTO consacré à RPM pour plus de renseignements).

Pour obtenir de la documentation sur une commande, dont la page man n'est pas assez fournie, utilisez :

rpm -qdf 'which COMMAND'

Remplacez COMMAND par le nom de la commande (assurez vous que la commande se trouve dans votre chemin).

6 1.3 Les HOWTOs et FAQs

La plupart des documentation issues du Projet de Documentation Linux sont disponibles sur votre système dans le répertoire /usr/doc.

Le répertoire /usr/doc/HOWTO contient les versions ASCII de tous les HOWTOs actuellement disponibles. Ces fichiers sont compressés avec l'utilitaire gzip, pour les consulter utilisez la commande :

zcat HAM-HOWTO.gz {\verbar} more

Vous pouvez aussi décompresser les fichiers sur votre système, mais à moins de les recompresser par la suite cette solution demande plus d'espace disque disponible.

Le répertoire /usr/doc/HOWTO/mini contient les versions ASCII de tous les mini-HOWTOs disponibles. Ils ne sont pas compressés, utilisez more ou less pour les consulter. Le répertoire /usr/doc/HTML contient les versions HTML des HOWTOs et l'ouvrage 'Linux Installation and Getting Started'. Pour les visualiser utilisez un browser WWW (Arena ou Red Baron de Red Hat Software) :

cd /usr/doc/HTML arena index.html

/usr/doc/FAQ contient les version ASCII (et HTML pour certains) des FAQs les plus courant (donc le RedHat-FAQ). Vous pouvez les consulter avec more ou less.

6 1.4 La commande 'locate'

Vous pouvez utiliser la commande locate pour localiser une commande ou un fichier dont vous ne connaissez pas le nom en entier. Assurez-vous que la base de données nécessaire à locate a été créée, si ce n'est pas le cas utilisez la commande :

/usr/bin/updatedb --prunepaths='/tmp /proc /mnt /var/tmp /dev'


Note : cette opération doit être effectuée par l'utilisateur root.

Si vous désirez connaître tous les fichiers contenant la chaîne 'finger', utilisez :

locate finger

Le résultat de cette commande est par exemple :

/usr/bin/finger /usr/lib/irc/script/finger /usr/man/man1/finger.1 /usr/man/man8/in.fingerd.8 /usr/sbin/in.fingerd

La commande locate retourne aussi les répertoires contenant la chaîne (exemple : /home/djb/finger).

6 1.5 Les pages 'info'

Les pages 'info' sont des documents hypertextes qui facilitent la lecture des documentations. De nombreux documents de ce type se trouvent sur la distribution Red Hat (en particulier ceux issus du projet GNU).

Pour visualiser ce type de document exécutez la commande info (sans argument). La liste des documentations disponibles sera affichée. Si cette liste est vide, vous n'avez sans doute pas installé le package correspondant. Utilisez RPM et recommencez.

Si vous êtes un habitué d'emacs, utilisez C-h C-i pour appeler le browser info.

Info utilise un système hypertexte. Tout texte en surbrillance est un lien vers d'autres informations. La touche Tab déplace le curseur sur le lien, et la touche Entrée vous permet d'y accéder. La touche p est utilisée pour retourner à la page précédente, n pour la page suivante, et u remonte d'un niveau. Pour sortir, utilisez C-x C-c.

La meilleure façon d'apprendre à utiliser info est de lire son fichier de documentation. Le premier écran d'info devrait vous permettre de l'utiliser rapidement.

6 2 L'aide via Internet

6 2.1 Les 'mailings lists' Red Hat

Si vous ne trouvez pas de solution à votre problème, et si vous possédez un accès sur le Web, consultez http://www.redhat.com/mailing-list.html. Vous y trouverez les réponses à de nombreuses questions. Voici les adresses des listes auxquelles vous pouvez souscrire:

redhat-list-request@redhat.com redhat-digest-request@redhat.com redhat-announce-list-request@redhat.com redhat-devel-list-request@redhat.com rpm-list-request@redhat.com axp-list-request@redhat.com sparc-list-request@redhat.com

Envoyez un mail à l'adresse de la liste à laquelle vous voulez souscrire, en précisant 'subscribe' dans le sujet du mail. Si vous ne voulez plus figurer sur une liste, envoyez un mail en précisant 'unsubscribe' dans le sujet.

Pour envoyer un mail à une liste, utilisez les adresses listées plus haut en retirant '-request' (pour redhat-digest utilisez 'redhat-list@redhat.com').

6 2.2 Les Newsgroups USENET

Vous pouvez aussi consultez les Newsgroups pour obtenir de nombreux renseignements, et plus particulièrement comp.os.linux.


Chapitre Suivant , Précédent , Début du document

Table des matières de ce chapitre, Table des matières générale


(c)1996 Pour l'adaptation française : "Logiciels du Soleil"