@version 1 !E_IVLDSPEC :E Invalid spec statement, line %d\n !E_NOMATCHSPEC :E No specification matching the key, line %d\n\t%s\n !E_UNKNOWNFUNC :E Unknown %s function\n !E_ENDSUB :E endsub statement out of sequence on line %d\n !E_IVLDCMD :E Invalid command, line %d\n%s !E_IVLDVALUE :E Invalid value :%s: for %s (default %d)\n !F_LINEPERPAGE :E line per page !F_CHARPERLINE :E char per line !F_LEFTMARGIN :E left margin !F_FUNCTION :E FUNCTION %s\n !F_VARIATION :E Variation %s\n !E_FUNCNOTCOVERED :E List of function not covered !E_SPECNOTCOVERED :E List of specification not dispatched !E_IVLDKEYSEQ :E Invalid key sequence\n%s !E_MISSINGCOLON :E file %s line %d: Missing :, rejected\n%s !E_MISSINGKEY :E Missing classification key: File %s ligne %d\n%s !E_CANTFINDSPEC :E Can't locate again specification: File %s offset %ld\n\t%s\n%s\n !E_IVLDFORMAT :E Fichier %s: Format invalide\n :F Invalid format for file %s\n !E_IVLDSTRUCT :E Invalid structure for file %s\n%s\n !E_IVLDFORMATLINE :E File %s, line %d: invalid format\n\t\n !I_USAGE :E Usage : nadoc Outline_file Prototypes_file [result]\n + Format a manual from to file\n + Prototypes_file is built using the extractor (proto).\n + Type a '-' if omitted.\n +\n + -a : Author of the document\n + -c : Number of char per line.\n + Default value: 60\n +\n + -f : Generate a TLMPDOC document.\n + Optionnally -f may specify a relative path.\n + It will be used to build hypertext links.\n +\n + -g : Generate a SGML (linux HOWTO style) document.\n +\n + -h : Generate a HTML document.\n + Optionnally -h may specify a relative path.\n + It will be used to build hypertext links.\n +\n + -i : Generate an integrity report\n + -i without argument output on stderr\n + -ixxx output in file xxx.\n +\n + -l : Number of line per page.\n + Default value: 58\n +\n + -m : Left margin (character).\n + Default value: 4\n +\n + -p : Extract specification from the source files of the\n + current directory.\n + -pP : Extract the specification from source for the given\n + directory P. Option -p may be used several times.\n +\n + -t : Title of the document\n + -xF : Cross reference file.\n + Option -x may be repeated, F is a file path.\n + file F was produced by the crossref utility.\n +\n + Outline_file hold the general organisation of\n + software system to describe.\n + It holds standard ascii text plus special command\n + to control formatting, and to merge function\n + specifications.\n +\n + Normally the manual is printed on the standard output.\n + A third, optionnal argument, indicates the path of\n + a file which will hold the manual.\n +\n + Special commands begin with a pound sign '#' and ends\n + with a colon ':'. They are always located at the\n + beginning of a line. They may be followed by some\n + parameters. Here is a list of supported commands.\n +\n +#endsub:\n + It directs Nadoc to resume section numbering at\n + the current level, before the last #subsection\n + command.\n +\n +#function: function ...\n + It tells Nadoc to merge the specifications of those\n + functions from the prototypes_file.\n +\n +#ignore: function ...\n + Normally Nadoc warns when a function of a system\n + is not referenced. #ignore marks those functions\n + as if they were referenced.\n +\n +#page:\n + Insert a page break.\n +\n +#ref: label\n + Record a label for cross-referencing\n +\n +#spec: key [ / key ... ]\n + Merge all the specifications matching exactly this key\n +#spec: key [ / key ... ] / *\n + Merge all the specifications with a key beginning like\n + this key\n +#spec: clé [ / clé ... ] / ...\n + Merge all the specifications with a key beginning like\n + this key and which has not been merged so far in the\n + document.\n +\n +#section: any title\n + Nadoc will automaticly assign a section number.\n + The title will be added to the table of content.\n +\n +#subsection:\n + It tell Nadoc that following #section commands\n + are sub-section of the current section of the\n + manual.\n +#\n + Activate/Desactivate paragraph formatting\n + Formatting is active initially.\n :F Usage : nadoc [options] fichier_guide fichier-prototypes [résultat]\n + Formatte un manuel en fusionnant un guide\n + et une série de prototypes.\n + Le fichier-prototypes est produit par l'extracteur\n + de prototypes (proto). Il est optionnel. Inscrire\n + un '-' si omis.\n +\n + -c : Nombre de caractères par ligne.\n + Valeur par défaut: 60\n +\n + -f : Produit un document TLMPDOC.\n + Optionnellement -f peut spécifier un path relatif\n + qui sera utilisé pour les liens hypertextes\n +\n + -g : Produit un document SGML (style Linux HOWTO).\n +\n + -h : Produit un document HTML.\n + Optionnellement -h peut spécifier un path relatif\n + qui sera utilisé pour les liens hypertextes\n +\n + -i : Commande une copie du rapport d'intégrité\n + -i sans argument produit le rapport sur le canal\n + d'erreur.\n + -ixxx produit le résultat dans le fichier xxx.\n +\n + -l : Nombre de lignes par page.\n + Valeur par défaut: 58\n + -m : Nombre de caractère réservés à la marge de gauche.\n + Valeur par défaut: 4\n +\n + -p : Commande l'extraction des spécifications en\n + balayant les fichiers sources. Le format des\n + commentaires est le suivant:\n + -pP : Commande l'extraction pour les sources du répertoire P.\n + L'option -p peut être répêté plusieurs fois.\n + +pP : Comme -pP, mais balaye recursivement les sous-répertoires.\n +\n + -xF : Fichier références croisées.\n + L'option -x peut être répétée, F est un fichier.\n + Le (les) fichier F a été produit par l'utilitaire crossref.\n +\n + /* #Spécification: clé [ / clé ... ]\n + ...\n + */\n + ou,\n + // #Spécification: clé [ / clé ... ]\n + ...\n + // #specend\n +\n + Fichier_présentation contient le squelette du manuel\n + à produire. Il contient du texte ascii ainsi que des\n + commandes. Il y a des commandes pour controler le\n + formattage et des commandes pour fusionner les\n + spécifications de fonctions extraites des sources.\n +\n + Par défaut, le manuel est produit à l'écran. Un\n + troisième argument optionnel indique le nom du\n + qui contiendra le manuel.\n +\n + Les commandes commencent toujours au début d'une ligne.\n + Elle débutent par le caractère '#' et terminent par le\n + caractère ':'. Voici la liste des commandes supportées.\n +\n +#finsous:\n + Ceci indique la fin d'une série de sous-sections.\n + Le numérotage des sections continuera au niveau\n + précédant, immédiatement avant la dernière commande\n + #soussection.\n +\n +#fonction: fonction ...\n + Les spécifications des fonctions énumérées seront\n + incluses dans le texte, à la position courante.\n +\n +#ignore: fonction ...\n + Normallement Nadoc génère un avertissement pour\n + chaque fonctions du système qui n'est pas référencée\n + par le manuel. La commande ignore désactive cet action\n + pour les fonctions énumérées\n +\n +#page:\n + Insère un saut de page.\n +\n +#ref: label\n + Enregistre un point d'entrée (cross-reference)\n +\n +#spec: clé [ / clé ... ]\n + Formatte les spécifications correspondant exactement\n + à cette clé.\n +#spec: clé [ / clé ... ] / *\n + Formatte les spécifications dont le début de la clé\n + correspond à cette clé\n +#spec: clé [ / clé ... ] / ...\n + Formatte les spécifications dont le début de la clé\n + correspond à cette clé et qui n'ont encore pas été\n + mentionnées.\n +\n +#section: titre ...\n + Nadoc numérote automatiquement cette section et ajoute\n + le titre à la table des matières.\n +\n +#soussection:\n + Suite à cette commande, Nadoc sous-numérotera toutes\n + les sections suivantes, jusqu'à la prochaine commande\n + #finsous.\n +#\n + Active/Désactive le formattage des paragraphes\n + Par défaut, le formattage est actif\n !I_CROSSREF :E crossref -pprefixe fichiers_html ...\n +\n +Ce programme extrait les points d'entrée des fichiers html\n +pour permettre à nadoc de produire de références vers ces points\n +d'entrée.\n +\n + -p Cet option insère un préfixe devant le path du fichier html.\n + On utilise cet option lorsqu'on balaye une hiérarchie\n + HTML complexe pour s'assurer que les hyperliens sont\n + consistent. Par exemple, pour le projet linuxconf où\n + tous les documents produits sont stocké dans le\n + sous-répertoire /linuxconf/tech/api, la ligne de commande\n + de crossref est:\n +\n + cd /home/httpd/html/linuxconf/tech/api\n + crossref -p/linuxconf/tech/api */*.html\n !I_CLSFORM :E clsform [options] fichier_proto ...\n +\n + Formatte la hierarchie des classes extraite\n + par proto (option -q).\n +\n + -cC Extrait la liste des fonctions membres de la classe C\n + incluant les fonctions membres des classes de base.\n + -c+C extrait les fonction interne de la classe.\n + -fF Lit le fichier F contenant des prototypes de fonction\n + membres. Ce fichier est généralement produit avec l'option\n + -c+d de la commande proto.\n + L'option -f peut être répétée plusieurs fois.\n + -g Produit du sgml.\n + -oF Produit le résultat dans le fichier F.\n + -t Produit l'arbre des classes.\n :F clsform [options] class_file ...\n +\n + Format the class hierarchy extracted by proto.\n + (See the -q option)\n +\n + -g Produce sgml output.\n !I_CLASSVIEW :E Classe %s, %s\n :F Class %s, %s\n !I_INTERNAL :E vue interne :F internal view !I_PUBLIC :E vue publique :F public view !E_TOOLONG :E Commentaire trop long pour la fonction %s\n :F Comment too long for function %s\n !E_DSTDIR :E You must specify the destination directory\n !E_ONEXREF :E At least one cross reference file needed\n !I_USAGEFIX :E Usage : crossfix -ddir -xcrossref_file [ -x...] html_files\n +\n +\"html_files\" will be copied to the destination directory\n +and the keyword in cross-reference files will be used\n +to insert HREF statement in the HTML files\n +\n +Those crossref are produced by nadoc and crossref utilities\n !I_USAGEPERM :E Usage : naperm [-f] [-m[dir]] [-s] [-v]\n + [Prototypes Index [Sommaire] [historique]]\n +\n + Prototypes est produit par proto.exe.\n + L'option '-c__d de proto.exe a été utilisée.\n +\n +\n + Index sera un index permutté.\n + Sommaire sera un résumé de fichier_prototype.\n + Historique retrace l'évolutions des fonctions.\n + d'un système.\n + prototype, Index et Sommaire peuvent être des listes.\n + ex: naperm *.nap *.nai *.nas *.nah\n + Si Index == '-', pas d'index permutté produit.\n + Si Sommaire == '-', pas de sommaire produit.\n + -f : Index, Sommaire et Historique seront produit même si\n + Prototypes est moins récent.\n + -m : Extensions standards\n + naperm -m -> naperm *.nap *.nai *.nas\n + naperm -mxxx -> naperm xxx/*.nap xxx/*.nai xxx/*.nas\n + xxx/*.nah\n + -s : Ne signale pas les fonctions qui n'ont pas de sommaire.\n + -v : N'affiche pas d'information sur traitement.\n +\n + Exemple:\n + proto -cod -fprojet.nap *.c\n + naperm projet.nap projet.nai projet.nas projet.nah\n :F Usage : naperm [-f] [-m[dir]] [-s] [-v]\n + [Prototypes Index [Sommary] [historic]]\n +\n +\n + Prototypes are extracted using PROTO.exe.\n + proto's option '-c__d' requiered.\n +\n +\n + Index will be a permutted index.\n + Summary will be a function quick reference.\n + Historic will trace the evolution of the functions.\n + prototype, Index, Summary and Historic may be wildcard.\n + ex: naperm *.nap *.nai *.nas *.nah\n + If Index == '-', no index generated.\n + If Summary == '-', no summary generated.\n + -f : Index, Summary and Historic are produced even\n + if Prototypes are older.\n + -m : Standard operation.\n + naperm -m -> naperm *.nap *.nai *.nas *.nah\n + naperm -mxxx -> naperm xxx/*.nap xxx/*.nai xxx/*.nas\n + xxx/*.nah\n + -s : No warning for function without documentation.\n + -v : Silent processing.\n +\n + Example:\n + proto -cod -fproject.nap *.c\n + naperm project.nap project.nai project.nas project.nah\n !E_NOCONNECTION :E **** Pas de correspondance %s -> %s\n :F **** No connection %s -> %s\n !E_IVLDARG :E Argument invalide\n :F Invalid argument\n