nitunit: update manpage with `--nitc`
authorJean Privat <jean@pryen.org>
Thu, 19 May 2016 03:58:01 +0000 (23:58 -0400)
committerJean Privat <jean@pryen.org>
Thu, 19 May 2016 14:41:34 +0000 (10:41 -0400)
Signed-off-by: Jean Privat <jean@pryen.org>

share/man/nitunit.md

index 4f9ad61..4e4ea82 100644 (file)
@@ -237,13 +237,19 @@ With the `--full` option, all imported modules (even those in standard) are also
 ### `-o`, `--output`
 Output name (default is 'nitunit.xml').
 
-### `nitunit` produces a XML file comatible with JUnit.
+`nitunit` produces a XML file compatible with JUnit.
 
 ### `--dir`
 Working directory (default is '.nitunit').
 
 In order to execute the tests, nit files are generated then compiled and executed in the giver working directory.
 
+### `--nitc`
+nitc compiler to use.
+
+By default, nitunit tries to locate the `nitc` program with the environment variable `NITC` or heuristics.
+The option is used to indicate a specific nitc binary.
+
 ### `--no-act`
 Does not compile and run tests.
 
@@ -271,6 +277,13 @@ Also generate test case for private methods.
 ### `--only-show`
 Only display the skeleton, do not write any file.
 
+
+# ENVIRONMENT VARIABLES
+
+### `NITC`
+
+Indicate the specific Nit compiler executable to use. See `--nitc`.
+
 # SEE ALSO
 
 The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>