mirror of
https://github.com/ganelson/inform.git
synced 2024-06-26 04:00:43 +03:00
88 lines
6.5 KiB
Plaintext
88 lines
6.5 KiB
Plaintext
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-locate show file paths of all the extensions, kits and so on needed to build
|
|
-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-registry X construct HTML menu pages for registry in the directory X
|
|
-build-trace show verbose reasoning during -build (default is -no-build-trace)
|
|
-no-confirmed don't confirm installation in the Inform GUI apps (default is -confirmed)
|
|
-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
|
|
-install install extension within the Inform GUI apps
|
|
-json X write output of -inspect to a JSON file in X (or '-' for stdout)
|
|
-matching X apply to all works in nest(s) matching requirement X
|
|
-modernise update copies to the newest available format
|
|
-preprocess-app X use CSS suitable for app platform X (macos, windows, linux)
|
|
-preprocess-html X construct HTML page based on X
|
|
-preprocess-html-to X set destination for -preprocess-html to be X
|
|
-rebuild completely rebuild target(s)
|
|
-recursive run -contents-of recursively to look through subdirectories too (default is -no-recursive)
|
|
-no-repair don't quietly fix missing or incorrect extension metadata (default is -repair)
|
|
-results X write HTML report file to X (for use within Inform GUI apps)
|
|
-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
|
|
-uninstall remove extension within the Inform GUI apps
|
|
-use-locate show file paths of all the extensions, kits and so on needed to use
|
|
-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
|
|
-verbose equivalent to -verbosity=1 (default is -no-verbose)
|
|
-verbosity=N how much explanation to print: lowest is 0 (default), highest is 3
|
|
-verify-registry X verify roster.json metadata of registry in the directory X
|
|
-no-versions-in-filenames don't append _v number to destination filenames on -copy-to or -sync-to (default is -versions-in-filenames)
|
|
|
|
for translating Inform source text to Inter:
|
|
-basic use Basic Inform language
|
|
-case X make any source links refer to the source in extension example X
|
|
-census withdrawn: previously, 'perform an extensions census' (default is -no-census)
|
|
-debug compile with debugging features even on a Release (default is -no-debug)
|
|
-format=X compile to the format X (default is Inform6/32)
|
|
-o X use file X as the compiled output (not for use with -project)
|
|
-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:
|
|
-deprecated-external X same as -external X, but issues warnings if the nest is actually used
|
|
-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 (an option now withdrawn)
|
|
|
|
for tweaking code generation from Inter:
|
|
-kit X (an option now withdrawn)
|
|
-pipeline X specify code-generation pipeline by name (default is "compile")
|
|
-pipeline-file X specify code-generation pipeline as file X
|
|
-variable X set pipeline variable X (in form name=value)
|
|
|
|
for generating extension or kit documentation:
|
|
-document (re-)generate documentation on this within current project
|
|
-document-from X generate documentation from documentation in a single Markdown file X
|
|
-document-set X generate documentation from a full documentation set in the path X
|
|
-document-sitemap X use file X as the 'sitemap.txt' when generating documentation sets
|
|
-document-to X divert generated documentation to directory X
|
|
|
|
for generating HTML from Markdown:
|
|
-markdown-from X generate HTML file from Markdown source file X
|
|
-markdown-from-dir X generate HTML files from all Markdown sources in X
|
|
-markdown-model X use this model file when generating HTML from Markdown ('none' for none)
|
|
-markdown-to X set filename for single Markdown-generated HTML file to be X
|
|
-markdown-to-dir X generate HTML files from Markdown sources into X
|
|
-markdown-variation X use dialect X of Markdown: 'CommonMark', 'GitHub', 'Inform', 'RTP'
|
|
|
|
-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
|
|
-locale X set locales as 'L=E', L being shell or console, E platform, utf-8 or iso-latin1
|
|
-log X write the debugging log to include diagnostics on X
|
|
-version print out version number
|