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



                                                                 

                                                                   
                                                                    
                                                                      
                                                                         
                                                              
                                                   
                                                                          
                                                                      

                                                                        

                                                                     
                                                                    
                                                                     
                                                            
                                                                     
                                                   



                                                                       
 
                 
                                                       

                                                   
                                                       



                                                          
                                                       

                                                                
                                                                 

                                                                       



                                                                        



                                                                               
                                                                

                                                            



                                                                          
                                                              
                                                              
                                                             

                                                                           
                                                                

                                                                       
                                                       
                                                                      
                                                  
                                                                   
                                                                        
                                                        
                                                                      
                                                                     

                                                                            

                                                                   
                                                             
                                                       

                                                                        




                                                                               

                                                                               
                                                                            
                                                                       

                                                                               
                                                             
Advanced commands:
  //compileToC, cc          compile project with C code generator
  //compileToCpp, cpp       compile project to C++ code
  //compileToOC, objc       compile project to Objective C code
  //js                      compile project to Javascript
  //rst2html                convert a reStructuredText file to HTML
  //rst2tex                 convert a reStructuredText file to TeX
  //jsondoc                 extract the documentation to a json file
  //buildIndex              build an index for the whole documentation
  //run                     run the project (with Tiny C backend; buggy!)
  //genDepend               generate a DOT file containing the
                            module dependency graph
  //dump                    dump all defined conditionals and search paths
  //check                   checks the project for syntax and semantic
  //idetools                compiler support for IDEs: possible options:
    --track:FILE,LINE,COL   track a file/cursor position
    --trackDirty:DIRTY_FILE,ORIG_FILE,LINE,COL
                            track a file, currently not saved to disk
    --suggest               suggest all possible symbols at position
    --def                   list all possible definitions at position
    --context               list possible invokation context
    --usages                list all usages of the symbol at position
    --eval                  evaluates an expression
  //serve                   start the compiler as a service mode (CAAS)
    --server.type:TYPE      either stdin or tcp
    --server.port:PORT      port for tcp mode, by default 6000
    --server.address:HOST   binds to that address, by default ""

Advanced options:
  -m, --mainmodule:FILE     set the project main module
  -o, --out:FILE            set the output filename
  --stdout                  output to stdout
  --listFullPaths           list full paths in messages
  -w, --warnings:on|off     turn all warnings on|off
  --warning[X]:on|off       turn specific warning X on|off
  --hints:on|off            turn all hints on|off
  --hint[X]:on|off          turn specific hint X on|off
  --lib:PATH                set the system library path
  --import:PATH             add an automatically imported module
  --include:PATH            add an automatically included module
  --nimcache:PATH           set the path used for generated files
  --header:FILE             the compiler should produce a .h file (FILE
                            is optional)
  -c, --compileOnly         compile only; do not assemble or link
  --noLinking               compile but do not link
  --noMain                  do not generate a main procedure
  --genScript               generate a compile script (in the 'nimcache'
                            subdirectory named 'compile_$project$scriptext')
  --os:SYMBOL               set the target operating system (cross-compilation)
  --cpu:SYMBOL              set the target processor (cross-compilation)
  --debuginfo               enables debug information
  --debugger:on|off         turn Embedded Nimrod Debugger on|off
  -t, --passC:OPTION        pass an option to the C compiler
  -l, --passL:OPTION        pass an option to the linker
  --cincludes:DIR           modify the C compiler header search path
  --clibdir:DIR             modify the linker library search path
  --clib:LIBNAME            link an additional C library
                            (you should omit platform-specific extensions)
  --genMapping              generate a mapping file containing
                            (Nimrod, mangled) identifier pairs
  --project                 document the whole project (doc2)
  --docSeeSrcUrl:url        activate 'see source' for doc and doc2 commands
                            (see doc.item.seesrc in config/nimdoc.cfg)
  --lineDir:on|off          generation of #line directive on|off
  --embedsrc                embeds the original source code as comments
                            in the generated output
  --threadanalysis:on|off   turn thread analysis on|off
  --tlsEmulation:on|off     turn thread local storage emulation on|off
  --taintMode:on|off        turn taint mode on|off
  --symbolFiles:on|off      turn symbol files on|off (experimental)
  --implicitStatic:on|off   turn implicit compile time evaluation on|off
  --patterns:on|off         turn pattern matching on|off
  --skipCfg                 do not read the general configuration file
  --skipUserCfg             do not read the user's configuration file
  --skipParentCfg           do not read the parent dirs' configuration files
  --skipProjCfg             do not read the project's configuration file
  --gc:refc|v2|markAndSweep|boehm|none
                            select the GC to use; default is 'refc'
  --index:on|off            turn index file generation on|off
  --putenv:key=value        set an environment variable
  --babelPath:PATH          add a path for Babel support
  --excludePath:PATH        exclude a path from the list of search paths
  --dynlibOverride:SYMBOL   marks SYMBOL so that dynlib:SYMBOL
                            has no effect and can be statically linked instead;
                            symbol matching is fuzzy so
                            that --dynlibOverride:lua matches 
                            dynlib: "liblua.so.3"
  --listCmd                 list the commands used to execute external programs
  --parallelBuild=0|1|...   perform a parallel build
                            value = number of processors (0 for auto-detect)
  --verbosity:0|1|2|3       set Nimrod's verbosity level (1 is default)
  --cs:none|partial         set case sensitivity level (default: none);
                            do not use! this setting affects the whole language
  -v, --version             show detailed version information