1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-06-17 07:40:47 +03:00

Added reference cards

This commit is contained in:
Graham Nelson 2020-03-26 23:26:35 +00:00
parent 4054358914
commit 93ffb8b3d6
50 changed files with 876 additions and 10 deletions

View file

@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>M/tbl</title>
<title>M/rc</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">

64
docs/inblorb/M-rc.html Normal file
View file

@ -0,0 +1,64 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>M/tbl</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="../compiler.html">compiler</a></li>
<li><a href="../other.html"><b>other tools</b></a></li>
<li><a href="../extensions.html">extensions and kits</a></li>
<li><a href="../units.html">unit test tools</a></li>
</ul>
<h2>Other Tools</h2>
<ul>
<li><a href="../inblorb/index.html">inblorb</a></li>
<li><a href="../indoc/index.html">indoc</a></li>
<li><a href="../inpolicy/index.html">inpolicy</a></li>
<li><a href="../inrtps/index.html">inrtps</a></li>
</ul>
<h2>Foundation</h2>
<ul>
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</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="../other.html">Other Tools</a></li><li><a href="index.html">inblorb</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>&#167;1. </b>Running Inblorb with <code class="display"><span class="extract">-help</span></code> currently produces the following summary:
</p>
<pre>
inblorb: a releaser and packager for IF story files
usage: inblorb [-options] [blurbfile [blorbfile]]
-project X work within Inform project X
-verbose print running notes on what's happening (default is -no-verbose)
-at X specify that this tool is installed at X
-crash intentionally crash on internal errors, for debugger 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>
<hr class="tocbar">
<ul class="toc"><li><a href="M-tbl.html">Back to 'The Blurb Language'</a></li><li><i>(This section ends Manual.)</i></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>
</html>

View file

@ -725,7 +725,7 @@ text "Release along with..." sentences.
</p>
<hr class="tocbar">
<ul class="toc"><li><a href="M-ui.html">Back to 'Using Inblorb'</a></li><li><i>(This section ends Manual.)</i></li></ul><hr class="tocbar">
<ul class="toc"><li><a href="M-ui.html">Back to 'Using Inblorb'</a></li><li><a href="M-rc.html">Continue with 'Reference Card'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>

View file

@ -46,6 +46,10 @@
<p><a href="M-tbl.html"><spon class="sectiontitle">The Blurb Language</span></a> -
<span class="purpose">A specification for the Blurb language, which describes how to package up a work of interactive fiction.</span></p>
</li>
<li>
<p><a href="M-rc.html"><spon class="sectiontitle">Reference Card</span></a> -
<span class="purpose">The current help information as it would be printed at the command line.</span></p>
</li>
</ul>
</li>
<li>

View file

@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>M/ui</title>
<title>M/rc</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">

126
docs/inbuild/M-rc.html Normal file
View file

