Mkd (Extracteur de documents)/mkd-Manuel (fr)
(Redirigé depuis Mkd (Extracteur de documents)/Manuels)
Manuel mkd de référence en français
modifierInstallation du manuel
modifiermkd_fr.1 31 mars 2013
Manuel de référence en français (mkd-0~120508)
- Procédure
- Copier le contenu de la boîte French.mak ci dessous dans un éditeur de texte
- Enregistrer le fichier sous le nom French.mak
- Copier le contenu de la boîte mkd_fr.1 ci-après dans un éditeur de texte UTF-8
- Enregistrer le fichier sous le nom mkd_fr.1
- Exécuter la commande make -f French.mak
Fichier French.mak
# File : French.mak
# Syntax: sudo (or su) make -f French.mak
#
# Manual:
mkd_fr.1.gz: mkd_fr.1
# Compresser
gzip -c mkd_fr.1 > mkd_fr.1.gz
# Fichier: En lecture seule
chmod 444 mkd_fr.1.gz
# Installation
echo "Installation du manuel français"
if [ -d "/usr/share/man/fr.UTF-8/man1" ]; \
then sudo cp -f mkd_fr.1.gz /usr/share/man/fr.UTF-8/man1/mkd.1.gz ; \
elif [ -d "/usr/share/man/fr/" ]; \
then sudo cp -f mkd_fr.1.gz /usr/share/man/fr/man1/mkd.1.gz ; \
fi
Fichier : mkd_fr.1
- mkd_fr.1 ci-après est formaté nroff pour manuels au format Unicode UTF-8
- Le manuel est lisible au format UTF-8 par la commande man .\mkd_fr.1
- Il est lisible éventuellement au format ASCII par la commande : nroff -man mkd_fr.1
- Lors de l'installation il sera renommé mkd.1 et installé dans le répertoire des manuels français UTF-8.
.\" Mise à jour par JPL le 1 avril 1989 dans version.h MKDOC.3
.\" Vérifications UTF-8 par Clara le 6 novembre 2012
.\" Mise à jour par Cardabela le 31 mars 2012
.\" Mise à jour par JPL le 6 avril 2013
.\" .
.\" FILE manuals Update_mkd_(fr).1.txt to edit in UTF-8 format
.TH MKD 1 "6 Avril 2013"
.SH NOM
mkd \- make documentation. Extrait des informations codées dans les programmes sources, et produit une documentation spécifique.
.SH RÉSUMÉ
.I mkd
.RB [\-ABCFPSafjlpstw]
.IR codes
.IR chemin_source
.RB [chemin_cible]
.SH DESCRIPTION
.TP
.I mkd
Des commentaires sélectionnés (ou tous les commentaires) sont extraits des programmes sources: 'chemin_source', et sont copiés dans un fichier documentaire: 'chemin_cible', afin de produire une documentation spécifique . Habituellement les fichiers documentaires sont des Organigrammes, des Structures de programme, des commentaires pour Programmeurs, des points de Test et 'warnings' .... Les codes de sélection peuvent être respectivement 'O', 'S', 'P', 'T' et 'www' juste après le caractère début de commentaire.
.TP
.I codes
Les commentaires commençant par ces caractères sont extraits du programme source et sont ajoutés au fichier documentaire. Tous les caractères ASCII peuvent servir a coder les commentaires, toutefois on utilise habituellement des caractères majuscules, sauf w pour 'warning'. Avec deux étoiles en paramètre codes, mkd extrait tous les commentaires. (Voir aussi option t et les exemples).
.TP
.I chemin_source
Chemin du fichier source (ou fichier projet: option j)
.TP
.I chemin_cible
Chemin du fichier documentaire. Par défaut chemin_cible est une copie de chemin_source auquel on remplace le suffixe par le suffixe \'.doc\'.
.SH OPTIONS
.TP
.I Options en majuscules:
Restreint l'extraction des commentaires a un style de langage:
.IP \fB\-A\fP
extrait le style Assembleur ( ; → fin de ligne )
.IP \fB\-B\fB
style Basic ( REM ou ' → fin de ligne )
.IP \fB\-C\fB
style C++ ( // → NL et /\* * → *\// )
.IP \fB\-F\fB
style Fortran ( c,C ou * → fin de ligne )
.IP \fB\-P\fB
style Pascal ( { → } et (* → *) )
.IP \fB\-S\fB
style Shell ou ratfor ( # → fin de ligne )
.TP
.I options en minuscules:
.B
.IP \fB\-a\fB
(append) Ajoute a la suite du fichier documentaire \'chemin_cible\'.
.IP \fB\-f\fB
(find) Trouve le langage du fichier source par analyse du suffixe. (s\'utilise généralement avec un fichier projet)
.IP \fB\-j\fB
(project) S\'utilise avec un fichier projet composé de sources en langages différents.
.IP \fB\-l\fB
(lignes) Extrait les lignes commençant par les caractères CD1 ou CD2 ou CD3 et suivis par un des caractères codes, le commentaire se termine par la lecture du caractère \'Nouvelle Ligne\'. CD1 et CD2 doivent être placés en 1ère colonne, alors que CD3 peut être placé en milieu de ligne. CD1, CD2, CD3, sont des options de compilation dans le fichier version.h de la distribution source de mkd. On peut connaître ces options compilées par la commande mkd \\?
.IP \fB\-n\fB
(num) numérote les lignes (numéro de ligne du fichier d'origine).
.IP \fB\-p\fB
(page) Extrait le texte débutant par le caractère CD4 suivi d\'un des caractères codes, l'extraction du commentaire se termine avec la lecture du caractère CD5. CD4 et CD5 sont des options de compilation dans le fichier version.h de la distribution source de mkd. On peut connaître ces options compilées par la commande mkd \\?
.IP \fB\-s\fB
(screen verbose) Duplique les commentaires extraits sur la sortie standard.
.IP \fB\-t\fB
(text) Ne copie que le commentaire.
.IP \fB\-w\fB
(overwrite) Réécrit le fichier documentaire.
.SH EXEMPLES
.TP
.I avec une commande shell :
.TP
mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz
(Produit un manuel UNIX en francais. au format UTF-8 depuis la version 12.03) C: pour décoder le fichier en langage C, s:avec visualisation à l\' écran, t:ne copier que le commentaire, F:sélectionner les commentaires debutants par F.
.TP
mkd -Ct M manual mkd.1 | gzip -f mkd.1.gz
(Produit un manuel UNIX standard en anglais au format UTF-8 depuis la version 12.03)
.TP
mkd -Csl '*Sied' mkd3.c '*.verif_struct'
(avec les options de compilation CD1 ou CD2 = '#', produit une documentation avec la structure du programme, avec les: include, define, ifdef, else, et endif, des options de compilations afin de vérifier la structure du programme.) C:décoder les commentaires style C, s:vérifier à l'écran, l:décoder egalement des lignes commencant par les caractères CD1 ou CD2 ou CD3 et suivis des char_codes:*Sied.
.TP
mkd -jfsl '*OHie' mkd_docu.prj mkd.org
(avec les options de compilation CD1 ou CD2 = '#', produit un organigramme. Les commentaires commencent par *,O,H, et les fichiers sources sont listés dans le fichier projet.) f:trouver le style de langage, j:le fichier source est un fichier projet qui contient la liste des fichiers a documenter.
.TP
mkd -l '*ide' mkd3.c '*.id_ei'
(avec les options de compilation CD1='#' ou CD2='#', décode les #includes, #define, #ifdef, #else, #endif des options de compilation en C ).
.TP
mkd -pj '**' mkd_docu.prj mkd.strings
(avec les options de compilation CD4=CD5=\'\\"\', extrait les chaînes de caractères du programme. (les commentaires sont transmis a la sortie standard).
.TP
mkd (sans argument)
Génère une erreur et envoie la syntaxe au terminal avec les caractères compilés pour les options l et p.
.SH VOIR AUSSI
.PP
mkdcppw(1)
.SH HISTOIRE
.PP
1986 - mkd pour DOS, et mkdoc pour UNIX, sont écrits au format ASCII par Jean-Paul Louyot pour le laboratoire 'CEM' de l'université de Montpellier (France).
.TP
1991 - mkdoc 3.12 pour PC et UNIX (Sun)
.TP
1995 - 2004 - mkdoc 3.22 à mkdoc 4 pour Unix et Linux: SUN-SPARC, HP-UX, RedHat
.TP
2004 - mkdoc 4 pour Linux Ubuntu, Windows 98, Windows 2000
.TP
2007 - 2012 - de mkdoc R7.01 à mkd R12.01 sont au format ISO-8859-1. Le nom 'mkdoc' est abandonné avec la version 10.01 compilée avec Visual C++ 2010
.TP
2012 - mkd 12.03 adapté au format UTF-8 pour son internationalisation. Dans la foulée mkdcppw est écrit pour les styles de langages C++ (C, c++, c#, php, java, javascript, CSS, etc.) en mode graphique avec gcc et 'gtkmm' (fenêtres).
.SH TELECHARGEMENTS
.PP
http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX
.SH AUTEURS
.PP
Manuel mis à jour par : Clara JIMENEZ
.SH TRADUCTEURS
.PP
Allemand : Clara, JPL, Martine
.TP
Catalan : Alizée
.TP
Espagnol : Alizée, JPT, Sharo
.TP
Italien : Luca
.TP
Email : http://edeulo.free.fr/contacts/formmail.php
.IP
.SH NOTES
.PP
Il appartient aux programmeurs de veiller à refermer les commentaires, blocs et lignes, par les codes de fermeture appropriés dans les fichiers sources.
Attention: La fermeture d'un commentaire ligne est un retour chariot ( NL, LF, CR/LF) selon les cas.
En fin de fichier: cette note implique un retour chariot en fin de commentaire ligne. Dans ce cas vous devez avoir une ligne vide à la fin du fichier source.
Remarque: Cette version ne lit et ne décode pas les fichier inclus par '#include' dans les sources.
.SH BUGS
.PP
Bugs Report: http://edeulo.free.fr/phpBB3/index.php
Générateur de documents mkd
Manuel
modifierMKD(1) MKD(1)
NOM
mkd - make documentation. Extrait des informations codées dans les
programmes sources, et produit une documentation spécifique.
RÉSUMÉ
mkd [-ABCFPSafjlpstw] codes chemin_source [chemin_cible]
DESCRIPTION
mkd Des commentaires sélectionnés (ou tous les commentaires) sont
extraits des programmes sources: 'chemin_source', et sont copiés
dans un fichier documentaire: 'chemin_cible', afin de produire
une documentation spécifique . Habituellement les fichiers
documentaires sont des Organigrammes, des Structures de
programme, des commentaires pour Programmeurs, des points de
Test et 'warnings' .... Les codes de sélection peuvent être
respectivement 'O', 'S', 'P', 'T' et 'www' juste après le
caractère début de commentaire.
codes Les commentaires commençant par ces caractères sont extraits du
programme source et sont ajoutés au fichier documentaire. Tous
les caractères ASCII peuvent servir a coder les commentaires,
toutefois on utilise habituellement des caractères majuscules,
sauf w pour 'warning'. Avec deux étoiles en paramètre codes, mkd
extrait tous les commentaires. (Voir aussi option t et les
exemples).
chemin_source
Chemin du fichier source (ou fichier projet: option j)
chemin_cible
Chemin du fichier documentaire. Par défaut chemin_cible est une
copie de chemin_source auquel on remplace le suffixe par le
suffixe ´.doc´.
OPTIONS
Options en majuscules:
Restreind l'extraction des commentaires a un style de langage:
-A extrait le style Assembleur ( ; → fin de ligne )
-B style Basic ( REM ou ' → fin de ligne )
-C style C++ ( // → NL et /* → */ )
-F style Fortran ( c,C ou * → fin de ligne )
-P style Pascal ( { → } et (* → *) )
-S style Shell ou ratfor ( # → fin de ligne )
options en minuscules:
-a (append) Ajoute a la suite du fichier documentaire
´chemin_cible´.
-f (find) Trouve le langage du fichier source par analyse du
suffixe. (s´utilise généralement avec un fichier projet). mkd
reconnait les extensions suivantes: .asm, .s; .bas, .vb, .bat;
.C, .H, .D, .cc, .hh, .cp, .cs, c#, .c++, .h++, c--, h--, .cpp,
.hpp, .css, .pr, .pl, .php, .jav, .jse .js; .for, .f; .pas, .p;
.sh, .csh , .pl, .rb, .py, .pyw; .pj, .prj
-j (project) S´utilise avec un fichier projet composé de sources en
langages différents.
-l (lignes) Extrait les lignes commençant par les caractères CD1 ou
CD2 ou CD3 et suivis par un des caractères codes, le commentaire
se termine par la lecture du caractère ´Nouvelle Ligne´. CD1 et
CD2 doivent être placés en 1ère colonne, alors que CD3 peut être
placé en milieu de ligne. CD1, CD2, CD3, sont des options de
compilation dans le fichier version.h de la distribution source
de mkd. On peut connaître ces options compilées par la commande
mkd \?
-n (num) numérote les lignes (numéro de ligne du fichier
d'origine).
-p (page) Extrait le texte débutant par le caractère CD4 suivi d´un
des caractères codes, l'extraction du commentaire se termine
avec la lecture du caractère CD5. CD4 et CD5 sont des options de
compilation dans le fichier version.h de la distribution source
de mkd. On peut connaître ces options compilées par la commande
mkd \?
-s (screen verbose) Duplique les commentaires extraits sur la
sortie standard.
-t (text) Ne copie que le commentaire.
-w (overwrite) Réécrit le fichier documentaire.
EXEMPLES
avec une commande shell :
mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz
(Produit un manuel UNIX en francais. au format UTF-8 depuis la
version 12.03) C: pour décoder le fichier en langage C, s:avec
visualisation à l´ écran, t:ne copier que le commentaire,
F:sélectionner les commentaires debutants par F.
mkd -Ct M manual mkd.1 | gzip -f mkd.1.gz
(Produit un manuel UNIX standard en anglais au format UTF-8
depuis la version 12.03)
mkd -Csl '*Sied' mkd3.c '*.verif_struct'
(avec les options de compilation CD1 ou CD2 = '#', produit une
documentation avec la structure du programme, avec les: include,
define, ifdef, else, et endif, des options de compilations afin
de vérifier la structure du programme.) C:décoder les
commentaires style C, s:vérifier à l'écran, l:décoder egalement
des lignes commencant par les caractères CD1 ou CD2 ou CD3 et
suivis des char_codes:*Sied.
mkd -jfsl '*OHie' mkd_docu.prj mkd.org
(avec les options de compilation CD1 ou CD2 = '#', produit un
organigramme. Les commentaires commencent par *,O,H, et les
fichiers sources sont listés dans le fichier projet.) f:trouver
le style de langage, j:le fichier source est un fichier projet
qui contient la liste des fichiers a documenter.
mkd -l '*ide' mkd3.c '*.id_ei'
(avec les options de compilation CD1='#' ou CD2='#', décode les
#includes, #define, #ifdef, #else, #endif des options de
compilation en C ).
mkd -pj '**' mkd_docu.prj mkd.strings
(avec les options de compilation CD4=CD5=´\"´, extrait les
chaînes de caractères du programme. (les commentaires sont
transmis a la sortie standard).
mkd (sans argument)
Génère une erreur et envoie la syntaxe au terminal avec les
caractères compilés pour les options l et p.
VOIR AUSSI
mkdcppw(1)
HISTOIRE
1986 - mkd pour DOS, et mkdoc pour UNIX, sont écrits au format ASCII
par Jean-Paul Louyot pour le laboratoire 'CEM' de l'université de
Montpellier (France).
1991 - mkdoc 3.12 pour PC et UNIX (Sun)
1995 - 2004 - mkdoc 3.22 à mkdoc 4 pour Unix et Linux: SUN-SPARC, HP-
UX, RedHat
2004 - mkdoc 4 pour Linux Ubuntu, Windows 98, Windows 2000
2007 - 2012 - de mkdoc R7.01 à mkd R12.01 sont au format ISO-8859-1.
Le nom 'mkdoc' est abandonné avec la version 10.01 compilée avec
Visual C++ 2010
2012 - mkd 12.03 adapté au format UTF-8 pour son internationalisation.
Dans la foulée mkdcppw est écrit pour les styles de langages C++ (C,
c++, c#, php, java, javscript, CSS, etc.) en mode graphique avec gcc et
'gtkmm' (fenêtres).
TELECHARGEMENTS
http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX
AUTEURS
Manuel mis à jour par : Clara JIMENEZ
TRADUCTEURS
Allemand : Clara, JPL, Martine
Catalan : Alizée
Espagnol : Alizée, JPT, Sharo
Italien : Luca
Email : http://edeulo.free.fr/contacts/formmail.php
NOTES
Il appartient aux programmeurs de veiller à refermer les commentaires,
blocs et lignes, par les codes de fermeture appropriés dans les
fichiers sources.
Attention: La fermeture d'un commentaire ligne est un retour chariot (
NL, LF, CR/LF) selon les cas.
En fin de fichier: cette note implique un retour chariot en fin de
commentaire ligne. Dans ce cas vous devez avoir une ligne vide à la fin
du fichier source.
Remarque: Cette version ne lit et ne décode pas les fichier inclus par
'#include' dans les sources.
BUGS
Bugs Report: http://edeulo.free.fr/phpBB3/index.php
Générateur de documents mkd
11 Mai 2013 MKD(1)
Manuels internationalisés
modifier- (man1) :
- Attention : Vérifiez les dates de publication de ces pages de manuels en bas de page.
- ↑ Manuels anglais allemand français
- ↑ Translations anglais allemand français