Mkd (Extracteur de documents)/mkd-Manuel (fr)

Un livre de Wikilivres.
Make documents

Manuel mkd de référence en français[modifier | modifier le wikicode]

Installation du manuel[modifier | modifier le wikicode]

Manuel[modifier | modifier le wikicode]

MKD(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 | modifier le wikicode]

  • (man1) :
- Téléchargez la mise à jour des manuels[1]
- Download the latest multi-lang Installer:[2]
  • Attention : Vérifiez les dates de publication de ces pages de manuels en bas de page.
  1. Manuels anglais allemand français
  2. Translations anglais allemand français