@ -0,0 +1,126 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>M/ui</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="../compiler.html"><b>compiler</b></a></li>
<li><a href="../other.html">other tools</a></li>
<li><a href="../extensions.html">extensions and kits</a></li>
<li><a href="../units.html">unit test tools</a></li>
</ul>
<h2>Compiler Webs</h2>
<ul>
<li><a href="../inbuild/index.html">inbuild</a></li>
<li><a href="../inform7/index.html">inform7</a></li>
<li><a href="../inter/index.html">inter</a></li>
</ul>
<h2>Inbuild Modules</h2>
<ul>
<li><a href="../inbuild-module/index.html">inbuild</a></li>
<li><a href="../arch-module/index.html">arch</a></li>
<li><a href="../words-module/index.html">words</a></li>
<li><a href="../syntax-module/index.html">syntax</a></li>
<li><a href="../html-module/index.html">html</a></li>
</ul>
<h2>Inform7 Modules</h2>
<ul>
<li><a href="../core-module/index.html">core</a></li>
<li><a href="../problems-module/index.html">problems</a></li>
<li><a href="../inflections-module/index.html">inflections</a></li>
<li><a href="../linguistics-module/index.html">linguistics</a></li>
<li><a href="../kinds-module/index.html">kinds</a></li>
<li><a href="../if-module/index.html">if</a></li>
<li><a href="../multimedia-module/index.html">multimedia</a></li>
<li><a href="../index-module/index.html">index</a></li>
</ul>
<h2>Inter Modules</h2>
<ul>
<li><a href="../inter-module/index.html">inter</a></li>
<li><a href="../building-module/index.html">building</a></li>
<li><a href="../codegen-module/index.html">codegen</a></li>
</ul>
<h2>Foundation</h2>
<ul>
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</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="../compiler.html">Compiler Tools</a></li><li><a href="index.html">inbuild</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>&#167;1. </b>Running Imuild with <code class="display"><span class="extract">-help</span></code> currently produces the following summary:
</p>
<pre>
A simple build and package manager for the Inform tools.
usage: inbuild [-TASK] TARGET1 TARGET2 ...
-archive sync copies of all extensions, kits and so on needed for -project into Materials
-archive-to X sync copies of all extensions, kits and so on needed into nest X
-build incrementally build target(s)
-build-missing show the extensions, kits and so on which are needed to build but missing
-build-needs show all the extensions, kits and so on needed to build
-build-trace show verbose reasoning during -build (default is -no-build-trace)
-contents-of X apply to all targets in the directory X
-copy-to X copy target(s) to nest X
-dry make this a dry run (print but do not execute shell commands) (default is -no-dry)
-graph show dependency graph of target(s) but take no action
-inspect show target(s) but take no action
-matching X apply to all works in nest(s) matching requirement X
-rebuild completely rebuild target(s)
-sync-to X forcibly copy target(s) to nest X, even if prior version already there
-tools X make X the directory of intools executables, and exit developer mode
-unit-test X perform unit test X (for debugging inbuild only)
-use-missing show the extensions, kits and so on which are needed to use but missing
-use-needs show all the extensions, kits and so on needed to use
for translating Inform source text to Inter:
-case X make any source links refer to the source in extension example X
-census perform an extensions census (default is -no-census)
-debug compile with debugging features even on a Release (default is -no-debug)
-format=X compile I6 code suitable for the virtual machine X
-project X work within the Inform project X
-release compile a version suitable for a Release build (default is -no-release)
-rng fix the random number generator of the story file (for testing) (default is -no-rng)
-source X use file X as the Inform source text
for locating resources in the file system:
-external X use X as the user's home for installed material such as extensions
-internal X use X as the location of built-in material such as the Standard Rules
-nest X add the nest at pathname X to the search list
-transient X use X for transient data such as the extensions census
for tweaking code generation from Inter:
-kit X include Inter code from the kit called X
-pipeline X specify code-generation pipeline
-pipeline-file X specify code-generation pipeline from file X
-variable X set pipeline variable X (in form name=value)
-at X specify that this tool is installed at X
-crash intentionally crash on internal errors, for debugger 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>
<hr class="tocbar">
<ul class="toc"><li><a href="M-ui.html">Back to 'Using Inbuild'</a></li><li><i>(This section ends Manual.)</i></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>
</html>

View file

@ -714,6 +714,7 @@ the project will still work exactly as it originally did.
</p>
<hr class="tocbar">
<ul class="toc"><li><i>(This section begins Manual.)</i></li><li><a href="M-rc.html">Continue with 'Reference Card'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>

View file

@ -66,6 +66,10 @@
<p><a href="M-ui.html"><spon class="sectiontitle">Using Inbuild</span></a> -
<span class="purpose">An introduction to the use of Inbuild on the command line.</span></p>
</li>
<li>
<p><a href="M-rc.html"><spon class="sectiontitle">Reference Card</span></a> -
<span class="purpose">The current help information as it would be printed at the command line.</span></p>
</li>
</ul>
</li>
<li>

View file

@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>M/dm</title>
<title>M/rc</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">

View file

@ -734,7 +734,7 @@ altogether from the Recipe Book. (Inform omits about 12 of these.)
</p>
<hr class="tocbar">
<ul class="toc"><li><a href="M-vai.html">Back to 'Volumes and Instructions'</a></li><li><i>(This section ends Manual.)</i></li></ul><hr class="tocbar">
<ul class="toc"><li><a href="M-vai.html">Back to 'Volumes and Instructions'</a></li><li><a href="M-rc.html">Continue with 'Reference Card'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>

71
docs/indoc/M-rc.html Normal file
View file

