Shell command projects/mkd
De Wiki EELL.
JPL (discuter | contributions) m (→Handbuch in German : Mise à jour de la date) |
JPL (discuter | contributions) m (→Manual in english : Manual updated 11 may 2013) |
||
| Ligne 55 : | Ligne 55 : | ||
This is red | This is red | ||
</PRE--> | </PRE--> | ||
| - | {{Boîte déroulante/début|titre=Manual en ( | + | {{Boîte déroulante/début|titre=Manual en (May 11, 2013)}} |
<pre style="color:white; | <pre style="color:white; | ||
background-color:black;"> | background-color:black;"> | ||
| - | + | MKD(1) MKD(1) | |
| - | MKD(1) | + | |
NAME | NAME | ||
| - | mkd - make documentation. Extract coded informations from programs | + | mkd - make documentation. Extract coded informations from programs |
sources and product specific documentation. | sources and product specific documentation. | ||
| Ligne 71 : | Ligne 70 : | ||
DESCRIPTION | DESCRIPTION | ||
| - | mkd | + | 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 com‐ | |
| - | + | ments for Programmers, Warnings and Tests points .... Coded | |
| - | + | informations are respectively 'O', 'S', 'P', 'www', ant 'T' just | |
| - | + | after the comment character. | |
| - | + | ||
char_codes | char_codes | ||
| - | All ASCII. The comment are extracted if the comment begin with | + | All ASCII. The comment are extracted if the comment begin with |
this character. With two star mkd extract all comments. | this character. With two star mkd extract all comments. | ||
| Ligne 87 : | Ligne 85 : | ||
path_target | path_target | ||
| - | Path target file. Default, path target is idendical to source | + | Path target file. Default, path target is idendical to source |
file with extension ´.doc´ . | file with extension ´.doc´ . | ||
| Ligne 110 : | Ligne 108 : | ||
-a append to current target file. | -a append to current target file. | ||
| - | -f find source file language. (useful with project file) | + | -f find source file language. (useful with project file). mkd rec‐ |
| + | ognizes the following files: .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 used if source file is a project file. | -j used if source file is a project file. | ||
| - | -l lines (extract lines delimited by CD1 or CD2 in first colomn or | + | -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 | + | CD3 in line, and next New-Line. CD1, CD2, CD3 are compilable |
| - | options in version.h from mkd distribution). You can see these | + | options in version.h from mkd distribution). You can see these |
options compiled by the command mkd \? | options compiled by the command mkd \? | ||
-n numbering the lines (line number from source files) | -n numbering the lines (line number from source files) | ||
| - | -p page (extract text delimited by CD4 and CD5 -begin with CD4 and | + | -p page (extract text delimited by CD4 and CD5 -begin with CD4 and |
| - | end | + | end with CD5-. CD4, CD5 are compilable options in version.h from |
| - | + | mkd distribution). You can see these options compiled by the | |
| - | + | command mkd \? | |
-s add to screen. (verbose) | -s add to screen. (verbose) | ||
| Ligne 142 : | Ligne 144 : | ||
mkd -Csl '*Sied' mkd3.c '*.verif_struct' | mkd -Csl '*Sied' mkd3.c '*.verif_struct' | ||
| - | Product documentation with structure of program, includes, | + | Product documentation with structure of program, includes, |
| - | defines, ifdef else and endif compile options, to verify struc‐ | + | defines, ifdef else and endif compile options, to verify struc‐ |
| - | ture | + | ture of program. (with compilable options CD1='#' or CD2='#' in |
| - | + | version.h from mkd distribution). | |
mkd -jfsl '*OHie' mkd_docu.prj mkd.org | mkd -jfsl '*OHie' mkd_docu.prj mkd.org | ||
| - | Product organigram. Comment begin with *,O,H, and sources files | + | Product organigram. Comment begin with *,O,H, and sources files |
| - | are | + | are listed in project file. (with compilable options CD1='#' or |
| - | + | CD2='#'). f: find language, j: source file is a project file | |
containing the list of sources files. | containing the list of sources files. | ||
mkd -l '*ide' mkd3.c '*.id_ei' | mkd -l '*ide' mkd3.c '*.id_ei' | ||
| - | (with compilable options CD1='#' or CD2='#', extract lines: | + | (with compilable options CD1='#' or CD2='#', extract lines: |
#include, #define, #ifdef, #else, #endif, etc.) | #include, #define, #ifdef, #else, #endif, etc.) | ||
mkd -pj '**' mkd_docu.prj mkd.strings | mkd -pj '**' mkd_docu.prj mkd.strings | ||
| - | Extract strings from program. (messages are printed to stdout). | + | Extract strings from program. (messages are printed to stdout). |
| - | (sources files are itemize in project file, and with compilable | + | (sources files are itemize in project file, and with compilable |
options CD4=CD5=´\"´). | options CD4=CD5=´\"´). | ||
mkd (without argument) | mkd (without argument) | ||
| - | Cause any error and syntax are transmit to terminal with carac‐ | + | Cause any error and syntax are transmit to terminal with carac‐ |
ters compiled to use options l and p. | ters compiled to use options l and p. | ||
| Ligne 170 : | Ligne 172 : | ||
HISTORY | HISTORY | ||
| - | 1986 | + | 1986 - mkd for DOS, and mkdoc for UNIX, are writen in ASCII format by |
| - | + | Jean-Paul Louyot for the Montpellier Universidad 'CEM' laboratory | |
(France). | (France). | ||
1991 - mkdoc 3.12 for PC and UNIX (Sun) | 1991 - mkdoc 3.12 for PC and UNIX (Sun) | ||
| - | 1995 - 2004 - mkdoc 3.22 to mkdoc 4 for Unix and Linux: SUN-SPARC, HP- | + | 1995 - 2004 - mkdoc 3.22 to mkdoc 4 for Unix and Linux: SUN-SPARC, HP- |
UX, RedHat | UX, RedHat | ||
2004 - mkdoc 4 for Linux Ubuntu, Windows 98, Windows 2000 | 2004 - mkdoc 4 for Linux Ubuntu, Windows 98, Windows 2000 | ||
| - | 2007-2012 | + | 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 | + | 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 | DOWNLOADS | ||
| - | http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX- | + | http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX |
| - | + | ||
AUTHORS | AUTHORS | ||
| Ligne 211 : | Ligne 211 : | ||
NOTES | NOTES | ||
| - | It belong to the programmers to close comments, blocks and lines, by | + | It belong to the programmers to close comments, blocks and lines, by |
the appropriate closing codes in the source files. | the appropriate closing codes in the source files. | ||
| - | Warning: The closure of a comment line is a carriage-return (NL, LF, | + | Warning: The closure of a comment line is a carriage-return (NL, LF, |
CR/LF) as the case. | CR/LF) as the case. | ||
| - | At the end of the file: this note implies a carriage-return at the end | + | At the end of the file: this note implies a carriage-return at the end |
| - | of | + | of the comment line. In this case you must have a blank line at the end |
| - | + | of the source file. | |
| - | Do es not allow to read and decode the files included by #include in | + | Do es not allow to read and decode the files included by #include in |
the sources files. | the sources files. | ||
| Ligne 232 : | Ligne 232 : | ||
| - | + | May 11, 2013 MKD(1) | |
</pre> | </pre> | ||
{{Boîte déroulante/fin}} | {{Boîte déroulante/fin}} | ||
