share/man/nitls.md

   1 % NITLS(1)
   2
   3 # NAME
   4
   5 nitls - lists the projects, groups and paths of Nit sources files.
   6
   7 # SYNOPSIS
   8
   9 nitls [*options*] FILE...
  10
  11 # DESCRIPTION
  12
  13 `nitls` is used to list Nit files in directories and extract the module-group-project relation.
  14
  15 It is basically a `ls` or a simple `find` specialized on `.nit` source files.
  16
  17 # EXAMPLES
  18
  19 Show the tree of modules from the current directory and subdirectories.
  20
  21     $ nitls -t -r .
  22
  23 Show the list of projects imported by the modules of the current directory.
  24
  25     $ nitls -d -P *.nit
  26
  27 # OPTIONS
  28
  29 ## COLLECT
  30
  31 `-r`, `--recursive`
  32 :   Process directories recursively.
  33
  34     All `.nit` files found in the specified directory and subdirectories are considered.
  35
  36 `-d`, `--depends`
  37 :   List dependencies of given modules
  38
  39     All imported modules are also considered.
  40
  41 `-k`, `--keep`
  42 :   Ignore errors and files that are not a Nit source file.
  43
  44     When a file that is not a valit Nit module is encoutered, it is ignored and the rest of the file are
  45     processed.
  46
  47     Without this option, a error message is displayed and nitls terminates on such a case.
  48
  49 ## PRESENTATION MODE
  50
  51 Three presentation modes are available.
  52
  53 `-P`, `--project`
  54 :   List projects in a flat list (default).
  55
  56     Only project are displayed (and not the individual files).
  57
  58 `-t`, `--tree`
  59 :   List source files in their groups and projects.
  60
  61     Each `.nit` file is presented in a tree of projects and groups.
  62
  63 `-s`, `--source`
  64 :   List source files in a flat list.
  65
  66     Each `.nit` file is presented indivitually.
  67
  68 ## PRESENTATION OPTIONS
  69
  70 `-p`, `--path`
  71 :   List only path (instead of name + path).
  72
  73 `-M`
  74 :   List dependencies suitable for a rule in a Makefile.
  75
  76     Alias for `-d`, `-p` and `-s`.
  77
  78 # SEE ALSO
  79
  80 The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>