Shell command projects/mkd
De Wiki EELL.
JPL (discuter | contributions) m (!) |
JPL (discuter | contributions) m (→Mise à jour des traductions / Update translations : Mise à jour) |
||
| Ligne 1 : | Ligne 1 : | ||
{{Modèle:mkd}} | {{Modèle:mkd}} | ||
| - | [[Fichier:Ubuntu.png|thumb|50px|Ubuntu]] | + | <!-- |
| - | ↑ <small>[[Portail:mkd|Retour au portail mkd]]</small><br/> | + | rappel mkdcppw |
| - | + | 1 Captures d'écran / Screenshot | |
| - | La version | + | 2 Téléchargements de paquets / Downloads local packages |
| + | 3 Distributions Ubuntu | ||
| + | 4 Docs | ||
| + | 5 Sources | ||
| + | 6 Langs | ||
| + | 7 Aide / Help | ||
| + | 8 Bugs | ||
| + | --> | ||
| + | [[Fichier:Ubuntu.png|thumb|50px|Ubuntu]][[Fichier:200px-Openlogo-debianV2.png|thumb|50px|Debian]][[Fichier:Fedora logo.png|thumb|50px|Fedora]] | ||
| + | ↑ <small>[[Portail:mkd|Retour au portail mkd]]</small><br/> | ||
| + | |||
| + | See also [[Projet_mkd/t%C3%A9l%C3%A9chargements/UNIX_LINUX]] Beta and unstable versions. | ||
| + | |||
| + | <!--== Téléchargements de paquets / Downloads '''local''' packages == | ||
| + | |||
| + | |||
| + | {{Modèle:Méta-bandeau | ||
| + | |||
| + | |titre=''' ATTENTION''' | ||
| + | |||
| + | |background=#fafafa | ||
| + | |||
| + | |border-left=red | ||
| + | |||
| + | |''' Les modifications sur les serveur de ''free.fr'' interdisent la lecture des répertoires. (Liens se terminant par le caractère '/')''' | ||
| + | |||
| + | ''Ces liens sont en cours de révision ... Merci de votre compréhension'' | ||
| + | }} | ||
| + | |||
| + | ; Packages :Debian/Ubuntu : | ||
| + | ; Index of [http://edeulo.free.fr/pub/mkd/ '''mkd local deb packages''', ''dist, doc and translations''] for : | ||
| + | :* '''mkd''' : Downloads ''updates for 32 bits (x86), and 64 bits (amd64) processors'' (de) (en) (fr) last update '''2014-05-15''' | ||
| + | |||
| + | :* '''mkddocu''' : Download ''update for all (x86 and amd64 processors)'' (en) (fr) last update '''mkddocu_140515_all.deb''' | ||
| + | |||
| + | :* '''Translations''': Download mkd_0~130514.lang.tar.gz (de) (en) (fr) for all versions 2012 to 2014. Updated the '''2013-05-14''' | ||
| + | |||
| + | ;Sources : Original files '''for all linux systems''' Debian, Ubuntu, Fedora, etc. : | ||
| + | :* Index of [http://edeulo.free.fr/pub/downloads_sources/ '''mkd local source files'''] Last update '''2014-05-15''' | ||
| + | --> | ||
| + | |||
| + | == Distributions Ubuntu / Update packages on '''launchpad'''.net == | ||
| + | <!--'''MISE À JOUR EN COURS'''--> | ||
| + | |||
| + | ; {{violet|Dernières versions à jour mkd - 140315 Saucy, 140515 Trusty et 140515 Utopic.}}<br> | ||
| + | '''''mkd 140515''' is updated for Trusty (Ubuntu 14.04) and Utopic (Ubuntu 14.10) and '''is available for Ubuntu Vivid (15.04)'''''<br/> | ||
| + | Télécharger le fichier .deb correspondant à votre processeur puis cliquez deux fois sur le fichier téléchargé pour l'installer. | ||
| + | : [https://launchpad.net/~jean-paul-louyot/+archive/mkd '''Adding this PPA to your system'''] | ||
| + | |||
| + | : [https://launchpad.net/~jean-paul-louyot/+archive/mkd/+copy-packages '''Téléchargements ''(sources et binaires)'' de la dernière version'''] | ||
| + | |||
| + | === Mettre votre liste des paquets à jour === | ||
| + | |||
| + | : deb http://ppa.launchpad.net/jean-paul-louyot/mkd/ubuntu <version ubuntu> main | ||
| + | |||
| + | : deb-src http://ppa.launchpad.net/jean-paul-louyot/mkd/ubuntu <version ubuntu> main | ||
| + | |||
| + | ; En cas d'échec avec deb : | ||
| + | |||
| + | : Pour les mises à jour automatiques : '''sudo add-apt-repository ppa:jean-paul-louyot/mkd''' | ||
| + | |||
| + | : Pour récupérer les fichiers source : '''apt-get source mkd''' ''après installation des mises à jour automatiques.'' | ||
| + | |||
| + | === Convertir les paquets Debian === | ||
| + | |||
| + | : '''Alien''' convertit les paquets deb dans les formats rpm, dpkg, stampede slp, et slackware tgz | ||
| + | |||
| + | : [http://joeyh.name/code/alien/ '''Site officiel Alien'''] ; [http://www.rpmfind.net/linux/rpm2html/search.php?query=alien '''Télécharger le logiciel Alien'''] | ||
| + | |||
| + | === Convertir un paquet .deb en .rpm === | ||
| + | |||
| + | Commande suggérée : | ||
| + | |||
| + | sudo alien -r mkd-doc_140515_all.deb | ||
| + | |||
| + | ; Installation des paquets rpm convertis avec Alien : | ||
| + | |||
| + | Il peut y avoir un conflit entre les systèmes de fichiers avec la commande yum. Utiliser la commande rpm : | ||
| + | |||
| + | Exemple : | ||
| + | sudo rpm -ivh mkd-doc-140515-2.noarch.rpm --force | ||
| + | |||
| + | == Distributions de mkd en paquets Debian, RPM, Windows == | ||
| + | |||
| + | |||
| + | ''Certains paquets sont convertis avec Alien d'autres sont mis en paquets avec Fedora 23'' | ||
| + | |||
| + | : 2018-09-19 Téléchargements sur la [http://91.162.11.71:39686 Disk station EELL] | ||
| + | |||
| + | == Manuels / Manuals mkd == | ||
| + | ; (man1) (man3) | ||
| + | : - Téléchargez a mise à jour des manuels incluse dans les fichiers de [http://edeulo.free.fr/pub/mkd/ '''translations'''] | ||
| + | |||
| + | === Manual mkd in english === | ||
| + | <!--PRE STYLE="font-family:monospace; | ||
| + | font-size:0.95em; | ||
| + | width:40%; | ||
| + | border:red 2px solid; | ||
| + | color:white; | ||
| + | background-color:black; "> | ||
| + | This is red | ||
| + | </PRE--> | ||
| + | {{Boîte déroulante/début|titre=mkd Manual en (May 11, 2013)}} | ||
| + | <pre style="color:white; | ||
| + | background-color:black;"> | ||
| + | MKD(1) 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', ant '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 ( // → NL and /* → */ ) | ||
| + | |||
| + | -F Fortran style ( c,C or * → end of line ) | ||
| + | |||
| + | -P Pascal style ( { → } and (* → *) ) | ||
| + | |||
| + | -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). 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. | ||
| + | |||
| + | -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). You can see these | ||
| + | options compiled by the command mkd \? | ||
| + | |||
| + | -n numbering the lines (line number from source files) | ||
| + | |||
| + | -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). You can see these options compiled by the | ||
| + | command mkd \? | ||
| + | |||
| + | -s add to screen. (verbose) | ||
| + | |||
| + | -t text (copy only the comment). | ||
| + | |||
| + | -w overwrite the current target file. | ||
| + | |||
| + | EXAMPLES | ||
| + | with shell 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 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. | ||
| + | |||
| + | mkd -l '*ide' mkd3.c '*.id_ei' | ||
| + | (with compilable options CD1='#' or CD2='#', extract lines: | ||
| + | #include, #define, #ifdef, #else, #endif, etc.) | ||
| + | |||
| + | mkd -pj '**' mkd_docu.prj mkd.strings | ||
| + | Extract strings from program. (messages are printed to stdout). | ||
| + | (sources files are itemize in project file, and with compilable | ||
| + | options CD4=CD5=´\"´). | ||
| + | |||
| + | mkd (without argument) | ||
| + | Cause any error and syntax are transmit to terminal with carac‐ | ||
| + | ters compiled to use options l and p. | ||
| + | |||
| + | SEE ALSO | ||
| + | mkdcppw(1) | ||
| + | |||
| + | HISTORY | ||
| + | 1986 - mkd for DOS, and mkdoc for UNIX, are writen in ASCII format by | ||
| + | Jean-Paul Louyot for the Montpellier Universidad 'CEM' laboratory | ||
| + | (France). | ||
| + | |||
| + | 1991 - mkdoc 3.12 for PC and UNIX (Sun) | ||
| + | |||
| + | 1995 - 2004 - mkdoc 3.22 to mkdoc 4 for Unix and Linux: SUN-SPARC, HP- | ||
| + | UX, RedHat | ||
| + | |||
| + | 2004 - mkdoc 4 for Linux Ubuntu, Windows 98, Windows 2000 | ||
| + | |||
| + | 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 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 | ||
| + | http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX | ||
| + | |||
| + | AUTHORS | ||
| + | man updated by Clara JIMENEZ, Cardabela, and JPL. | ||
| + | |||
| + | TRANSLATORS | ||
| + | Catalan : Alizée | ||
| + | |||
| + | English : JPL, Cardabela | ||
| + | |||
| + | German : Clara, JPL, Martine | ||
| + | |||
| + | Italian : Luca | ||
| + | |||
| + | Spanish : Alizée, JPT, Sharo | ||
| + | |||
| + | Email : http://edeulo.free.fr/contacts/formmail.php | ||
| + | |||
| + | 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 Report: http://edeulo.free.fr/phpBB3/index.php | ||
| + | |||
| + | Documents generator mkd | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | May 11, 2013 MKD(1) | ||
| + | </pre> | ||
| + | {{Boîte déroulante/fin}} | ||
| + | |||
| + | === Manual mkd en español === | ||
| + | {{Boîte déroulante/début|titre=mkd Manual es (11 Mai 2013)}} | ||
| + | <pre style="color:white;background-color:black;"> | ||
| + | MKD(1) Manual de usario Unix MKD(1) | ||
| + | |||
| + | |||
| + | |||
| + | Ultima actualizado hace 3 de octubre de, 2017 | ||
| + | |||
| + | NOMBRE | ||
| + | mkd - make documentation. Generar (agregar) documentación. El programa | ||
| + | extrae la información codificada de los programas fuentes, y produce la | ||
| + | documentación especifica. | ||
| + | |||
| + | SINOPSIS | ||
| + | mkd [-ABCFPSafjlpstw] codigos ruta-de_origen [ruta-destino] | ||
| + | |||
| + | DESCRIPCIÓN | ||
| + | mkd Los comentarios seleccionados (o todos los comentarios) son | ||
| + | extraidos de los programas fuente ‘ruta-de_origen’ y son copia‐ | ||
| + | dos en un fichero documental : ‘ruta-destino’, a fin de producir | ||
| + | una documentacion especifica. Por norma general los ficheros | ||
| + | documentales sont organigramas, estructuras de programa, comen‐ | ||
| + | tarios para programadores, puntos de test y ‘alertas’ (warn‐ | ||
| + | ings)… Los codigos a seleccionar pueden ser los siguientes : | ||
| + | ‘O’, ‘S’,’P’,’T’ y ‘www’ justo despues del caracter delimitador. | ||
| + | |||
| + | codigos | ||
| + | Los comentarios que empiezen por estos caracteres son extraidos | ||
| + | del programa fuente y son anadidos al fichero documental. Todos | ||
| + | los caracteres ASCII pueden servir para codificar los comentar‐ | ||
| + | ios, no obstante se suelen utilizar caracteres con mayusculas, | ||
| + | excepto W para ‘warning’. Con dos astericos en parametro codi‐ | ||
| + | gos, mkd etrae todos los comentarios. (ver tambien opcion t y | ||
| + | los ejamplos) | ||
| + | |||
| + | ruta-de_origen | ||
| + | Ruta del archivo de fuente (o archive(fichero) proyecto: opción | ||
| + | j). | ||
| + | |||
| + | ruta-destino | ||
| + | Ruta del fichero documental. Por defecto ruta-destino es una | ||
| + | copia de ruta de origen al cual anadimos el sufijo por el sufijo | ||
| + | ‘doc’ | ||
| + | |||
| + | OPCIONES | ||
| + | Opciones de mayúsculas: | ||
| + | Limita la extraccion de los comentarios a un estilo de lenguaje | ||
| + | específico: | ||
| + | |||
| + | -A Extrae comentarios de estilo ensamblador (; al final de la | ||
| + | línea) | ||
| + | |||
| + | -B Estilo basico (REM o ' → final de la línea) | ||
| + | |||
| + | -C Estilo C ++ ( // → NL y /* → */ ) | ||
| + | |||
| + | -F Estilo Fortran (c, C o * → final de la línea) | ||
| + | |||
| + | -P Estilo -P Pascal ( { → } y (* → *) ) | ||
| + | |||
| + | -S Shell o estilo Ratfor ( # → final de la línea) | ||
| + | |||
| + | Lowercase options: | ||
| + | |||
| + | -a (append) Anade despues del fichero documental ruta destino. | ||
| + | |||
| + | -f (find) Encuentra un lenguaje del fichero fuente con el analisis | ||
| + | del sufijo. (útil con el archivo de proyecto). mkd reconoce los | ||
| + | siguientes archivos: .asm, .s; .bas, .vb, .bat; .C, .H, .D, | ||
| + | .cc, .hh, .cp, .cs, C #, .c ++, .h ++, c--, H-, .cpp, .hpp, | ||
| + | .css, .pr, .pl, .php, .jav, .js .JSE; .para, .f; .pas, .p; | ||
| + | .sh, .csh, .pl, .rb, .py, .pyw; .pj, .prj | ||
| + | |||
| + | -j (project) Se utiliza con un fichero proyecto compuesto de | ||
| + | fuentes de lenguajes diferentes. | ||
| + | |||
| + | -l (lines) Extrae las lineas que empiezan por los caracteres CD1 o | ||
| + | CD2 o CD3 y seguidos por caracteres codigos, el comentario se | ||
| + | acaba por la lectura del caracter ‘linea nueva’. CD1 y CD2 deben | ||
| + | estar en le primera columna, en vez de CD3 puede estar en el | ||
| + | medio de la linea. CD1, CD2, CD3, son opciones compilables en el | ||
| + | fichero version.h de la distribucion de origen de mkd. Se pueden | ||
| + | conocer estas opciones compiladas por mkd \? | ||
| + | |||
| + | -n (num) Enumera las líneas (número de línea del archivo fuente) | ||
| + | |||
| + | -p (page) Extrae el texto que empieze por el caracter CD4 seguido | ||
| + | de uno de los caracteres de codigos. La extraccion del comen‐ | ||
| + | tario se acaba con la lectura del caracter CD5. CD4 y CD5 son | ||
| + | opciones compiladas en el fichero version.h de la distribucion | ||
| + | de origen de MKD. Se pueden conocer estas opciones compiladas | ||
| + | por mkd \? | ||
| + | |||
| + | -s (screen, verbose) Duplica los comentarios extraidos en la salida | ||
| + | |||
| + | -t (text) Solamente copia en comentario | ||
| + | |||
| + | -w (overwrite) Escribe de nuevo el fichero documental. | ||
| + | |||
| + | EJEMPLOS | ||
| + | con el comando shell: | ||
| + | |||
| + | mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz | ||
| + | Producto manual de UNIX para los usuarios franceses. | ||
| + | |||
| + | mkd -Ct M manual mkd.1 | gzip -f mkd.1.gz | ||
| + | Manual de UNIX del producto. | ||
| + | |||
| + | mkd -Csl '*Sied' mkd3.c '*.verif_struct' | ||
| + | Documentación del producto con la estructura del programa, | ||
| + | incluye, define, ifdef cosa y endif opciones de compilación, | ||
| + | para verificar estructura del programa. (con opciones compil‐ | ||
| + | ables CD1 = '#' o CD2 = '#' en version.h de distribución mkd). | ||
| + | |||
| + | mkd -jfsl '*OHie' mkd_docu.prj mkd.org | ||
| + | Organigrama del producto. Comentarios empezar *, O, H y archivos | ||
| + | de fuentes se enumeran en el archivo de proyecto. (con opciones | ||
| + | compilables CD1 = '#' o CD2 = '#'). f: encontrar un lenguaje, | ||
| + | j: archivo de origen es un archivo de proyecto que contiene la | ||
| + | lista de archivos de fuentes. | ||
| + | |||
| + | mkd -l '*ide' mkd3.c '*.id_ei' | ||
| + | (con opciones compilables CD1 = '#' o CD2 = '#', líneas de | ||
| + | extracto: #include, #define, #ifdef, #else, #endif, etc.) | ||
| + | |||
| + | mkd -pj '**' mkd_docu.prj mkd.strings | ||
| + | Extraer cadenas de programa. (mensajes se imprimen en stdout). | ||
| + | (archivos de fuentes están detallar en el archivo de proyecto y | ||
| + | con compilable Opciones CD4=CD5=´\"´). Extract strings from | ||
| + | program. (messages are printed to stdout). (sources files are | ||
| + | itemize in project file, and with compilable options | ||
| + | CD4=CD5=´\"´). | ||
| + | |||
| + | mkd (sin argumento) | ||
| + | Causa cualquier error y la sintaxis se transmiten al terminal | ||
| + | con los caracteres compilados para utilizar opciones l y p. | ||
| + | |||
| + | VER TAMBIÉN | ||
| + | mkdcppw(1) | ||
| + | |||
| + | HISTORIA | ||
| + | 1986 - MKD para DOS y mkdoc para UNIX, se Escrito en formato ASCII | ||
| + | Jean-Paul Louyot para el laboratorio de la Universidad de Montpellier | ||
| + | "CEM" (Francia). | ||
| + | |||
| + | 1991 - mkdoc 3.12 para PC y UNIX (Sun) | ||
| + | |||
| + | 1995 - 2004 - mkdoc 3.22 a mkdoc 4 para Unix y Linux: SUN-SPARC, HP-UX, | ||
| + | RedHat | ||
| + | |||
| + | 2004 - mkdoc 4 para Linux Ubuntu, Windows 98, Windows 2000 | ||
| + | |||
| + | 2007-2012 - mkdoc versión 7.01 para MKD R12.01 están en formato | ||
| + | ISO-8859-1. El nombre 'mkdoc' se abandona con el lanzamiento 10,01 com‐ | ||
| + | pilado con Visual C ++ 2010 | ||
| + | |||
| + | 2012 - MKD 12.03 está adaptado a formato UTF-8 para traducciones y | ||
| + | internacionalización. En el mkdcppw estela se writen para decodificar | ||
| + | equipo C, C ++ y lenguajes PHP en modo gráfico con 'gcc' y 'gtkmm'. | ||
| + | |||
| + | DESCARGAS | ||
| + | http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX | ||
| + | |||
| + | AUTORES | ||
| + | Manual actualizado por Clara Jimenez, Cardabela, y el JPL. | ||
| + | |||
| + | TRADUCTORES | ||
| + | Spanish : Alizée Louyot, Claudie Favier | ||
| + | |||
| + | Email : http://edeulo.free.fr/contacts/formmail.php | ||
| + | |||
| + | NOTAS | ||
| + | Es pertenecen a los programadores para cerrar comentarios, bloques y | ||
| + | líneas, por los códigos de cierre apropiados en los archivos de origen. | ||
| + | |||
| + | Advertencia: El cierre de una línea de comentario es un retorno de | ||
| + | carro (NL, LF, CR / LF) según sea el caso. | ||
| + | |||
| + | Al final del archivo: esta nota implica un retorno de carro al final de | ||
| + | la línea de comentario. En este caso debe tener una línea en blanco al | ||
| + | final del archivo de origen. | ||
| + | |||
| + | No es que no permiten leer y decodificar los archivos incluidos por | ||
| + | #include en los archivos de fuentes. | ||
| + | |||
| + | FALLOS | ||
| + | Bugs Report: http://edeulo.free.fr/phpBB3/index.php | ||
| + | |||
| + | Documentos extrator | ||
| + | |||
| + | |||
| + | |||
| + | 6 de Abril, 2016 MKD(1) | ||
| + | </pre> | ||
| + | {{Boîte déroulante/fin}} | ||
| + | |||
| + | === Manuel mkd en français === | ||
| + | {{Boîte déroulante/début|titre=mkd Manuel fr (11 Mai 2013)}} | ||
| + | <pre style="color:white;background-color:black;"> | ||
| + | MKD(1) MKD(1) | ||
| + | |||
| + | |||
| + | |||
| + | NOM | ||
| + | mkd - make documentation. Extrait des informations codées dans les | ||
| + | programmes sources, et produit une documentation spécifique. | ||
| + | |||
| + | RÉSUMÉ | ||
| + | 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) | ||
| + | |||
| + | chemin_cible | ||
| + | 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++ ( // → NL et /* → */ ) | ||
| + | |||
| + | -F style Fortran ( c,C ou * → fin de ligne ) | ||
| + | |||
| + | -P style Pascal ( { → } et (* → *) ) | ||
| + | |||
| + | -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). mkd | ||
| + | reconnait les extensions suivantes: .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 (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 ´Nouvelle Ligne´. 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. On peut connaître ces options compilées par la commande | ||
| + | mkd \? | ||
| + | |||
| + | -n (num) numérote les lignes (numéro de ligne du fichier | ||
| + | d'origine). | ||
| + | |||
| + | -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. On peut connaître ces options compilées par la commande | ||
| + | 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 shell : | ||
| + | |||
| + | 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 | ||
| + | fichiers sources sont listés dans le fichier projet.) f:trouver | ||
| + | le style de langage, j:le fichier source est un fichier projet | ||
| + | qui contient la liste des fichiers a 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. | ||
| + | |||
| + | |||
| + | VOIR AUSSI | ||
| + | mkdcppw(1) | ||
| + | |||
| + | |||
| + | HISTOIRE | ||
| + | 1986 - mkd pour DOS, et mkdoc pour UNIX, sont écrits au format ASCII | ||
| + | par Jean-Paul Louyot pour le laboratoire 'CEM' de l'université de | ||
| + | Montpellier (France). | ||
| + | |||
| + | 1991 - mkdoc 3.12 pour PC et UNIX (Sun) | ||
| + | |||
| + | 1995 - 2004 - mkdoc 3.22 à mkdoc 4 pour Unix et Linux: SUN-SPARC, HP- | ||
| + | UX, RedHat | ||
| + | |||
| + | 2004 - mkdoc 4 pour Linux Ubuntu, Windows 98, Windows 2000 | ||
| + | |||
| + | 2007 - 2012 - de mkdoc R7.01 à mkd R12.01 sont au format ISO-8859-1. | ||
| + | Le nom 'mkdoc' est abandonné avec la version 10.01 compilée avec | ||
| + | Visual C++ 2010 | ||
| + | |||
| + | 2012 - mkd 12.03 adapté au format UTF-8 pour son internationalisation. | ||
| + | Dans la foulée mkdcppw est écrit pour les styles de langages C++ (C, | ||
| + | c++, c#, php, java, javscript, CSS, etc.) en mode graphique avec gcc et | ||
| + | 'gtkmm' (fenêtres). | ||
| + | |||
| + | TELECHARGEMENTS | ||
| + | http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX | ||
| + | |||
| + | AUTEURS | ||
| + | Manuel mis à jour par : Clara JIMENEZ | ||
| + | |||
| + | TRADUCTEURS | ||
| + | Allemand : Clara, JPL, Martine | ||
| + | |||
| + | Catalan : Alizée | ||
| + | |||
| + | Espagnol : Alizée, JPT, Sharo | ||
| + | |||
| + | Italien : Luca | ||
| + | |||
| + | Email : http://edeulo.free.fr/contacts/formmail.php | ||
| + | |||
| + | NOTES | ||
| + | Il appartient aux programmeurs de veiller à refermer les commentaires, | ||
| + | blocs et lignes, par les codes de fermeture appropriés dans les | ||
| + | fichiers sources. | ||
| + | |||
| + | Attention: La fermeture d'un commentaire ligne est un retour chariot ( | ||
| + | NL, LF, CR/LF) selon les cas. | ||
| + | |||
| + | En fin de fichier: cette note implique un retour chariot en fin de | ||
| + | commentaire ligne. Dans ce cas vous devez avoir une ligne vide à la fin | ||
| + | du fichier source. | ||
| + | |||
| + | Remarque: Cette version 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 | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | 11 Mai 2013 MKD(1) | ||
| + | </pre> | ||
| + | {{Boîte déroulante/fin}} | ||
| + | |||
| + | === mkd Handbuch in German === | ||
| + | |||
| + | {{Boîte déroulante/début|titre=mkd-Handbuch de (11. Mai 2013)}} | ||
| + | <pre style="color:white;background-color:black;"> | ||
| + | MKD(1) MKD(1) | ||
| + | |||
| + | |||
| + | |||
| + | BEZEICHNUNG | ||
| + | mkd - make documentation. Extrakte codierten Informationen aus Quellen | ||
| + | Programm und Produkt spezifische Dokumentation. | ||
| + | |||
| + | ÜBERSICHT | ||
| + | mkd [-ABCFPSafjlnpstw] Codes Quellpfad [Zieldatei] | ||
| + | |||
| + | 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 comments 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 Proggramme | ||
| + | Quelle extrahiert und Produkt spezifische Dokumentation. Üblichen | ||
| + | Zieldateien sind Organigramme, Struktur der Programme, Kommentare für | ||
| + | Programmierer, Warnungen oder Testpunkte Kommenttare ... Codierte | ||
| + | Informationen sind jeweils 'O', 'S', 'P', 'www' und 'T', direkt hinter | ||
| + | dem Kommentar. | ||
| + | |||
| + | Codes Alle ASCII. Der Kommentar werden extrahiert, wenn der Kommentar | ||
| + | beginnt mit diesem Zeichen. | ||
| + | |||
| + | Quellpfad | ||
| + | Pfad der Quelldatei. (Oder mit Projektdatei : Option j). | ||
| + | |||
| + | Zieldatei | ||
| + | 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 oder ' → Zum Ende der Zeile ) | ||
| + | |||
| + | -C C++ Stil ( // → Ende der Zeile, und /* → */ ) | ||
| + | |||
| + | -F Fortran Stil ( c,C oder * → Zum Ende der Zeile ) | ||
| + | |||
| + | -P Pascal Stil ( { Bis zu } und (* Bis zu *) ) | ||
| + | |||
| + | -S Shell oder Ratfor Stil ( # → Bis zu Ende der Zeile ) | ||
| + | |||
| + | Kleinbuchstaben Optionen: | ||
| + | |||
| + | -a (append) Hinzufügen am ende von Zieldatei. | ||
| + | |||
| + | -f (find) Finden Quelldatei Programmierung Sprache. (Mit Projekt | ||
| + | Datei). mkd erkennt die folgenden Dateien : .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 (project) Verwendet, wenn die Quelldatei ist eine Projektdatei. | ||
| + | |||
| + | -l (lines) 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'). Sie sehen die Optionen kompiliert mit dem | ||
| + | Befehl mkd \? | ||
| + | |||
| + | -n (num) Zeilennummerierung (Die Nummer der Zeile der Quelldatei). | ||
| + | |||
| + | -p (page) 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'). Sie sehen die Optionen | ||
| + | kompiliert mit dem Befehl mkd \? | ||
| + | |||
| + | -s (screen verbose) Fügt auf dem Konsole Bildschirm ('Verbose' ; | ||
| + | Ausführliche) | ||
| + | |||
| + | -t (text only) Text (Kopiert nur der Kommentar). | ||
| + | |||
| + | -w (overwrite) Überschrieben die aktuelle Zieldatei. | ||
| + | |||
| + | EXEMPLES | ||
| + | Mit shell-Befehl: | ||
| + | |||
| + | mkd -Cst F manual mkd.1 | gzip -f mkd.1.gz | ||
| + | Produkt französisch UNIX Manual; Version 12.03. C: Sprache C, | ||
| + | s:Auch anzeigen die Konsole, t:nur text, F:Code zu | ||
| + | entschlüsseln. | ||
| + | |||
| + | mkd -Ct M manual mkd.1 | gzip -f mkd.1.gz | ||
| + | Produkt englisch UNIX Manual; Version 12.03. (Produit un manuel | ||
| + | UNIX standard en anglais au format UTF-8 depuis la version | ||
| + | 12.03) | ||
| + | |||
| + | mkd -Csl '*Sied' mkd3.c '*.verif_struct' | ||
| + | (Mit den Kompilierung--optionen CD1='#' oder CD2='#' in 'mkd | ||
| + | distribution' version.h).Produkt Dokumentation mit Struktur | ||
| + | der Programme, '#includes', '#defines', '#ifdef', '#else' und | ||
| + | '#endif' Kompilierte Optionen, für überprüfen die Struktur in | ||
| + | Quelldatei in Programms | ||
| + | |||
| + | mkd -jfsl '*OHie' mkd_docu.prj mkd.org | ||
| + | (Mit den Kompilierung Optionen CD1='#' oder CD2='#' in 'mkd | ||
| + | distribution' version.h) Produkt Organigramm. Der Kommentar | ||
| + | beginnt mit * oder O oder 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. | ||
| + | |||
| + | 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 | ||
| + | den Quelldateien. (Die Saiten werden auf die Standard-Ausgabe | ||
| + | angezeigt.) | ||
| + | |||
| + | mkd \? Zeigt die Syntax und den Charakter CD1 bis CD5 Kompiliert. (Mit | ||
| + | den Optionen l und p verwendet) | ||
| + | |||
| + | 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 | ||
| + | Jean-Paul Louyot für CEM loratory in Montpellier Universität | ||
| + | (Frankreich). | ||
| + | |||
| + | 1991 - 1991 - mkdoc 3.12 für PC und UNIX (Sun) | ||
| + | |||
| + | 1995 - 2004 - mkdoc 3.22 für Unix und Linux: SUN-SPARC, HP-UX, RedHat | ||
| + | |||
| + | 2004 - mkdoc 4 für Linux Ubuntu, Windows 98, Windows 2000 | ||
| + | |||
| + | 2007 - 2012 -mkdoc R7.01 bis R12.01 sind auf ISO-8859-1-Format | ||
| + | abgestimmt. | ||
| + | |||
| + | 2012 - mkd 12.03 ist umgeschrieben in UTF-8 Format, und mkdcppw (für C, | ||
| + | c++, php) ist geschrieben für Fenstern mit gcc und gtkmm. | ||
| + | |||
| + | DOWLOADS | ||
| + | http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX | ||
| + | |||
| + | AUTOREN | ||
| + | Manuel mis à jour par : Clara JIMENEZ und JPL | ||
| + | |||
| + | ÜBERSETZER | ||
| + | Deutsch : Clara, JPL, Martine | ||
| + | |||
| + | Englisch : JPL, Cardabela | ||
| + | |||
| + | Italienisch : Luca | ||
| + | |||
| + | Katalanisch : Alizée | ||
| + | |||
| + | Spanisch : Alizée, JPT, Sharo | ||
| + | |||
| + | E-Mail : http://edeulo.free.fr/contacts/formmail.php | ||
| + | |||
| + | HINWEISE | ||
| + | Es gehört zu Programmierer, um die Kommentare zu schließen, blöcke und | ||
| + | Zeilen, mit entsprechenden Codes in Quelldateien. | ||
| + | |||
| + | Warnung: Die Schließung einer Kommentarzeile ist ein Wagenrücklauf (NL, | ||
| + | LF, CR/LF) als der Fall. | ||
| + | |||
| + | Ende der Datei: Diese Beobachtung impliziert einen Wagenrücklauf am | ||
| + | ende des Kommentar Linie. In diesem Fall muss eine leerzeile am Ende | ||
| + | der Quelldatei. | ||
| + | |||
| + | Diese Version lesen, und Dekodiert nicht, mit '#include' Richtlinie | ||
| + | in der Quelldatei. | ||
| + | |||
| + | BUGS | ||
| + | Bugs Report: http://edeulo.free.fr/phpBB3/index.php | ||
| + | |||
| + | Documents generator mkd | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | 11. Mai 2013 MKD(1) | ||
| + | </pre> | ||
| + | |||
| + | {{Boîte déroulante/fin}} | ||
| + | |||
| + | == Manuels / Manuals mkddocu == | ||
| + | |||
| + | === {{bleu|Manual mkddocu in english}} === | ||
| + | {{Boîte déroulante/début|titre=mkddocu Manual en (10 Mars 2014)}} | ||
| + | <pre style="color:white;background-color:black;"> | ||
| + | mkddocu(1) Linux User's Manual mkddocu(1) | ||
| + | |||
| + | NAME | ||
| + | mkddocu - This shell command generates the software documentations for all project | ||
| + | compatible with the software mkd. | ||
| + | |||
| + | SYNOPSIS | ||
| + | mkddocu [project] [-s] | ||
| + | |||
| + | DESCRIPTION | ||
| + | The command mkd linked to mkddocu, extracts the special comments marked by a benchmark | ||
| + | character. | ||
| + | Example : //D this is a php comment with a 'D' benchmark. | ||
| + | If some C files exist, then mkddocu will create a global header for the project, with | ||
| + | the benchmark character 'H'. | ||
| + | |||
| + | Benchmarks : | ||
| + | D - Extract the general documentation. | ||
| + | H - Extract comments from C files to create the global header file. | ||
| + | P - Creates the file useful for maintainers with General descriptions. | ||
| + | T - Creates the file useful for maintainers with the directives of tests. | ||
| + | |||
| + | OPTIONS | ||
| + | -project | ||
| + | This option allows to choose a project name which is different from the default | ||
| + | name, else the project name is 'project'. If 'project' is the character '?' the | ||
| + | command will show the syntax. | ||
| + | |||
| + | -s This option specifies that the command should create the strings file, and also | ||
| + | the file of strings useful for translate with gettext and poedit. | ||
| + | |||
| + | RETURN VALUE | ||
| + | 0 : End - when the command is complete or at the end of the help execution. (syntax) | ||
| + | -1 : mkd command is not found. | ||
| + | -2 : Command stopped. The backup is not performed. | ||
| + | |||
| + | EXAMPLES | ||
| + | The self-documentation of this command is created by the original file mkddocu.sh | ||
| + | Execute the command : 'mkddocu.sh mkddocu -s' | ||
| + | The directory maintenance/mkddocu contains the documents. | ||
| + | The directories of projects are generated by series and are stored in the directory | ||
| + | 'Backups' when the number of the series reaches the limit BACKUPSMAX | ||
| + | To test them, limit the value of BACKUPSMAX at 2. (3 backups by serie) | ||
| + | |||
| + | NOTES | ||
| + | BACKUPSMAX is normally fixed at 9 however you can modify this value by editing the file | ||
| + | /usr/bin/mkddocu. | ||
| + | |||
| + | SEE ALSO | ||
| + | mkd(1) xgettext(1) poedit(1) | ||
| + | |||
| + | DOWNLOADS | ||
| + | http://edeulo.free.fr | ||
| + | |||
| + | AUTHORS | ||
| + | Clara, JPL, Luca | ||
| + | Email : http://edeulo.free.fr/contacts/formmail.php | ||
| + | |||
| + | BUGS | ||
| + | Bug reports : http://edeulo.free.fr/phpBB3/viewforum.php?f=14 | ||
| + | |||
| + | 2014-02-24 mkddocu(1) | ||
| + | </pre> | ||
| + | |||
| + | {{Boîte déroulante/fin}} | ||
| + | |||
| + | === {{bleu|Manuel mkddocu en français}} === | ||
| + | {{Boîte déroulante/début|titre=mkddocu Manuel fr (10 Mars 2014)}} | ||
| + | <pre style="color:white;background-color:black;"> | ||
| + | mkddocu(1) Linux User's Manual mkddocu(1) | ||
| + | |||
| + | NOM | ||
| + | mkddocu - Cette commande shell génère la documentation informatique de tout fichier de | ||
| + | projet reconnu par le logiciel mkd. | ||
| + | |||
| + | SYNOPSIS | ||
| + | mkddocu [projet] [-s] | ||
| + | |||
| + | DESCRIPTION | ||
| + | La commande mkd associée à mkddocu, extrait les commentaires dotés d'un caractère | ||
| + | repère. | ||
| + | Exemple : //D ceci est un commentaire php répéré par le caractère 'D' | ||
| + | Si des fichiers de langage C sont présents, mkddocu génère un fichier d'entête global | ||
| + | (header) du projet informatique. | ||
| + | |||
| + | Repère : | ||
| + | D - Extrait la documentation générale. | ||
| + | H - Crée le fichier d'entête global (header) si un fichier C est présent. | ||
| + | P - Extrait un document utile aux mainteneurs, noms, dates, versions, etc. | ||
| + | T - Extrait le document des directives de tests. (Unitaires, d'intégration, etc.) | ||
| + | |||
| + | OPTIONS | ||
| + | projet Cette option permet de choisir un nom de projet différent de project par défaut. | ||
| + | Si 'projet' est le caractère '?' la commande affiche la syntaxe. | ||
| + | |||
| + | -s Cette option précise qu'il faut générer le fichier des chaînes de caractères et | ||
| + | le fichier des chaînes utiles aux traductions avec gettext et poedit. | ||
| + | |||
| + | VALEURS RETOURNÉES | ||
| + | 0 : Fin normale à la fin de l'exécution de la commande ou de l'aide (syntaxe). | ||
| + | -1 : La commande mkd n'est pas installée. | ||
| + | -2 : Arrêt de la commande. La sauvegarde de la série de documents dans Backups n'a pas | ||
| + | été effectuée. | ||
| + | |||
| + | EXEMPLES | ||
| + | L'auto-documentation de cette commande se crée avec le fichier d'origne mkddocu.sh | ||
| + | Lancer la commande 'mkddocu.sh mkddocu -s' | ||
| + | Le répertoire maintenance/mkddocu contiendra les documents. | ||
| + | Les répertoires de projet sont générés par séries et peuvent avoir été sauvegardés dans | ||
| + | un répertoire Backups si le nombre de fichiers de projet de la série a atteind la lim‐ | ||
| + | ite BACKUPSMAX | ||
| + | Pour les essais on peut se limiter à BACKUPSMAX=2 (3 'backups' par série.) | ||
| + | |||
| + | REMARQUES | ||
| + | BACKUPSMAX est normalement fixé à 9 mais peut être modifié par édition du fichier : | ||
| + | /usr/bin/mkddocu. | ||
| + | |||
| + | VOIR AUSSI | ||
| + | mkd(1) xgettext(1) poedit(1) | ||
| + | |||
| + | TÉLÉCHARGEMENTS | ||
| + | http://edeulo.free.fr | ||
| + | |||
| + | AUTEURS | ||
| + | Clara, JPL, Luca | ||
| + | Email : http://edeulo.free.fr/contacts/formmail.php | ||
| + | |||
| + | BUGS | ||
| + | Rapports de bugs : http://edeulo.free.fr/phpBB3/viewforum.php?f=14 | ||
| + | |||
| + | 2014-02-24 mkddocu(1) | ||
| + | </pre> | ||
| + | |||
| + | {{Boîte déroulante/fin}} | ||
| + | |||
| + | [http://edeulo.free.fr/phpBB3/viewtopic.php?f=16&t=323 Discussion / Forum : Bug on mkddocu 140515] | ||
| + | |||
| + | == Mise à jour des traductions / Update translations == | ||
| + | ; Votre aide à la traduction serait bienvenue. | ||
| + | <!--: [http://edeulo.free.fr/telechargements/console-ubuntu/po/po.tar.gz Fichiers texte traduits, à traduire, ou à modifier (*.po)]--> | ||
| + | : [https://fr.wikibooks.org/wiki/Mkd_%28Extracteur_de_documents%29/Internationalisation_des_messages internationalisation des messages sur wikibook] | ||
| + | |||
| + | == Aide / Help == | ||
| + | |||
| + | [[:wikibooks:fr:Mkd_(Extracteur_de_documents)|'''Wikibooks: Aide et exercices pour utiliser mkd''']] | ||
| + | |||
| + | [[Projet mkd/mkd/Aide|Aide simple]] | ||
| + | |||
| + | [[Projet mkd/mkd/Help|Simple help]] | ||
| + | |||
| + | == Bugs == | ||
| + | Forum [http://edeulo.free.fr/phpBB3/viewforum.php?f=14&sid=31b7b884a56ef082e08fa120974d171d Rapports de bugs / Bugs report] | ||
| + | |||
| + | [[Catégorie:Générateurs de documentation]] | ||
| + | [[Catégorie:Générateurs de documentation pour consoles]] | ||
| + | [[Catégorie:Programmation-Distribution]] | ||
| + | [[Catégorie:Mkd]] | ||
