« Mkd (Extracteur de documents)/mkd-Manuel (fr) » : différence entre les versions
Contenu supprimé Contenu ajouté
m →Manuel : Mise à jour |
m →Installation : Mise à jour du 6 avril |
||
Ligne 46 :
.\" Vérifications UTF-8 par Clara le 6 novembre 2012
.\" Mise à jour par Cardabela le 31 mars 2012
.\" Mise à jour par JPL le 6 avril 2013
.\" .
.\" FILE manuals Update_mkd_(fr).1.txt to edit in UTF-8 format
.TH MKD 1 "
.SH
mkd \- make documentation. Extrait des informations codées dans les programmes sources, et produit une documentation spécifique.
.SH
.I mkd
.RB [\-ABCFPSafjlpstw]
Ligne 69 ⟶ 70 :
Chemin du fichier source (ou fichier projet: option j)
.TP
.I 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\'.
.SH OPTIONS
Ligne 76 ⟶ 77 :
Restreind l'extraction des commentaires a un style de langage:
.IP \fB\-A\fP
extrait le style Assembleur ( ;
.IP \fB\-B\fB
style Basic ( REM ou '
.IP \fB\-C\fB
style C
.IP \fB\-F\fB
style Fortran ( c,C ou *
.IP \fB\-P\fB
style Pascal (
.IP \fB\-S\fB
style Shell ou ratfor ( # →
.TP
.I options en minuscules:
Ligne 97 ⟶ 98 :
(project) S\'utilise avec un fichier projet composé de sources en langages différents.
.IP \fB\-l\fB
(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 \'
.IP \fB\-n\fB
(num) numérote les lignes (numéro de ligne du fichier d'origine).
.IP \fB\-p\fB
(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 /\?
.IP \fB\-s\fB
(screen verbose) Duplique les commentaires extraits sur la sortie standard.
Ligne 108 ⟶ 111 :
.SH EXEMPLES
.TP
.I avec une commande
.TP
mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz
Ligne 120 ⟶ 123 :
.TP
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
.TP
mkd -l '*ide' mkd3.c '*.id_ei'
Ligne 131 ⟶ 134 :
Génère une erreur et envoie la syntaxe au terminal avec les caractères compilés pour les options l et p.
.SH
.PP
mkdcppw(1)
.SH HISTOIRE
.PP
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).
.TP
1991 - mkdoc 3.12 pour PC et UNIX (Sun)
.TP
1995 - 2004 - mkdoc 3.22 à mkdoc 4 pour Unix et Linux: SUN-SPARC, HP-UX, RedHat
.TP
2004 - mkdoc 4 pour Linux Ubuntu, Windows 98, Windows 2000
.TP
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
.TP
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).
.SH TELECHARGEMENTS
.PP
http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX
.SH AUTEURS
.PP
Manuel mis à jour par : Clara JIMENEZ
.SH TRADUCTEURS
.PP
Allemand : Clara, JPL, Martine
.TP
Catalan : Alizée
.TP
Espagnol : Alizée, JPT, Sharo
.TP
Italien : Luca
.TP
Email : http://edeulo.free.fr/contacts/formmail.php
.IP
.SH NOTES
.PP
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.
.SH BUGS
| |||