summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorAraq <rumpf_a@web.de>2011-02-25 01:53:58 +0100
committerAraq <rumpf_a@web.de>2011-02-25 01:53:58 +0100
commitf8dd74a0733b86a63dd805dfee580a5b4cf484ad (patch)
tree0ab327d97cfa30d2db6c7c2bb87aee2862bae74e /doc
parent0a4498bd6b699e42d97a9f7c9fcddd435a5d6e5b (diff)
downloadNim-f8dd74a0733b86a63dd805dfee580a5b4cf484ad.tar.gz
--stdout support; idetools implemented
Diffstat (limited to 'doc')
-rwxr-xr-xdoc/advopt.txt21
-rwxr-xr-xdoc/basicopt.txt12
2 files changed, 20 insertions, 13 deletions
diff --git a/doc/advopt.txt b/doc/advopt.txt
index 2d0080b72..2a0b64c4c 100755
--- a/doc/advopt.txt
+++ b/doc/advopt.txt
@@ -1,22 +1,28 @@
 Advanced commands:
   //compileToC, cc          compile project with C code generator
   //compileToOC, oc         compile project to Objective C code
-  //rst2html                converts a reStructuredText file to HTML
-  //rst2tex                 converts a reStructuredText file to TeX
-  //run                     run the project (with Tiny C backend; Linux only!)
+  //rst2html                convert a reStructuredText file to HTML
+  //rst2tex                 convert a reStructuredText file to TeX
+  //run                     run the project (with Tiny C backend; buggy!)
   //pretty                  pretty print the inputfile
   //genDepend               generate a DOT file containing the
                             module dependency graph
-  //listDef                 list all defined conditionals and exit
+  //dump                    dump all defined conditionals and search paths
   //check                   checks the project for syntax and semantic
-  //parse                   parses a single file (for debugging Nimrod)
+  //idetools                compiler support for IDEs: possible options:
+    --track:FILE,LINE,COL   track a file/cursor position
+    --suggest               suggest all possible symbols at position
+    --def                   list all possible symbols at position
+    --context               list possible invokation context  
 
 Advanced options:
+  -o, --out:FILE            set the output filename
+  --stdout                  output to stdout
   -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 path to the system.nim library
+  --lib:PATH                set the system library path
   -c, --compileOnly         compile only; do not assemble or link
   --noLinking               compile but do not link
   --noMain                  do not generate a main procedure
@@ -35,10 +41,11 @@ Advanced options:
   --skipCfg                 do not read the general configuration file
   --skipProjCfg             do not read the project's configuration file
   --gc:refc|boehm|none      use Nimrod's native GC|Boehm GC|no GC
-  --index:FILE              use FILE to generate a documenation index file
+  --index:FILE              use FILE to generate a documentation index file
   --putenv:key=value        set an environment variable
   --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 (0 is default)
   -v, --version             show detailed version information
+
diff --git a/doc/basicopt.txt b/doc/basicopt.txt
index bd311e993..dd9e50ec2 100755
--- a/doc/basicopt.txt
+++ b/doc/basicopt.txt
@@ -1,16 +1,15 @@
 Usage::
-  nimrod command [options] inputfile [arguments]
+  nimrod command [options] [projectfile] [arguments]
 
 Command:
-  //compile, c              compile project with default code generator (C)
-  //doc                     generate the documentation for inputfile
-  //i                       start Nimrod in interactive mode (limited)
-  
+  //compile, c                compile project with default code generator (C)
+  //doc                       generate the documentation for inputfile
+  //i                         start Nimrod in interactive mode (limited)
+
 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
@@ -33,3 +32,4 @@ Options:
   -r, --run                 run the compiled program with given arguments
   --advanced                show advanced command line switches
   -h, --help                show this help
+