@ -0,0 +1,71 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>M/dm</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="../compiler.html">compiler</a></li>
<li><a href="../other.html"><b>other tools</b></a></li>
<li><a href="../extensions.html">extensions and kits</a></li>
<li><a href="../units.html">unit test tools</a></li>
</ul>
<h2>Other Tools</h2>
<ul>
<li><a href="../inblorb/index.html">inblorb</a></li>
<li><a href="../indoc/index.html">indoc</a></li>
<li><a href="../inpolicy/index.html">inpolicy</a></li>
<li><a href="../inrtps/index.html">inrtps</a></li>
</ul>
<h2>Foundation</h2>
<ul>
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</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="../other.html">Other Tools</a></li><li><a href="index.html">indoc</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>&#167;1. </b>Running Indoc with <code class="display"><span class="extract">-help</span></code> currently produces the following summary:
</p>
<pre>
indoc 4 (Inform Tools Suite)
indoc: a tool for rendering Inform documentation
Usage: indoc [OPTIONS] TARGET
where TARGET must be one of those set up in the instructions.
-from X use documentation in directory X (instead of 'Documentation' in cwd)
-insertion X insert HTML in file X at the top of each page head
-instructions X read further instructions from file X
-test-index test indexing (default is -no-test-index)
-to X redirect output to folder X (which must already exist)
-verbose explain what indoc is doing (default is -no-verbose)
-xrefs X write a file of documentation cross-references to filename X
-at X specify that this tool is installed at X
-crash intentionally crash on internal errors, for debugger 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>
<hr class="tocbar">
<ul class="toc"><li><a href="M-dm.html">Back to 'Documentation Markup'</a></li><li><i>(This section ends Manual.)</i></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>
</html>

View file

@ -50,6 +50,10 @@
<p><a href="M-dm.html"><spon class="sectiontitle">Documentation Markup</span></a> -
<span class="purpose">How to mark up the plain-text source for Inform documentation.</span></p>
</li>
<li>
<p><a href="M-rc.html"><spon class="sectiontitle">Reference Card</span></a> -
<span class="purpose">The current help information as it would be printed at the command line.</span></p>
</li>
</ul>
</li>
<li>

View file

@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>M/cu</title>
<title>M/rc</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">

View file

@ -238,6 +238,7 @@ had been worked into the verification process for builds. The history since
</p>
<hr class="tocbar">
<ul class="toc"><li><i>(This section begins Manual.)</i></li><li><a href="M-rc.html">Continue with 'Reference Card'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>

115
docs/inform7/M-rc.html Normal file
View file

@ -0,0 +1,115 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>M/cu</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="../compiler.html"><b>compiler</b></a></li>
<li><a href="../other.html">other tools</a></li>
<li><a href="../extensions.html">extensions and kits</a></li>
<li><a href="../units.html">unit test tools</a></li>
</ul>
<h2>Compiler Webs</h2>
<ul>
<li><a href="../inbuild/index.html">inbuild</a></li>
<li><a href="../inform7/index.html">inform7</a></li>
<li><a href="../inter/index.html">inter</a></li>
</ul>
<h2>Inbuild Modules</h2>
<ul>
<li><a href="../inbuild-module/index.html">inbuild</a></li>
<li><a href="../arch-module/index.html">arch</a></li>
<li><a href="../words-module/index.html">words</a></li>
<li><a href="../syntax-module/index.html">syntax</a></li>
<li><a href="../html-module/index.html">html</a></li>
</ul>
<h2>Inform7 Modules</h2>
<ul>
<li><a href="../core-module/index.html">core</a></li>
<li><a href="../problems-module/index.html">problems</a></li>
<li><a href="../inflections-module/index.html">inflections</a></li>
<li><a href="../linguistics-module/index.html">linguistics</a></li>
<li><a href="../kinds-module/index.html">kinds</a></li>
<li><a href="../if-module/index.html">if</a></li>
<li><a href="../multimedia-module/index.html">multimedia</a></li>
<li><a href="../index-module/index.html">index</a></li>
</ul>
<h2>Inter Modules</h2>
<ul>
<li><a href="../inter-module/index.html">inter</a></li>
<li><a href="../building-module/index.html">building</a></li>
<li><a href="../codegen-module/index.html">codegen</a></li>
</ul>
<h2>Foundation</h2>
<ul>
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</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="../compiler.html">Compiler Tools</a></li><li><a href="index.html">inform7</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>&#167;1. </b>Running Inform7 with <code class="display"><span class="extract">-help</span></code> currently produces the following summary:
</p>
<pre>
Inform 7 v10.1.0 has started.
inform7: a compiler from source text to Inter code
Usage: inform7 [OPTIONS]
for translating Inform source text to Inter:
-case X make any source links refer to the source in extension example X
-census perform an extensions census (default is -no-census)
-debug compile with debugging features even on a Release (default is -no-debug)
-format=X compile I6 code suitable for the virtual machine X
-project X work within the Inform project X
-release compile a version suitable for a Release build (default is -no-release)
-rng fix the random number generator of the story file (for testing) (default is -no-rng)
-source X use file X as the Inform source text
for locating resources in the file system:
-external X use X as the user's home for installed material such as extensions
-internal X use X as the location of built-in material such as the Standard Rules
-nest X add the nest at pathname X to the search list
-transient X use X for transient data such as the extensions census
for tweaking code generation from Inter:
-kit X include Inter code from the kit called X
-pipeline X specify code-generation pipeline
-pipeline-file X specify code-generation pipeline from file X
-variable X set pipeline variable X (in form name=value)
for testing and debugging inform7:
-crash-all intentionally crash on Problem messages, for debugger backtracing (default is -no-crash-all)
-no-index don't produce an Index (default is -index)
-no-progress don't display progress percentages (default is -progress)
-require-problem X return 0 unless exactly this Problem message is generated
-sigils print Problem message sigils (default is -no-sigils)
-at X specify that this tool is installed at X
-crash intentionally crash on internal errors, for debugger 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>
<hr class="tocbar">
<ul class="toc"><li><a href="M-cu.html">Back to 'Command-Line Usage'</a></li><li><i>(This section ends Manual.)</i></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>
</html>

