Linux-Mandrake:
Guide d'installation

MandrakeSoft

 
 
Janvier 2000
http://www.linux-mandrake.com


Suivant : Avant-propos
Précédent : Notice légale
Retour

(Retour à la table des matières)

Chapitre 2 : Conventions typographiques


Pour clarifier les explications, ce document utilise différentes polices de caractères pour représenter des objets aux interprétations différentes. On utilise parfois la même fonte pour divers types d'objets; c'est alors le contexte qui vous permettra de savoir de quoi on parle, ou il n'est pas crucial d'être capable à la lecture de distinguer précisément entre les divers types d'objets.

Portions de codes et assimilés

Remarquez que dans les exemples qui suivent la taille de la police est ajustée automatiquement pour occuper au mieux la largeur de la page. Ce sera le cas dans tout le manuel. La plupart des exemples de cette section utilisent des programmes invoqués depuis une ligne de commande, c'est-à-dire un terminal dans lequel on tape des commandes. Rendez-vous au chapitre correspondant pour savoir comment obtenir un terminal.

Exemple de portion de code

# Les portions de code sont présentées ainsi.
# Une portion de code est une interaction
#   dans un terminal entre l'utilisateur et
#   l'ordinateur.
# Les lignes commençant par un signe « dièse »
#   comme celle-ci, (#) sont des commentaires.
# Les lignes commençant par un signe « dollar »
#   ($) sont des commandes à taper, soit en tant
#   que vous-même, soit en tant que root (c'est
#   la lecture du contexte qui vous le dira).
# Les lignes se terminant par une anti-barre
#   oblique (\) se continuent sur la ligne qui
#   suit. Certains programmes comprennent cette
#   convention.
# Les autres lignes sont les messages de
#   l'ordinateur.
$ file /dev/null
/dev/null: character special (1/3)
$ echo Bonjour \
  le monde
Bonjour le monde
$ echo Bonjour le monde
Bonjour le monde

Exemple d'extrait de fichier

# Les portions des fichiers de configuration
#   sont présentées ainsi. Souvent, les lignes
#   commençant par des signes « dièse » (#)
#   sont des commentaires.
# affecte une valeur à la variable TOTO
TOTO="Ma valeur"

Exemple de syntaxe d'une commande

commande <argument non littéral> [argument optionnel...]

Il est très important de comprendre comment interpréter les caractères spéciaux dans les syntaxes de commande.

Les signes « plus grand que » et « inférieur à » entourent un argument à ne pas recopier littéralement, mais à interpréter avant de ce faire. Par example, <nom_fichier> se réfère au nom du fichier proprement dit. Si ce nom est toto.txt, il vous faudra taper toto.txt, et non pas <toto.txt> ou <nom_fichier>.

Les crochets signalent des arguments facultatifs, que vous pouvez ou non inclure dans la commande.

Les points de suspension indiquent qu'on peut insérer un nombre arbitraire d'objets.

Cette syntaxe reprend la syntaxe utilisée dans la synopsis des pages de manuel du système

Exemple d'entrée utilisateur

C'est ainsi qu'est représenté ce que vous devez taper littéralement.

Exemple de sortie par l'ordinateur

Les messages affichés par l'ordinateur sont présentés ainsi.

Fontes particulières

Ce manuel utilise un certain nombre de polices différentes (dont les effets peuvent parfois s'additionner) pour vous aider à distinguer la sémantique ou la nature des mots utilisés. Elles apparaîtront de la manière suivante:

Divers

Note: les remarques à prendre en compte sont présentées ainsi.
Attention: les remarques importantes sont présentées ainsi.

Outils utilisés dans la conception de ce manuel

Ce manuel a été mis en forme avec LaTeX. Perl et GNU Make furent employés pour gérer l'ensemble de fichiers du projet. Les images ont été prises avec xwd et converties avec la commande convert (du paquetage ImageMagick). Les fichiers au format PostScript furent produits avec dvips. Tous ces logiciels sont libres et sont présents sur votre distribution de Linux-Mandrake.


Suivant : Avant-propos
Précédent : Notice légale
Retour

Copyright © 2000 MandrakeSoft