Conventions de documentation

En lisant ce manuel vous verrez que certains mots sont présentés en différents caractères, types, tailles et graisses. Cette présentation est systématique ; différents mots sont représentés dans le même style pour indiquer leur appartenance à une certaine catégorie. Les types de mots représentés de la façon suivante comprennent :

command

Les commandes de Linux (et d'autres commandes de systèmes d'exploitation, lorsqu'elles sont utilisées) sont représentées de la façon suivante. Ce style devrait vous indiquer que vous pouvez taper le mot ou l'expression sur la ligne de commande et appuyer sur [Entrée] pour invoquer une commande. Une commande contient parfois des mots qui, tous seuls, seraient présentés différemment (comme les noms de fichiers). Ils sont alors considérés comme une partie de la commande ; toute la phrase est alors affichée comme une commande. Par exemple :

Utilisez la commande cat fichier test pour visualiser le contenu d'un fichier, appelé fichiertest, dans le répertoire actuellement en cours d'exécution.

nom de fichier

Les noms de fichiers, de répertoires, les chemins d'accès et noms des paquetages RPM sont représentés de la façon suivante. Ce style devrait indiquer qu'un fichier ou un répertoire portant ce nom existe dans votre système Red Hat Linux. Exemples :

Le fichier .bashrc dans votre répertoire personnel contient des définitions et alias de shell bash pour votre propre utilisation.

Le fichier /etc/fstab contient les informations concernant les différents périphériques et systèmes de fichiers.

Installez le RPM webalizer si vous voulez utiliser un programme d'analyse du journal de connexions au serveur Web..

application

Ce style vous indique que le programme appelé est une application d'utilisateur final (par opposition au logiciel de système). Par exemple :

Utilisez Netscape Navigator pour parcourir le Web.

[touche]

Une touche du clavier est présentée de cette façon. Par exemple :

Pour utiliser le complètement [Tab], tapez un caractère puis appuyez sur la touche [Tab]. Votre terminal affichera la liste des fichiers du répertoire qui commencent avec cette lettre.

[touche]-[combinaison]

Une combinaison de touches se présente de cette façon. Par exemple :

La combinaison [Ctrl]-[Alt]-[Effacement arrière] vous déconnecte de votre session graphique et affiche l'écran de connexion graphique ou la console.

texte d'une interface graphique

Un titre, un mot ou une expression apparaissant sur l'écran d'une interface graphique se présente de la façon suivante. Ce style vous indique qu'il s'agit d'un écran d'une interface graphique ou un élément d'un écran d'interface graphique (par exemple un texte associé à une case à cocher ou un champ). Exemples :

Cochez la case Nécessite un mot de passe si vous voulez que votre écran de veille demande un mot de passe avant de terminer.

haut de menu d'un éran d'interface graphique ou d'une fenêtre

Ce style vous indique que le mot représente le premier élément d'un menu déroulant. Cliquez sur le mot de l'écran d'interface graphique pour afficher le reste du menu. Par exemple :

Sous Paramètres d'un terminal GNOME, vous trouverez les articles suivants : Préférences, R.à Z. terminal, Réinitialiser et effacer et Sélection de la couleur.

Si vous devez entrer une séquence de commandes depuis un menu d'interface graphique, ils apparaîtront de la façon suivante :

Pour lancer l'éditeur de texte Emacs, cliquez sur Programmes=>Applications=>Emacs.

bouton d'un écran ou d'une fenêtre d'interface graphique

Ce style indique que le texte se trouve sur un bouton à cliquer d'un écran d'interface graphique. Par exemple :

Cliquez sur le bouton Back pour revenir à la dernière page Web que vous avez affichée :

sortie de l'ordinateur

Un texte de ce style vous indique qu'il est affiché par l'ordinateur à la ligne de commande. Vous verrez les réponses à vos commandes, messages d'erreur et invites interactives de votre saisie dans les scripts ou programmes affichés de cette manière. Par exemple :

Utilisez la commande ls pour afficher le contenu d'un répertoire :

$ ls
Desktop                axhome           logs          paulwesterberg.gif
Mail                   backupfiles      mail          reports

La sortie qui répond à cette commande (dans de cas le contenu du répertoire) est affichée de la façon suivante.

invite

L'invite est la façon qu'a l'ordinateur de vous signifier qu'il est prêt à recevoir votre saisie. Elle est représentée de la façon suivante :

$

#

[stephen@maturin stephen]$

leopard login:

saisie de l'utilisateur

Le texte que l'utilisateur doit entrer, que ce soit à la ligne de commande ou dans une boîte de texte d'une interface graphique, est affiché de cette façon. Dans l'exemple suivant, text est affiché de cette façon:

Pour lancer votre système dans le progamme d'installation basé sur du texte, il vous faudra entrer la commande text à l'invite boot:.

De plus, nous utilisons différentes stratégies pour attirer votre attention sur certaines informations. Suivant l'importance de l'information pour votre système, ces remarques seront présentées sous forme de :

NoteRemarque
 

N'oubliez pas que Linux différencie les majuscules et les minuscules. Autrement dit, rose n'est ni ROSE ni rOsE.

TuyauAstuce
 

Le répertoire /usr/share/doc contient de la documentation supplémentaire pour les paquetages installés sur votre système.

ImportantImportant
 

Si vous modifiez le fichier de configuration DHCP, les changements ne prendront pas effet tant que vous ne redémarrerez pas le démon DHCP.

AttentionAttention
 

N'effectuez pas de tâches standards en tant qu'utilisateur root. Nous vous conseillons d'utiliser toujours un compte utilisateur normal, à moins que vous ne deviez administrer votre système.

AvertissementAvertissement
 

Si vous choisissez de ne pas partitionner manuellement, une installation de classe serveur effacera toutes les partitions existantes sur tous les disques durs installés. N'utilisez cette classe d'installation que si vous êtes certain de ne pas avoir de données à sauvegarder.