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

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

diff --git a/share/man/nitlight.md b/share/man/nitlight.md
index 4529bcb..97e363b 100644 (file)
--- a/share/man/nitlight.md
+++ b/share/man/nitlight.md
@@ -1,5 +1,3 @@
-% NITLIGHT(1)
-

 # NAME
 
 nitlight - generates HTML of highlighted code from Nit source files.
 # NAME
 
 nitlight - generates HTML of highlighted code from Nit source files.

@@ -17,49 +15,64 @@ Unlike generic lexical or syntactic highlighter, nitlight use semantic informati
 Common options of the Nit tools are understood.
 Here, only the specific one are indicated.
 
 Common options of the Nit tools are understood.
 Here, only the specific one are indicated.
 

-`-f`, `--fragment`
-:   Omit document header and footer.
+### `--txt`
+Generate text with ANSI coloring escape sequences.
+
+Instead of HTML, this generate text files with ANSI escape sequence for colors.
+The options `-f`, `--line-id-prefix` and `--ast` are ignored in this mode.
+
+### `-f`, `--fragment`
+Omit document header and footer.
+
+By default, a complete autonomous HTML document is generated.
+If `-f` is given, only the inside of the body part is generated such that it could be integrated
+into a HTML document.
+
+### `--line-id-prefix`
+Prefix of the id of each line `<span>` element.
+
+By default, each line is enclosed in its own `<span>` element with an `id` attribute made of the line number prefixed by `L` (e.g. `L1` for the first line).

 
 

-    By default, a complete autonomous HTML document is generated.
-    If `-f` is given, only the inside of the body part is generated such that it could be integrated
-    into a HTML document.
+This option changes the prefix used.
+If an empty string is used, then the `<span>` are generated without `id` attributes.

 
 

-`--line-id-prefix`
-:   Prefix of the id of each line `<span>` element.
+This option is especially useful with `--fragment` when more than one highlighted code is
+included in the same HTML document.
+Each fragment can thus be generated with its own distinct prefix, or the id can be disabled altogether.

 
 

-    By default, each line is enclosed in its own `<span>` element with an `id` attribute made of the line number prefixed by `L` (e.g. `L1` for the first line).
+### `--first-line`
+Start the source file at this line (default: 1).

 
 

-    This option changes the prefix used.
-    If an empty string is used, then the `<span>` are generated without `id` attributes.
+The generated HTML will only contains lines bellow the specified one.

 
 

-    This option is especially usuful with `--fragment` when more than one highlighted code is
-    included in the same HTML document.
-    Each fragment can thus be generated with its own distinct prefix, or the id can be disabled alltogether.
+### `--last-line`
+End the source file at this line (default: to the end).

 
 

-`--first-line`
-:   Start the source file at this line (default: 1).
+The generated HTML will only contains lines above the specified one.

 
 

-    The generated HTML will only contains lines bellow the specified one.
+### `-d`, `--dir`
+Output html files in a specific directory (required if more than one module).

 
 

-`--last-line`
-:   End the source file at this line (default: to the end)
+By default the generated HTML is outputted on the screen.
+If this option is used, then HTML files are generated in the specified directory.

 
 

-    The generated HTML will only contains lines ebove the specified one.
+A basic `index.heml` and a `style.css` file are also generated in the directory.

 
 

-`-d`, `--dir`
-:   Output html files in a specific directory (required if more than one module).
+### `--full`
+Process also imported modules.

 
 

-    By default the generated HTML is outputted on the screen.
-    If this option is used, then HTML files are generated in the specified directory.
+By default, only the modules indicated on the command line are highlighted.

 
 

-    A basic `index.heml` and a `style.css` file are also generated in the directory.
+With the `--full` option, all imported modules (even those in standard) are also precessed.

 
 

-`--full`
-:   Process also imported modules.
+### `--no-infobox`
+Disable the generation of infoboxes.

 
 

-    By default, only the modules indicated on the command line are highlighted.
+### `--ast`
+Generate specific HTML elements for each Node of the AST.

 
 

-    With the `--full` option, all imported modules (even those in standard) are also precessed.
+Additional `<span>` elements are generated for each node of the AST.
+The HTML generated can become quite large.

 
 # SEE ALSO
 
 
 # SEE ALSO