Updated Branches: refs/heads/master2 2f1210891 -> 8cd7d1cde
[CB-3794] Clarified help documentation. Project: http://git-wip-us.apache.org/repos/asf/cordova-cli/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-cli/commit/8cd7d1cd Tree: http://git-wip-us.apache.org/repos/asf/cordova-cli/tree/8cd7d1cd Diff: http://git-wip-us.apache.org/repos/asf/cordova-cli/diff/8cd7d1cd Branch: refs/heads/master2 Commit: 8cd7d1cde4a3d6ac5922a39c97479c7048c2eddf Parents: 2f12108 Author: Fil Maj <[email protected]> Authored: Tue Jun 18 10:09:25 2013 -0700 Committer: Fil Maj <[email protected]> Committed: Tue Jun 18 10:09:25 2013 -0700 ---------------------------------------------------------------------- bin/cordova | 2 +- doc/help.txt | 41 ++++++++++++++++++++++------------------- 2 files changed, 23 insertions(+), 20 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/8cd7d1cd/bin/cordova ---------------------------------------------------------------------- diff --git a/bin/cordova b/bin/cordova index 130f115..fc7fbb4 100755 --- a/bin/cordova +++ b/bin/cordova @@ -32,7 +32,7 @@ if (verbose) { if (version) { console.log(require('../package').version); } else if (cmd === undefined) { - console.log(cordova.help()); + cordova.help(); } else if (cordova.hasOwnProperty(cmd)) { var opts = Array.prototype.slice.call(tokens, 0); if (cmd == 'create' || cmd == 'docs' || cmd == 'serve') { http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/8cd7d1cd/doc/help.txt ---------------------------------------------------------------------- diff --git a/doc/help.txt b/doc/help.txt index 73510d0..f0cab81 100644 --- a/doc/help.txt +++ b/doc/help.txt @@ -4,31 +4,34 @@ Synopsis Global Commands - create [path] [id] [name] ......... creates a cordova project in the specified directory optional name and id (package name, reverse-domain style) + create <PATH> [ID] [NAME] ................ creates a cordova project in the specified PATH, with + optional NAME and ID (reverse-domain-style package name) + help ..................................... shows this syntax summary Project-Level Commands - platform(s) [add|remove|ls [name]] ... adds or removes a platform, or lists all currently-added platforms - plugin(s) [add|remove|ls [path]] ..... adds or removes a plugin (from the specified path), or lists all currently-added plugins - prepare [platform...] ................ copies files into the specified platforms, or all platforms - it is then ready for building by Eclipse/Xcode/etc - compile [platform...] ................ builds the app for the specified (or all) platforms - build [platform...]................... alias for prepare and then compile - emulate [platform...] ................ starts emulator for the specified (or all) platforms, then deploys application to emulator - run [platform...] .................... deployes the application to the specified (or all) platform devices, which must be - connected and configured for running via your machine - serve <platform> [port] .............. runs a local web server for the www/ directory of the given platform - the default port is 8000 - note that you must edit the native code to point at the server! - ripple <platform> [port] ............. uses the serve command as a base and then wraps the server - with ripple to test your app in your desktop browser - help ................................. shows this! + platform(s) {add|remove|rm} <PLATFORM> ... add or remove a specified PLATFORM + platform(s) ls ........................... list all currently installed platforms + plugin(s) {add|remove|rm} <PATH> ......... add or remove a plugin from the specified PATH + plugin(s) ls ............................. list all currently installed plugins + prepare [PLATFORM..] ..................... copies files for specified platforms, or all platforms, + so that the project is ready to build in each SDK. + compile [PLATFORM..] ..................... builds the app for specified platforms, or all platforms + build [PLATFORM...] ...................... shortcut for prepare, then compile + emulate [PLATFORM...] .................... deploys app in specified (or all) platforms' emulator, + opening emulator if necessary + run [PLATFORM...] ........................ deploys app on specified (or all) platform devices, which + must be properly connected and configured in each SDK + serve <PLATFORM> [PORT] .................. runs a local web server for the specified platform's www/ + directory, with optional port number that defaults to 8000. + (Note: you must edit the native code to reference the server.) + ripple <PLATFORM> [PORT] ................. same as serve, but app displays within the ripple device emulator Command-line Flags/Options - -v, --version ......................... prints out this utility's version - -d, --verbose ......................... debug, or verbose, mode. Makes this utility very chatty, logging everything it does, including - redirecting output of commands it shells out to back to stdout + -v, --version ............................ prints out this utility's version + -d, --verbose ............................ debug mode produces verbose log output for all activity, + including output of sub-commands cordova invokes Example usage
