share/man: add manpage for `nitpackage`
authorAlexandre Terrasa <alexandre@moz-code.org>
Wed, 2 May 2018 19:59:56 +0000 (15:59 -0400)
committerAlexandre Terrasa <alexandre@moz-code.org>
Fri, 4 May 2018 16:01:47 +0000 (12:01 -0400)
Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>

share/man/nitpackage.md [new file with mode: 0644]

diff --git a/share/man/nitpackage.md b/share/man/nitpackage.md
new file mode 100644 (file)
index 0000000..0c21fdb
--- /dev/null
@@ -0,0 +1,34 @@
+# NAME
+
+nitpackage - provide useful features to manage Nit packages.
+
+
+# SYNOPSIS
+
+nitpackage [*options*] FILE...
+
+
+# DESCRIPTION
+
+`nitpackage` provide packages related features.
+
+For now, only one thing is implemented: the *package expansion*.
+
+## Expanding packages
+
+The `--expand` option is used to move singleton packages in their own directory.
+
+For example, to move all singleton packages from `lib/` into directories, one can
+use the following command.
+
+~~~sh
+nitpackage --expand lib/
+~~~
+
+# OPTIONS
+
+### `--expand`
+Move singleton packages to their own directory.
+
+### `-h`, `-?`, `--help`
+Show Help (the list of options).