man: rewrite the documentation of the other tools

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

diff --git a/share/man/nitls.md b/share/man/nitls.md
index 705a099..2d1f0a7 100644 (file)
--- a/share/man/nitls.md
+++ b/share/man/nitls.md
@@ -2,91 +2,78 @@
 
 # NAME
 
-Lists the projects and/or paths of Nit sources files.
+nitls - lists the projects, groups and paths of Nit sources files.
 
-# SYNOPSYS
+# SYNOPSIS
 
-nitls [*options*]...
+nitls [*options*] FILE...
 
-# OPTIONS
+# DESCRIPTION
 
-`-W`, `--warn`
-:   Show more warnings
+`nitls` is used to list Nit files in directories and extract the module-group-project relation.
 
-`-w`, `--warning`
-:   Show/hide a specific warning
+It is basically a `ls` or a simple `find` specialized on `.nit` source files.
 
-`-q`, `--quiet`
-:   Do not show warnings
+# EXAMPLES
 
-`--stop-on-first-error`
-:   Stop on first error
+Show the tree of modules from the current directory and subdirectories.
 
-`--no-color`
-:   Do not use color to display errors and warnings
+    $ nitls -t -r .
 
-`--log`
-:   Generate various log files
+Show the list of projects imported by the modules of the current directory.
 
-`--log-dir`
-:   Directory where to generate log files
+    $ nitls -d -P *.nit
 
-`-h`, `-?`, `--help`
-:   Show Help (This screen)
+# OPTIONS
 
-`--version`
-:   Show version and exit
+## COLLECT
 
-`--set-dummy-tool`
-:   Set toolname and version to DUMMY. Useful for testing
+`-r`, `--recursive`
+:   Process directories recursively.
 
-`-v`, `--verbose`
-:   Verbose
+    All `.nit` files found in the specified directory and subdirectories are considered.
 
-`--bash-completion`
-:   Generate bash_completion file for this program
+`-d`, `--depends`
+:   List dependencies of given modules
 
-`--stub-man`
-:   Generate a stub manpage in pandoc markdown format
+    All imported modules are also considered.
 
-`--disable-phase`
-:   DEBUG: Disable a specific phase; use `list` to get the list.
+`-k`, `--keep`
+:   Ignore errors and files that are not a Nit source file.
 
-`-I`, `--path`
-:   Set include path for loaders (may be used more than once)
+    When a file that is not a valit Nit module is encoutered, it is ignored and the rest of the file are
+    processed.
 
-`--only-parse`
-:   Only proceed to parse step of loaders
+    Without this option, a error message is displayed and nitls terminates on such a case.
 
-`--only-metamodel`
-:   Stop after meta-model processing
+## PRESENTATION MODE
 
-`--ignore-visibility`
-:   Do not check, and produce errors, on visibility issues.
+Three presentation modes are available.
 
-`-k`, `--keep`
-:   Ignore errors and files that are not a Nit source file
+`-P`, `--project`
+:   List projects in a flat list (default).
 
-`-r`, `--recursive`
-:   Process directories recussively
+    Only project are displayed (and not the individual files).
 
 `-t`, `--tree`
-:   List source files in their groups and projects
+:   List source files in their groups and projects.
+
+    Each `.nit` file is presented in a tree of projects and groups.
 
 `-s`, `--source`
-:   List source files
+:   List source files in a flat list.
 
-`-P`, `--project`
-:   List projects paths (default)
+    Each `.nit` file is presented indivitually.
 
-`-d`, `--depends`
-:   List dependencies of given modules
+## PRESENTATION OPTIONS
 
 `-p`, `--path`
-:   List only path (instead of name + path)
+:   List only path (instead of name + path).
 
 `-M`
-:   List dependencies suitable for a rule in a Makefile. Alias for -d, -p and -s
+:   List dependencies suitable for a rule in a Makefile.
+
+    Alias for `-d`, `-p` and `-s`.
 
 # SEE ALSO