notangle - En ligne dans le Cloud

PROGRAMME:

Nom

notangle, noweave, nountangle - noweb, un outil de programmation littéraire

SYNOPSIS

pas enchevêtrer [-Rnom racine ...] [-filtre commande] [-L[format]] [fichier] ...
non-enchevêtrement [-ml|-m3|-c|-c++|-awk|-Texas|-f77|-f90|-zézayer|-matlab] [-Rnom racine ...] [-filtre
commande] [-wlargeur] [fichier] ...
maintenant [options] [fichier] ...

DESCRIPTION

MaintenantWeb est un outil de programmation littéraire comme celui de Knuth LA TOILE, seulement plus simple. UNE pas de web filet
contient le code source du programme entrelacé avec la documentation. Lorsque pas enchevêtrer reçoit un
pas de web fichier, il écrit le programme sur la sortie standard. Lorsque maintenant reçoit un pas de web fichier,
il lit le pas de web source et produit, en sortie standard, Latex, Texas, trof, ou HTML
source pour la documentation composée. non-enchevêtrement convertit un programme lettré en un programme ordinaire
programme en transformant la documentation entrelacée en commentaires. Le nom de fichier « - » fait référence à
entrée standard.

Format OF MAINTENANT DES DOSSIERS

A pas de web fichier est une séquence de morceaux, qui peuvent apparaître dans n'importe quel ordre. Un morceau peut contenir
code ou documentation. Les morceaux de documentation commencent par une ligne qui commence par un signe at
(@) suivi d'un espace ou d'une nouvelle ligne. Ils n'ont pas de noms. Les morceaux de code commencent par
<<gros morceau prénom>> =
sur une ligne par lui-même. La double équerre gauche (<<) doit être dans la première colonne.
Les morceaux se terminent par le début d'un autre morceau ou par la fin d'un fichier. Si le premier
ligne dans le fichier ne marque pas le début d'un morceau, il est supposé être le premier
ligne d'un morceau de documentation.

Les morceaux de documentation contiennent du texte qui est ignoré par pas enchevêtrer et copié textuellement dans
sortie standard par maintenant (sauf pour le code cité). maintenant peut travailler avec Latex, plaine
Texas, trof or HTML. avec plaine Texas, il insère une référence à un Texas paquet de macros, nwmac,
qui définit des commandes comme \chapitre et \section.

Les morceaux de code contiennent le code source du programme et des références à d'autres morceaux de code. Plusieurs codes
les morceaux peuvent avoir le même nom ; pas enchevêtrer concatène leurs définitions pour produire un seul
morceau, tout comme enchevêtrement(1). Les définitions de fragments de code sont comme les définitions de macros ;
pas enchevêtrer extrait un programme en développant un morceau (par défaut, le morceau nommé <<*>>).
La définition de ce morceau contient des références à d'autres morceaux, qui sont eux-mêmes
élargi, et ainsi de suite. pas enchevêtrerla sortie de est lisible ; il préserve l'indentation de
morceaux étendus par rapport aux morceaux dans lesquels ils apparaissent.

Le code peut être cité dans les morceaux de documentation en plaçant des doubles crochets ([[...]])
autour de. Ces doubles crochets sont ignorés par pas enchevêtrement, mais ils peuvent être utilisés par
maintenant pour donner au code un traitement typographique particulier, par exemple des liens hypertextes. Si cité
le code se termine par trois crochets ou plus, maintenant choisit la paire la plus à droite, de sorte que,
par exemple, [[un[i]]] est correctement analysé. Les noms des morceaux de code peuvent apparaître dans
le code entre guillemets sauf si ce code entre guillemets fait lui-même partie du nom d'un morceau de code.

Dans le code, noweb traite les doubles crochets non appariés gauche ou droit comme littéraux << et >>.
Pour forcer de telles parenthèses, même des parenthèses appariées ou des parenthèses dans la documentation, à être
traité comme littéral, utilisez un signe avant (par exemple @<).