View file

@ -66,6 +66,10 @@
<p><a href="M-cu.html"><spon class="sectiontitle">Command-Line Usage</span></a> -
<span class="purpose">A brief note on using Inform 7 at the command line.</span></p>
</li>
<li>
<p><a href="M-rc.html"><spon class="sectiontitle">Reference Card</span></a> -
<span class="purpose">The current help information as it would be printed at the command line.</span></p>
</li>
</ul>
</li>
<li>

View file

@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>M/ui</title>
<title>M/rc</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">

65
docs/inpolicy/M-rc.html Normal file
View file

@ -0,0 +1,65 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>M/ui</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="../compiler.html">compiler</a></li>
<li><a href="../other.html"><b>other tools</b></a></li>
<li><a href="../extensions.html">extensions and kits</a></li>
<li><a href="../units.html">unit test tools</a></li>
</ul>
<h2>Other Tools</h2>
<ul>
<li><a href="../inblorb/index.html">inblorb</a></li>
<li><a href="../indoc/index.html">indoc</a></li>
<li><a href="../inpolicy/index.html">inpolicy</a></li>
<li><a href="../inrtps/index.html">inrtps</a></li>
</ul>
<h2>Foundation</h2>
<ul>
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</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="../other.html">Other Tools</a></li><li><a href="index.html">inpolicy</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>&#167;1. </b>Running Inpolicy with <code class="display"><span class="extract">-help</span></code> currently produces the following summary:
</p>
<pre>
A lint-like tool to check up on various policies used in Inform source code.
usage: inpolicy [options]
-check-problems check problem test case coverage
-silence print nothing unless there's something wrong (default is -no-silence)
-verbose explain what inpolicy is doing (default is -no-verbose)
-at X specify that this tool is installed at X
-crash intentionally crash on internal errors, for debugger 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>
<hr class="tocbar">
<ul class="toc"><li><a href="M-ui.html">Back to 'Using Inpolicy'</a></li><li><i>(This section ends Manual.)</i></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>
</html>

View file

@ -113,6 +113,7 @@ attempts to match these up. It prints out a report, and concludes with either
</p>
<hr class="tocbar">
<ul class="toc"><li><i>(This section begins Manual.)</i></li><li><a href="M-rc.html">Continue with 'Reference Card'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>

View file

@ -42,6 +42,10 @@
<p><a href="M-ui.html"><spon class="sectiontitle">Using Inpolicy</span></a> -
<span class="purpose">A very short guide to a very small program.</span></p>
</li>
<li>
<p><a href="M-rc.html"><spon class="sectiontitle">Reference Card</span></a> -
<span class="purpose">The current help information as it would be printed at the command line.</span></p>
</li>
</ul>
</li>
<li>

View file

@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>M/ui</title>
<title>M/rc</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">

63
docs/inrtps/M-rc.html Normal file
View file

@ -0,0 +1,63 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>M/ui</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="../compiler.html">compiler</a></li>
<li><a href="../other.html"><b>other tools</b></a></li>
<li><a href="../extensions.html">extensions and kits</a></li>
<li><a href="../units.html">unit test tools</a></li>
</ul>
<h2>Other Tools</h2>
<ul>
<li><a href="../inblorb/index.html">inblorb</a></li>
<li><a href="../indoc/index.html">indoc</a></li>
<li><a href="../inpolicy/index.html">inpolicy</a></li>
<li><a href="../inrtps/index.html">inrtps</a></li>
</ul>
<h2>Foundation</h2>
<ul>
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</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="../other.html">Other Tools</a></li><li><a href="index.html">inrtps</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>&#167;1. </b>Running Inrtps with <code class="display"><span class="extract">-help</span></code> currently produces the following summary:
</p>
<pre>
A generator of HTML pages to show for run-time problem messages in Inform.
usage: inrtps from-folder to-folder [options]
-no-font don't explicitly set sans-serif fonts by name (default is -font)
-at X specify that this tool is installed at X
-crash intentionally crash on internal errors, for debugger 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>
<hr class="tocbar">
<ul class="toc"><li><a href="M-ui.html">Back to 'Using Inrtps'</a></li><li><i>(This section ends Manual.)</i></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>
</html>

