Shell command projects/mkd
De Wiki EELL.
m (→Convertir les paquets Debian : Retouches) |
m (→Manuels / Manuals : Ajout de mkddocu manuele en français) |
||
| Ligne 63 : | Ligne 63 : | ||
: - Téléchargez a mise à jour des manuels incluse dans les fichiers de [http://edeulo.free.fr/pub/mkd/translations/ '''translations'''] | : - Téléchargez a mise à jour des manuels incluse dans les fichiers de [http://edeulo.free.fr/pub/mkd/translations/ '''translations'''] | ||
| - | === Manual in english === | + | === Manual mkd in english === |
<!--PRE STYLE="font-family:monospace; | <!--PRE STYLE="font-family:monospace; | ||
font-size:0.95em; | font-size:0.95em; | ||
| Ligne 72 : | Ligne 72 : | ||
This is red | This is red | ||
</PRE--> | </PRE--> | ||
| - | {{Boîte déroulante/début|titre=Manual en (May 11, 2013)}} | + | {{Boîte déroulante/début|titre=mkd Manual en (May 11, 2013)}} |
<pre style="color:white; | <pre style="color:white; | ||
background-color:black;"> | background-color:black;"> | ||
| Ligne 253 : | Ligne 253 : | ||
{{Boîte déroulante/fin}} | {{Boîte déroulante/fin}} | ||
| - | === Manuel en français === | + | === Manuel mkd en français === |
| - | {{Boîte déroulante/début|titre=Manuel fr (11 Mai 2013)}} | + | {{Boîte déroulante/début|titre=mkd Manuel fr (11 Mai 2013)}} |
<pre style="color:white;background-color:black;"> | <pre style="color:white;background-color:black;"> | ||
MKD(1) MKD(1) | MKD(1) MKD(1) | ||
| Ligne 465 : | Ligne 465 : | ||
{{Boîte déroulante/fin}} | {{Boîte déroulante/fin}} | ||
| - | === Handbuch in German === | + | === mkd Handbuch in German === |
{{Boîte déroulante/début|titre=mkd-Handbuch de (11. Mai 2013)}} | {{Boîte déroulante/début|titre=mkd-Handbuch de (11. Mai 2013)}} | ||
| Ligne 662 : | Ligne 662 : | ||
11. Mai 2013 MKD(1) | 11. Mai 2013 MKD(1) | ||
| + | </pre> | ||
| + | |||
| + | {{Boîte déroulante/fin}} | ||
| + | |||
| + | === 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> | </pre> | ||
