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 4ba5154..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.
@@ -19,37 +17,50 @@ If no command are given, the program starts an interactive session where command
 
 # 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.
+### `param: Type`
+lookup methods using the corresponding 'Type' as parameter.
 
-`return: Type`
-:   lookup methods returning the corresponding 'Type'.
+### `return: Type`
+lookup methods returning the corresponding 'Type'.
 
-`new: Type`
-:   lookup methods creating new instances of 'Type'.
+### `new: Type`
+lookup methods creating new instances of 'Type'.
 
-`call: Property`
-:   lookup calls to 'Property'.
+### `call: Property`
+lookup calls to 'Property'.
 
-`doc: name`
-:   lookup documentation pages about 'name'.
+### `doc: name`
+lookup documentation pages about 'name'.
 
-`code: name`
-:   lookup source code related to 'name'.
+### `code: name`
+lookup source code related to 'name'.
 
-`:h`
-:   display an help message about the commands.
+### `:h`
+display an help message about the commands.
 
-`:q`
-:   exit the tool.
+### `:q`
+exit the tool.
 
 # OPTIONS
 
-`-q`
-:      execute a query, display results in console then quit.
+### `-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