View file

@ -133,6 +133,7 @@ escape codes, which Inrtps expands. Thus:
blank if <code class="display"><span class="extract">nofont</span></code> is set, or will choose a Helvetica-like font if <code class="display"><span class="extract">font</span></code> is set.)
</li></ul>
<hr class="tocbar">
<ul class="toc"><li><i>(This section begins Manual.)</i></li><li><a href="M-rc.html">Continue with 'Reference Card'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>

View file

@ -42,6 +42,10 @@
<p><a href="M-ui.html"><spon class="sectiontitle">Using Inrtps</span></a> -
<span class="purpose">A brief user guide.</span></p>
</li>
<li>
<p><a href="M-rc.html"><spon class="sectiontitle">Reference Card</span></a> -
<span class="purpose">The current help information as it would be printed at the command line.</span></p>
</li>
</ul>
</li>
<li>

View file

@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>M/pas</title>
<title>M/rc</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">

View file

@ -501,7 +501,7 @@ the description.
</p>
<hr class="tocbar">
<ul class="toc"><li><a href="M-io.html">Back to 'Inform Organisation'</a></li><li><i>(This section ends Manual.)</i></li></ul><hr class="tocbar">
<ul class="toc"><li><a href="M-io.html">Back to 'Inform Organisation'</a></li><li><a href="M-rc.html">Continue with 'Reference Card'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>

96
docs/inter/M-rc.html Normal file
View file

@ -0,0 +1,96 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>M/pas</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="../compiler.html"><b>compiler</b></a></li>
<li><a href="../other.html">other tools</a></li>
<li><a href="../extensions.html">extensions and kits</a></li>
<li><a href="../units.html">unit test tools</a></li>
</ul>
<h2>Compiler Webs</h2>
<ul>
<li><a href="../inbuild/index.html">inbuild</a></li>
<li><a href="../inform7/index.html">inform7</a></li>
<li><a href="../inter/index.html">inter</a></li>
</ul>
<h2>Inbuild Modules</h2>
<ul>
<li><a href="../inbuild-module/index.html">inbuild</a></li>
<li><a href="../arch-module/index.html">arch</a></li>
<li><a href="../words-module/index.html">words</a></li>
<li><a href="../syntax-module/index.html">syntax</a></li>
<li><a href="../html-module/index.html">html</a></li>
</ul>
<h2>Inform7 Modules</h2>
<ul>
<li><a href="../core-module/index.html">core</a></li>
<li><a href="../problems-module/index.html">problems</a></li>
<li><a href="../inflections-module/index.html">inflections</a></li>
<li><a href="../linguistics-module/index.html">linguistics</a></li>
<li><a href="../kinds-module/index.html">kinds</a></li>
<li><a href="../if-module/index.html">if</a></li>
<li><a href="../multimedia-module/index.html">multimedia</a></li>
<li><a href="../index-module/index.html">index</a></li>
</ul>
<h2>Inter Modules</h2>
<ul>
<li><a href="../inter-module/index.html">inter</a></li>
<li><a href="../building-module/index.html">building</a></li>
<li><a href="../codegen-module/index.html">codegen</a></li>
</ul>
<h2>Foundation</h2>
<ul>
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</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="../compiler.html">Compiler Tools</a></li><li><a href="index.html">inter</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>&#167;1. </b>Running Inter with <code class="display"><span class="extract">-help</span></code> currently produces the following summary:
</p>
<pre>
For handling intermediate Inform code.
usage: inter file1 file2 ... [options]
-architecture X generate inter with architecture X
-assimilate X assimilate I6T code into inter inside template X
-binary X write to file X in binary format
-domain X specify folder to read/write inter files from/to
-pipeline X specify pipeline textually
-pipeline-file X specify pipeline from file X
-template X specify folder holding i6t template files
-test X perform unit tests from file X
-textual X write to file X in textual format
-variable X set pipeline variable X (in form name=value)
-at X specify that this tool is installed at X
-crash intentionally crash on internal errors, for debugger 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>
<hr class="tocbar">
<ul class="toc"><li><a href="M-pas.html">Back to 'Pipelines and Stages'</a></li><li><i>(This section ends Manual.)</i></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>
</html>

