128 lines
5.6 KiB
HTML
128 lines
5.6 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>M/spl</title>
|
|
<meta name="viewport" content="width=device-width initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta http-equiv="Content-Language" content="en-gb">
|
|
<link href="../inweb.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
</head>
|
|
<body>
|
|
<nav role="navigation">
|
|
<h1><a href="../webs.html">Sources</a></h1>
|
|
<ul>
|
|
<li><a href="../inweb/index.html">inweb</a></li>
|
|
</ul>
|
|
<h2>Foundation</h2>
|
|
<ul>
|
|
<li><a href="../foundation-module/index.html">foundation-module</a></li>
|
|
<li><a href="../foundation-test/index.html">foundation-test</a></li>
|
|
</ul>
|
|
|
|
|
|
</nav>
|
|
<main role="main">
|
|
|
|
<!--Weave of 'M/rc' generated by 7-->
|
|
<ul class="crumbs"><li><a href="../webs.html">Source</a></li><li><a href="index.html">inweb</a></li><li><a href="index.html#M">Manual</a></li><li><b>Reference Card</b></li></ul><p class="purpose">The current help information as it would be printed at the command line.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP1"></a><b>§1. </b>Running Inweb with <code class="display"><span class="extract">-help</span></code> currently produces the following summary:
|
|
</p>
|
|
|
|
<pre>
|
|
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)
|
|
|
|
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
|
|
|
|
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
|
|
-sequential name woven leaves with sequential numbering (default is -no-sequential)
|
|
-weave weave the web into human-readable form
|
|
-weave-as X set weave pattern to X (default is 'HTML')
|
|
-weave-docs weave the web for use at GitHub Pages
|
|
-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
|
|
|
|
-at X specify that this tool is installed at X
|
|
-crash intentionally crash on internal errors, for backtracing (default is -no-crash)
|
|
-fixtime pretend the time is 11 a.m. on 28 March 2016 for testing (default is -no-fixtime)
|
|
-help print this help information
|
|
-log X write the debugging log to include diagnostics on X
|
|
-version print out version number
|
|
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"><a id="SP2"></a><b>§2. </b>Running Inweb with <code class="display"><span class="extract">-show-languages</span></code> currently produces the following list
|
|
of programming languages for which support is provided in the standard
|
|
distribution:
|
|
</p>
|
|
|
|
<pre>
|
|
Keyw of !reserved
|
|
Inweb can see the following programming language definitions:
|
|
|
|
Inform 7: The natural-language based language Inform 7
|
|
InC: The Inform-tools extension to the C programming language
|
|
Inform 6: The C-like interactive fiction language Inform 6
|
|
C++: The C++ programming language
|
|
None: For programs in languages not yet supported by Inweb
|
|
ILDF: The Inweb Language Definition File format
|
|
Plain Text: For text files which are not programs
|
|
Perl: The scripting language Perl 5
|
|
C: The C programming language
|
|
ACME: The ACME assembly language for 6502 and related CPUs
|
|
|
|
</pre>
|
|
|
|
<p class="inwebparagraph">It's easy to make new language definitions, and contributions of these are
|
|
welcome.
|
|
</p>
|
|
|
|
<hr class="tocbar">
|
|
<ul class="toc"><li><a href="M-spl.html">Back to 'Supporting Programming Languages'</a></li><li><i>(This section ends Manual.)</i></li></ul><hr class="tocbar">
|
|
<!--End of weave-->
|
|
</main>
|
|
</body>
|
|
</html>
|
|
|