Shell command projects/mkd
De Wiki EELL.
JPL (discuter | contributions) m (→Manuels / Manuals : Rayé les manuels obsolètes) |
JPL (discuter | contributions) m (→Manuel en français : Mise à jour) |
||
| Ligne 211 : | Ligne 211 : | ||
=== Manuel en français === | === Manuel en français === | ||
| - | {{Boîte déroulante/début|titre=Manuel fr ( | + | {{Boîte déroulante/début|titre=Manuel fr (6 Avril 2013)}} |
<pre> | <pre> | ||
| - | + | MKD(1) | |
NOM | NOM | ||
| - | mkd - make | + | mkd - make documentation. Extrait des informations codées dans les |
programmes sources, et produit une documentation spécifique. | programmes sources, et produit une documentation spécifique. | ||
| Ligne 225 : | Ligne 225 : | ||
DESCRIPTION | DESCRIPTION | ||
| - | mkd Des commentaires sélectionnés (ou tous | + | mkd Des commentaires sélectionnés (ou tous les commentaires) sont |
| - | extraits des programmes sources: 'chemin_source', et sont | + | extraits des programmes sources: 'chemin_source', et sont |
| - | dans un fichier documentaire: 'chemin_cible', afin de | + | copiés dans un fichier documentaire: 'chemin_cible', afin de |
| - | une documentation spécifique . | + | produire une documentation spécifique . Habituellement les |
| - | documentaires | + | fichiers documentaires sont des Organigrammes, des Structures |
| - | programme, | + | de programme, des commentaires pour Programmeurs, des points de |
| - | Test et 'warnings' .... Les | + | Test et 'warnings' .... Les codes de sélection peuvent être |
| - | respectivement 'O', 'S', 'P', 'T' et 'www' | + | respectivement 'O', 'S', 'P', 'T' et 'www' juste après le |
caractère début de commentaire. | caractère début de commentaire. | ||
| - | codes Les commentaires commençant par ces caractères sont extraits | + | codes Les commentaires commençant par ces caractères sont extraits du |
| - | programme source | + | programme source et sont ajoutés au fichier documentaire. Tous |
| - | les caractères ASCII peuvent servir a | + | les caractères ASCII peuvent servir a coder les commentaires, |
| - | toutefois on | + | toutefois on utilise habituellement des caractères majuscules, |
| - | sauf w pour 'warning'. Avec deux étoiles en paramètre codes, | + | sauf w pour 'warning'. Avec deux étoiles en paramètre codes, |
| - | extrait | + | mkd extrait tous les commentaires. (Voir aussi option t et les |
exemples). | exemples). | ||
| Ligne 246 : | Ligne 246 : | ||
Chemin du fichier source (ou fichier projet: option j) | Chemin du fichier source (ou fichier projet: option j) | ||
| - | + | chemin_cible | |
| - | Chemin du fichier documentaire. Par défaut chemin_cible est | + | Chemin du fichier documentaire. Par défaut chemin_cible est une |
| - | copie de chemin_source auquel on | + | copie de chemin_source auquel on remplace le suffixe par le |
suffixe ´.doc´. | suffixe ´.doc´. | ||
| Ligne 269 : | Ligne 269 : | ||
options en minuscules: | options en minuscules: | ||
| - | -a (append) | + | -a (append) Ajoute a la suite du fichier documentaire |
´chemin_cible´. | ´chemin_cible´. | ||
| - | -f (find) Trouve le langage du fichier source | + | -f (find) Trouve le langage du fichier source par analyse du |
suffixe. (s´utilise généralement avec un fichier projet) | suffixe. (s´utilise généralement avec un fichier projet) | ||
| - | -j (project) S´utilise avec un fichier projet composé de sources | + | -j (project) S´utilise avec un fichier projet composé de sources |
| - | langages différents. | + | en langages différents. |
| - | -l (lignes) Extrait les lignes commençant par les caractères CD1 | + | -l (lignes) Extrait les lignes commençant par les caractères CD1 |
| - | CD2 ou CD3 et suivis par un des caractères codes, le | + | ou CD2 ou CD3 et suivis par un des caractères codes, le |
| - | se termine par la lecture du caractère ´Nouvelle Ligne´. CD1 et | + | 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 -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 | |
| - | -p (page) Extrait le texte débutant par le caractère CD4 suivi | + | options de compilation dans le fichier version.h de la |
| - | des caractères codes, l'extraction du commentaire se | + | distribution source de mkd. On peut connaître ces options |
| - | avec la lecture du caractère CD5. CD4 et CD5 sont des options de | + | compilées par la commande mkd /.IP -s (screen verbose) Duplique |
| - | + | les commentaires extraits sur la sortie standard. | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
-t (text) Ne copie que le commentaire. | -t (text) Ne copie que le commentaire. | ||
| Ligne 303 : | Ligne 301 : | ||
EXEMPLES | EXEMPLES | ||
| - | avec une commande | + | avec une commande shell : |
mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz | mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz | ||
| - | (Produit un | + | (Produit un manuel UNIX en francais. au format UTF-8 depuis la |
| - | version 12.03) C: pour décoder le fichier en langage | + | version 12.03) C: pour décoder le fichier en langage C, s:avec |
| - | visualisation à l´ écran, t:ne copier que | + | 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 un manuel UNIX standard | + | (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 | + | (avec les options de compilation CD1 ou CD2 = '#', produit une |
| - | documentation avec la structure du programme, avec les: | + | documentation avec la structure du programme, avec les: |
| - | define, ifdef, else, et endif, des options de | + | include, define, ifdef, else, et endif, des options de |
| - | de vérifier la structure | + | 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 | mkd -jfsl '*OHie' mkd_docu.prj mkd.org | ||
| - | (avec les options | + | (avec les options de compilation CD1 ou CD2 = '#', produit un |
| - | organigramme. Les commentaires | + | organigramme. Les commentaires commencent par *,O,H, et les |
| - | fichiers | + | fichiers sources sont listés dans le fichier projet.) f:trouver |
| - | le style de langage, j:le fichier source est un | + | le style de langage, j:le fichier source est un fichier projet |
qui contient la liste des fichiers a documenter. | qui contient la liste des fichiers a documenter. | ||
mkd -l '*ide' mkd3.c '*.id_ei' | mkd -l '*ide' mkd3.c '*.id_ei' | ||
| - | (avec | + | (avec les options de compilation CD1='#' ou CD2='#', décode les |
| - | #includes, #define, #ifdef, #else, #endif des options | + | #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 de | + | 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. | ||
| Ligne 351 : | Ligne 349 : | ||
HISTOIRE | HISTOIRE | ||
| - | 1986 - mkd pour DOS, et mkdoc pour UNIX, sont écrits | + | 1986 - mkd pour DOS, et mkdoc pour UNIX, sont écrits au format |
| - | par Jean-Paul Louyot | + | ASCII par Jean-Paul Louyot pour le laboratoire 'CEM' de |
| - | + | l'université de Montpellier (France). | |
1991 - mkdoc 3.12 pour PC et UNIX (Sun) | 1991 - mkdoc 3.12 pour PC et UNIX (Sun) | ||
| - | 1995 - mkdoc 3.22 pour Linux | + | 1995 - 2004 - mkdoc 3.22 à mkdoc 4 pour Unix et Linux: SUN-SPARC, HP- |
| + | UX, RedHat | ||
| - | 2004 - mkdoc 4 pour | + | 2004 - mkdoc 4 pour Linux Ubuntu, Windows 98, Windows 2000 |
| - | 2007 - 2012 - de mkdoc R7.01 à mkd R12.01 | + | 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 | + | 2012 - mkd 12.03 adapté au format UTF-8 pour son |
| - | Dans la foulée mkdcppw est écrit pour langages C, c++ | + | 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). | graphique avec gcc et 'gtkmm' (fenêtres). | ||
TELECHARGEMENTS | 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 | AUTEURS | ||
| Ligne 387 : | Ligne 388 : | ||
NOTES | NOTES | ||
| - | Cette version ne lit et ne décode pas les fichier inclus par '#include' | + | 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. | ||
| Ligne 399 : | Ligne 411 : | ||
| - | + | 6 Avril 2013 MKD(1) | |
</pre> | </pre> | ||
{{Boîte déroulante/fin}} | {{Boîte déroulante/fin}} | ||