View file

@ -94,6 +94,10 @@
<p><a href="M-pas.html"><spon class="sectiontitle">Pipelines and Stages</span></a> -
<span class="purpose">Sequences of named code-generation stages are called pipelines.</span></p>
</li>
<li>
<p><a href="M-rc.html"><spon class="sectiontitle">Reference Card</span></a> -
<span class="purpose">The current help information as it would be printed at the command line.</span></p>
</li>
</ul>
</li>
<li>

View file

@ -11,6 +11,7 @@ Import: foundation
Manual
Using Inblorb
The Blurb Language
Reference Card
Chapter 1: Blurbs
"A little infrastructure, but basically, parsing of our instructions."

13
inblorb/Figures/help.txt Normal file
View file

@ -0,0 +1,13 @@
inblorb: a releaser and packager for IF story files
usage: inblorb [-options] [blurbfile [blorbfile]]
-project X work within Inform project X
-verbose print running notes on what's happening (default is -no-verbose)
-at X specify that this tool is installed at X
-crash intentionally crash on internal errors, for debugger 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

View file

@ -0,0 +1,7 @@
Reference Card.
The current help information as it would be printed at the command line.
@ Running Inblorb with |-help| currently produces the following summary:
[[help.txt]]

View file

@ -15,6 +15,7 @@ Import: inbuild
Manual
Using Inbuild
Reference Card
Chapter 1: Inbuild outside of Inform
Main

51
inbuild/Figures/help.txt Normal file
View file

@ -0,0 +1,51 @@
A simple build and package manager for the Inform tools.
usage: inbuild [-TASK] TARGET1 TARGET2 ...
-archive sync copies of all extensions, kits and so on needed for -project into Materials
-archive-to X sync copies of all extensions, kits and so on needed into nest X
-build incrementally build target(s)
-build-missing show the extensions, kits and so on which are needed to build but missing
-build-needs show all the extensions, kits and so on needed to build
-build-trace show verbose reasoning during -build (default is -no-build-trace)
-contents-of X apply to all targets in the directory X
-copy-to X copy target(s) to nest X
-dry make this a dry run (print but do not execute shell commands) (default is -no-dry)
-graph show dependency graph of target(s) but take no action
-inspect show target(s) but take no action
-matching X apply to all works in nest(s) matching requirement X
-rebuild completely rebuild target(s)
-sync-to X forcibly copy target(s) to nest X, even if prior version already there
-tools X make X the directory of intools executables, and exit developer mode
-unit-test X perform unit test X (for debugging inbuild only)
-use-missing show the extensions, kits and so on which are needed to use but missing
-use-needs show all the extensions, kits and so on needed to use
for translating Inform source text to Inter:
-case X make any source links refer to the source in extension example X
-census perform an extensions census (default is -no-census)
-debug compile with debugging features even on a Release (default is -no-debug)
-format=X compile I6 code suitable for the virtual machine X
-project X work within the Inform project X
-release compile a version suitable for a Release build (default is -no-release)
-rng fix the random number generator of the story file (for testing) (default is -no-rng)
-source X use file X as the Inform source text
for locating resources in the file system:
-external X use X as the user's home for installed material such as extensions
-internal X use X as the location of built-in material such as the Standard Rules
-nest X add the nest at pathname X to the search list
-transient X use X for transient data such as the extensions census
for tweaking code generation from Inter:
-kit X include Inter code from the kit called X
-pipeline X specify code-generation pipeline
-pipeline-file X specify code-generation pipeline from file X
-variable X set pipeline variable X (in form name=value)
-at X specify that this tool is installed at X
-crash intentionally crash on internal errors, for debugger 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

View file

@ -0,0 +1,7 @@
Reference Card.
The current help information as it would be printed at the command line.
@ Running Imuild with |-help| currently produces the following summary:
[[help.txt]]

View file

@ -12,6 +12,7 @@ Manual
Introduction to Indoc
Volumes and Instructions
Documentation Markup
Reference Card
Chapter 1: Setting Up
Basics

20
indoc/Figures/help.txt Normal file
View file

