La documentation fournie avec Mandrake Linux

La documentation de MandrakeSoft

Cette section détaille la documentation produite par MandrakeSoft pour la version en cours :

  • Vous pouvez également consulter les versions remises à jour en ligne : les pages doc

    Si vous avez choisi le groupe de documentation durant l'installation, vous trouverez tous nos guides dans les langues que vous avez installées dans la section Documentation du menu principal.

  • Guide de démarrage

    Ce manuel a pour but de guider vos premiers pas avec Mandrake Linux. Il traite de sujets basiques qui intéresseront les nouveaux utilisateurs GNU/Linux, et de configuration plus avancée concernant des situations courantes.

  • Manuel de référence

    Disponible en ligne et dans l'édition Mandrake Linux - Édition ProSuite™ de Mandrake Linux, ce document aborde les fonctions avancées de GNU/Linux et l'administration du système.

Les pages de manuel

C'est sans doute la source d'information principale au quotidien. Pratiquement toutes les commandes ont leur page de manuel (man page), et il y a aussi des pages de manuel sur le format de certains fichiers de configuration, sur les fonctions de bibliothèque (en anglais, library) pour les programmeurs, et plus encore. Une grande partie des pages de manuel existent en français, mais malheureusement, elles ne sont pas traduites.

Le contenu des pages de manuel est organisé en différentes sections. Plusieurs références aux dites sections sont faites de la manière suivante : open(2), fstab(5) réfèrent respectivement à la section 2 de la page de manuel open et à la section 5 de la page de manuel fstab.

La commande pour afficher une page de manuel dans un terminal (ou shell) est man, et sa syntaxe est la suivante :

man [options] [section] <page de manuel>

Il y a même une page de manuel pour man, soit man man. Elles sont pré-formatées puis affichées avec un pager (ou visionneuse), less étant utilisé par défaut.

Les noms des pages de manuel et de leurs sections relatives apparaissent au haut de chacune des pages. Tout à fait au bas de ces dernières (en général dans la section VOIR AUSSI ou SEE ALSO pour les pages de manuel qui ne sont pas encore francisées) d'autres pages de manuel sont mentionnées, et traitent de sujets connexes à ceux de la page que vous consultez.

Vous pouvez commencer par consulter les pages de manuel des différentes commandes qui sont abordées dans le Manuel de référence : ls(1), chmod(1), etc.

Si vous ne tombez pas sur la bonne page de manuel –– par exemple, vous voulez utiliser la fonction mknod dans un de vos programmes mais ouvrez la page de manuel de la commande mknod ––, vous devez mentionner la section : en l'occurrence, mknod(2). Si vous ne vous souvenez plus de la section exacte, la commande man -a mknod parcourra toutes les sections à la recherche de pages de manuel ayant pour nom mknod.

Les pages info

Elles sont une autre source de documentation, plus complète que les pages de manuel. La commande pour les consulter depuis un terminal est info.

Elles sont organisées sous forme d'arborescence dont le sommet s'appelle dir. À partir de là, vous pouvez accéder à toutes les pages info existantes.

Vous pouvez accéder aux pages info de deux façons. Sans argument, vous vous retrouverez au sommet de l'arborescence. Si vous y rajoutez un nom de commande ou de paquetage, la page correspondante, si elle existe, sera ouverte. Par exemple :

info emacs

Malheureusement, toutes les pages d'info sont pour l'instant en anglais. Dans les pages info, un texte similaire à :

* Buffers::

indique un lien. Si vous placez le curseur sur ce lien (à l'aide des touches fléchées) et appuyez sur la touche Entrée, vous serez alors amené à la page info correspondante.

Les raccourcis-clavier suivants existent :

  • u : pour Up (haut), monte au niveau supérieur ;

  • n : pour Next (prochain), va à la page info suivante dans ce niveau de l'arborescence ;

  • p : pour Prev (précédent), va à la page info précédente.

  • q : pour Quitter, ferme la visionneuse info.

Les commandes sont nombreuses, vous pouvez taper «?» pour en obtenir la liste.

Les HOWTO

Les HOWTO (ou «comment faire») sont édités par le TLDP (The Linux Documentation Project, soit le Projet de Documentation Linux) et sont dédiés à la configuration de nombreux aspects de votre système. Si le bon paquetage est installé (il s'agit des paquetages howto-html-en et howto-html-fr pour les éditions anglaise et française respectivement), ces HOWTO procurent des réponses ou solutions spécifiques à des problèmes reliés à votre système. Cette documentation se trouve dans le répertoire /usr/doc/HOWTO/HTML/fr/ pour la version française. Ce sont des fichiers HTML consultables et imprimables à partir de n'importe quel navigateur Web.

La liste est très longue. Pour vous en convaincre, consultez l'index à partir du menu principal de votre gestionnaire de fenêtres : Documentation->Howto en français. Si vous tombez sur un problème que vous n'arrivez pas à résoudre, trouver le HOWTO correspondant s'il existe. Le meilleur point de départ est de le lire, et il est très probable que vous y trouviez la solution d'une part. Vous apprendrez aussi beaucoup de choses en le lisant. Entre autres sujets sont couverts le réseau (NET-3-HOWTO), la configuration de cartes son (Sound-HOWTO), comment graver un CD (CD-Writing-HOWTO), la configuration de NIS et NFS, ainsi que plusieurs autres sujets.

Il faut cependant faire attention aux dates de dernière modification des HOWTO : certains d'entre eux n'ont pas été mis à jour depuis des lustres. Conséquemment, il est probable que leur contenu ne soit plus valide. Donc, méfiez-vous des vieux HOWTO traitant particulièrement de configuration matériel puisque GNU/Linux évolue très vite. Souvenez-vous aussi que le qualificatif «ancien» dans le mode du logiciel libre est encore plus significatif qu'en informatique en général : un logiciel libre vieux de quinze jours est parfois considéré comme ancien, voire périmé !

Note

Les HOWTO sont disponibles en ligne sur le site du TLDP et susceptibles d'y être légèrement plus à jour. Consultez aussi les HOWTO et la Foire aux Questions ou FAQ, en anglais.

Le répertoire /usr/doc

Quelques paquetages viennent également avec leur propre documentation. Ils sont placés dans un sous-répertoire de /usr/doc et leur nom est souvent celui du paquetage. Malheureusement, cette documentation est souvent en anglais.