X-Git-Url: http://nitlanguage.org diff --git a/share/man/nitls.md b/share/man/nitls.md index b8273f4..5e9ec4d 100644 --- a/share/man/nitls.md +++ b/share/man/nitls.md @@ -1,8 +1,6 @@ -% 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 @@ -10,7 +8,7 @@ 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. @@ -33,7 +31,7 @@ Show the tree of modules from the current directory. $ 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 @@ -45,58 +43,58 @@ Each combination of option Three presentation modes are available. -`-P`, `--project` -: List projects in a flat list (default). +### `-P`, `--package` +List packages in a flat list (default). - Only project are displayed (and not the individual files). +Only package are displayed (and not the individual files). -`-t`, `--tree` -: List source files in their groups and projects. +### `-t`, `--tree` +List source files in their groups and packages. - Each `.nit` file is presented in a tree of projects and groups. +Each `.nit` file is presented in a tree of packages and groups. -`-s`, `--source` -: List source files in a flat list. +### `-s`, `--source` +List source files in a flat list. - Each `.nit` file is presented indivitually. +Each `.nit` file is presented individually. The three modes are exclusives. -The default mode is `--project` unless one on the argument is a group, then it is `--group`. +The default mode is `--package` unless one on the argument is a group, then it is `--group`. ## COLLECT -`-r`, `--recursive` -: Process directories recursively. +### `-r`, `--recursive` +Process directories recursively. - All `.nit` files found in the specified directory and subdirectories are considered. +All `.nit` files found in the specified directory and subdirectories are considered. -`-d`, `--depends` -: List dependencies of given modules +### `-d`, `--depends` +List dependencies of given modules. - All imported modules are also considered. +All imported modules are also considered. - In --tree and --source modes, the modules direclty imported are also displayed. +In --tree and --source modes, the modules directly imported are also displayed. -`-k`, `--keep` -: Ignore errors and files that are not a Nit source file. +### `-k`, `--keep` +Ignore errors and files that are not a Nit source file. - When a file that is not a valid Nit module is encoutered, it is ignored and the rest of the files are - processed. +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. +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-only` +List only path (instead of name + path). - Paths are displayed uncolored. +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