# 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
-
-`-W`, `--warn`
-: Show more warnings
-
-`-w`, `--warning`
-: Show/hide a specific warning
+# DESCRIPTION
-`-q`, `--quiet`
-: Do not show warnings
+`nitx` in an interactive tool that displays informations about programs and libraries.
-`--stop-on-first-error`
-: Stop on first error
+A command that query some information can be given as parameter.
+This will immediately displays the information then terminates the programs.
-`--no-color`
-: Do not use color to display errors and warnings
+If no command are given, the program starts an interactive session where commands are entered until `:q` is given.
-`--log`
-: Generate various log files
+# COMMANDS
-`--log-dir`
-: Directory where to generate log files
+`name`
+: lookup module, class and property with the corresponding 'name'.
-`-h`, `-?`, `--help`
-: Show Help (This screen)
+`param: Type`
+: lookup methods using the corresponding 'Type' as parameter.
-`--version`
-: Show version and exit
+`return: Type`
+: lookup methods returning the corresponding 'Type'.
-`--set-dummy-tool`
-: Set toolname and version to DUMMY. Useful for testing
+`new: Type`
+: lookup methods creating new instances of 'Type'.
-`-v`, `--verbose`
-: Verbose
+`call: Property`
+: lookup calls to 'Property'.
-`--bash-completion`
-: Generate bash_completion file for this program
+`doc: name`
+: lookup documentation pages about 'name'.
-`--stub-man`
-: Generate a stub manpage in pandoc markdown format
+`code: name`
+: lookup source code related to 'name'.
-`--disable-phase`
-: DEBUG: Disable a specific phase; use `list` to get the list.
+`:h`
+: display an help message about the commands.
-`-I`, `--path`
-: Set include path for loaders (may be used more than once)
+`:q`
+: exit the tool.
-`--only-parse`
-: Only proceed to parse step of loaders
-
-`--only-metamodel`
-: Stop after meta-model processing
+# OPTIONS
-`--ignore-visibility`
-: Do not check, and produce errors, on visibility issues.
+`-q`
+: execute a query, display results in console then quit.
# SEE ALSO