From 031354901d1f840e58cc8dc9ecfe2c3e0c07bfea Mon Sep 17 00:00:00 2001 From: =?utf8?q?Alexis=20Laferri=C3=A8re?= Date: Sat, 3 Mar 2018 15:53:20 -0500 Subject: [PATCH] share: update picnit man page MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Alexis Laferrière --- share/man/nitpm.md | 38 +++++++++++++++++++++++--------------- 1 file changed, 23 insertions(+), 15 deletions(-) diff --git a/share/man/nitpm.md b/share/man/nitpm.md index 56bc3eb..b0f222f 100644 --- a/share/man/nitpm.md +++ b/share/man/nitpm.md @@ -9,42 +9,50 @@ nitpm [--help] [--verbose] [] # OPTIONS ### `-h`, `--help` - -Show the help message. +Show help message. ### `-v`, `--verbose` - -Print more information, may be useful for debugging. +Print more information. # COMMANDS -### install - -Install a package by searching for its name or directly from a Git repository URL. +### `install` +Install packages by name, Git repository address or from the local package.ini. + # Search and install package by name, e.g. hello_nitpm: nitpm install hello_nitpm + + # Install package from a Git repository: nitpm install https://gitlab.com/xymus/hello_nitpm.git -### list + # Search and install a specific branch or tag of a package, e.g. 1.0: + nitpm install nitpm_test_versions=1.0 + + # Install all packages declared in the local package.ini file: + nitpm install +To support the last command, the package.ini file should list the required packages after `[package]` on an `import=` line: + + [package] + name=my_package + import=nitpm_test_versions=1.0,gamnit + +### `list` List installed packages. nitpm list -### upgrade - +### `upgrade` Upgrade a package. nitpm upgrade hello_nitpm -### uninstall - -Uninstall a package. +### `uninstall` +Uninstall packages. nitpm uninstall hello_nitpm -### help - +### `help` Show general help message or the help for a command. nitpm help -- 1.7.9.5