-% NITLS(1)
-
# NAME
-nitls - lists the projects, groups and paths of Nit sources files.
+nitls - lists the packages, groups and paths of Nit sources files.
# SYNOPSIS
-nitls [*options*] FILE...
+nitls [*options*] [*FILE*]...
# DESCRIPTION
-`nitls` is used to list Nit files in directories and extract the module-group-project relation.
+`nitls` is used to list Nit files in directories and extract the module-group-package relation.
It is basically a `ls` or a simple `find` specialized on `.nit` source files.
+By default `nitls` works with the current directory (`.`).
+
+Each file can then be:
+
+* A Nit module (file).
+ In this case, only this single module is considered
+* A Nit group (directory).
+ In this case, all the modules of the groups (and recursively the sub-groups) are considered
+* A normal directory.
+ In this case, all its entries are analysed.
+ Files that are Nit modules and directories that are Nit groups are considered.
+ Other files and directories are ignored.
+
# EXAMPLES
-Show the tree of modules from the current directory and subdirectories.
+Show the tree of modules from the current directory.
- $ nitls -t -r .
+ $ nitls -t
-Show the list of projects imported by the modules of the current directory.
+Show the list of packages imported by the modules of the current directory.
$ nitls -d -P *.nit
# OPTIONS
-## COLLECT
+Each combination of option
-`-r`, `--recursive`
-: Process directories recursively.
+## PRESENTATION MODE
- All `.nit` files found in the specified directory and subdirectories are considered.
+Three presentation modes are available.
-`-d`, `--depends`
-: List dependencies of given modules
+### `-P`, `--package`
+List packages in a flat list (default).
- All imported modules are also considered.
+Only package are displayed (and not the individual files).
-`-k`, `--keep`
-: Ignore errors and files that are not a Nit source file.
+### `-t`, `--tree`
+List source files in their groups and packages.
- When a file that is not a valit Nit module is encoutered, it is ignored and the rest of the file are
- processed.
+Each `.nit` file is presented in a tree of packages and groups.
- Without this option, a error message is displayed and nitls terminates on such a case.
+### `-s`, `--source`
+List source files in a flat list.
-## PRESENTATION MODE
+Each `.nit` file is presented individually.
-Three presentation modes are available.
+The three modes are exclusives.
+
+The default mode is `--package` unless one on the argument is a group, then it is `--group`.
+
+## COLLECT
-`-P`, `--project`
-: List projects in a flat list (default).
+### `-r`, `--recursive`
+Process directories recursively.
- Only project are displayed (and not the individual files).
+All `.nit` files found in the specified directory and subdirectories are considered.
-`-t`, `--tree`
-: List source files in their groups and projects.
+### `-d`, `--depends`
+List dependencies of given modules
- Each `.nit` file is presented in a tree of projects and groups.
+All imported modules are also considered.
-`-s`, `--source`
-: List source files in a flat list.
+In --tree and --source modes, the modules directly imported are also displayed.
- Each `.nit` file is presented indivitually.
+### `-k`, `--keep`
+Ignore errors and files that are not a Nit source file.
+
+When a file that is not a valid Nit module is encountered, it is ignored and the rest of the files are
+processed.
+
+Without this option, an error message is displayed and nitls terminates on such a case.
## PRESENTATION OPTIONS
-`-p`, `--path`
-: List only path (instead of name + path).
+### `-p`, `--path`
+List only path (instead of name + path).
+
+Paths are displayed uncolored.
-`-M`
-: List dependencies suitable for a rule in a Makefile.
+### `-M`
+List dependencies suitable for a rule in a Makefile.
- Alias for `-d`, `-p` and `-s`.
+Alias for `-d`, `-p` and `-s`.
# SEE ALSO
nitlanguage / nit.git / blobdiff