share/man/nitpackage.md

   1 # NAME
   2
   3 nitpackage - provide useful features to manage Nit packages.
   4
   5
   6 # SYNOPSIS
   7
   8 nitpackage [*options*] FILE...
   9
  10
  11 # DESCRIPTION
  12
  13 `nitpackage` provide packages related features.
  14
  15 For now, only one thing is implemented: the *package expansion*.
  16
  17 ## Expanding packages
  18
  19 The `--expand` option is used to move singleton packages in their own directory.
  20
  21 For example, to move all singleton packages from `lib/` into directories, one can
  22 use the following command.
  23
  24 ~~~sh
  25 nitpackage --expand lib/
  26 ~~~
  27
  28 ## Generating `package.ini` files
  29
  30 The `--gen-ini` option is used to create `package.ini` files.
  31
  32 For example, the following command will create a `package.ini` stub for each package
  33 that does not already have a one.
  34
  35 ~~~sh
  36 nitpackage --gen-ini lib/
  37 ~~~
  38
  39 The `--force` option can be used to force the creation of the INI stub even if the package
  40 already contains one.
  41
  42 ~~~sh
  43 nitpackage --gen-ini -f lib/
  44 ~~~
  45
  46 # OPTIONS
  47
  48 ### `--expand`
  49 Move singleton packages to their own directory.
  50
  51 ### `--gen-ini`
  52 Generate package.ini files.
  53
  54 ### `--check-ini`
  55 Check package.ini files.
  56
  57 ### `--gen-makefile`
  58 Generate Makefile files.
  59
  60 ### `--check-makefile`
  61 Check Makefile files.
  62
  63 ### `--check-man`
  64 Check manpages files.
  65
  66 ### `--gen-man`
  67 Generate manpages files.
  68
  69 ### `--check-readme`
  70 Check README.md files.
  71
  72 ### `-f`, `--force`
  73 Force update of existing files.
  74
  75 ### `-h`, `-?`, `--help`
  76 Show Help (the list of options).