Certains langages de programmation ou de formatage peuvent nécessiter un seul @ signer dans la première colonne.
Les utilisateurs de Noweb peuvent obtenir cet effet en mettant un double @@ dans la première colonne ; dans ce
position seulement, il représente un seul @ signe.

ENVELOPPEMENT

pas enchevêtrer et non-enchevêtrement accepter le même ensemble d'options, bien que certaines options aient des effets
seulement sur l'un ou l'autre. Les options sont :

-Rprénom Élargir la <<prénom>> morceau de code. Les -R option peut être répétée, auquel cas chaque
un morceau est écrit dans la sortie. Sinon -R option est donnée, développez le morceau nommé
<<*>>.

-Lle format
Émettre des indications de numéro de ligne aux limites des tronçons. Une indication de numéro de ligne
identifie la source de la ligne qui la suit. Dans le format, %F indique le
nom du fichier source, %L indique le numéro de ligne du fichier source, %N
indique une nouvelle ligne, et %% indique un signe de pourcentage. Un signe et un chiffre peuvent être
inséré entre le signe pour cent et le `L', auquel cas le numéro de ligne sera
être ajusté de ce montant. Si le format est omis, le format par défaut est celui
accepté par le préprocesseur C : `#ligne %L "%F"%N'. Lors de l'utilisation du -Lle format option,
pas enchevêtrer garantit que tout le texte apparaît dans la même colonne en entrée et en sortie.
non-enchevêtrement ignore cette option.

Les chaînes de format courantes incluent :
C -L'#ligne %L "%F"%N'
Soleil FORTRAN -L'\# %L "%F"%N'
Icône -L'#ligne %-1L "%F"%N'
Modula-xnumx -L'<*LINE %L "%F" *>%N'
SML / NJ -L'(*#ligne %L "%F"*)'

Pour résoudre le problème inverse, c'est-à-dire faire en sorte que noweb fasse quelque chose de sensé avec
#ligne dans son entrée, voir le trait net filtre dans le répertoire des exemples.

-tk Copiez les onglets intacts de l'entrée à la sortie et utilisez les onglets pour l'indentation, en supposant
s'arrête chaque k Colonnes. Par défaut, les tabulations sont étendues aux espaces avec des arrêts tous les 8
colonnes.

-filtre cmd
Filtrer le pas de web source à travers cmd après l'avoir converti en forme d'outil et avant
enchevêtrement. pas enchevêtrer cherche des cmd d'abord sur l'utilisateur PATH, puis dans /usr/lib/noweb.
De tels filtres peuvent être utilisés pour ajouter des fonctionnalités à pas enchevêtrer; pour un exemple voir
/usr/lib/noweb/emptydefn. Pour connaisseurs seulement.

-balisage analyseur
Utilisez le analyseur pour analyser le fichier d'entrée. Permet l'utilisation d'outils noweb sur des fichiers dans d'autres
formats ; par exemple, le balisage nu l'analyseur comprend nuweb(1) format. Voir
pas de filtres Web(7) pour plus d'informations. Pour connaisseurs seulement.

-awk | -c | -icn | -icône | -ml | -m3 | -pascal | -f77 | -f90 | -Texas
Quand non-enchevêtrement transforme des morceaux de documentation en commentaires, utilisez le commentaire
format de la langue nommée. -c est la valeur par défaut. pas enchevêtrer ignore ces options.

-wn Quand non-enchevêtrement transforme des morceaux de documentation en commentaires, crée des commentaires sur
lignes de largeur n. pas enchevêtrer ignore cette option.

TISSAGE

Sortie de maintenant peut être utilisé dans Texas documents qui \saisir nwmac, in Latex INSTITUTIONNELS
qui utilisent le pas de web paquet (voir style noweb(1)), et en HTML documents à parcourir avec
Mosaic (1). maintenant traite les morceaux de code un peu comme Latex liste environnements. Si le ``@
'' qui termine un morceau de code est immédiatement suivi par du texte, ce texte suit le
morceau de code sans saut de paragraphe. Si le reste de la ligne est vide, maintenant met Texas
en ``mode vertical'', et plus tard le texte commence un nouveau paragraphe en retrait.