@ -0,0 +1,20 @@
indoc 4 (Inform Tools Suite)
indoc: a tool for rendering Inform documentation
Usage: indoc [OPTIONS] TARGET
where TARGET must be one of those set up in the instructions.
-from X use documentation in directory X (instead of 'Documentation' in cwd)
-insertion X insert HTML in file X at the top of each page head
-instructions X read further instructions from file X
-test-index test indexing (default is -no-test-index)
-to X redirect output to folder X (which must already exist)
-verbose explain what indoc is doing (default is -no-verbose)
-xrefs X write a file of documentation cross-references to filename X
-at X specify that this tool is installed at X
-crash intentionally crash on internal errors, for debugger 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

View file

@ -0,0 +1,7 @@
Reference Card.
The current help information as it would be printed at the command line.
@ Running Indoc with |-help| currently produces the following summary:
[[help.txt]]

View file

@ -27,6 +27,7 @@ Import: index
Manual
Command-Line Usage
Reference Card
Chapter 1: Delegation
Main

40
inform7/Figures/help.txt Normal file
View file

@ -0,0 +1,40 @@
Inform 7 v10.1.0 has started.
inform7: a compiler from source text to Inter code
Usage: inform7 [OPTIONS]
for translating Inform source text to Inter:
-case X make any source links refer to the source in extension example X
-census perform an extensions census (default is -no-census)
-debug compile with debugging features even on a Release (default is -no-debug)
-format=X compile I6 code suitable for the virtual machine X
-project X work within the Inform project X
-release compile a version suitable for a Release build (default is -no-release)
-rng fix the random number generator of the story file (for testing) (default is -no-rng)
-source X use file X as the Inform source text
for locating resources in the file system:
-external X use X as the user's home for installed material such as extensions
-internal X use X as the location of built-in material such as the Standard Rules
-nest X add the nest at pathname X to the search list
-transient X use X for transient data such as the extensions census
for tweaking code generation from Inter:
-kit X include Inter code from the kit called X
-pipeline X specify code-generation pipeline
-pipeline-file X specify code-generation pipeline from file X
-variable X set pipeline variable X (in form name=value)
for testing and debugging inform7:
-crash-all intentionally crash on Problem messages, for debugger backtracing (default is -no-crash-all)
-no-index don't produce an Index (default is -index)
-no-progress don't display progress percentages (default is -progress)
-require-problem X return 0 unless exactly this Problem message is generated
-sigils print Problem message sigils (default is -no-sigils)
-at X specify that this tool is installed at X
-crash intentionally crash on internal errors, for debugger 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

View file

@ -0,0 +1,7 @@
Reference Card.
The current help information as it would be printed at the command line.
@ Running Inform7 with |-help| currently produces the following summary:
[[help.txt]]

View file

@ -10,6 +10,7 @@ Import: foundation
Manual
Using Inpolicy
Reference Card
Chapter 1: Setting Up
Basics

14
inpolicy/Figures/help.txt Normal file
View file

@ -0,0 +1,14 @@
A lint-like tool to check up on various policies used in Inform source code.
usage: inpolicy [options]
-check-problems check problem test case coverage
-silence print nothing unless there's something wrong (default is -no-silence)
-verbose explain what inpolicy is doing (default is -no-verbose)
-at X specify that this tool is installed at X
-crash intentionally crash on internal errors, for debugger 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

View file

@ -0,0 +1,7 @@
Reference Card.
The current help information as it would be printed at the command line.
@ Running Inpolicy with |-help| currently produces the following summary:
[[help.txt]]

View file

@ -10,6 +10,7 @@ Import: foundation
Manual
Using Inrtps
Reference Card
Chapter 1: The Whole Shooting Match
Main

12
inrtps/Figures/help.txt Normal file
View file

@ -0,0 +1,12 @@
A generator of HTML pages to show for run-time problem messages in Inform.
usage: inrtps from-folder to-folder [options]
-no-font don't explicitly set sans-serif fonts by name (default is -font)
-at X specify that this tool is installed at X
-crash intentionally crash on internal errors, for debugger 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

View file

@ -0,0 +1,7 @@
Reference Card.
The current help information as it would be printed at the command line.
@ Running Inrtps with |-help| currently produces the following summary:
[[help.txt]]

View file

@ -23,6 +23,7 @@ Manual
Inform Annotations
Inform Organisation
Pipelines and Stages
Reference Card
Chapter 1: Delegation
Basics

21
inter/Figures/help.txt Normal file
View file

