Shell command projects/mkd
De Wiki EELL.
JPL (discuter | contributions) m (→Manuel en français : OK) |
JPL (discuter | contributions) m (→Manual in english : OK) |
||
| Ligne 47 : | Ligne 47 : | ||
*'''Attention :''' Vérifiez les dates de publication de ces pages de manuels ci-dessous en bas de page. | *'''Attention :''' Vérifiez les dates de publication de ces pages de manuels ci-dessous en bas de page. | ||
=== Manual in english === | === Manual in english === | ||
| - | {{Boîte déroulante/début|titre=Manual en ( | + | {{Boîte déroulante/début|titre=Manual en (April 6, 2013)}} |
<pre> | <pre> | ||
| - | MKD(1) | + | |
| + | MKD(1) MKD(1) | ||
NAME | NAME | ||
| - | mkd - make | + | mkd - make documentation. Extract coded informations from programs |
sources and product specific documentation. | sources and product specific documentation. | ||
| Ligne 62 : | Ligne 63 : | ||
DESCRIPTION | DESCRIPTION | ||
mkd | mkd | ||
| - | Selected comments (or all comments) are extracted from | + | Selected comments (or all comments) are extracted from pro‐ |
| - | sources and product specific documentation to target file. Usual | + | grams sources and product specific documentation to target |
| - | + | file. Usual target files are Organigrams, or Structure of pro‐ | |
| - | + | grams, 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 | char_codes | ||
| - | All ASCII. | + | 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 77 : | Ligne 78 : | ||
path_target | path_target | ||
| - | Path target file. Default, path target is | + | Path target file. Default, path target is idendical to source |
file with extension ´.doc´ . | file with extension ´.doc´ . | ||
| Ligne 104 : | Ligne 105 : | ||
-j used if source file is a project file. | -j used if source file is a project file. | ||
| - | -l lines | + | -l lines (extract lines delimited by CD1 or CD2 in first colomn or |
| - | CD3 in line, and next New-Line. CD1, | + | CD3 in line, and next New-Line. CD1, CD2, CD3 are compilable |
| - | options in version.h from mkd distribution) | + | options in version.h from mkd distribution). You can see these |
| + | 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 | + | -p page (extract text delimited by CD4 and CD5 -begin with CD4 and |
| - | end with CD5-. CD4, CD5 are compilable options in version.h | + | end with CD5-. CD4, CD5 are compilable options in version.h |
| - | mkd distribution) | + | from mkd distribution). You can see these options compiled by |
| + | the command mkd \? | ||
-s add to screen. (verbose) | -s add to screen. (verbose) | ||
| Ligne 121 : | Ligne 124 : | ||
EXAMPLES | EXAMPLES | ||
| - | with | + | with shell command: |
mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz | mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz | ||
| Ligne 130 : | Ligne 133 : | ||
mkd -Csl '*Sied' mkd3.c '*.verif_struct' | mkd -Csl '*Sied' mkd3.c '*.verif_struct' | ||
| - | Product documentation with structure of program, | + | Product documentation with structure of program, includes, |
| - | defines, ifdef else and endif compile options, to verify | + | defines, ifdef else and endif compile options, to verify struc‐ |
| - | ture of program. (with compilable options CD1='#' or CD2='#' | + | ture of program. (with compilable options CD1='#' or CD2='#' |
| - | version.h from mkd distribution). | + | 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 | + | Product organigram. Comment begin with *,O,H, and sources files |
| - | are | + | are listed in project file. (with compilable options CD1='#' |
| - | or CD2='#'). | + | or CD2='#'). f: find language, j: source file is a project file |
| + | 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='#' | + | (with compilable options CD1='#' or CD2='#', extract lines: |
| + | #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 | + | Extract strings from program. (messages are printed to stdout). |
| - | (sources | + | (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 | + | 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 156 : | Ligne 161 : | ||
HISTORY | HISTORY | ||
| - | 1986 - mkd for DOS, and mkdoc for UNIX, are writen in ASCII format | + | 1986 - mkd for DOS, and mkdoc for UNIX, are writen in ASCII format |
| - | Jean-Paul Louyot | + | 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 - mkdoc 3.22 for Linux | + | 1995 - 2004 - mkdoc 3.22 to mkdoc 4 for Unix and Linux: SUN-SPARC, HP- |
| + | UX, RedHat | ||
| - | 2004 - mkdoc 4 for | + | 2004 - mkdoc 4 for Linux Ubuntu, Windows 98, Windows 2000 |
| - | 2007-2012 - mkdoc release 7.01 to mkd R12.01 are in format | + | 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 |
| - | internationalization. In the wake mkdcppw is writen to decode | + | and internationalization. In the wake mkdcppw is writen to decode |
| - | C, c++ and php languages in graphical mode with 'gcc' and 'gtkmm'. | + | 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-LINUX | + | http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX- |
| + | LINUX | ||
AUTHORS | AUTHORS | ||
| - | man updated by Clara JIMENEZ. | + | man updated by Clara JIMENEZ, Cardabela, and JPL. |
TRANSLATORS | TRANSLATORS | ||
| Ligne 194 : | Ligne 202 : | ||
NOTES | NOTES | ||
| - | + | It belong to the programmers to close comments, blocks and lines, by | |
| - | + | the appropriate closing codes in the source files. | |
| + | |||
| + | Warning: The closure of a comment line is a carriage-return (NL, LF, | ||
| + | CR/LF) as the case. | ||
| + | |||
| + | At the end of the file: this note implies a carriage-return at the end | ||
| + | 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 | ||
| + | the sources files. | ||
BUGS | BUGS | ||
| Ligne 206 : | Ligne 223 : | ||
| - | + | April 6, 2013 MKD(1) | |
</pre> | </pre> | ||
{{Boîte déroulante/fin}} | {{Boîte déroulante/fin}} | ||