Aucun saut de page ne se produit au milieu des morceaux de code, sauf si nécessaire pour éviter un débordement
vbox. Le morceau de documentation précédant immédiatement un morceau de code apparaît sur la même page
comme ce morceau de code à moins que cela ne viole la règle précédente.

maintenant n'insère pas de nouvelles lignes supplémentaires dans son Texas sortie, donc les numéros de ligne donnés dans Texas
les messages d'erreur sont les mêmes que ceux du fichier d'entrée.

maintenant a des options qui dictent le choix du formateur et qui prennent en charge différents formatages
idiomes et outils. Les options de base sont décrites ici ; options liées à l'indexation et
les informations de référence sont décrites dans la section INDEXATION ET REFERENCES.

-latex Émettre LaTeX, y compris le wrapper dans article style avec le pas de web paquet et page
style. (Défaut)

-Texas Émettre du TeX brut, y compris le wrapper avec nwmac macro.

-html Émettre du HTML à l'aide d'un wrapper HTML. Le rendu est inintéressant sans -indice or -x.
Les balises et , sur des lignes par eux-mêmes, produisent une liste de
morceaux et un index d'identifiants, respectivement. Si ces balises ne sont pas présentes,
la liste et l'index sont placés à la fin du fichier.

-latex+html
Supposons que les morceaux de documentation soient LaTeX, mais génèrent du HTML pour les morceaux de code, de manière appropriée
marqué donc conversion avec latex2html(1) donne un rendement raisonnable. Une enveloppe LaTeX
est implicite, mais peut être désactivé avec -n. Utilisez le of ceci. option is obsolète ; utilisé
-html avec -filtre l2h à la place.

-troff Émettre trof(1) balisage (sans wrapper). Le résultat doit être traité avec
Noroff(1). Rapports de bogues pour -troff à Aharon Robbins <[email protected]>.

-n N'utilisez aucun emballage (en-tête ou remorque). Cette option est utile lorsque maintenant's
la sortie fera partie d'un document plus volumineux. Voir également -retard.

-filtre cmd
Filtre le pas de web source à travers cmd après l'avoir converti en forme d'outil et avant
convertir en Texas. maintenant cherche des cmd d'abord sur l'utilisateur CHEMIN, puis dans
/usr/lib/noweb. De tels filtres peuvent être utilisés pour ajouter des fonctionnalités à maintenant; pour un
exemple, voir /usr/lib/noweb/noxref.krom. maintenant prend en charge jusqu'à quatre filtres ; une
peut obtenir plus par la ruse du shell, par exemple, -filtre "icon.filter | noidx"L’
-autodefs, -x, -indiceet -indexde les options sont implémentées en tant que filtres. Filtres
sont exécutés avec le shell eval commande, donc cmd doit être cité en conséquence.

-balisage analyseur
Utilisez le analyseur pour analyser le fichier d'entrée. Permet l'utilisation d'outils noweb sur des fichiers dans d'autres
formats ; par exemple, le balisage nu l'analyseur comprend nuweb(1) format. Voir
pas de filtres Web(7) pour plus d'informations. Pour connaisseurs seulement.

-Option opter
Ajoute \noweboptions{opter} à la Latex entête. Voir style noweb(1) pour des valeurs de opter.
Normalement utile uniquement avec le -latex option, mais -Option longxréf fait de la magie noire
avec -html.

-retard Par défaut, maintenant met le nom de fichier et d'autres informations dans la sortie avant le
première partie du programme. -retard retarde cette information jusqu'après le premier
morceau de documentation, faisant agir un peu comme le WEB ``limbo.'' L'option est
généralement utilisé pour permettre à un utilisateur de mettre un Latex \classe de documents commander
et d'autres éléments de préambule dans le premier bloc de documentation (c'est-à-dire, avant le
premier signe @). Cette option force également les informations de recoupement de fin à
être émis juste avant le morceau final, plutôt qu'à la fin du document ; les
le morceau final devrait contenir \fin{document}. Le manuel de formation -retard option implique la
-n option.

