summary refs log blame commit diff stats
path: root/doc/basicopt.txt
blob: 7d2a9b26d7a824404e193b283ec9d54cd53d5823 (plain) (tree)
1
2
3
4
5
6
7
8
9
10

                                                







                                                                           






                                                                             
                                                           













                                                                           
                                                                 
                                                                              


                                                                         
Usage::
  nimrod command [options] inputfile [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

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
  -u, --undef:SYMBOL        undefine a conditional symbol
  -f, --forceBuild          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
  -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
  -r, --run                 run the compiled program with given arguments
  --advanced                show advanced command line switches
  -h, --help                show this help