Shell command projects/mkd

MKD(1)                                                                 MKD(1)

       mkd  -  make documentation.  Extrait des informations codées dans les

       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

               Chemin du fichier documentaire. Par défaut chemin_cible est une

               copie  de  chemin_source  auquel  on remplace le suffixe par le

       -a    (append)   Ajoute  a  la  suite  du  fichier  documentaire

       -f    (find)  Trouve le langage du fichier source par analyse du

               suffixe. (s´utilise généralement avec un fichier projet).  mkd

       -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.

               (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,

               (Produit un manuel UNIX standard en  anglais  au  format  UTF-8

               (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.

               (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

               (avec les options de compilation CD1='#' ou CD2='#', décode les

               #includes, #define, #ifdef, #else, #endif des options   de

               compilation en C ).

               (avec  les  options  de  compilation  CD4=CD5=´\"´, extrait les

               chaînes de caractères  du  programme.  (les  commentaires  sont

               Génère  une  erreur  et  envoie la syntaxe au terminal avec les

       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).

       1995 - 2004 - mkdoc 3.22 à mkdoc 4 pour Unix et Linux: SUN-SPARC,  HP-

       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).

       http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX

       Il appartient aux programmeurs de veiller à refermer les commentaires,

       blocs et lignes, par  les  codes  de  fermeture  appropriés dans les

       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

                                  11 Mai 2013                           MKD(1)