Shell command projects/mkd
De Wiki EELL.
Version du 2 décembre 2012 à 17:47 par JPL (discuter | contributions)
↑ Retour au portail mkd
Cette page n'est pas encore opérationnelle. L'empaquetage n'est pas prévue avant juillet 2012.
La version console (terminal) non empaquetée est disponible: Projet_mkd/téléchargements/UNIX_LINUX
Sommaire |
Documentation visuelle
Téléchargement de paquets
Download local packages
Index of mkd local package distribution
Distribution Ubuntu
dist bin deb https://launchpad.net/~jean-paul-louyot/+archive/mkd/+packages ubuntu 12.04 (precise)
Mettre votre liste des paquets à jour (systèmes d'expoitation plus anciens) :
deb http://ppa.launchpad.net/jean-paul-louyot/mkd/ubuntu precise main
deb-src http://ppa.launchpad.net/jean-paul-louyot/mkd/ubuntu precise main
Pour les nouveaux systèmes ubuntu 12.04 (precise) l'utilitaire deb n'existe plus.
Pour mettre votre liste à jour, utilisez : sudo add-apt-repository ppa:jean-paul-louyot/mkd
Pour récupérer les fichiers source : apt-get source mkd
Traductions
Les messages du code source étaient écrits en français ISO et a été réécrit en anglais pour faciliter les traductions en UTF-8.
Depuis la version 120508 les messages sont traduits en français UTF-8
Docs
- Attention : Ces manuels sont au format UTF-8 pour lecture. Téléchargez les applications qui contiennent les manuels 'man1' (Manual pages)
Manual en
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 com‐
ments for Programmers, Warnings and Tests points .... Coded
informations are respectively 'O', 'S', 'P', 'www', and '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)
-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 struc‐
ture 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 itemized in project file. Options: 'f' find languages, 'j'
Source file is a 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 itemized in project file, and with compilable
options CD4=CD5=´\"´).
mkd (without argument)
Cause any error and syntax are transmited to terminal.
AUTHORS
JP LOUYOT, Clara JIMENEZ.
Translations : Alizée (Catalan, Spanish), Luca (Italian).
http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX
NOTES
No match to read and decode the files included in the sources files in
this Release 12.05.0
BUGS
Bugs Report: http://edeulo.free.fr/phpBB3/index.php
Documents generator mkd 2 December 2012 MKD(1)
Manuel fr
MKD(1)
NOM
mkd - make documentation. Extrait des informations codées dans les
programmes sources, et produit une documentation spécifique.
SYNOPSIS
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 ŽNew LineŽ. 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.
-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
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'
(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.
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
JP LOUYOT, Clara JIMENEZ
Traductions : Alizée (Catalan, Espagnol), Luca (Italien).
http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX
NOTES
Cette version 12.03.0 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 2 Décembre 2012 MKD(1)
mkd-Handbuch de
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
1986 - mkd für DOS, und mkdoc für UNIX, sind in ASCII geschieben für
Labor 'CEM' an der Universität Montpellier (Franreich).
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-Format abgestimmt.
2012 - mkd 12.03 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)
