Shell command projects/mkd
De Wiki EELL.
JPL (discuter | contributions) m (→Docs : Corrections de traductions) |
JPL (discuter | contributions) m (→Docs : mise à jour des manuels et ajout du manuel en allemand) |
||
| Ligne 53 : | Ligne 53 : | ||
target files are Organigrams, or Structure of programs, or com‐ | target files are Organigrams, or Structure of programs, or com‐ | ||
ments for Programmers, Warnings and Tests points .... Coded | ments for Programmers, Warnings and Tests points .... Coded | ||
| - | informations are respectively 'O', 'S', 'P', 'www', | + | informations are respectively 'O', 'S', 'P', 'www', and 'T' just |
after the comment character. | after the comment character. | ||
| Ligne 122 : | Ligne 122 : | ||
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 itemized | + | are itemized in project file. Options: 'f' find languages, 'j' |
| + | Source file is a project file. (with compilable options CD1='#' | ||
or CD2='#'). | or CD2='#'). | ||
| Ligne 149 : | Ligne 150 : | ||
Bugs Report: http://edeulo.free.fr/phpBB3/index.php | Bugs Report: http://edeulo.free.fr/phpBB3/index.php | ||
| - | |||
| + | Documents generator mkd 2 December 2012 MKD(1) | ||
| - | |||
| - | |||
| - | |||
| - | |||
</pre> | </pre> | ||
{{Boîte déroulante/fin}} | {{Boîte déroulante/fin}} | ||
| Ligne 197 : | Ligne 194 : | ||
Chemin du fichier documentaire. Par défaut chemin_cible est une | Chemin du fichier documentaire. Par défaut chemin_cible est une | ||
copie de chemin_source auquel on remplace le suffixe par le | copie de chemin_source auquel on remplace le suffixe par le | ||
| - | suffixe | + | suffixe Ž.docŽ. |
OPTIONS | OPTIONS | ||
| Ligne 218 : | Ligne 215 : | ||
-a (append) Ajoute a la suite du fichier documentaire | -a (append) Ajoute a la suite du fichier documentaire | ||
| - | + | Žchemin_cibleŽ. | |
-f (find) Trouve le langage du fichier source par analyse du | -f (find) Trouve le langage du fichier source par analyse du | ||
| - | suffixe. ( | + | suffixe. (sŽutilise généralement avec un fichier projet) |
| - | -j (project) | + | -j (project) SŽutilise avec un fichier projet composé de sources en |
langages différents. | langages différents. | ||
-l (lignes) Extrait les lignes commençant par les caractères CD1 ou | -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 | CD2 ou CD3 et suivis par un des caractères codes, le commentaire | ||
| - | se termine par la lecture du caractère | + | 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 | 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 | placé en milieu de ligne. CD1, CD2, CD3, sont des options de | ||
| Ligne 234 : | Ligne 231 : | ||
de mkd. | de mkd. | ||
| - | -p (page) Extrait le texte débutant par le caractère CD4 suivi | + | -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 | des caractères codes, l'extraction du commentaire se termine | ||
avec la lecture du caractère CD5. CD4 et CD5 sont des options de | avec la lecture du caractère CD5. CD4 et CD5 sont des options de | ||
| Ligne 253 : | Ligne 250 : | ||
(Produit un manuel UNIX en francais. au format UTF-8 depuis la | (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 | version 12.03) C: pour décoder le fichier en langage C, s:avec | ||
| - | visualisation à | + | visualisation à lŽ écran, t:ne copier que le commentaire, |
F:sélectionner les commentaires debutants par F. | F:sélectionner les commentaires debutants par F. | ||
| Ligne 272 : | Ligne 269 : | ||
(avec les options de compilation CD1 ou CD2 = '#', produit un | (avec les options de compilation CD1 ou CD2 = '#', produit un | ||
organigramme. Les commentaires commencent par *,O,H, et les | organigramme. Les commentaires commencent par *,O,H, et les | ||
| - | fichiers source sont | + | chemins d'accès aux fichiers source sont les constituants du |
| - | + | fichier projet. Les options : 'f' trouve le style du langage, | |
| - | + | 'j' dit que le fichier source est un fichier projet (liste des | |
| + | fichiers à documenter). | ||
mkd -l '*ide' mkd3.c '*.id_ei' | mkd -l '*ide' mkd3.c '*.id_ei' | ||
| Ligne 282 : | Ligne 280 : | ||
mkd -pj '**' mkd_docu.prj mkd.strings | mkd -pj '**' mkd_docu.prj mkd.strings | ||
| - | (avec les options de compilation CD4=CD5= | + | (avec les options de compilation CD4=CD5=Ž\"Ž, extrait les |
chaînes de caractères du programme. (les commentaires sont | chaînes de caractères du programme. (les commentaires sont | ||
transmis a la sortie standard). | transmis a la sortie standard). | ||
| Ligne 290 : | Ligne 288 : | ||
caractères compilés pour les options l et p. | caractères compilés pour les options l et p. | ||
| + | SIEHE AUCH | ||
| + | mkdcppw(1) | ||
| + | |||
| + | HISTOIRE | ||
| + | 1989 -mkdoc pour DOS, et mkd pour UNIX, sont écrits au format ASCII | ||
| + | par Jean-Paul Louyot pour le laboratoire 'CEM' de l'université de | ||
| + | Montpellier (France). | ||
| + | |||
| + | 2004 -mkdoc est adapté au format ISO. | ||
| + | |||
| + | 2012 -mkd est transposé 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). Le nom 'mkdoc' est abandonné | ||
| + | pour MS-Windows. mkd pour MS-Windows a été mis à jour en 2010 pour | ||
| + | Visual C++ 2010 | ||
AUTEURS | AUTEURS | ||
| Ligne 304 : | Ligne 317 : | ||
Bugs Report: http://edeulo.free.fr/phpBB3/index.php | Bugs Report: http://edeulo.free.fr/phpBB3/index.php | ||
| - | + | ||
| + | Générateur de documents mkd 2 Décembre 2012 MKD(1) | ||
| + | |||
| + | </pre> | ||
| + | {{Boîte déroulante/fin}} | ||
| + | |||
| + | {{Boîte déroulante/début|titre=mkd-Handbuch de}} | ||
| + | <pre> | ||
| + | MKD(1) | ||
| + | |||
| + | |||
| + | |||
| + | BEZEICHNUNG | ||
| + | mkd - make documentation. Extrakte codierten Informationen aus Quellen | ||
| + | Programm und produkt spezifiche dokumentation. | ||
| + | |||
| + | ÜBERSICHT | ||
| + | mkd [-ABCFPSafjlpstw] char_codes path_source [path_target] | ||
| + | |||
| + | 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 com‐ | ||
| + | ments for Programmers, Warnings and Tests points .... Coded | ||
| + | informations are respectively 'O', 'S', 'P', 'www', ant 'T' just | ||
| + | after the comment character. | ||
| + | |||
| + | Ausgewähte Kommentaren, (oder alle Kommentaren) werden von Pro- | ||
| + | gramme Quelle extrahiert und produkt spezifiche dokumentation. | ||
| + | Oblichen Zieldateien sind Organigramme, Struktur der Programme, | ||
| + | Kommentare für Programmierer, Warnungen oder Testpunkte Kommen- | ||
| + | tare ... Codierte Informationen sind jeweils 'O', 'S', 'P', | ||
| + | 'www' und 'T', direkt hinter dem Kommentar. | ||
| + | |||
| + | char_codes | ||
| + | Alle ASCII. Der Kommentar werden extrahiert, wenn der Kommentar | ||
| + | beginnt mit diesem Zeichen. | ||
| + | |||
| + | path_source | ||
| + | Pfad der Quelldatei. (Oder Projektdatei : Option j). | ||
| + | |||
| + | path_target | ||
| + | Pfad der Zieldatei. In der Standardeinstellung Pfad Ziel ist | ||
| + | identisch mit der Quelldatei mit der Erweiterung '.doc'. | ||
| + | |||
| + | OPTIONEN | ||
| + | Grossbuchstaben Optionen: | ||
| + | restrict comments to one specific language: | ||
| + | Wählen Sie eine bestimmte Programmierung Langage: | ||
| + | |||
| + | -A Assembler Stil Kommentare zu extraktieren ( ; to end of line ) | ||
| + | |||
| + | -B Basic Stil (REM or ' -> end of line) | ||
| + | |||
| + | -C C Stil ( / * -> * / ) | ||
| + | |||
| + | -F Fortran Stil (c,C or * -> end of line) | ||
| + | |||
| + | -P Pascal Stil ( { -> } ) | ||
| + | |||
| + | -S Shell or ratfor Stil ( # -> end of line) | ||
| + | |||
| + | Kleinbuchstaben Optionen: | ||
| + | |||
| + | -a Hinzufügen am ende von Zieldatei. | ||
| + | |||
| + | -f Finden Quelldatei Programmierung Langage. (Mit Projekt Datei) | ||
| + | |||
| + | -j Verwendet, wenn die Quelldatei ist eine ProjektDatei. | ||
| + | |||
| + | -l Linien (Extrakt Linien beginnend mit CD1 oder CD2 in erste | ||
| + | Spalte, oder CD3 in linie bis next New-Line. CD1, CD2, CD3, sind | ||
| + | compilierbare im Vertrieb und sind definiert in 'version.h') | ||
| + | |||
| + | -p Seite (Extrackt Text beschränkt mit CD4 and CD5 - Beginnend mit | ||
| + | CD4 und ended mit CD5 - CD4, CD5, sind compilierbare im Vertrieb | ||
| + | und sind definiert in 'mkd distribution', in 'version.h') | ||
| + | |||
| + | -s Fügt auf dem Konsole Bildschim (Verbose) | ||
| + | |||
| + | -t Text (Kopiert nur der Kommentar). | ||
| + | |||
| + | -w Überschrieben die aktuelle Zieldatei. | ||
| + | |||
| + | BEISPIELE | ||
| + | Mit Cshell command: | ||
| + | |||
| + | mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz | ||
| + | Produkt französisch UNIX manual. | ||
| + | |||
| + | mkd -Ct M manual mkd.1 | gzip -f mkd.1.gz | ||
| + | Produkt english UNIX manual. | ||
| + | |||
| + | mkd -Csl '*Sied' mkd3.c '*.verif_struct' | ||
| + | Produkt Dokumentation mit Struktur der Programme, '#includes', | ||
| + | '#defines', '#ifdef', '#else' und '#endif' Kompilierte Optionen, | ||
| + | für überprüfen die Struktur in Quelledatei in Programms (Mit den | ||
| + | Kompilierungsoptionen CD1='#' oder CD2='#' in 'mkd distribution' | ||
| + | version.h). | ||
| + | |||
| + | mkd -jfsl '*OHie' mkd_docu.prj mkd.org | ||
| + | Produkt Organigramm. Der kommentar beginnt mit *,O,H, und Pfad | ||
| + | zu den Quelldatei sind die Komponenten der Projektdatei. | ||
| + | Optionen : 'f' finded der Stil der Spache, 'j' sagte dass die | ||
| + | Quelldatei ist eine Projekdatei. (Mit den Kompilierungsoptionen | ||
| + | CD1='#' oder CD2='#' in 'mkd distribution' version.h) | ||
| + | |||
| + | mkd -l '*ide' mkd3.c '*.id_ei' | ||
| + | ( Mit Kompilierungsoptionen CD1='#' oder CD2='#' extrahiert | ||
| + | #include, #define, #ifdef, #else, #endif Compileroptinen der | ||
| + | C- Strache. | ||
| + | |||
| + | mkd -pj '**' mkd_docu.prj mkd.strings | ||
| + | (Mit Kompilierungsoptionen CD4=CD5='\"', extrahiert Saiten aus | ||
| + | aus den Quelldateien. (Die Saiten werden auf die Standard- | ||
| + | ausgabe angezeit.) | ||
| + | |||
| + | mkd (mit ohne Argumente) | ||
| + | Generiert einen Syntaxfehler und zeigt die Syntax zum Konsole. | ||
| + | |||
| + | SIEHE AUCH | ||
| + | mkdcppw(1) | ||
| + | |||
| + | GESCHICHTE | ||
| + | 1989 -mkdoc für DOS, und mkd für UNIX, sind in ASCII geschieben für | ||
| + | Labor 'CEM' an der Universität Montpellier (Franreich). | ||
| + | |||
| + | 2004 -mkdoc ist auf das ISO-Format abgestimmt. | ||
| + | |||
| + | 2012 -mkd ist umgeschieben in UTF-8 Format und mkdcppw für C, c++, und | ||
| + | php, ist geschieben für fenstern. | ||
| + | |||
| + | AUTOREN | ||
| + | JP LOUYOT, Clara JIMENEZ | ||
| + | übersetzungen : Alizée (Katalanisch, Spanisch), Luca (Italienisch), | ||
| + | Deutsch (JPL geholfen von Martine) | ||
| + | http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX | ||
| + | |||
| + | HINWEISE | ||
| + | Diese Version lesen, und Decopdiert nicht, mit '#include' Richtlinie | ||
| + | in der Quelldatei. | ||
| + | |||
| + | |||
| + | Dokuments-generator mkd 2 Dezember 2012 MKD(1) | ||
| + | |||
</pre> | </pre> | ||
{{Boîte déroulante/fin}} | {{Boîte déroulante/fin}} | ||
