1.2 A propos de ce manuel

Ce manuel est actuellement disponible en Texinfo, texte plein, Info, HTML, PostScript and PDF versions. A cause de leur taille, les versions en PostScript et PDF ne sont pas inclues dans la distribution principale de MySQL, mais sont disponibles sur http://www.mysql.com.

Le document initial est le fichier Texinfo. La version HTML a été générée automatiquement avec une version modifiée de texi2html. Les versions plain text et Info ont été produites avec makeinfo. La version Postscript version a été produite en utilisant texi2dvi et dvips. La version PDF a été produite avec l'utilitaire Ghostscript ps2pdf.

La version américaine de ce manuel a été écrite et mise à jour par David Axmark, Michael (Monty) Widenius, Paul DuBois and Kim Aldale. Pour les autres contributeurs, cf. section C Contributions à MySQL.

1.2.1 Conventions utilisées dans ce manuel

Ce manuel utilise certaines conventions typographiques :

constant

La police à empattement constant est utilisée pour les noms de commandes et les options; les déclarations en SQL; les noms de base de données, tables et colonnes; le code en C et Perl; et les variables d'environnement. Exemple: ``Pour obtenir une aide succinte, utilisez l'option --help de mysqladmin.''

``filename''

La police à empattement constant avec des guillemets est utilisée pour les noms de fichiers et les arborescences. Exemple: ``La distribution est installée dans le dossier ``/usr/local/''.''

``c''

La police à empattement constant avec des guillemets est aussi utilisée pour indiquer une suite de caractères. Exemple: ``Pour indiquer un caractère joker, utilisez le caractère ``%''.''

italic

La police italic est utilisée pour mettre en relief certains termes, Comme ceci.

boldface

La police Gras pour un accès à des noms privilégiés (e.g., ``Ne distribuez pas le droit de process à la légère'') et souligner des termes spécialement importants.

Lorsque les commandes sont décrites et doivent être exécutées par un programme spécifique, le programme est indiquée par le prompt avec la commande. Par exemple, shell> indique que la commande doit être exécutée à partir du login shell, et mysql> indique que la commande doit être exécutée à partir client mysql.

shell> Tapez une commande shell ici

mysql> Tapez une commande mysql ici 

Les commandes Shell décrites utilisent la syntaxe shell Bourne. Si vous utilisez un shell csh, vous devez formuler vos commandes un peu différemment.

Par exemple, la séquence de mise à jour d'une variable d'environnement et d'exécution d'une commande se présente comme suit dans la syntaxe Bourne:

shell> VARNAME=value some_command

pour csh:

shell> setenv VARNAME value

shell> some_command

Les noms de base de données, tables et colonnes sont souvent utilisés dans des commandes. Pour indiquer ces utilisations le manuel utilise la convention suivante, nom_base_de_donnees, nom_table et nom_colonne. Par exemple, vous pourrez voir des déclarations comme les suivantes:

mysql> SELECT nom_colonne FROM nom_base_de_donnees.nom_table;

Cela signifie que si vous devez utiliser une déclaration similaire, vos utiliserez vos propres noms de base de données, de tables et de colonnes, peut-être comme ceci :

mysql> SELECT nom_auteur FROM biblio_db.liste_auteur;

Les déclarations SQL peuvent être écrites en majuscules ou minuscules. Lorsque ce manuel montre une expression SQL, les majuscules sont utilisées pour les mots clefs en cours de discussion et les minuscules pour le reste de l'expression. Donc vous pourrez voir ce qui suit pour la déclaration du SELECT:

mysql> SELECT count(*) FROM nom_table;

D'autre part, si il s'agit de la fonction COUNT(), l'expression sera écrite comme suit:

mysql> select COUNT(*) from nom_table;

Dans le cas où aucun mot clef n'est à souligner, l'expression est en majuscule.

Dans la description de la syntaxe d'une expression, les crochets (``['' et ``]'') sont utilisés pour indiquer les options:

DROP TABLE [IF EXISTS] nom_table

Lorsque les éléments syntaxiques consistent en un certain nombres d'alternatives, les alternatives sont séparés par des barres verticales (``|''). Quand un membre d'un ensemble de possibilités peut être choisit, les possibilités sont listées à l'intérieure de crochets. Quand un membre doit être choisit, les possibilités sont listées à l'intérieure de (``{'' and ``''}):

TRIM([[BOTH | LEADING | TRAILING] [remstr] FROM] str)

{DESCRIBE | DESC} nom_table {nom_colonne | wild}