share: generate stubs for manpages
authorJean Privat <jean@pryen.org>
Wed, 15 Oct 2014 19:04:52 +0000 (15:04 -0400)
committerJean Privat <jean@pryen.org>
Wed, 15 Oct 2014 19:04:52 +0000 (15:04 -0400)
Signed-off-by: Jean Privat <jean@pryen.org>

13 files changed:
share/man/Makefile [new file with mode: 0644]
share/man/README.md [new file with mode: 0644]
share/man/nit.md [new file with mode: 0644]
share/man/nitdoc.md [new file with mode: 0644]
share/man/nitg.md [new file with mode: 0644]
share/man/nitlight.md [new file with mode: 0644]
share/man/nitls.md [new file with mode: 0644]
share/man/nitmetrics.md [new file with mode: 0644]
share/man/nitpick.md [new file with mode: 0644]
share/man/nitpretty.md [new file with mode: 0644]
share/man/nitserial.md [new file with mode: 0644]
share/man/nitunit.md [new file with mode: 0644]
share/man/nitx.md [new file with mode: 0644]

diff --git a/share/man/Makefile b/share/man/Makefile
new file mode 100644 (file)
index 0000000..3eeeb03
--- /dev/null
@@ -0,0 +1,21 @@
+# This file is part of NIT ( http://www.nitlanguage.org ).
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+IN=$(wildcard nit*.md)
+OUT=$(patsubst %.md,man1/%.1,$(IN))
+
+all: $(OUT)
+
+man1/%.1: %.md
+       pandoc $< -t man -s -o $@
diff --git a/share/man/README.md b/share/man/README.md
new file mode 100644 (file)
index 0000000..a167029
--- /dev/null
@@ -0,0 +1,21 @@
+# Manual pages for nit commands
+
+Pages, in markdown, in this directory where initially generated thanks to the `--stub-man` options of the commands.
+
+Transformation to real man pages (troff) are done with `pandoc -t man -s` command.
+See the `Makefile`.
+
+
+Once generated, manpages can then be checked individually with `man -l`
+
+~~~
+man -l man1/nitg.1
+~~~
+
+For global access, one can set the `MANPATH` environment variable to this `man` directory (not the `man1` subdirectory).
+Do not forget to append a trailing column (`:`) to keep existing manpages accessible.
+
+~~~
+export MANPATH=/path/to/nit/share/man:
+man nitg
+~~~
diff --git a/share/man/nit.md b/share/man/nit.md
new file mode 100644 (file)
index 0000000..26b2adb
--- /dev/null
@@ -0,0 +1,99 @@
+% NIT(1)
+
+# NAME
+
+Interprets and debugs Nit programs.
+
+# SYNOPSYS
+
+nit [*options*]...
+
+# OPTIONS
+
+`-W`, `--warn`
+:   Show more warnings
+
+`-w`, `--warning`
+:   Show/hide a specific warning
+
+`-q`, `--quiet`
+:   Do not show warnings
+
+`--stop-on-first-error`
+:   Stop on first error
+
+`--no-color`
+:   Do not use color to display errors and warnings
+
+`--log`
+:   Generate various log files
+
+`--log-dir`
+:   Directory where to generate log files
+
+`-h`, `-?`, `--help`
+:   Show Help (This screen)
+
+`--version`
+:   Show version and exit
+
+`--set-dummy-tool`
+:   Set toolname and version to DUMMY. Useful for testing
+
+`-v`, `--verbose`
+:   Verbose
+
+`--bash-completion`
+:   Generate bash_completion file for this program
+
+`--stub-man`
+:   Generate a stub manpage in pandoc markdown format
+
+`--disable-phase`
+:   DEBUG: Disable a specific phase; use `list` to get the list.
+
+`-I`, `--path`
+:   Set include path for loaders (may be used more than once)
+
+`--only-parse`
+:   Only proceed to parse step of loaders
+
+`--only-metamodel`
+:   Stop after meta-model processing
+
+`--ignore-visibility`
+:   Do not check, and produce errors, on visibility issues.
+
+`--discover-call-trace`
+:   Trace calls of the first invocation of a method
+
+`-d`
+:   Launches the target program with the debugger attached to it
+
+`-c`
+:   Launches the target program with the interpreter, such as when the program fails, the debugging prompt is summoned
+
+`--socket`
+:   Launches the target program with raw output on the network via sockets
+
+`--websocket`
+:   Launches the target program with output on the network via websockets
+
+`--port`
+:   Sets the debug port (Defaults to 22125) - Must be contained between 0 and 65535
+
+`-o`
+:   compatibility (does noting)
+
+`-m`
+:   Additionals module to min-in
+
+`-e`
+:   Specifies the program from command-line
+
+`-n`
+:   Repeatedly run the program for each line in file-name arguments
+
+# SEE ALSO
+
+The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>
diff --git a/share/man/nitdoc.md b/share/man/nitdoc.md
new file mode 100644 (file)
index 0000000..d39c076
--- /dev/null
@@ -0,0 +1,114 @@
+% NITDOC(1)
+
+# NAME
+
+Generates HTML pages of API documentation from Nit source files.
+
+# SYNOPSYS
+
+nitdoc [*options*]...
+
+# OPTIONS
+
+`-W`, `--warn`
+:   Show more warnings
+
+`-w`, `--warning`
+:   Show/hide a specific warning
+
+`-q`, `--quiet`
+:   Do not show warnings
+
+`--stop-on-first-error`
+:   Stop on first error
+
+`--no-color`
+:   Do not use color to display errors and warnings
+
+`--log`
+:   Generate various log files
+
+`--log-dir`
+:   Directory where to generate log files
+
+`-h`, `-?`, `--help`
+:   Show Help (This screen)
+
+`--version`
+:   Show version and exit
+
+`--set-dummy-tool`
+:   Set toolname and version to DUMMY. Useful for testing
+
+`-v`, `--verbose`
+:   Verbose
+
+`--bash-completion`
+:   Generate bash_completion file for this program
+
+`--stub-man`
+:   Generate a stub manpage in pandoc markdown format
+
+`--disable-phase`
+:   DEBUG: Disable a specific phase; use `list` to get the list.
+
+`-I`, `--path`
+:   Set include path for loaders (may be used more than once)
+
+`--only-parse`
+:   Only proceed to parse step of loaders
+
+`--only-metamodel`
+:   Stop after meta-model processing
+
+`--ignore-visibility`
+:   Do not check, and produce errors, on visibility issues.
+
+`-d`, `--dir`
+:   output directory
+
+`--source`
+:   link for source (%f for filename, %l for first line, %L for last line)
+
+`--sharedir`
+:   directory containing nitdoc assets
+
+`--shareurl`
+:   use shareurl instead of copy shared files
+
+`--no-dot`
+:   do not generate graphes with graphviz
+
+`--private`
+:   also generate private API
+
+`--custom-title`
+:   custom title for homepage
+
+`--custom-footer-text`
+:   custom footer text
+
+`--custom-overview-text`
+:   custom intro text for homepage
+
+`--custom-brand`
+:   custom link to external site
+
+`--github-upstream`
+:   Git branch where edited commits will be pulled into (ex: user:repo:branch)
+
+`--github-base-sha1`
+:   Git sha1 of base commit used to create pull request
+
+`--github-gitdir`
+:   Git working directory used to resolve path name (ex: /home/me/myproject/)
+
+`--piwik-tracker`
+:   Piwik tracker URL (ex: nitlanguage.org/piwik/)
+
+`--piwik-site-id`
+:   Piwik site ID
+
+# SEE ALSO
+
+The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>
diff --git a/share/man/nitg.md b/share/man/nitg.md
new file mode 100644 (file)
index 0000000..1c45f1d
--- /dev/null
@@ -0,0 +1,177 @@
+% NITG(1)
+
+# NAME
+
+Compiles Nit programs.
+
+# SYNOPSYS
+
+nitg [*options*]...
+
+# OPTIONS
+
+`-W`, `--warn`
+:   Show more warnings
+
+`-w`, `--warning`
+:   Show/hide a specific warning
+
+`-q`, `--quiet`
+:   Do not show warnings
+
+`--stop-on-first-error`
+:   Stop on first error
+
+`--no-color`
+:   Do not use color to display errors and warnings
+
+`--log`
+:   Generate various log files
+
+`--log-dir`
+:   Directory where to generate log files
+
+`-h`, `-?`, `--help`
+:   Show Help (This screen)
+
+`--version`
+:   Show version and exit
+
+`--set-dummy-tool`
+:   Set toolname and version to DUMMY. Useful for testing
+
+`-v`, `--verbose`
+:   Verbose
+
+`--bash-completion`
+:   Generate bash_completion file for this program
+
+`--stub-man`
+:   Generate a stub manpage in pandoc markdown format
+
+`--disable-phase`
+:   DEBUG: Disable a specific phase; use `list` to get the list.
+
+`-I`, `--path`
+:   Set include path for loaders (may be used more than once)
+
+`--only-parse`
+:   Only proceed to parse step of loaders
+
+`--only-metamodel`
+:   Stop after meta-model processing
+
+`--ignore-visibility`
+:   Do not check, and produce errors, on visibility issues.
+
+`-o`, `--output`
+:   Output file
+
+`--dir`
+:   Output directory
+
+`--no-cc`
+:   Do not invoke C compiler
+
+`--no-main`
+:   Do not generate main entry point
+
+`--make-flags`
+:   Additional options to make
+
+`--compile-dir`
+:   Directory used to generate temporary files
+
+`--hardening`
+:   Generate contracts in the C code against bugs in the compiler
+
+`--no-shortcut-range`
+:   Always insantiate a range and its iterator on 'for' loops
+
+`--no-check-covariance`
+:   Disable type tests of covariant parameters (dangerous)
+
+`--no-check-attr-isset`
+:   Disable isset tests before each attribute access (dangerous)
+
+`--no-check-assert`
+:   Disable the evaluation of explicit 'assert' and 'as' (dangerous)
+
+`--no-check-autocast`
+:   Disable implicit casts on unsafe expression usage (dangerous)
+
+`--no-check-null`
+:   Disable tests of null receiver (dangerous)
+
+`--no-check-all`
+:   Disable all tests (dangerous)
+
+`--typing-test-metrics`
+:   Enable static and dynamic count of all type tests
+
+`--invocation-metrics`
+:   Enable static and dynamic count of all method invocations
+
+`--isset-checks-metrics`
+:   Enable static and dynamic count of isset checks before attributes access
+
+`--stacktrace`
+:   Control the generation of stack traces
+
+`--no-gcc-directive`
+:   Disable a advanced gcc directives for optimization
+
+`--release`
+:   Compile in release mode and finalize application
+
+`--global`
+:   Use global compilation
+
+`--separate`
+:   Use separate compilation
+
+`--no-inline-intern`
+:   Do not inline call to intern methods
+
+`--no-union-attribute`
+:   Put primitive attibutes in a box instead of an union
+
+`--no-shortcut-equal`
+:   Always call == in a polymorphic way
+
+`--inline-coloring-numbers`
+:   Inline colors and ids (semi-global)
+
+`--inline-some-methods`
+:   Allow the separate compiler to inline some methods (semi-global)
+
+`--direct-call-monomorph`
+:   Allow the separate compiler to direct call monomorph sites (semi-global)
+
+`--skip-dead-methods`
+:   Do not compile dead methods (semi-global)
+
+`--semi-global`
+:   Enable all semi-global optimizations
+
+`--colo-dead-methods`
+:   Force colorization of dead methods
+
+`--tables-metrics`
+:   Enable static size measuring of tables used for vft, typing and resolution
+
+`--erasure`
+:   Erase generic types
+
+`--no-check-erasure-cast`
+:   Disable implicit casts on unsafe return with erasure-typing policy (dangerous)
+
+`--rta`
+:   Activate RTA (implicit with --global and --separate)
+
+`-m`
+:   Additionals module to min-in
+
+# SEE ALSO
+
+The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>
diff --git a/share/man/nitlight.md b/share/man/nitlight.md
new file mode 100644 (file)
index 0000000..54b2896
--- /dev/null
@@ -0,0 +1,84 @@
+% NITLIGHT(1)
+
+# NAME
+
+Generates HTML of highlited code from Nit source files.
+
+# SYNOPSYS
+
+nitlight [*options*]...
+
+# OPTIONS
+
+`-W`, `--warn`
+:   Show more warnings
+
+`-w`, `--warning`
+:   Show/hide a specific warning
+
+`-q`, `--quiet`
+:   Do not show warnings
+
+`--stop-on-first-error`
+:   Stop on first error
+
+`--no-color`
+:   Do not use color to display errors and warnings
+
+`--log`
+:   Generate various log files
+
+`--log-dir`
+:   Directory where to generate log files
+
+`-h`, `-?`, `--help`
+:   Show Help (This screen)
+
+`--version`
+:   Show version and exit
+
+`--set-dummy-tool`
+:   Set toolname and version to DUMMY. Useful for testing
+
+`-v`, `--verbose`
+:   Verbose
+
+`--bash-completion`
+:   Generate bash_completion file for this program
+
+`--stub-man`
+:   Generate a stub manpage in pandoc markdown format
+
+`--disable-phase`
+:   DEBUG: Disable a specific phase; use `list` to get the list.
+
+`-I`, `--path`
+:   Set include path for loaders (may be used more than once)
+
+`--only-parse`
+:   Only proceed to parse step of loaders
+
+`--only-metamodel`
+:   Stop after meta-model processing
+
+`--ignore-visibility`
+:   Do not check, and produce errors, on visibility issues.
+
+`-f`, `--fragment`
+:   Omit document header and footer
+
+`--first-line`
+:   Start the source file at this line (default: 1)
+
+`--last-line`
+:   End the source file at this line (default: to the end)
+
+`-d`, `--dir`
+:   Output html files in a specific directory (required if more than one module)
+
+`--full`
+:   Process also imported modules
+
+# SEE ALSO
+
+The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>
diff --git a/share/man/nitls.md b/share/man/nitls.md
new file mode 100644 (file)
index 0000000..705a099
--- /dev/null
@@ -0,0 +1,93 @@
+% NITLS(1)
+
+# NAME
+
+Lists the projects and/or paths of Nit sources files.
+
+# SYNOPSYS
+
+nitls [*options*]...
+
+# OPTIONS
+
+`-W`, `--warn`
+:   Show more warnings
+
+`-w`, `--warning`
+:   Show/hide a specific warning
+
+`-q`, `--quiet`
+:   Do not show warnings
+
+`--stop-on-first-error`
+:   Stop on first error
+
+`--no-color`
+:   Do not use color to display errors and warnings
+
+`--log`
+:   Generate various log files
+
+`--log-dir`
+:   Directory where to generate log files
+
+`-h`, `-?`, `--help`
+:   Show Help (This screen)
+
+`--version`
+:   Show version and exit
+
+`--set-dummy-tool`
+:   Set toolname and version to DUMMY. Useful for testing
+
+`-v`, `--verbose`
+:   Verbose
+
+`--bash-completion`
+:   Generate bash_completion file for this program
+
+`--stub-man`
+:   Generate a stub manpage in pandoc markdown format
+
+`--disable-phase`
+:   DEBUG: Disable a specific phase; use `list` to get the list.
+
+`-I`, `--path`
+:   Set include path for loaders (may be used more than once)
+
+`--only-parse`
+:   Only proceed to parse step of loaders
+
+`--only-metamodel`
+:   Stop after meta-model processing
+
+`--ignore-visibility`
+:   Do not check, and produce errors, on visibility issues.
+
+`-k`, `--keep`
+:   Ignore errors and files that are not a Nit source file
+
+`-r`, `--recursive`
+:   Process directories recussively
+
+`-t`, `--tree`
+:   List source files in their groups and projects
+
+`-s`, `--source`
+:   List source files
+
+`-P`, `--project`
+:   List projects paths (default)
+
+`-d`, `--depends`
+:   List dependencies of given modules
+
+`-p`, `--path`
+:   List only path (instead of name + path)
+
+`-M`
+:   List dependencies suitable for a rule in a Makefile. Alias for -d, -p and -s
+
+# SEE ALSO
+
+The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>
diff --git a/share/man/nitmetrics.md b/share/man/nitmetrics.md
new file mode 100644 (file)
index 0000000..5aeb779
--- /dev/null
@@ -0,0 +1,120 @@
+% NITMETRICS(1)
+
+# NAME
+
+Computes various metrics on Nit programs.
+
+# SYNOPSYS
+
+nitmetrics [*options*]...
+
+# OPTIONS
+
+`-W`, `--warn`
+:   Show more warnings
+
+`-w`, `--warning`
+:   Show/hide a specific warning
+
+`-q`, `--quiet`
+:   Do not show warnings
+
+`--stop-on-first-error`
+:   Stop on first error
+
+`--no-color`
+:   Do not use color to display errors and warnings
+
+`--log`
+:   Generate various log files
+
+`--log-dir`
+:   Directory where to generate log files
+
+`-h`, `-?`, `--help`
+:   Show Help (This screen)
+
+`--version`
+:   Show version and exit
+
+`--set-dummy-tool`
+:   Set toolname and version to DUMMY. Useful for testing
+
+`-v`, `--verbose`
+:   Verbose
+
+`--bash-completion`
+:   Generate bash_completion file for this program
+
+`--stub-man`
+:   Generate a stub manpage in pandoc markdown format
+
+`--disable-phase`
+:   DEBUG: Disable a specific phase; use `list` to get the list.
+
+`-I`, `--path`
+:   Set include path for loaders (may be used more than once)
+
+`--only-parse`
+:   Only proceed to parse step of loaders
+
+`--only-metamodel`
+:   Stop after meta-model processing
+
+`--ignore-visibility`
+:   Do not check, and produce errors, on visibility issues.
+
+`--all`
+:   Compute all metrics
+
+`--mmodules`
+:   Compute metrics about mmodules
+
+`--mclasses`
+:   Compute metrics about mclasses
+
+`--mendel`
+:   Compute mendel metrics
+
+`--inheritance`
+:   Compute metrics about inheritance usage
+
+`--refinement`
+:   Compute metrics about refinement usage
+
+`--self`
+:   Compute metrics about the usage of explicit and implicit self
+
+`--ast`
+:   Compute metrics about the usage of nodes and identifiers in the AST
+
+`--nullables`
+:   Compute metrics on nullables send
+
+`--static-types`
+:   Compute explicit static types metrics
+
+`--tables`
+:   Compute tables metrics
+
+`--rta`
+:   Compute RTA metrics
+
+`--csv`
+:   Export metrics in CSV format
+
+`--generate_hyperdoc`
+:   Generate Hyperdoc
+
+`--poset`
+:   Complete metrics on posets
+
+`-d`, `--dir`
+:   Directory where some statistics files are generated
+
+`--no-colors`
+:   Disable colors in console outputs
+
+# SEE ALSO
+
+The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>
diff --git a/share/man/nitpick.md b/share/man/nitpick.md
new file mode 100644 (file)
index 0000000..f852d27
--- /dev/null
@@ -0,0 +1,69 @@
+% NITPICK(1)
+
+# NAME
+
+Collect potential style and code issues.
+
+# SYNOPSYS
+
+nitpick [*options*]...
+
+# OPTIONS
+
+`-W`, `--warn`
+:   Show more warnings
+
+`-w`, `--warning`
+:   Show/hide a specific warning
+
+`-q`, `--quiet`
+:   Do not show warnings
+
+`--stop-on-first-error`
+:   Stop on first error
+
+`--no-color`
+:   Do not use color to display errors and warnings
+
+`--log`
+:   Generate various log files
+
+`--log-dir`
+:   Directory where to generate log files
+
+`-h`, `-?`, `--help`
+:   Show Help (This screen)
+
+`--version`
+:   Show version and exit
+
+`--set-dummy-tool`
+:   Set toolname and version to DUMMY. Useful for testing
+
+`-v`, `--verbose`
+:   Verbose
+
+`--bash-completion`
+:   Generate bash_completion file for this program
+
+`--stub-man`
+:   Generate a stub manpage in pandoc markdown format
+
+`--disable-phase`
+:   DEBUG: Disable a specific phase; use `list` to get the list.
+
+`-I`, `--path`
+:   Set include path for loaders (may be used more than once)
+
+`--only-parse`
+:   Only proceed to parse step of loaders
+
+`--only-metamodel`
+:   Stop after meta-model processing
+
+`--ignore-visibility`
+:   Do not check, and produce errors, on visibility issues.
+
+# SEE ALSO
+
+The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>
diff --git a/share/man/nitpretty.md b/share/man/nitpretty.md
new file mode 100644 (file)
index 0000000..3238ced
--- /dev/null
@@ -0,0 +1,84 @@
+% NITPRETTY(1)
+
+# NAME
+
+Pretty print Nit code from Nit source files.
+
+# SYNOPSYS
+
+nitpretty [*options*]...
+
+# OPTIONS
+
+`-W`, `--warn`
+:   Show more warnings
+
+`-w`, `--warning`
+:   Show/hide a specific warning
+
+`-q`, `--quiet`
+:   Do not show warnings
+
+`--stop-on-first-error`
+:   Stop on first error
+
+`--no-color`
+:   Do not use color to display errors and warnings
+
+`--log`
+:   Generate various log files
+
+`--log-dir`
+:   Directory where to generate log files
+
+`-h`, `-?`, `--help`
+:   Show Help (This screen)
+
+`--version`
+:   Show version and exit
+
+`--set-dummy-tool`
+:   Set toolname and version to DUMMY. Useful for testing
+
+`-v`, `--verbose`
+:   Verbose
+
+`--bash-completion`
+:   Generate bash_completion file for this program
+
+`--stub-man`
+:   Generate a stub manpage in pandoc markdown format
+
+`--disable-phase`
+:   DEBUG: Disable a specific phase; use `list` to get the list.
+
+`-I`, `--path`
+:   Set include path for loaders (may be used more than once)
+
+`--only-parse`
+:   Only proceed to parse step of loaders
+
+`--only-metamodel`
+:   Stop after meta-model processing
+
+`--ignore-visibility`
+:   Do not check, and produce errors, on visibility issues.
+
+`--dir`
+:   Working directory (default is '.nitpretty')
+
+`-o`, `--output`
+:   Output name (default is pretty.nit)
+
+`--diff`
+:   Show diff between source and output
+
+`--meld`
+:   Show diff between source and output using meld
+
+`--check`
+:   Check format of Nit source files
+
+# SEE ALSO
+
+The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>
diff --git a/share/man/nitserial.md b/share/man/nitserial.md
new file mode 100644 (file)
index 0000000..056b692
--- /dev/null
@@ -0,0 +1,75 @@
+% NITSERIAL(1)
+
+# NAME
+
+Generates a serialization support module
+
+# SYNOPSYS
+
+nitserial [*options*]...
+
+# OPTIONS
+
+`-o`, `--output`
+:   Output file (can also be 'stdout')
+
+`--dir`
+:   Output directory
+
+`-W`, `--warn`
+:   Show more warnings
+
+`-w`, `--warning`
+:   Show/hide a specific warning
+
+`-q`, `--quiet`
+:   Do not show warnings
+
+`--stop-on-first-error`
+:   Stop on first error
+
+`--no-color`
+:   Do not use color to display errors and warnings
+
+`--log`
+:   Generate various log files
+
+`--log-dir`
+:   Directory where to generate log files
+
+`-h`, `-?`, `--help`
+:   Show Help (This screen)
+
+`--version`
+:   Show version and exit
+
+`--set-dummy-tool`
+:   Set toolname and version to DUMMY. Useful for testing
+
+`-v`, `--verbose`
+:   Verbose
+
+`--bash-completion`
+:   Generate bash_completion file for this program
+
+`--stub-man`
+:   Generate a stub manpage in pandoc markdown format
+
+`--disable-phase`
+:   DEBUG: Disable a specific phase; use `list` to get the list.
+
+`-I`, `--path`
+:   Set include path for loaders (may be used more than once)
+
+`--only-parse`
+:   Only proceed to parse step of loaders
+
+`--only-metamodel`
+:   Stop after meta-model processing
+
+`--ignore-visibility`
+:   Do not check, and produce errors, on visibility issues.
+
+# SEE ALSO
+
+The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>
diff --git a/share/man/nitunit.md b/share/man/nitunit.md
new file mode 100644 (file)
index 0000000..24d2e1e
--- /dev/null
@@ -0,0 +1,99 @@
+% NITUNIT(1)
+
+# NAME
+
+Executes the unit tests from Nit source files.
+
+# SYNOPSYS
+
+nitunit [*options*]...
+
+# OPTIONS
+
+`-W`, `--warn`
+:   Show more warnings
+
+`-w`, `--warning`
+:   Show/hide a specific warning
+
+`-q`, `--quiet`
+:   Do not show warnings
+
+`--stop-on-first-error`
+:   Stop on first error
+
+`--no-color`
+:   Do not use color to display errors and warnings
+
+`--log`
+:   Generate various log files
+
+`--log-dir`
+:   Directory where to generate log files
+
+`-h`, `-?`, `--help`
+:   Show Help (This screen)
+
+`--version`
+:   Show version and exit
+
+`--set-dummy-tool`
+:   Set toolname and version to DUMMY. Useful for testing
+
+`-v`, `--verbose`
+:   Verbose
+
+`--bash-completion`
+:   Generate bash_completion file for this program
+
+`--stub-man`
+:   Generate a stub manpage in pandoc markdown format
+
+`--disable-phase`
+:   DEBUG: Disable a specific phase; use `list` to get the list.
+
+`-I`, `--path`
+:   Set include path for loaders (may be used more than once)
+
+`--only-parse`
+:   Only proceed to parse step of loaders
+
+`--only-metamodel`
+:   Stop after meta-model processing
+
+`--ignore-visibility`
+:   Do not check, and produce errors, on visibility issues.
+
+`--full`
+:   Process also imported modules
+
+`-o`, `--output`
+:   Output name (default is 'nitunit.xml')
+
+`--dir`
+:   Working directory (default is '.nitunit')
+
+`--no-act`
+:   Does not compile and run tests
+
+`-p`, `--pattern`
+:   Only run test case with name that match pattern. Examples: 'TestFoo', 'TestFoo*', 'TestFoo::test_foo', 'TestFoo::test_foo*', 'test_foo', 'test_foo*'
+
+`-t`, `--target-file`
+:   Specify test suite location.
+
+`--gen-suite`
+:   Generate test suite skeleton for a module
+
+`-f`, `--force`
+:   Force test generation even if file exists
+
+`--private`
+:   Also generate test case for private methods
+
+`--only-show`
+:   Only display skeleton, do not write file
+
+# SEE ALSO
+
+The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>
diff --git a/share/man/nitx.md b/share/man/nitx.md
new file mode 100644 (file)
index 0000000..73cee66
--- /dev/null
@@ -0,0 +1,69 @@
+% NITX(1)
+
+# NAME
+
+Displays specific pieces of API information from Nit source files.
+
+# SYNOPSYS
+
+nitx [*options*]...
+
+# OPTIONS
+
+`-W`, `--warn`
+:   Show more warnings
+
+`-w`, `--warning`
+:   Show/hide a specific warning
+
+`-q`, `--quiet`
+:   Do not show warnings
+
+`--stop-on-first-error`
+:   Stop on first error
+
+`--no-color`
+:   Do not use color to display errors and warnings
+
+`--log`
+:   Generate various log files
+
+`--log-dir`
+:   Directory where to generate log files
+
+`-h`, `-?`, `--help`
+:   Show Help (This screen)
+
+`--version`
+:   Show version and exit
+
+`--set-dummy-tool`
+:   Set toolname and version to DUMMY. Useful for testing
+
+`-v`, `--verbose`
+:   Verbose
+
+`--bash-completion`
+:   Generate bash_completion file for this program
+
+`--stub-man`
+:   Generate a stub manpage in pandoc markdown format
+
+`--disable-phase`
+:   DEBUG: Disable a specific phase; use `list` to get the list.
+
+`-I`, `--path`
+:   Set include path for loaders (may be used more than once)
+
+`--only-parse`
+:   Only proceed to parse step of loaders
+
+`--only-metamodel`
+:   Stop after meta-model processing
+
+`--ignore-visibility`
+:   Do not check, and produce errors, on visibility issues.
+
+# SEE ALSO
+
+The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>