MKD(1)
BEZEICHNUNG
mkd - make documentation. Extrakte codierten Informationen aus Quellen
Programm und Produkt spezifische Dokumentation.
ÜBERSICHT
mkd [-ABCFPSafjlnpstw] 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ählte Kommentaren, (oder alle Kommentaren) werden von Prog-
gramme Quelle extrahiert und Produkt spezifische Dokumentation.
Üblichen Zieldateien sind Organigramme, Struktur der Programme,
Kommentare für Programmierer, Warnungen oder Testpunkte Komment-
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
Großbuchstaben Optionen:
Wählen Sie eine bestimmte Programmierung Sprache:
-A Assembler Stil Kommentare zu extrahieren ( ; Zum Ende der Zeile )
-B Basic Stil (REM or ' -> Ende der Zeile)
-C C Stil ( / * -> * / )
-F Fortran Stil (c,C or * -> Ende der Zeile)
-P Pascal Stil ( { -> } )
-S Shell oder Ratfor Stil ( # -> Ende der Zeile)
Kleinbuchstaben Optionen:
-a Hinzufügen am ende von Zieldatei.
-f Finden Quelldatei Programmierung Sprache. (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 nächste ende der Zeile. CD1, CD2, CD3, sind
kompilierbare im Vertrieb und sind definiert in 'version.h')
-n Zeilennummerierung
-p 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 Fügt auf dem Konsole Bildschirm ('Verbose' ; Ausführliche)
-t Text (Kopiert nur der Kommentar).
-w Überschrieben die aktuelle Zieldatei.
BEISPIELE
Mit Cshell-Befehl:
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 englisch 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 Quelldatei in Programms (Mit den
Kompilierung--optionen 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' finden der Stil der Sprache, 'j' sagte dass die
Quelldatei ist eine Projektdatei. (Mit den Kompilierung Optionen
CD1='#' oder CD2='#' in 'mkd distribution' version.h)
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
aus den Quelldateien. (Die Saiten werden auf die Standard-
Ausgabe angezeigt.)
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
JP Louyot für CEM loratory in Montpellier Universität (Frankreich).
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 umgeschrieben in UTF-8 Format und mkdcppw für C,
c++, und php, ist geschrieben für Fenstern.
AUTOREN
Aktualisiert von : 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 Dekodiert nicht, mit '#include' Richtlinie
in der Quelldatei.
Dokuments--generator mkd 5 Dezember 2012 MKD(1)