4. Conventions de documentation

Les commandes de Linux (et les commandes d'autres systèmes d'exploitation, lorsqu'elles sont utilisées) sont représentées de cette façon. Ce style vous indique que vous pouvez saisir 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, individuellement, seraient représentés différemment (comme les noms de fichiers). Dans ces cas précis, ils sont considérés comme une partie de la commande ; toute la phrase sera donc affichée comme une commande. Par exemple :

Utilisez la commande cat testfile pour afficher le contenu d'un fichier nommé testfile, dans le répertoire de travail courant.

Les noms de fichiers, de répertoires, les chemins d'accès et les noms de paquetages RPM sont représentés de cette façon. Ce style devrait indiquer qu'un fichier ou un répertoire de ce nom existe dans votre système. Par exemple :

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

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

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

Ce style indique que le programme est une application d'utilisateur final (par opposition aux logiciels de système). Par exemple :

Utilisez Mozilla pour parcourir le Web.

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

Pour utiliser la fonctionnalité d'achèvement [Tab], saisissez un caractère, puis appuyez sur la touche [Tab]. Votre terminal affichera la liste des fichiers du répertoire qui commencent avec cette lettre.

Une combinaison de touches est représentée de cette façon. Par exemple :

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

Un titre, un mot ou une phrase figurant sur l'écran ou dans la fenêtre d'une interface GUI est représenté de cette façon. Lorsque vous voyez du texte dans ce style, il est utilisé pour identifier un écran GUI ou un élément sur un écran GUI particulier (comme du texte associé avec une case à cocher ou un champ de saisie). Par exemple :

Cochez la case Nécessite un mot de passe si vous voulez que votre écran de veille demande un mot de passe avant de s'arrêter.

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 GUI pour afficher le reste du menu. Par exemple :

Sous Fichier d'un terminal GNOME, vous trouverez l'option Nouvel onglet vous permettant d'ouvrir plusieurs invites du shell dans la même fenêtre.

Si vous devez saisir une séquence de commandes depuis un menu GUI, ces dernières apparaîtront de la façon suivante :

Cliquez sur Menu principal (sur le tableau de bord) => Programmation => Emacs pour lancer l'éditeur de texte Emacs.

Ce style indique que le texte se trouve sur un bouton à cliquer dans un écran GUI. Par exemple :

Cliquez sur le bouton Précédent pour revenir à la dernière page Web que vous avez affichée.

Ce style indique du texte affiché dans une invite du shell tel que des messages d'erreur et des réponses de commandes. Par exemple :

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

Desktop                about.html       logs          paulwesterberg.png
Mail                   backupfiles      mail          reports

La sortie produite en réponse à cette commande (dans ce cas, le contenu du répertoire) est affichée de cette façon.

L'invite est la façon utilisée par l'ordinateur pour vous indiquer qu'il est prêt à recevoir votre saisie. Elle est représentée comme ci-dessous. Par exemple :

$

#

[stephen@maturin stephen]$

leopard login:

Le texte que l'utilisateur doit saisir, que ce soit en ligne de commande ou dans une zone de texte dans un écran GUI, est affiché de cette façon. Dans l'exemple ci-dessous, text est affiché de la manière suivante :

Vous devez saisir la commande text à l'invite boot: pour démarrer votre système dans le programme d'installation en mode texte.

Le texte utilisé pour les exemples et qui doit être remplacé par des données saisies par l'utilisateur est affiché de cette façon. Dans l'exemple ci-dessous, <version-number> est affiché de la manière suivante :

Le répertoire de la source du noyau est /usr/src/<version-number>/, où <version-number> représente la version du noyau installée sur ce système.