share/man/nitc: Adding the man explication to disable contracts

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

diff --git a/share/man/nitx.md b/share/man/nitx.md
index c655110..755649e 100644 (file)
--- a/share/man/nitx.md
+++ b/share/man/nitx.md
@@ -1,5 +1,3 @@
-% NITX(1)
-
 # NAME
 
 nitx - displays specific pieces of API information from Nit source files.
@@ -10,36 +8,59 @@ nitx [*options*] FILE [COMMAND]
 
 # DESCRIPTION
 
-`nitx` in an interactive tool that display information about programs and libraries.
+`nitx` in an interactive tool that displays informations about programs and libraries.
 
-A command that query some information can be given as and argument.
+A command that query some information can be given as parameter.
 This will immediately displays the information then terminates the programs.
 
 If no command are given, the program starts an interactive session where commands are entered until `:q` is given.
 
 # COMMANDS
 
-`name`
-:   lookup module, class and property with the corresponding 'name'.
+### `name`
+lookup module, class and property with the corresponding 'name'.
+
+### `param: Type`
+lookup methods using the corresponding 'Type' as parameter.
+
+### `return: Type`
+lookup methods returning the corresponding 'Type'.
 
-`param: Type`
-:   lookup methods using the corresponding 'Type' as parameter.
+### `new: Type`
+lookup methods creating new instances of 'Type'.
 
-`return: Type`
-:   lookup methods returning the corresponding 'Type'.
+### `call: Property`
+lookup calls to 'Property'.
 
-`new: Type`
-:   lookup methods creating new instances of 'Type'.
+### `doc: name`
+lookup documentation pages about 'name'.
 
-`:h`
-:   display an help message about the commands.
+### `code: name`
+lookup source code related to 'name'.
 
-`:q`
-:   exit the tool.
+### `:h`
+display an help message about the commands.
+
+### `:q`
+exit the tool.
 
 # OPTIONS
 
-Only common options of the Nit tools are understood.
+### `-c`, `--command`
+Nitx command to perform.
+
+Execute a command, display results in the console, then quit.
+
+### `--no-attributes`
+Ignore the attributes.
+
+### `--private`
+Also generate private API.
+
+### `--catalog`
+Use catalog.
+
+Allow queries to catalog data (can be long on large code base).
 
 # SEE ALSO