Split up docs by command and add a short summary
diff --git a/doc/create.txt b/doc/create.txt
new file mode 100644
index 0000000..933034a
--- /dev/null
+++ b/doc/create.txt
@@ -0,0 +1,13 @@
+Create a plugin
+
+Usage: plugman create PARAMETER... [OPTION]...
+
+Parameters:
+ --name <pluginName> The name of the plugin
+ --plugin_id <pluginID> An ID for the plugin, ex: org.bar.foo
+ --plugin_version <version> A version for the plugin, ex: 0.0.1
+
+Options:
+ --path <directory> An absolute or relative path for the directory
+ where the plugin project will be created
+ --variable NAME=VALUE Extra variables such as description or Author
diff --git a/doc/createpackagejson.txt b/doc/createpackagejson.txt
new file mode 100644
index 0000000..0d32061
--- /dev/null
+++ b/doc/createpackagejson.txt
@@ -0,0 +1,3 @@
+Derive a package.json file for a plugin based on its plugin.xml
+
+Usage: plugman createpackagejson <plugin directory>
diff --git a/doc/help.txt b/doc/help.txt
deleted file mode 100644
index 5d3723b..0000000
--- a/doc/help.txt
+++ /dev/null
@@ -1,87 +0,0 @@
-plugman manages plugin.xml-compatible cordova plugins into cordova-generated projects.
-
-Usage
-=====
-
-To display this help file, use one of the following:
-
-$ plugman --help
-$ plugman -h
-
-To display the plugman version, use one of the following:
-
- $ plugman --version
- $ plugman -v
-
-Optional flags
---------------
-
- --debug|-d : Verbose mode
-
-Install a plugin
-----------------
-
- $ plugman install --platform <platform> --project <directory> --plugin <plugin> [--variable NAME=VALUE]
-
-Parameters:
-
- - platform <platform>: One of android, ios, blackberry10, wp8, or windows8
- - project <directory>: Path reference to a cordova-generated project of the platform you specify
- - plugin <plugin>: One of a path reference to a local copy of a plugin, or a remote https: or git: URL pointing to a cordova plugin (optionally append #branch:subdir) or a plugin ID from http://plugins.cordova.io
- - variable NAME=VALUE: Some plugins require install-time variables to be defined. These could be things like API keys/tokens or other app-specific variables.
-
- Optional parameters:
-
- - www <directory>: www assets for the plugin will be installed into this directory. Default is to install into the standard www directory for the platform specified
- - plugins_dir <directory>: a copy of the plugin will be stored in this directory. Default is to install into the <project directory>/plugins folder
- - searchpath <directory>: when looking up plugins by ID, look in this directory and each of its subdirectories for the plugin before hitting the registry.
- Multiple search paths can be used by either specifying the flag multiple times, or by separating paths with a delimiter (: on 'nix, ; on Windows).
-
-Uninstall a plugin
-------------------
-
- $ plugman uninstall --platform <platform> --project <directory> --plugin <plugin-id>
-
-Parameters:
-
- - platform <platform>: One of android, ios, blackberry10, wp8, or windows8
- - project <directory>: Path reference to a cordova-generated project of the platform you specify
- - plugin <plugin-id>: The plugin to remove, identified by its id (see the plugin.xml's <plugin id> attribute)
-
-Create A Plugin
----------------
-
- $ plugman create --name <pluginName> --plugin_id <pluginID> --plugin_version <version> [--path <directory>] [--variable NAME=VALUE]
-
-Parameters:
-
- - <pluginName>: The name of the plugin
- - <pluginID>: An ID for the plugin, ex: org.bar.foo
- - <version>: A version for the plugin, ex: 0.0.1
- - <directory>: An absolute or relative path for the directory where the plugin project will be created
- - variable NAME=VALUE: Extra variables such as description or Author
-
-Add a Package.JSON file to plugin
----------------------------------
-Creates a package.json file in the plugin based on values from plugin.xml.
-
- $ plugman createpackagejson <directory>
-
-
-Add a Platform to a Plugin
---------------------------
-
- $ plugman platform add --platform_name <platform>
-
-Parameters:
-
-- <platform>: One of android, ios
-
-Remove a Platform from a Plugin
--------------------------------
-
- $ plugman platform remove --platform_name <platform>
-
-Parameters:
-
-- <platform>: One of android, ios
diff --git a/doc/install.txt b/doc/install.txt
new file mode 100644
index 0000000..60f68fa
--- /dev/null
+++ b/doc/install.txt
@@ -0,0 +1,26 @@
+Install a plugin
+
+Usage: plugman install PARAMETER... [OPTION]...
+
+Parameters:
+ --platform <platform> The platform for which to install the plugin
+ --project <directory> Path to a cordova-generated project of <platform>
+ --plugin <plugin> The spec of the plugin to install. Anything that
+ could be passed to npm install
+
+Options:
+ --variable NAME=VALUE Some plugins require install-time variables to be
+ defined. These could be things like API keys/tokens
+ or other app-specific variables.
+ --www <directory> www assets for the plugin will be installed into
+ this directory. Default is to install into the
+ standard www directory for the platform specified
+ --plugins_dir <directory> a copy of the plugin will be stored in this
+ directory. Default is to install into the
+ <project directory>/plugins folder
+ --searchpath <directory> when looking up plugins by ID, look in this
+ directory and each of its subdirectories for the
+ plugin before hitting the registry. Multiple search
+ paths can be used by either specifying the flag
+ multiple times, or by separating paths with a
+ delimiter (: on 'nix, ; on Windows).
diff --git a/doc/platform.txt b/doc/platform.txt
new file mode 100644
index 0000000..918e916
--- /dev/null
+++ b/doc/platform.txt
@@ -0,0 +1,4 @@
+Add or remove a platform to a plugin
+
+Usage: plugman platform add --platform_name <platform>
+ plugman platform remove --platform_name <platform>
diff --git a/doc/summary.txt b/doc/summary.txt
new file mode 100644
index 0000000..69527f0
--- /dev/null
+++ b/doc/summary.txt
@@ -0,0 +1,17 @@
+Usage: plugman [OPTION]... <command>
+
+These are the available plugman commands:
+
+Manage plugins in a Cordova project
+ install Install a plugin into a Cordova project
+ uninstall Uninstall a plugin from a Cordova project
+
+Author plugins
+ create Create a plugin
+ createpackagejson Add a package.json file to a plugin
+ platform Add and remove platforms from a plugin
+
+Global options:
+ --help, -h Show help for <command> or this if none was given
+ --debug, -d Enable verbose output
+ --version, -v Display the plugman version
diff --git a/doc/uninstall.txt b/doc/uninstall.txt
new file mode 100644
index 0000000..218c6be
--- /dev/null
+++ b/doc/uninstall.txt
@@ -0,0 +1,9 @@
+Uninstall a plugin
+
+Usage plugman uninstall PARAMETER...
+
+Parameters:
+ --platform <platform> The platform from which to install the plugin
+ --project <directory> Path to a cordova-generated project of <platform>
+ --plugin <plugin-id> The ID of the plugin to remove; see attribute 'id'
+ of element 'plugin' in plugin.xml
diff --git a/main.js b/main.js
index 2f625df..28cabb7 100755
--- a/main.js
+++ b/main.js
@@ -84,7 +84,7 @@
if (cli_opts.version) {
console.log(pkg.version);
} else if (cli_opts.help) {
- console.log(help());
+ console.log(help(commands[cmd] ? cmd : 'summary'));
} else if (commands[cmd]) {
Promise.resolve(commands[cmd](cli_opts))
.catch(fail);
diff --git a/src/help.js b/src/help.js
index f2233b5..05d24c6 100644
--- a/src/help.js
+++ b/src/help.js
@@ -19,8 +19,10 @@
var fs = require('fs');
var path = require('path');
-var doc_txt = path.join(__dirname, '..', 'doc', 'help.txt');
-module.exports = function help () {
- return fs.readFileSync(doc_txt, 'utf-8');
+const docsDir = path.join(__dirname, '../doc');
+
+module.exports = function help (topic = 'summary') {
+ const doc = path.join(docsDir, topic + '.txt');
+ return fs.readFileSync(doc, 'utf-8');
};
