Shell command projects/mkd

MKD(1)                                                                  MKD(1)



NAME
       mkd  -  make  documentation.   Extract coded informations from programs
       sources and product specific documentation.

SYNOPSIS
       mkd [-ABCFPSafjlpstw] char_codes path_source [path_target]

DESCRIPTION
       mkd
               Selected comments (or all comments) are extracted from programs
              sources and product specific documentation to target file. Usual
              target files are  Organigrams,  or  Structure  of  programs,  or
              comments  for  Programmers, Warnings and Tests points .... Coded
              informations are respectively 'O', 'S', 'P', 'www', ant 'T' just
              after the comment character.

       char_codes
              All  ASCII.  The comment are extracted if the comment begin with
              this character. With two star mkd extract all comments.

       path_source
              Path source file (or project file: option j ).

       path_target
              Path target file. Default, path target is  idendical  to  source
              file with extension ´.doc´ .

OPTIONS
       Uppercase options:
              restrict comments to one specific language:

       -A     extract Assembler style comments ( ; to end of line )

       -B     Basic style                 (REM or ' -> end of line)

       -C     C style                     (  / *    ->      * /   )

       -F     Fortran style               (c,C or * -> end of line)

       -P     Pascal style                (   {     ->       }    )

       -S     Shell or ratfor style       (   #     -> end of line)

       Lowercase options:

       -a     append to current target file.

       -f     find source file language. (useful with project file)

       -j     used if source file is a project file.

       -l     lines  (extract lines delimited by CD1 or CD2 in first colomn or
              CD3 in line, and next New-Line. CD1,  CD2,  CD3  are  compilable
              options in version.h from mkd distribution)

       -n     numbering the lines (line number from source files)

       -p     page  (extract text delimited by CD4 and CD5 -begin with CD4 and
              end with CD5-. CD4, CD5 are compilable options in version.h from
              mkd distribution)

       -s     add to screen. (verbose)

       -t     text (copy only the comment).

       -w     overwrite the current target file.

EXAMPLES
       with Cshell command:

       mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz
              Product UNIX manual for french users.

       mkd -Ct M manual mkd.1 | gzip -f mkd.1.gz
              Product UNIX manual.

       mkd -Csl '*Sied' mkd3.c  '*.verif_struct'
              Product  documentation  with  structure  of  program,  includes,
              defines,  ifdef  else  and  endif  compile  options,  to  verify
              structure  of  program.   (with  compilable  options  CD1='#' or
              CD2='#' in version.h from mkd distribution).

       mkd -jfsl '*OHie' mkd_docu.prj mkd.org
              Product organigram. Comment begin with *,O,H, and sources  files
              are  itemize  in project file.  (with compilable options CD1='#'
              or CD2='#').

       mkd -l '*ide' mkd3.c '*.id_ei'
              (with compilable options CD1='#' or CD2='#').

       mkd -pj '**' mkd_docu.prj mkd.strings
              Extract strings from program. (messages are printed to  stdout).
              (sources  files are itemize in project file, and with compilable
              options CD4=CD5=´\"´).

       mkd (without argument)
              Cause any  error  and  syntax  are  transmit  to  terminal  with
              caracters compiled to use options l and p.

SEE ALSO
       mkdcppw(1)

HISTORY
       1986 - mkd for DOS, and mkdoc for UNIX, are writen  in  ASCII format by
       Jean-Paul Louyot  for  the  Montpellier  Universidad  'CEM'  laboratory
       (France).

       1991 - mkdoc 3.12 for PC and UNIX (Sun)

       1995 - mkdoc 3.22 for Linux Red-Hat

       2004 - mkdoc 4 for SUN-SPARC, HP-UX, RedHat, Windows 98, Windows 2000

       2007-2012 - mkdoc release 7.01 to mkd R12.01 are in format  ISO-8859-1.
       The name 'mkdoc' is  abandoned with the  release  10.01  compiled  with
       Visual C++ 2010

       2012 - mkd 12.03 is  adapted  to  UTF-8  format  for  translations  and
       internationalization. In the wake mkdcppw is writen to decode  computer
       C, c++ and php languages in graphical mode with 'gcc' and 'gtkmm'.

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

AUTHORS
       man updated by Clara JIMENEZ.

TRANSLATORS
       Catalan : Alizée

       English : JPL, Cardabela

       German : Clara, JPL, Martine

       Italian : Luca

       Spanish : Alizée, JPT, Sharo

       Email : http://edeulo.free.fr/contacts/formmail.php

NOTES
       No  match,  for read and decode included files by directive #include in
       sources files.


BUGS
       Bugs Report: http://edeulo.free.fr/phpBB3/index.php

       Documents generator mkd





                                6 December 2012                         MKD(1)

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)

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

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

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


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 - mkdoc 3.22 pour Linux Red-Hat

       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.
       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 langages C, c++ et  php  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
       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





                                6 Décembre 2012                         MKD(1)

MKD(1)                                                               MKD(1)



BEZEICHNUNG
       mkd  -  make  documentation.  Extrakte  codierten  Informationen aus
       Quellen Programm und Produkt spezifische Dokumentation.

ÜBERSICHT
       mkd [-ABCFPSafjlnpstw] Codes Quellpfad [Zieldatei]

BESCHREIBUNG
       mkd

       Selected comments (or alle comments)  are  extracted  from  programs
       sources  and  product  specific  documentation to target file. Usual
       target files are Organigrams, or Structure of programs, or  comments
       for  Programmers,  Warnings and Tests points .... Coded informations
       are respectively 'O', 'S',  'P',  'www',  ant  'T'  just  after  the
       comment character.

       Ausgewählte   Kommentaren,    (oder  alle  Kommentaren)  werden  von
       Proggramme    Quelle    extrahiert    und    Produkt     spezifische
       Dokumentation.  Üblichen Zieldateien sind Organigramme, Struktur der
       Programme, Kommentare für Programmierer, Warnungen  oder  Testpunkte
       Kommenttare  ...  Codierte Informationen sind jeweils 'O', 'S', 'P',
       'www' und 'T', direkt hinter dem Kommentar.

       Codes  Alle   ASCII.  Der  Kommentar  werden  extrahiert,  wenn  der
              Kommentar beginnt mit diesem Zeichen.

       Quellpfad
              Pfad der Quelldatei. (Oder mit Projektdatei : Option j).

       Zieldatei
              Pfad  der  Zieldatei. In der  Standardeinstellung  Pfad  Ziel
              ist identisch mit der Quelldatei mit der Erweiterung '.doc'.

OPTIONEN
       Großbuchstaben Optionen:
              Wählen Sie eine bestimmte Programmierung Sprache:

       -A     Assembler Stil Kommentare zu extrahieren (  ;  Zum  Ende  der
              Zeile)

       -B     Basic  Stil                  (REM  oder  ' -> Ende der Zeile)
              
       -C     C Stil                       (    /*       ->       */      )

       -F     Fortran  Stil                (c,C  oder  * -> Ende der Zeile)

       -P     Pascal  Stil                 (    {        ->        }      )

       -S     Shell  oder  Ratfor  Stil    (    #        -> Ende der Zeile)             

       Kleinbuchstaben Optionen:

       -a     (append) Hinzufügen am ende von Zieldatei.

       -f     (find) Finden Quelldatei Programmierung Sprache. (Mit Projekt
              Datei)

       -j     (project)   Verwendet,   wenn   die   Quelldatei   ist   eine
              Projektdatei.

       -l     (lines) Linien (Extrakt  Linien beginnend mit  CD1  oder  CD2
              in  erste  Spalte,  oder  CD3  in  Linie bis nächste Ende der
              Zeile. CD1, CD2, CD3, sind kompilierbare im Vertrieb und sind
              definiert in 'version.h')

       -n     (num)   Zeilennummerierung   (Die   Nummer   der   Zeile  der
              Quelldatei).

       -p     (page) Seite  (Extrakt Text beschränkt  mit  CD4  und  CD5  -
              Beginnend  mit  CD4  und  beendet  mit  CD5  - CD4, CD5, sind
              kompilierbare  im  Vertrieb  und  sind  definiert   in   'mkd
              distribution', in 'version.h')

       -s     (screen verbose) Fügt auf dem Konsole Bildschirm ('Verbose' ;
              Ausführliche)

       -t     (text only) Text (Kopiert nur der Kommentar).

       -w     (overwrite) Überschrieben die aktuelle Zieldatei.

EXEMPLES
       Mit Cshell-Befehl:

       mkd -Cst F manual mkd.1 | gzip -f mkd.1.gz
              Produkt französisch UNIX Manual; Version 12.03. C: Sprache C,
              s:Auch   anzeigen   die   Konsole,   t:nur  text,  F:Code  zu
              entschlüsseln.

       mkd -Ct M manual mkd.1 | gzip -f mkd.1.gz
              Produkt englisch UNIX Manual;  Version  12.03.   (Produit  un
              manuel  UNIX  standard  en  anglais au format UTF-8 depuis la
              version 12.03)

       mkd -Csl '*Sied' mkd3.c  '*.verif_struct'
              (Mit den Kompilierung--optionen CD1='#' oder CD2='#' in  'mkd
              distribution' version.h).Produkt  Dokumentation  mit Struktur
              der Programme, '#includes', '#defines', '#ifdef', '#else' und
              '#endif' Kompilierte Optionen, für überprüfen die Struktur in
              Quelldatei in Programms

       mkd -jfsl '*OHie' mkd_docu.prj mkd.org
              (Mit den Kompilierung Optionen CD1='#' oder CD2='#'  in  'mkd
              distribution'  version.h)  Produkt Organigramm. Der Kommentar
              beginnt mit * oder O oder H, und Pfad zu den Quelldatei  sind
              die  Komponenten  der Projektdatei. Optionen : 'f' finden der
              Stil der Sprache, 'j'  sagte dass  die  Quelldatei  ist  eine
              Projektdatei.

       mkd -l '*ide' mkd3.c '*.id_ei'
              ( Mit Kompilierung--optionen  CD1='#' oder CD2='#' extrahiert
              #include,      #define,      #ifdef,      #else,       #endif
              Kompilierung--optionen der C- Sprache.

       mkd -pj '**' mkd_docu.prj mkd.strings
              (Mit  Kompilierung--optionen  CD4=CD5='\"', extrahiert Saiten
              aus den Quelldateien. (Die Saiten werden  auf  die  Standard-
              Ausgabe angezeigt.)

       mkd \? Zeigt  die  Syntax  und den Charakter CD1 bis CD5 Kompiliert.
              (Mit den Optionen l und p verwendet)

       mkd (mit ohne Argumente)
              Generiert  einen  Syntaxfehler  und  zeigt  die  Syntax   zum
              Konsole.

SIEHE AUCH
       mkdcppw(1)

GESCHICHTE
       1986  - mkd für DOS, und mkdoc für UNIX, werden in ASCII geschrieben
       von Jean-Paul Louyot für CEM  loratory  in  Montpellier  Universität
       (Frankreich).

       1991 - 1991 - mkdoc 3.12 für PC und UNIX (Sun)

       1995 - mkdoc 3.22 für Linux Red-Hat

       2004  -  mkdoc  4  für SUN-SPARC, HP-UX, RedHat, Windows 98, Windows
       2000

       2007 - 2012 -mkdoc  R7.01  bis  R12.01  sind  auf  ISO-8859-1-Format
       abgestimmt.

       2012 - mkd 12.03 ist umgeschrieben in UTF-8 Format, und mkdcppw (für
       C, c++, php) ist geschrieben für Fenstern mit gcc und gtkmm.

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

AUTOREN
       Manuel mis à jour par : Clara JIMENEZ

ÜBERSETZER
       Deutsch : Clara, JPL, Martine

       Englisch : JPL, Cardabela

       Italienisch : Luca

       Katalanisch : Alizée

       Spanisch : Alizée, JPT, Sharo

       E-Mail : http://edeulo.free.fr/contacts/formmail.php

HINWEISE
       Diese   Version   lesen,   und  Dekodiert  nicht,   mit   '#include'
       Richtlinie in der Quelldatei.

BUGS
       Bugs Report: http://edeulo.free.fr/phpBB3/index.php

       Générateur de documents mkd





                              6 Décembre 2012                        MKD(1)

== Sources ==
[http://edeulo.free.fr/pub/downloads/mkd-0~120508.tar.gz mkd-0~120508.tar.gz] (langs: en, fr) Available on DEBIAN, UBUNTU, FEDORA

[[Catégorie:Générateurs de documentation]]
[[Catégorie:Générateurs de documentation pour consoles]]
[[Catégorie:Programmation-Distribution]]