share: generate stubs for manpages
[nit.git] / share / man / nitunit.md
1 % NITUNIT(1)
2
3 # NAME
4
5 Executes the unit tests from Nit source files.
6
7 # SYNOPSYS
8
9 nitunit [*options*]...
10
11 # OPTIONS
12
13 `-W`, `--warn`
14 :   Show more warnings
15
16 `-w`, `--warning`
17 :   Show/hide a specific warning
18
19 `-q`, `--quiet`
20 :   Do not show warnings
21
22 `--stop-on-first-error`
23 :   Stop on first error
24
25 `--no-color`
26 :   Do not use color to display errors and warnings
27
28 `--log`
29 :   Generate various log files
30
31 `--log-dir`
32 :   Directory where to generate log files
33
34 `-h`, `-?`, `--help`
35 :   Show Help (This screen)
36
37 `--version`
38 :   Show version and exit
39
40 `--set-dummy-tool`
41 :   Set toolname and version to DUMMY. Useful for testing
42
43 `-v`, `--verbose`
44 :   Verbose
45
46 `--bash-completion`
47 :   Generate bash_completion file for this program
48
49 `--stub-man`
50 :   Generate a stub manpage in pandoc markdown format
51
52 `--disable-phase`
53 :   DEBUG: Disable a specific phase; use `list` to get the list.
54
55 `-I`, `--path`
56 :   Set include path for loaders (may be used more than once)
57
58 `--only-parse`
59 :   Only proceed to parse step of loaders
60
61 `--only-metamodel`
62 :   Stop after meta-model processing
63
64 `--ignore-visibility`
65 :   Do not check, and produce errors, on visibility issues.
66
67 `--full`
68 :   Process also imported modules
69
70 `-o`, `--output`
71 :   Output name (default is 'nitunit.xml')
72
73 `--dir`
74 :   Working directory (default is '.nitunit')
75
76 `--no-act`
77 :   Does not compile and run tests
78
79 `-p`, `--pattern`
80 :   Only run test case with name that match pattern. Examples: 'TestFoo', 'TestFoo*', 'TestFoo::test_foo', 'TestFoo::test_foo*', 'test_foo', 'test_foo*'
81
82 `-t`, `--target-file`
83 :   Specify test suite location.
84
85 `--gen-suite`
86 :   Generate test suite skeleton for a module
87
88 `-f`, `--force`
89 :   Force test generation even if file exists
90
91 `--private`
92 :   Also generate test case for private methods
93
94 `--only-show`
95 :   Only display skeleton, do not write file
96
97 # SEE ALSO
98
99 The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>