nitlanguage
/
nit.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
gamnit: don't load the same .mat material more than once
[nit.git]
/
share
/
man
/
nitx.md
diff --git
a/share/man/nitx.md
b/share/man/nitx.md
index
73cee66
..
fc2f8e6
100644
(file)
--- a/
share/man/nitx.md
+++ b/
share/man/nitx.md
@@
-1,68
+1,61
@@
-% NITX(1)
-
# NAME
# NAME
-Displays specific pieces of API information from Nit source files.
+nitx - displays specific pieces of API information from Nit source files.
-# SYNOPSYS
+# SYNOPSIS
-nitx [*options*]...
+nitx [*options*] FILE [COMMAND]
-# OPTIONS
+# DESCRIPTION
-`-W`, `--warn`
-: Show more warnings
+`nitx` in an interactive tool that displays informations about programs and libraries.
-`-w`, `--warning`
-: Show/hide a specific warning
+A command that query some information can be given as parameter.
+This will immediately displays the information then terminates the programs.
-`-q`, `--quiet`
-: Do not show warnings
+If no command are given, the program starts an interactive session where commands are entered until `:q` is given.
-`--stop-on-first-error`
-: Stop on first error
+# COMMANDS
-`--no-color`
-: Do not use color to display errors and warnings
+### `name`
+lookup module, class and property with the corresponding 'name'.
-`--log`
-: Generate various log files
+### `param: Type`
+lookup methods using the corresponding 'Type' as parameter.
-`--log-dir`
-: Directory where to generate log files
+### `return: Type`
+lookup methods returning the corresponding 'Type'.
-`-h`, `-?`, `--help`
-: Show Help (This screen)
+### `new: Type`
+lookup methods creating new instances of 'Type'.
-`--version`
-: Show version and exit
+### `call: Property`
+lookup calls to 'Property'.
-`--set-dummy-tool`
-: Set toolname and version to DUMMY. Useful for testing
+### `doc: name`
+lookup documentation pages about 'name'.
-`-v`, `--verbose`
-: Verbose
+### `code: name`
+lookup source code related to 'name'.
-`--bash-completion`
-: Generate bash_completion file for this program
+### `:h`
+display an help message about the commands.
-`--stub-man`
-: Generate a stub manpage in pandoc markdown format
+### `:q`
+exit the tool.
-`--disable-phase`
-: DEBUG: Disable a specific phase; use `list` to get the list.
+# OPTIONS
-`-I`, `--path`
-: Set include path for loaders (may be used more than once)
+### `-c`, `--command`
+Nitx command to perform.
-`--only-parse`
-: Only proceed to parse step of loaders
+Execute a command, display results in the console, then quit.
-`--only-metamodel`
-: Stop after meta-model processing
+### `--no-attributes`
+Ignore the attributes.
-`--ignore-visibility`
-: Do not check, and produce errors, on visibility issues.
+### `--private`
+Also generate private API.
# SEE ALSO
# SEE ALSO