Shell command projects/mkd

MKD(1)

NAME

      mkd  -  make  documentation.   Extrait des informations codées dans les
      programmes sources, et produit une documentation spécifique.

SYNOPSIS

      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)

      path_target
             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                    (  / *    ->      * /    )

      -F     style Fortran              (c,C ou * -> fin de ligne)

      -P     style Pascal               (   {     ->       }     )

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

      -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 ´New Line´. 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.

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

      -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 Cshell :

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

      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.

AUTHOR

      JP LOUYOT, Clara JIMENEZ

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

NOTES

      Cette  version  12.03.0  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