misc/vim: inform the user when no results are found

[nit.git] / share / man / nitx.md

diff --git a/share/man/nitx.md b/share/man/nitx.md
index 73cee66..c655110 100644 (file)
--- a/share/man/nitx.md
+++ b/share/man/nitx.md
@@ -2,67 +2,44 @@
 
 # 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
-
-`-q`, `--quiet`
-:   Do not show warnings
+# DESCRIPTION
 
-`--stop-on-first-error`
-:   Stop on first error
+`nitx` in an interactive tool that display information about programs and libraries.
 
-`--no-color`
-:   Do not use color to display errors and warnings
+A command that query some information can be given as and argument.
+This will immediately displays the information then terminates the programs.
 
-`--log`
-:   Generate various log files
+If no command are given, the program starts an interactive session where commands are entered until `:q` is given.
 
-`--log-dir`
-:   Directory where to generate log files
+# COMMANDS
 
-`-h`, `-?`, `--help`
-:   Show Help (This screen)
+`name`
+:   lookup module, class and property with the corresponding 'name'.
 
-`--version`
-:   Show version and exit
+`param: Type`
+:   lookup methods using the corresponding 'Type' as parameter.
 
-`--set-dummy-tool`
-:   Set toolname and version to DUMMY. Useful for testing
+`return: Type`
+:   lookup methods returning the corresponding 'Type'.
 
-`-v`, `--verbose`
-:   Verbose
+`new: Type`
+:   lookup methods creating new instances of 'Type'.
 
-`--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.
-
-`-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
+# OPTIONS
 
-`--ignore-visibility`
-:   Do not check, and produce errors, on visibility issues.
+Only common options of the Nit tools are understood.
 
 # SEE ALSO