6. Conventions utilisées dans ce manuel
6.1. Conventions typographiques
Afin d'accentuer clairement certains mots ou groupes de mots, nous avons utilisé certains attributs typographiques. Le tableau suivant en donne la signification symbolique :
| Exemple formaté | Signification | |
|---|---|---|
| inœud | Signale qu'un terme technique est expliqué dans le Glossaire. | |
| ls -lta | Types utilisés pour une commande et ses arguments, les options et les noms de fichier (voir la section « Synopsis d'une commande »). | |
| ls(1) | Référence vers une page de manuel. Pour consulter la page correspondante dans un shell (ou ligne de commande), exécutez la commande man 1 ls. | |
| Ce style est utilisé pour une copie d'écran texte. Signale une interaction utilisateur-ordinateur, le code source d'un programme, etc. | |
| localhost | Données littérales qui ne correspondent généralement pas à une des catégories précédemment définies : citation d'un mot-clé tiré d'un fichier de configuration, par exemple. | |
| Apache | Nom des applications. À ne pas confondre avec le nom de la commande associée (vois plus haut). | |
| Entrées de menu ou labels des interfaces graphiques, en général. La lettre soulignée indique le raccourci clavier éventuel. | ||
| Bus SCSI | Partie d'un ordinateur ou ordinateur lui-même. | |
| Once upon a time... | Citation en langue étrangère. | |
| Attention ! | Types réservés pour les mots que nous voulons accentuer (on les lira à voix haute ;-) |
 | Cette icône introduit une note. Il s'agit généralement d'une remarque dans le contexte courant, pour donner une information additionnelle. |
 | Cette icône introduit une astuce. Il peut s'agir d'un conseil d'ordre général sur la meilleure façon d'arriver à un but spécifique, ou une fonctionnalité intéressante qui peut vous rendre la vie plus facile. |
 | Soyez très attentif lorsque vous rencontrez cette icône. Il s'agit toujours d'informations très importantes sur le sujet en cours de discussion. |
6.2. Conventions générales
6.2.1. Synopsis d'une commande
L'exemple ci-dessous présente les différents signes et symboles que vous rencontrerez lorsque nous décrivons les arguments d'une commande :
command <argument non littéral> [--option={arg1,arg2,arg3}] [argument optionnel...] |
Les signes « < » (supérieur) et « > » (inférieur) indiquent un argument obligatoire qui ne doit pas être recopié tel quel mais remplacé par votre texte spécifique. Par exemple : <fichier> désigne le nom d'un fichier ; si ce fichier est toto.txt, vous devrez taper toto.txt, et non <toto.txt> ou <fichier>.
Les crochets « [ ] » indiquent des arguments optionnels que vous déciderez ou non d'inclure dans la ligne de commande.
Les points de suspension « ... » signifient qu'un nombre illimité d'options peut être inséré à cet endroit.
Les accolades « { } » contiennent les arguments autorisés à cet endroit. Il faudra obligatoirement insérer un d'entre eux à cet endroit précis.
6.2.2. Notations particulières
Il vous sera demandé, de temps à autre, de presser les touches Ctrl+R. Cela signifie que vous devez taper et maintenir la touche Ctrl enfoncée pendant que vous appuyez sur la touche R. Le même chose se rencontre pour les touches Alt et Shift.
De même, à propos des menus, aller sur l'entrée de menu -> (Ctrl+R) signifie : cliquer sur le texte du menu (généralement horizontal en haut de la fenêtre) puis sur le menu vertical qui apparaît, cliquer sur . De plus, vous êtes informé que vous pouvez utiliser la combinaison de touches Ctrl+R comme décrit ci-dessus pour arriver au même résultat.
6.2.3. Utilisateurs du système
À chaque fois que cela est possible, nous utiliserons deux utilisateurs génériques dans nos exemples :
