2020-03-27 01:26:35 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
2020-04-14 19:56:54 +03:00
< title > Reference Card< / title >
2020-03-27 01:26:35 +02:00
< 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" >
2020-04-14 19:56:54 +03:00
2020-03-27 01:26:35 +02:00
< / head >
< body >
< nav role = "navigation" >
2020-04-14 19:56:54 +03:00
< h1 > < a href = "../index.html" >
< img src = "../docs-src/Figures/Inform.png" height = 72" >
< / a > < / h1 >
< ul > < li > < a href = "../compiler.html" > compiler tools< / a > < / li >
2020-03-27 01:26:35 +02:00
< 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 >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Compiler Webs< / h2 > < ul >
< li > < a href = "index.html" > < span class = "selectedlink" > inbuild< / span > < / a > < / li >
2020-03-27 01:26:35 +02:00
< li > < a href = "../inform7/index.html" > inform7< / a > < / li >
< li > < a href = "../inter/index.html" > inter< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Inbuild Modules< / h2 > < ul >
< li > < a href = "../supervisor-module/index.html" > supervisor< / a > < / li >
< / ul > < h2 > Inform7 Modules< / h2 > < ul >
2020-03-27 01:26:35 +02:00
< li > < a href = "../core-module/index.html" > core< / 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 >
2020-04-14 19:56:54 +03:00
< li > < a href = "../problems-module/index.html" > problems< / a > < / li >
2020-03-27 01:26:35 +02:00
< li > < a href = "../index-module/index.html" > index< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Inter Modules< / h2 > < ul >
< li > < a href = "../bytecode-module/index.html" > bytecode< / a > < / li >
2020-03-27 01:26:35 +02:00
< li > < a href = "../building-module/index.html" > building< / a > < / li >
< li > < a href = "../codegen-module/index.html" > codegen< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Shared Modules< / h2 > < ul >
< li > < a href = "../arch-module/index.html" > arch< / a > < / li >
< li > < a href = "../syntax-module/index.html" > syntax< / a > < / li >
< li > < a href = "../words-module/index.html" > words< / a > < / li >
< li > < a href = "../html-module/index.html" > html< / a > < / li >
2020-03-27 01:26:35 +02:00
< li > < a href = "../../../inweb/docs/foundation-module/index.html" > foundation< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul >
2020-03-27 01:26:35 +02:00
< / nav >
< main role = "main" >
2020-04-14 19:56:54 +03:00
<!-- Weave of 'Reference Card' generated by 7 -->
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / 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 >
2020-03-27 01:26:35 +02:00
2020-03-27 01:31:05 +02:00
< p class = "inwebparagraph" > < a id = "SP1" > < / a > < b > § 1. < / b > Running Inbuild with < code class = "display" > < span class = "extract" > -help< / span > < / code > 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.
2020-03-27 01:26:35 +02:00
< / p >
2020-04-14 19:56:54 +03:00
< pre class = "undisplay" >
2020-04-07 03:06:09 +03:00
< span class = "plain" > A simple build and package manager for the Inform tools.< / span >
2020-03-27 01:26:35 +02:00
2020-04-07 03:06:09 +03:00
< span class = "plain" > usage: inbuild [-TASK] TARGET1 TARGET2 ...< / span >
2020-03-27 01:26:35 +02:00
2020-04-07 03:06:09 +03:00
< span class = "plain" > -archive sync copies of all extensions, kits and so on needed for -project into Materials< / span >
< span class = "plain" > -archive-to X sync copies of all extensions, kits and so on needed into nest X< / span >
< span class = "plain" > -build incrementally build target(s)< / span >
< span class = "plain" > -build-missing show the extensions, kits and so on which are needed to build but missing< / span >
< span class = "plain" > -build-needs show all the extensions, kits and so on needed to build< / span >
< span class = "plain" > -build-trace show verbose reasoning during -build (default is -no-build-trace)< / span >
< span class = "plain" > -contents-of X apply to all targets in the directory X< / span >
< span class = "plain" > -copy-to X copy target(s) to nest X< / span >
< span class = "plain" > -dry make this a dry run (print but do not execute shell commands) (default is -no-dry)< / span >
< span class = "plain" > -graph show dependency graph of target(s) but take no action< / span >
< span class = "plain" > -inspect show target(s) but take no action< / span >
< span class = "plain" > -matching X apply to all works in nest(s) matching requirement X< / span >
< span class = "plain" > -rebuild completely rebuild target(s)< / span >
< span class = "plain" > -sync-to X forcibly copy target(s) to nest X, even if prior version already there< / span >
< span class = "plain" > -tools X make X the directory of intools executables, and exit developer mode< / span >
< span class = "plain" > -use-missing show the extensions, kits and so on which are needed to use but missing< / span >
< span class = "plain" > -use-needs show all the extensions, kits and so on needed to use< / span >
2020-03-27 01:26:35 +02:00
2020-04-07 03:06:09 +03:00
< span class = "plain" > for translating Inform source text to Inter:< / span >
2020-04-08 01:02:44 +03:00
< span class = "plain" > -case X make any source links refer to the source in extension example X< / span >
< span class = "plain" > -census perform an extensions census (default is -no-census)< / span >
< span class = "plain" > -debug compile with debugging features even on a Release (default is -no-debug)< / span >
< span class = "plain" > -format=X compile I6 code suitable for the virtual machine X< / span >
< span class = "plain" > -project X work within the Inform project X< / span >
< span class = "plain" > -release compile a version suitable for a Release build (default is -no-release)< / span >
< span class = "plain" > -rng fix the random number generator of the story file (for testing) (default is -no-rng)< / span >
< span class = "plain" > -source X use file X as the Inform source text< / span >
2020-03-27 01:26:35 +02:00
2020-04-07 03:06:09 +03:00
< span class = "plain" > for locating resources in the file system:< / span >
2020-04-08 01:02:44 +03:00
< span class = "plain" > -external X use X as the user's home for installed material such as extensions< / span >
< span class = "plain" > -internal X use X as the location of built-in material such as the Standard Rules< / span >
< span class = "plain" > -nest X add the nest at pathname X to the search list< / span >
< span class = "plain" > -transient X use X for transient data such as the extensions census< / span >
2020-03-27 01:26:35 +02:00
2020-04-07 03:06:09 +03:00
< span class = "plain" > for tweaking code generation from Inter:< / span >
2020-04-08 01:02:44 +03:00
< span class = "plain" > -kit X include Inter code from the kit called X< / span >
< span class = "plain" > -pipeline X specify code-generation pipeline by name (default is "compile")< / span >
< span class = "plain" > -pipeline-file X specify code-generation pipeline as file X< / span >
< span class = "plain" > -variable X set pipeline variable X (in form name=value)< / span >
2020-03-27 01:26:35 +02:00
2020-04-07 03:06:09 +03:00
< span class = "plain" > -at X specify that this tool is installed at X< / span >
< span class = "plain" > -crash intentionally crash on internal errors, for backtracing (default is -no-crash)< / span >
< span class = "plain" > -fixtime pretend the time is 11 a.m. on 28 March 2016 for testing (default is -no-fixtime)< / span >
< span class = "plain" > -help print this help information< / span >
< span class = "plain" > -log X write the debugging log to include diagnostics on X< / span >
< span class = "plain" > -version print out version number< / span >
2020-03-27 01:26:35 +02:00
< / pre >
2020-04-07 03:06:09 +03:00
< p class = "inwebparagraph" > < / p >
2020-03-27 01:26:35 +02:00
< 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 >