mirror of
https://github.com/ganelson/inform.git
synced 2024-05-03 17:49:39 +03:00
131 lines
10 KiB
HTML
131 lines
10 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>Reference Card</title>
|
|
<link href="../docs-assets/Breadcrumbs.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<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="../docs-assets/Contents.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<link href="../docs-assets/Progress.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<link href="../docs-assets/Navigation.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<link href="../docs-assets/Fonts.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<link href="../docs-assets/Base.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<link href="../docs-assets/Colours.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
|
|
</head>
|
|
<body class="commentary-font">
|
|
<nav role="navigation">
|
|
<h1><a href="../index.html">
|
|
<img src="../docs-assets/Inform.png" height=72">
|
|
</a></h1>
|
|
<ul><li><a href="../index.html">home</a></li>
|
|
</ul><h2>Compiler</h2><ul>
|
|
<li><a href="../structure.html">structure</a></li>
|
|
<li><a href="../inbuildn.html">inbuild</a></li>
|
|
<li><a href="../inform7n.html">inform7</a></li>
|
|
<li><a href="../intern.html">inter</a></li>
|
|
<li><a href="../services.html">services</a></li>
|
|
<li><a href="../secrets.html">secrets</a></li>
|
|
</ul><h2>Other Tools</h2><ul>
|
|
<li><a href="../inblorbn.html">inblorb</a></li>
|
|
<li><a href="../indocn.html">indoc</a></li>
|
|
<li><a href="../inform6.html">inform6</a></li>
|
|
<li><a href="../inpolicyn.html">inpolicy</a></li>
|
|
<li><a href="../inrtpsn.html">inrtps</a></li>
|
|
</ul><h2>Resources</h2><ul>
|
|
<li><a href="../extensions.html">extensions</a></li>
|
|
<li><a href="../kits.html">kits</a></li>
|
|
</ul><h2>Repository</h2><ul>
|
|
<li><a href="https://github.com/ganelson/inform"><img src="../docs-assets/github.png" height=18> github</a></li>
|
|
</ul><h2>Related Projects</h2><ul>
|
|
<li><a href="../../../inweb/index.html">inweb</a></li>
|
|
<li><a href="../../../intest/index.html">intest</a></li>
|
|
|
|
</ul>
|
|
</nav>
|
|
<main role="main">
|
|
<!--Weave of 'Reference Card' generated by Inweb-->
|
|
<div class="breadcrumbs">
|
|
<ul class="crumbs"><li><a href="../index.html">Home</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></div>
|
|
<p class="purpose">The current help information as it would be printed at the command line.</p>
|
|
|
|
<p class="commentary firstcommentary"><a id="SP1" class="paragraph-anchor"></a><b>§1. </b>Running Inbuild with <span class="extract"><span class="extract-syntax">-help</span></span> currently produces the following summary.
|
|
Note that Inbuild shares a number of command-line options with Inform7,
|
|
and those not documented in this manual are covered in that one.
|
|
</p>
|
|
|
|
<pre class="undisplayed-code all-displayed-code code-font">
|
|
<span class="plain-syntax">A simple build and package manager for the Inform tools.</span>
|
|
|
|
<span class="plain-syntax">usage: inbuild [-TASK] TARGET1 TARGET2 ...</span>
|
|
|
|
<span class="plain-syntax">-archive sync copies of all extensions, kits and so on needed for -project into Materials</span>
|
|
<span class="plain-syntax">-archive-to X sync copies of all extensions, kits and so on needed into nest X</span>
|
|
<span class="plain-syntax">-build incrementally build target(s)</span>
|
|
<span class="plain-syntax">-build-locate show file paths of all the extensions, kits and so on needed to build</span>
|
|
<span class="plain-syntax">-build-missing show the extensions, kits and so on which are needed to build but missing</span>
|
|
<span class="plain-syntax">-build-needs show all the extensions, kits and so on needed to build</span>
|
|
<span class="plain-syntax">-build-registry X construct HTML menu pages for registry in the directory X</span>
|
|
<span class="plain-syntax">-build-trace show verbose reasoning during -build (default is -no-build-trace)</span>
|
|
<span class="plain-syntax">-contents-of X apply to all targets in the directory X</span>
|
|
<span class="plain-syntax">-copy-to X copy target(s) to nest X</span>
|
|
<span class="plain-syntax">-dry make this a dry run (print but do not execute shell commands) (default is -no-dry)</span>
|
|
<span class="plain-syntax">-graph show dependency graph of target(s) but take no action</span>
|
|
<span class="plain-syntax">-inspect show target(s) but take no action</span>
|
|
<span class="plain-syntax">-matching X apply to all works in nest(s) matching requirement X</span>
|
|
<span class="plain-syntax">-preprocess-app X use CSS suitable for app platform X (macos, windows, linux)</span>
|
|
<span class="plain-syntax">-preprocess-html X construct HTML page based on X</span>
|
|
<span class="plain-syntax">-preprocess-html-to X set destination for -preprocess-html to be X</span>
|
|
<span class="plain-syntax">-rebuild completely rebuild target(s)</span>
|
|
<span class="plain-syntax">-no-repair don't quietly fix missing or incorrect extension metadata (default is -repair)</span>
|
|
<span class="plain-syntax">-sync-to X forcibly copy target(s) to nest X, even if prior version already there</span>
|
|
<span class="plain-syntax">-tools X make X the directory of intools executables, and exit developer mode</span>
|
|
<span class="plain-syntax">-use-locate show file paths of all the extensions, kits and so on needed to use</span>
|
|
<span class="plain-syntax">-use-missing show the extensions, kits and so on which are needed to use but missing</span>
|
|
<span class="plain-syntax">-use-needs show all the extensions, kits and so on needed to use</span>
|
|
<span class="plain-syntax">-verify-registry X verify roster.json metadata of registry in the directory X</span>
|
|
<span class="plain-syntax">-no-versions-in-filenames don't append _v number to destination filenames on -copy-to or -sync-to (default is -versions-in-filenames)</span>
|
|
|
|
<span class="plain-syntax">for translating Inform source text to Inter:</span>
|
|
<span class="plain-syntax"> -basic use Basic Inform language</span>
|
|
<span class="plain-syntax"> -case X make any source links refer to the source in extension example X</span>
|
|
<span class="plain-syntax"> -census perform an extensions census (default is -no-census)</span>
|
|
<span class="plain-syntax"> -debug compile with debugging features even on a Release (default is -no-debug)</span>
|
|
<span class="plain-syntax"> -format=X compile to the format X (default is Inform6/32)</span>
|
|
<span class="plain-syntax"> -o X use file X as the compiled output (not for use with -project)</span>
|
|
<span class="plain-syntax"> -project X work within the Inform project X</span>
|
|
<span class="plain-syntax"> -release compile a version suitable for a Release build (default is -no-release)</span>
|
|
<span class="plain-syntax"> -rng fix the random number generator of the story file (for testing) (default is -no-rng)</span>
|
|
<span class="plain-syntax"> -source X use file X as the Inform source text</span>
|
|
|
|
<span class="plain-syntax">for locating resources in the file system:</span>
|
|
<span class="plain-syntax"> -external X use X as the user's home for installed material such as extensions</span>
|
|
<span class="plain-syntax"> -internal X use X as the location of built-in material such as the Standard Rules</span>
|
|
<span class="plain-syntax"> -nest X add the nest at pathname X to the search list</span>
|
|
<span class="plain-syntax"> -transient X use X for transient data such as the extensions census</span>
|
|
|
|
<span class="plain-syntax">for tweaking code generation from Inter:</span>
|
|
<span class="plain-syntax"> -kit X include Inter code from the kit called X</span>
|
|
<span class="plain-syntax"> -pipeline X specify code-generation pipeline by name (default is "compile")</span>
|
|
<span class="plain-syntax"> -pipeline-file X specify code-generation pipeline as file X</span>
|
|
<span class="plain-syntax"> -variable X set pipeline variable X (in form name=value)</span>
|
|
|
|
<span class="plain-syntax">-at X specify that this tool is installed at X</span>
|
|
<span class="plain-syntax">-crash intentionally crash on internal errors, for backtracing (default is -no-crash)</span>
|
|
<span class="plain-syntax">-fixtime pretend the time is 11 a.m. on 28 March 2016 for testing (default is -no-fixtime)</span>
|
|
<span class="plain-syntax">-help print this help information</span>
|
|
<span class="plain-syntax">-locale X set locales as 'L=E', L being shell or console, E platform, utf-8 or iso-latin1</span>
|
|
<span class="plain-syntax">-log X write the debugging log to include diagnostics on X</span>
|
|
<span class="plain-syntax">-version print out version number</span>
|
|
</pre>
|
|
<nav role="progress"><div class="progresscontainer">
|
|
<ul class="progressbar"><li class="progressprev"><a href="M-agtr.html">❮</a></li><li class="progresscurrentchapter">M</li><li class="progresssection"><a href="M-ui.html">ui</a></li><li class="progresssection"><a href="M-agtk.html">agtk</a></li><li class="progresssection"><a href="M-agtlb.html">agtlb</a></li><li class="progresssection"><a href="M-agtpm.html">agtpm</a></li><li class="progresssection"><a href="M-agtr.html">agtr</a></li><li class="progresscurrent">rc</li><li class="progresschapter"><a href="1-mn.html">1</a></li><li class="progressnext"><a href="1-mn.html">❯</a></li></ul></div>
|
|
</nav><!--End of weave-->
|
|
|
|
</main>
|
|
</body>
|
|
</html>
|
|
|