Shell command projects/mkd
De Wiki EELL.
JPL (discuter | contributions) m (→Docs : Mise à jour) |
JPL (discuter | contributions) m (→Manuel en français : !! man fr) |
||
| Ligne 187 : | Ligne 187 : | ||
{{Boîte déroulante/début|titre=Manuel fr}} | {{Boîte déroulante/début|titre=Manuel fr}} | ||
<pre> | <pre> | ||
| - | MKD(1) | + | MKD(1) MKD(1) |
| Ligne 195 : | Ligne 195 : | ||
programmes sources, et produit une documentation spécifique. | programmes sources, et produit une documentation spécifique. | ||
| - | + | RÉSUMÉ | |
mkd [-ABCFPSafjlpstw] codes chemin_source [chemin_cible] | mkd [-ABCFPSafjlpstw] codes chemin_source [chemin_cible] | ||
| Ligne 223 : | Ligne 223 : | ||
Chemin du fichier documentaire. Par défaut chemin_cible est une | Chemin du fichier documentaire. Par défaut chemin_cible est une | ||
copie de chemin_source auquel on remplace le suffixe par le | copie de chemin_source auquel on remplace le suffixe par le | ||
| - | suffixe | + | suffixe ´.doc´. |
OPTIONS | OPTIONS | ||
| Ligne 244 : | Ligne 244 : | ||
-a (append) Ajoute a la suite du fichier documentaire | -a (append) Ajoute a la suite du fichier documentaire | ||
| - | + | ´chemin_cible´. | |
-f (find) Trouve le langage du fichier source par analyse du | -f (find) Trouve le langage du fichier source par analyse du | ||
| - | suffixe. ( | + | suffixe. (s´utilise généralement avec un fichier projet) |
| - | -j (project) | + | -j (project) S´utilise avec un fichier projet composé de sources en |
langages différents. | langages différents. | ||
-l (lignes) Extrait les lignes commençant par les caractères CD1 ou | -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 | CD2 ou CD3 et suivis par un des caractères codes, le commentaire | ||
| - | se termine | + | se termine par la lecture du caractère ´Nouvelle Ligne´. CD1 et |
| - | doivent être placés en 1ère colonne, alors | + | 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 | placé en milieu de ligne. CD1, CD2, CD3, sont des options de | ||
compilation dans le fichier version.h de la distribution source | compilation dans le fichier version.h de la distribution source | ||
de mkd. | de mkd. | ||
| - | -n | + | -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 | + | -p (page) Extrait le texte débutant par le caractère CD4 suivi d´un |
| - | des caractères codes, l'extraction du | + | des caractères codes, l'extraction du commentaire se termine |
avec la lecture du caractère CD5. CD4 et CD5 sont des options de | avec la lecture du caractère CD5. CD4 et CD5 sont des options de | ||
| - | compilation dans le fichier version.h de la distribution | + | compilation dans le fichier version.h de la distribution source |
de mkd. | de mkd. | ||
| - | -s (screen | + | -s (screen verbose) Duplique les commentaires extraits sur la |
sortie standard. | sortie standard. | ||
| Ligne 279 : | Ligne 280 : | ||
mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz | mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz | ||
| - | (Produit un manuel UNIX en francais. au format UTF-8 | + | (Produit un manuel UNIX en francais. au format UTF-8 depuis la |
| - | version | + | version 12.03) C: pour décoder le fichier en langage C, s:avec |
| - | visualisation à | + | visualisation à l´ écran, t:ne copier que le commentaire, |
F:sélectionner les commentaires debutants par F. | F:sélectionner les commentaires debutants par F. | ||
mkd -Ct M manual mkd.1 | gzip -f mkd.1.gz | mkd -Ct M manual mkd.1 | gzip -f mkd.1.gz | ||
| - | (Produit | + | (Produit un manuel UNIX standard en anglais au format UTF-8 |
depuis la version 12.03) | depuis la version 12.03) | ||
mkd -Csl '*Sied' mkd3.c '*.verif_struct' | mkd -Csl '*Sied' mkd3.c '*.verif_struct' | ||
| - | (avec les options de compilation CD1 ou CD2 = '#', | + | (avec les options de compilation CD1 ou CD2 = '#', produit une |
documentation avec la structure du programme, avec les: include, | documentation avec la structure du programme, avec les: include, | ||
| - | define, ifdef, else, et endif, des options de compilations | + | define, ifdef, else, et endif, des options de compilations afin |
| - | de | + | de vérifier la structure du programme.) C:décoder les |
| - | commentaires style C, s:vérifier à l'écran, l:décoder | + | commentaires style C, s:vérifier à l'écran, l:décoder egalement |
| - | des | + | des lignes commencant par les caractères CD1 ou CD2 ou CD3 et |
suivis des char_codes:*Sied. | suivis des char_codes:*Sied. | ||
mkd -jfsl '*OHie' mkd_docu.prj mkd.org | mkd -jfsl '*OHie' mkd_docu.prj mkd.org | ||
| - | (avec les options de compilation CD1 ou CD2 = | + | (avec les options de compilation CD1 ou CD2 = '#', produit un |
| - | organigramme. | + | organigramme. Les commentaires commencent par *,O,H, et les |
| - | + | fichiers source sont décrits 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. | |
| - | fichiers | + | |
mkd -l '*ide' mkd3.c '*.id_ei' | mkd -l '*ide' mkd3.c '*.id_ei' | ||
| - | (avec les options de compilation CD1='#' ou CD2='#', décode | + | (avec les options de compilation CD1='#' ou CD2='#', décode les |
| - | #includes, | + | #includes, #define, #ifdef, #else, #endif des options de |
compilation en C ). | compilation en C ). | ||
mkd -pj '**' mkd_docu.prj mkd.strings | mkd -pj '**' mkd_docu.prj mkd.strings | ||
| - | (avec les options de compilation CD4=CD5= | + | (avec les options de compilation CD4=CD5=´\"´, extrait les |
| - | chaînes | + | chaînes de caractères du programme. (les commentaires sont |
transmis a la sortie standard). | transmis a la sortie standard). | ||
mkd (sans argument) | mkd (sans argument) | ||
| - | Génère une erreur et envoie | + | Génère une erreur et envoie la syntaxe au terminal avec les |
caractères compilés pour les options l et p. | caractères compilés pour les options l et p. | ||
| - | + | ||
| + | VOIR AUSSI | ||
mkdcppw(1) | mkdcppw(1) | ||
| + | |||
HISTOIRE | HISTOIRE | ||
| Ligne 326 : | Ligne 328 : | ||
par Jean-Paul Louyot pour le laboratoire 'CEM' de l'université de | par Jean-Paul Louyot pour le laboratoire 'CEM' de l'université de | ||
Montpellier (France). | Montpellier (France). | ||
| - | + | ||
1991 - mkdoc 3.12 pour PC et UNIX (Sun) | 1991 - mkdoc 3.12 pour PC et UNIX (Sun) | ||
| Ligne 332 : | Ligne 334 : | ||
2004 - mkdoc 4 pour SUN-SPARC, HP-UX, RedHat, Windows 98, Windows 2000 | 2004 - mkdoc 4 pour SUN-SPARC, HP-UX, RedHat, Windows 98, Windows 2000 | ||
| - | + | ||
2007 - 2012 - de mkdoc R7.01 à mkd R12.01 sont au format ISO-8859-1. | 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 | Le nom 'mkdoc' est abandonné avec la version 10.01 compilée avec | ||
| Ligne 339 : | Ligne 341 : | ||
2012 - mkd 12.03 adapté au format UTF-8 pour son internationalisation. | 2012 - mkd 12.03 adapté au format UTF-8 pour son internationalisation. | ||
Dans la foulée mkdcppw est écrit pour langages C, c++ et php en mode | Dans la foulée mkdcppw est écrit pour langages C, c++ et php en mode | ||
| - | graphique avec gcc et 'gtkmm' (fenêtres). | + | graphique avec gcc et 'gtkmm' (fenêtres). |
| - | + | TELECHARGEMENTS | |
| - | + | ||
| - | + | ||
http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX | 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 | NOTES | ||
| - | Cette | + | Cette version ne lit et ne décode pas les fichier inclus par '#include' |
| - | + | dans les sources. | |
BUGS | BUGS | ||
Bugs Report: http://edeulo.free.fr/phpBB3/index.php | Bugs Report: http://edeulo.free.fr/phpBB3/index.php | ||
| + | |||
| + | Générateur de documents mkd | ||
| + | |||
| + | |||
| + | |||
| - | + | 6 Décembre 2012 MKD(1) | |
</pre> | </pre> | ||