@ -0,0 +1,21 @@
For handling intermediate Inform code.
usage: inter file1 file2 ... [options]
-architecture X generate inter with architecture X
-assimilate X assimilate I6T code into inter inside template X
-binary X write to file X in binary format
-domain X specify folder to read/write inter files from/to
-pipeline X specify pipeline textually
-pipeline-file X specify pipeline from file X
-template X specify folder holding i6t template files
-test X perform unit tests from file X
-textual X write to file X in textual format
-variable X set pipeline variable X (in form name=value)
-at X specify that this tool is installed at X
-crash intentionally crash on internal errors, for debugger 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

View file

@ -0,0 +1,7 @@
Reference Card.
The current help information as it would be printed at the command line.
@ Running Inter with |-help| currently produces the following summary:
[[help.txt]]

View file

@ -384,8 +384,10 @@ pages:
rm docs/EnglishLanguageKit/*.html
$(INWEBX) inform7/Internal/Inter/EnglishLanguageKit -weave-docs -weave-into docs/EnglishLanguageKit -navigation docs/docs-src/navk.html -breadcrumb 'Source:../webs.html' -breadcrumb 'Kits:../extensions.html'
rm docs/inblorb/*.html
$(INBLORBX) -help >inblorb/Figures/help.txt
$(INWEBX) inblorb -weave-docs -weave-into docs/inblorb -navigation docs/docs-src/navo.html -breadcrumb 'Source:../webs.html' -breadcrumb 'Other Tools:../other.html'
rm docs/inbuild/*.html
$(INBUILDX) -help >inbuild/Figures/help.txt
$(INWEBX) inbuild -weave-docs -weave-into docs/inbuild -navigation docs/docs-src/navc.html -breadcrumb 'Source:../webs.html' -breadcrumb 'Compiler Tools:../compiler.html'
rm docs/arch-module/*.html
$(INWEBX) inbuild/arch-module -weave-docs -weave-into docs/arch-module -navigation docs/docs-src/navc.html -breadcrumb 'Source:../webs.html' -breadcrumb 'Compiler Modules:../compiler.html'
@ -402,8 +404,10 @@ pages:
rm docs/html-module/*.html
$(INWEBX) inbuild/html-module -weave-docs -weave-into docs/html-module -navigation docs/docs-src/navc.html -breadcrumb 'Source:../webs.html' -breadcrumb 'Compiler Modules:../compiler.html'
rm docs/indoc/*.html
$(INDOCX) -help >indoc/Figures/help.txt
$(INWEBX) indoc -weave-docs -weave-into docs/indoc -navigation docs/docs-src/navo.html -breadcrumb 'Source:../webs.html' -breadcrumb 'Other Tools:../other.html'
rm docs/inform7/*.html
$(INFORM7X) -help >inform7/Figures/help.txt
$(INWEBX) inform7 -weave-docs -weave-into docs/inform7 -navigation docs/docs-src/navc.html -breadcrumb 'Source:../webs.html' -breadcrumb 'Compiler Tools:../compiler.html'
rm docs/core-module/*.html
$(INWEBX) inform7/core-module -weave-docs -weave-into docs/core-module -navigation docs/docs-src/navc.html -breadcrumb 'Source:../webs.html' -breadcrumb 'Compiler Modules:../compiler.html'
@ -430,10 +434,13 @@ pages:
rm docs/problems-test/*.html
$(INWEBX) inform7/problems-test -weave-docs -weave-into docs/problems-test -navigation docs/docs-src/navu.html -breadcrumb 'Source:../webs.html' -breadcrumb 'Unit Test Tools:../units.html'
rm docs/inpolicy/*.html
$(INPOLICYX) -help >inpolicy/Figures/help.txt
$(INWEBX) inpolicy -weave-docs -weave-into docs/inpolicy -navigation docs/docs-src/navo.html -breadcrumb 'Source:../webs.html' -breadcrumb 'Other Tools:../other.html'
rm docs/inrtps/*.html
$(INRTPSX) -help >inrtps/Figures/help.txt
$(INWEBX) inrtps -weave-docs -weave-into docs/inrtps -navigation docs/docs-src/navo.html -breadcrumb 'Source:../webs.html' -breadcrumb 'Other Tools:../other.html'
rm docs/inter/*.html
$(INTERX) -help >inter/Figures/help.txt
$(INWEBX) inter -weave-docs -weave-into docs/inter -navigation docs/docs-src/navc.html -breadcrumb 'Source:../webs.html' -breadcrumb 'Compiler Tools:../compiler.html'
rm docs/inter-module/*.html
$(INWEBX) inter/inter-module -weave-docs -weave-into docs/inter-module -navigation docs/docs-src/navc.html -breadcrumb 'Source:../webs.html' -breadcrumb 'Compiler Modules:../compiler.html'