« Mkd (Extracteur de documents)/mkd-Manuel (fr) » : différence entre les versions
Contenu supprimé Contenu ajouté
m →Manuels / Manuals : Mise en attente du modèle cacher à l'impression. |
Mise à jour |
||
Ligne 3 :
{{en travaux}}
<!--<small>{{Cacher à l'impression|''Les liens, ci-dessous, vers les manuels {{en}} et {{de}} ne sont pas compilables''}}</small>
-->
Ligne 18 ⟶ 9 :
=== [[Mkd_(Extracteur_de_documents)/Traductions_Internationales/mkd-Handbuch#Installieren|Handbuch in German]] ===
=== Installation ===
{{Boîte déroulante début|titre='''mkd_fr.1''' <small>''31 mars 2013''</small>|}}
<small>Manuel de référence en français (mkd-0~120508)</small>
Copier le contenu de la boîte mkd_fr.1 ci-dessous dans un éditeuir de texte UTF-8<br />
Enregistrer le fichier sous le nom '''mkd_fr.1''' puis exécuter le makefife '''make -f French.mak'''.
Fichier '''French.mak'''
<source lang="make">
# File : French.mak
# Syntax: sudo (or su) make -f French.mak
# Manual:
mkd_fr.1.gz: mkd_fr.1
# Compresser
gzip -c mkd_fr.1 > mkd_fr.1.gz
# Fichier: En lecture seule
chmod 444 mkd_fr.1.gz
# Installation
echo "Installation du manuel français"
if [ -d "/usr/share/man/fr.UTF-8/man1" ]; \
then sudo cp -f mkd_fr.1.gz /usr/share/man/fr.UTF-8/man1/mkd.1.gz ; \
elif [ -d "/usr/share/man/fr/" ]; \
then sudo cp -f mkd_fr.1.gz /usr/share/man/fr/man1/mkd.1.gz ; \
fi
</source>
Fichier : '''mkd_fr.1'''
Formaté nroff pour manuels au format [[w:Unicode#UTF-8|'''Unicode UTF-8''']]<br />
''Lisible au format UTF-8 par la commande '''man .\mkd_fr.1'''''<br />
<small>''Lisible éventuellement au format ASCII par la commande : '''nroff -man mkd_fr.1'''''</small>
<pre>
.\" FILE manuals Update_mkd_(fr).1.txt to edit in UTF-8 format
.TH MKD 1 "29 Mars 2012"
.SH NAME
mkd \- make documentation. Extrait des informations codées dans les programmes sources, et produit une documentation spécifique.
.SH SYNOPSIS
.I mkd
.RB [\-ABCFPSafjlpstw]
.IR codes
.IR chemin_source
.RB [chemin_cible]
.SH DESCRIPTION
.TP
.I 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.
.TP
.I 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).
.TP
.I chemin_source
Chemin du fichier source (ou fichier projet: option j)
.TP
.I 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\'.
.SH OPTIONS
.TP
.I Options en majuscules:
Restreind l'extraction des commentaires a un style de langage:
.IP \fB\-A\fP
extrait le style Assembleur ( ; \-> fin de ligne)
.IP \fB\-B\fB
style Basic (REM ou ' \-> fin de ligne)
.IP \fB\-C\fB
style C ( / * \-> * / )
.IP \fB\-F\fB
style Fortran (c,C ou * \-> fin de ligne)
.IP \fB\-P\fB
style Pascal ( { \-> } )
.IP \fB\-S\fB
style Shell ou ratfor ( # \-> fin de ligne)
.TP
.I options en minuscules:
.B
.IP \fB\-a\fB
(append) Ajoute a la suite du fichier documentaire \'chemin_cible\'.
.IP \fB\-f\fB
(find) Trouve le langage du fichier source par analyse du suffixe. (s\'utilise généralement avec un fichier projet)
.IP \fB\-j\fB
(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 \'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.
.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.
.IP \fB\-s\fB
(screen verbose) Duplique les commentaires extraits sur la sortie standard.
.IP \fB\-t\fB
(text) Ne copie que le commentaire.
.IP \fB\-w\fB
(overwrite) Réécrit le fichier documentaire.
.SH EXEMPLES
.TP
.I avec une commande Cshell :
.TP
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.
.TP
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)
.TP
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.
.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 source sont décrits 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.
.TP
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 ).
.TP
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).
.TP
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.
.SH AUTHOR
.PP
JP LOUYOT, Clara JIMENEZ
http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX
.IP
.SH NOTES
.PP
Cette version 12.03.0 ne lit et ne décode pas les fichier inclus par '#include' dans les sources.
.SH BUGS
.PP
Bugs Report: http://edeulo.free.fr/phpBB3/index.php
Générateur de documents mkd
</pre>
{{Boîte déroulante fin}}
=== Manuel ===
<!--{{Boîte déroulante/début|titre=Manuel (fr) <small>''31 Mars 2013''</small>}}-->
<pre>
Ligne 210 ⟶ 337 :
</pre>
<!--{{Boîte déroulante/fin}}-->
== Manuels internationalisés ==
*(man1) :
: - <strike>Téléchargez la mise à jour des manuels 2012-11-06:</strike><ref name="Manuals">[http://edeulo.free.fr/telechargements/console-ubuntu/mkd/mkd_manuals_2012-11-06.tgz mkd manuals 2012-11-06] {{en}} {{de}} {{fr}}</ref> Voir la mise à jour 2013-03-31
: - <strike>Download the latest manual multi-lang Installer:</strike><ref name="Manuals"/>
*'''Attention :''' Vérifiez les dates de publication de ces pages de manuels ci-dessous en bas de page.<br />
<references />
| |||