2020-03-26 23:01:14 +00:00
|
|
|
inweb: a tool for literate programming
|
|
|
|
|
|
|
|
|
|
Usage: inweb WEB OPTIONS RANGE
|
|
|
|
|
|
|
|
|
|
WEB must be a directory holding a literate program (a 'web')
|
|
|
|
|
|
|
|
|
|
The legal RANGEs are:
|
|
|
|
|
all: complete web (the default if no TARGETS set)
|
|
|
|
|
P: all preliminaries
|
|
|
|
|
1: Chapter 1 (and so on)
|
|
|
|
|
A: Appendix A (and so on, up to Appendix O)
|
|
|
|
|
3/eg: section with abbreviated name "3/eg" (and so on)
|
|
|
|
|
You can also, or instead, specify:
|
|
|
|
|
index: to weave an HTML page indexing the project
|
|
|
|
|
chapters: to weave all chapters as individual documents
|
|
|
|
|
sections: ditto with sections
|
|
|
|
|
|
|
|
|
|
-import-from X specify that imported modules are at pathname X
|
|
|
|
|
-verbose explain what inweb is doing (default is -no-verbose)
|
2020-04-05 17:37:43 +00:00
|
|
|
|
|
|
|
|
for locating programming language definitions:
|
|
|
|
|
-read-language X read language definition from file X
|
|
|
|
|
-read-languages X read all language definitions in path X
|
|
|
|
|
-show-languages list programming languages supported by Inweb
|
2020-04-06 23:53:26 +00:00
|
|
|
-test-language X test language X on...
|
|
|
|
|
-test-language-on X ...the code in the file X
|
2020-04-05 17:37:43 +00:00
|
|
|
|
|
|
|
|
for analysing a web:
|
|
|
|
|
-advance-build increment daily build code for the web
|
|
|
|
|
-advance-build-file X increment daily build code in file X
|
|
|
|
|
-catalog same as '-catalogue'
|
|
|
|
|
-catalogue list the sections in the web
|
|
|
|
|
-functions catalogue the functions in the web
|
|
|
|
|
-gitignore X write a .gitignore file for this web and store it in X
|
|
|
|
|
-makefile X write a makefile for this web and store it in X
|
|
|
|
|
-prototype X translate makefile from prototype X
|
|
|
|
|
-scan scan the web
|
|
|
|
|
-structures catalogue the structures in the web
|
|
|
|
|
-write-me X write a read-me file following instructions in file X
|
|
|
|
|
|
|
|
|
|
for weaving a web:
|
|
|
|
|
-breadcrumb X use the text X as a breadcrumb in overhead navigation
|
|
|
|
|
-navigation X use the file X as a column of navigation links
|
|
|
|
|
-open weave then open woven file
|
|
|
|
|
-weave weave the web into human-readable form
|
|
|
|
|
-weave-as X set weave pattern to X (default is 'HTML')
|
|
|
|
|
-weave-into X weave, but into directory X
|
|
|
|
|
-weave-tag X weave, but only using material tagged as X
|
|
|
|
|
-weave-to X weave, but to filename X (for single files only)
|
|
|
|
|
|
|
|
|
|
for tangling a web:
|
|
|
|
|
-tangle tangle the web into machine-compilable form
|
|
|
|
|
-tangle-to X tangle, but to filename X
|
2020-03-26 23:01:14 +00:00
|
|
|
|
2020-04-13 16:06:45 +00:00
|
|
|
for dealing with colonies of webs together:
|
|
|
|
|
-colony X use the file X as a list of webs in this colony
|
|
|
|
|
-member X use member X from the colony as our web
|
|
|
|
|
|
2020-03-26 23:01:14 +00:00
|
|
|
-at X specify that this tool is installed at X
|
2020-03-27 23:15:40 +00:00
|
|
|
-crash intentionally crash on internal errors, for backtracing (default is -no-crash)
|
2020-03-26 23:01:14 +00:00
|
|
|
-fixtime pretend the time is 11 a.m. on 28 March 2016 for testing (default is -no-fixtime)
|
|
|
|
|
-help print this help information
|
2020-07-04 19:28:54 +00:00
|
|
|
-locale X set locales as 'L=E', L being shell or console, E platform, utf-8 or iso-latin1
|
2020-03-26 23:01:14 +00:00
|
|
|
-log X write the debugging log to include diagnostics on X
|
|
|
|
|
-version print out version number
|
