share: generate stubs for manpages
[nit.git] / share / man / nitlight.md
1 % NITLIGHT(1)
2
3 # NAME
4
5 Generates HTML of highlited code from Nit source files.
6
7 # SYNOPSYS
8
9 nitlight [*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 `-f`, `--fragment`
68 :   Omit document header and footer
69
70 `--first-line`
71 :   Start the source file at this line (default: 1)
72
73 `--last-line`
74 :   End the source file at this line (default: to the end)
75
76 `-d`, `--dir`
77 :   Output html files in a specific directory (required if more than one module)
78
79 `--full`
80 :   Process also imported modules
81
82 # SEE ALSO
83
84 The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>