-tk Développez les onglets avec des arrêts tous les k Colonnes. (La valeur par défaut consiste à étendre toutes les 8 colonnes.)

-t Copiez les onglets dans la sortie.

-v Imprimez le pipeline et les informations RCS sur l'erreur standard.

INDEXAGE ET RÉFÉRENCES CROISÉES

Lorsqu'il est utilisé avec Latex, trof, ou HTML, maintenant peut fournir une indexation et des références croisées
informations pour les morceaux et pour les identificateurs de langage de programmation. Définitions des identifiants
peut être marqué à la main en utilisant des backticks (`); les -filtre btdefn l'option reconnaît ces
marquages. Pour certaines langues, les définitions peuvent être trouvées automatiquement en utilisant le -autodefs
option. Cette section décrit les options d'indexation et de référence croisée ; ça pourrait bien être
sauté en première lecture.

-x Pour Latex, ajouter un numéro de page à chaque nom de morceau identifiant l'emplacement de ce
définition du morceau, et émettre des informations de référence croisée concernant les définitions et
les usages. Pour HTML, créer des liens hypertextes entre les usages et les définitions des morceaux.
Quand maintenant -x s'utilise avec Latex, la séquence de contrôle \nowebchunks s'étend à un
liste triée de tous les morceaux de code.

-indice Créez des informations de référence croisée (ou des liens hypertextes) pour des identifiants définis.
Les définitions sont celles trouvées dans les fichiers d'entrée par -autodefs langue ou
-filtrebtdefn. A besoin Latex or HTML. -indice implique -X; y compris les deux seront
générer une sortie d'apparence étrange. maintenant ne génère pas de références croisées à
identifiants qui apparaissent dans le code entre guillemets (@[[...@]]), mais il génère de l'hypertexte
liens. Lorsque maintenant -indice s'utilise avec Latex, la séquence de contrôle \nowwebindex
se développe en un index d'identifiants.

-indexde indice
J'aime -indice, mais les identifiants à indexer sont tirés du fichier indice. Voir
noindex (1).

-autodefs long
Découvrez automatiquement les définitions d'identifiants. Le code en morceaux doit être dans la langue
long. Permis longs varient mais peuvent inclure Texas or icône. Inutile sans -indice,
qu'il doit précéder.

-showautodefs
Afficher les valeurs de long utilisable avec -autodefs.

ERREUR MESSAGES

If pas enchevêtrer or maintenant rencontre un nom de morceau dans la documentation, il suppose que ce
indique une erreur, généralement une faute d'orthographe ``< >=''. D'autres messages d'erreur devraient être
explicite.

Il est incorrect de faire référence à un morceau qui n'est jamais défini, mais il est normal que les morceaux soient
défini et non utilisé.

EXEMPLES

Si vous avez du mal à digérer cette page de manuel, vous n'êtes pas seul. Voici quelques exemples pour
vous lancer. Je suppose que vous avez un foo.nw fichier avec un programme C en bloc < >
et un fichier d'en-tête en bloc < >, et que votre documentation est balisée à l'aide
latex(1). Je vais vous montrer comment construire des choses en utilisant les options les plus courantes.

Pour reconstruire votre source C, essayez
pas enchevêtrer -L -Rfoo.c foo.nw > foo.c
Pour reconstruire votre fichier d'en-tête, essayez
pas enchevêtrer -Rfoo.h foo.nw | cpif foo.h
Il y a ici deux compromis. Omettre -L Conserve #ligne de votre fichier d'en-tête, et
grâce à cpif empêche la réécriture de la commande foo.h sauf si le contenu a changé.
C'est donc un bon code à mettre dans une règle Makefile.

Pour créer un document imprimé, exécutez
maintenant -autodefs c -indice foo.nw > foo.tex
Si vous avez votre propre préambule, contenant \classe de documents et tout, vous aurez également besoin du
-retard option.

Pour créer une page Web, exécutez
maintenant -filtre l2h -autodefs c -indice -html foo.nw | htmltoc > toto.html
Amusez-vous!

Utilisez notangle en ligne en utilisant les services onworks.net