Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com
Answertopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

Linuxtopia - CentOS Enterprise Linux Guide de reference - Conventions de documentation

4. Conventions de documentation

En lisant ce manuel, vous verrez que certains mots sont repr�sent�s avec des polices diff�rentes au niveau du type, de la taille et de l'utilisation de caract�res gras. 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. Parmi les types de mots repr�sent�s de cette fa�on figurent�:

commande

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.

nom de fichier

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.

application

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.

[touche]

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.

[combinaison]-[touche]

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.

texte trouv� sur une interface GUI

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.

premier niveau d'un menu sur un �cran ou une fen�tre GUI

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.

bouton dans un �cran ou une fen�tre GUI

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.

sortie d'ordinateur

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.

invite

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:

saisie de l'utilisateur

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.

rempla�able

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.

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 �l�ments seront pr�sent�s sous forme de symbole indiquant une remarque, une astuce, un point important, un message d'attention ou un avertissement. Par exemple�:

NoteRemarque
 

N'oubliez pas que Linux est sensible � la casse. 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 de DHCP, les changements ne prendront pas effet tant que vous n'aurez pas red�marr� le d�mon DHCP.

AttentionAttention
 

N'effectuez pas de t�ches quotidiennes en tant que root — utilisez un compte utilisateur ordinaire � moins que vous n'ayez besoin d'utiliser le compte super-utilisateur pour des t�ches d'administration syst�me.

AvertissementAvertissement
 

Faites attention � ne supprimer que les partitions Red Hat Enterprise Linux n�cessaires. La suppression d'autres partitions pourrait provoquer la perte de donn�es ou la corruption d'un environnement syst�me.

 
 
  Published under the terms of the GNU General Public License Design by Interspire