diff options
Diffstat (limited to 'doc/basicopt.txt')
| -rw-r--r--[-rwxr-xr-x] | doc/basicopt.txt | 45 |
1 files changed, 24 insertions, 21 deletions
diff --git a/doc/basicopt.txt b/doc/basicopt.txt index 7d2a9b26d..e8133d227 100755..100644 --- a/doc/basicopt.txt +++ b/doc/basicopt.txt @@ -1,37 +1,40 @@ -Usage:: - nimrod command [options] inputfile [arguments] + + nim command [options] [projectfile] [arguments] Command: //compile, c compile project with default code generator (C) - //compileToC, cc compile project with C code generator - //doc generate the documentation for inputfile - //rst2html converts a reStructuredText file to HTML - //rst2tex converts a reStructuredText file to TeX + //r compile to $nimcache/projname, run with `arguments` + using backend specified by `--backend` (default: c) + //doc generate the documentation for inputfile for + backend specified by `--backend` (default: c) Arguments: arguments are passed to the program being run (if --run option is selected) + Options: -p, --path:PATH add path to search paths - -o, --out:FILE set the output filename - -d, --define:SYMBOL define a conditional symbol + -d, --define:SYMBOL(:VAL) + define a conditional symbol + (Optionally: Define the value for that symbol, + see: "compile time define pragmas") -u, --undef:SYMBOL undefine a conditional symbol - -f, --forceBuild force rebuilding of all modules + -f, --forceBuild:on|off force rebuilding of all modules --stackTrace:on|off turn stack tracing on|off --lineTrace:on|off turn line tracing on|off - --debugger:on|off turn Embedded Nimrod Debugger on|off + --threads:on|off turn support for multi-threading on|off -x, --checks:on|off turn all runtime checks on|off - --objChecks:on|off turn obj conversion checks on|off - --fieldChecks:on|off turn case variant field checks on|off - --rangeChecks:on|off turn range checks on|off - --boundChecks:on|off turn bound checks on|off - --overflowChecks:on|off turn int over-/underflow checks on|off -a, --assertions:on|off turn assertions on|off - --floatChecks:on|off turn all floating point (NaN/Inf) checks on|off - --nanChecks:on|off turn NaN checks on|off - --infChecks:on|off turn Inf checks on|off - --deadCodeElim:on|off whole program dead code elimination on|off --opt:none|speed|size optimize not at all or for speed|size - --app:console|gui|lib generate a console|GUI application|dynamic library + Note: use -d:release for a release build! + --debugger:native use native debugger (gdb) + --app:console|gui|lib|staticlib + generate a console app|GUI app|DLL|static library -r, --run run the compiled program with given arguments - --advanced show advanced command line switches + --eval:cmd evaluate nim code directly; e.g.: `nim --eval:"echo 1"` + defaults to `e` (nimscript) but customizable: + `nim r --eval:'for a in stdin.lines: echo a'` + --fullhelp show all command line switches -h, --help show this help + -v, --version show detailed version information + +Note, single letter options that take an argument require a colon. E.g. -p:PATH. |