Merge pull request #648 from NativeScript/fatme/help-for-livesync-command

Mitko-Kerezov · Mitko-Kerezov · commit 2cda8fec249d · 2015-07-16T10:56:50.000+03:00
Help for live sync command
diff --git a/docs/man_pages/index.md b/docs/man_pages/index.md
@@ -32,6 +32,7 @@ Command | Description
 [debug `<Platform>`](project/testing/debug.html) | Debugs your project on a connected device. 
 [install](project/configuration/install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory.
 [plugin](lib-management/plugin.html) | Lets you manage the plugins for your project.
+[livesync](project/testing/livesync.html) | Synchronizes the latest changes in your project to devices.
 
 ## Device Commands
 Command | Description
diff --git a/docs/man_pages/project/testing/build-android.md b/docs/man_pages/project/testing/build-android.md
@@ -28,6 +28,9 @@ Command | Description
 [emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
 [emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
 [emulate](emulate.html) | You must run the emulate command with a related command.
+[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
+[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices.
+[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
diff --git a/docs/man_pages/project/testing/build-ios.md b/docs/man_pages/project/testing/build-ios.md
@@ -33,6 +33,9 @@ Command | Description
 [emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
 [emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
 [emulate](emulate.html) | You must run the emulate command with a related command.
+[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
+[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices.
+[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
diff --git a/docs/man_pages/project/testing/build.md b/docs/man_pages/project/testing/build.md
@@ -30,6 +30,9 @@ Command | Description
 [emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
 [emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
 [emulate](emulate.html) | You must run the emulate command with a related command.
+[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
+[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices.
+[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
diff --git a/docs/man_pages/project/testing/debug-android.md b/docs/man_pages/project/testing/debug-android.md
@@ -48,6 +48,9 @@ Command | Description
 [emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
 [emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
 [emulate](emulate.html) | You must run the emulate command with a related command.
+[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
+[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices.
+[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
diff --git a/docs/man_pages/project/testing/debug-ios.md b/docs/man_pages/project/testing/debug-ios.md
@@ -47,6 +47,9 @@ Command | Description
 [emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
 [emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
 [emulate](emulate.html) | You must run the emulate command with a related command.
+[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
+[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices.
+[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
diff --git a/docs/man_pages/project/testing/debug.md b/docs/man_pages/project/testing/debug.md
@@ -30,6 +30,9 @@ Command | Description
 [emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
 [emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
 [emulate](emulate.html) | You must run the emulate command with a related command.
+[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
+[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices.
+[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
diff --git a/docs/man_pages/project/testing/deploy.md b/docs/man_pages/project/testing/deploy.md
@@ -44,6 +44,9 @@ Command | Description
 [emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
 [emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
 [emulate](emulate.html) | You must run the emulate command with a related command.
+[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
+[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices.
+[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
diff --git a/docs/man_pages/project/testing/emulate-android.md b/docs/man_pages/project/testing/emulate-android.md
@@ -56,6 +56,9 @@ Command | Description
 [deploy](deploy.html) | Builds and deploys the project to a connected physical or virtual device.
 [emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
 [emulate](emulate.html) | You must run the emulate command with a related command.
+[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
+[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices.
+[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
diff --git a/docs/man_pages/project/testing/emulate-ios.md b/docs/man_pages/project/testing/emulate-ios.md
@@ -41,6 +41,9 @@ Command | Description
 [deploy](deploy.html) | Builds and deploys the project to a connected physical or virtual device.
 [emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
 [emulate](emulate.html) | You must run the emulate command with a related command.
+[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
+[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices.
+[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
diff --git a/docs/man_pages/project/testing/emulate.md b/docs/man_pages/project/testing/emulate.md
@@ -26,6 +26,9 @@ Command | Description
 [deploy](deploy.html) | Builds and deploys the project to a connected physical or virtual device.
 [emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
 [emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
+[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
+[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices.
+[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
diff --git a/docs/man_pages/project/testing/livesync-android.md b/docs/man_pages/project/testing/livesync-android.md
@@ -0,0 +1,35 @@
+livesync android
+==========
+
+Usage | Synopsis
+------|-------
+General | `$ tns livesync android [--device <Device ID>] [--watch]`
+
+Synchronizes the latest changes in your project to Android devices. 
+
+### Options
+* `--watch` - If set, when you save changes to the project, changes are automatically synchronized to the connected device.
+* `--device` - Specifies the serial number or the index of the connected device to which you want to synchronize changes. To list all connected devices, grouped by platform, run `$ tns device`
+
+### Attributes
+* `<Device ID>` is the device index or identifier as listed by `$ tns device`
+
+### Related Commands
+
+Command | Description
+----------|----------
+[build android](build-android.html) | Builds the project for Android and produces an APK that you can manually deploy on device or in the native emulator.
+[build ios](build-ios.html) | Builds the project for iOS and produces an APP or IPA that you can manually deploy in the iOS Simulator or on device, respectively.
+[build](build.html) | Builds the project for the selected target platform and produces an application package that you can manually deploy on device or in the native emulator.
+[debug android](debug-android.html) | Debugs your project on a connected Android device or in a native emulator.
+[debug ios](debug-ios.html) | Debugs your project on a connected iOS device or in a native emulator.
+[debug](debug.html) | Debugs your project on a connected device or in a native emulator.
+[deploy](deploy.html) | Builds and deploys the project to a connected physical or virtual device.
+[emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
+[emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
+[emulate](emulate.html) | You must run the emulate command with a related command.
+[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
+[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices.
+[run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
+[run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
+<% } %>
diff --git a/docs/man_pages/project/testing/livesync-ios.md b/docs/man_pages/project/testing/livesync-ios.md
@@ -0,0 +1,35 @@
+livesync ios
+==========
+
+Usage | Synopsis
+------|-------
+General | `$ tns livesync ios [--device <Device ID>] [--watch]`
+
+Synchronizes the latest changes in your project to iOS devices. 
+
+### Options
+* `--watch` - If set, when you save changes to the project, changes are automatically synchronized to the connected device.
+* `--device` - Specifies the serial number or the index of the connected device to which you want to synchronize changes. To list all connected devices, grouped by platform, run `$ tns device`
+
+### Attributes
+* `<Device ID>` is the device index or identifier as listed by `$ tns device`
+
+### Related Commands
+
+Command | Description
+----------|----------
+[build android](build-android.html) | Builds the project for Android and produces an APK that you can manually deploy on device or in the native emulator.
+[build ios](build-ios.html) | Builds the project for iOS and produces an APP or IPA that you can manually deploy in the iOS Simulator or on device, respectively.
+[build](build.html) | Builds the project for the selected target platform and produces an application package that you can manually deploy on device or in the native emulator.
+[debug android](debug-android.html) | Debugs your project on a connected Android device or in a native emulator.
+[debug ios](debug-ios.html) | Debugs your project on a connected iOS device or in a native emulator.
+[debug](debug.html) | Debugs your project on a connected device or in a native emulator.
+[deploy](deploy.html) | Builds and deploys the project to a connected physical or virtual device.
+[emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
+[emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
+[emulate](emulate.html) | You must run the emulate command with a related command.
+[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
+[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
+[run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
+[run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
+<% } %>
diff --git a/docs/man_pages/project/testing/livesync.md b/docs/man_pages/project/testing/livesync.md
@@ -0,0 +1,33 @@
+livesync
+==========
+
+Usage | Synopsis
+------|-------
+General | `$ tns livesync [<Platform>]`
+
+Synchronizes the latest changes in your project to devices. If no target platform is specified, changes are synchronized to all devices.
+
+### Attributes
+`<Platform>` is the target mobile platform to which you want to synchronize your changes. You can set the following target platforms.
+* `android` - Synchronizes the latest changes in your project to connected Android devices. 
+* `ios` - Synchronizes the latest changes in your project to connected iOS devices.
+
+### Related Commands
+
+Command | Description
+----------|----------
+[build android](build-android.html) | Builds the project for Android and produces an APK that you can manually deploy on device or in the native emulator.
+[build ios](build-ios.html) | Builds the project for iOS and produces an APP or IPA that you can manually deploy in the iOS Simulator or on device, respectively.
+[build](build.html) | Builds the project for the selected target platform and produces an application package that you can manually deploy on device or in the native emulator.
+[debug android](debug-android.html) | Debugs your project on a connected Android device or in a native emulator.
+[debug ios](debug-ios.html) | Debugs your project on a connected iOS device or in a native emulator.
+[debug](debug.html) | Debugs your project on a connected device or in a native emulator.
+[deploy](deploy.html) | Builds and deploys the project to a connected physical or virtual device.
+[emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
+[emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
+[emulate](emulate.html) | You must run the emulate command with a related command.
+[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices.
+[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
+[run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
+[run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
+<% } %>
diff --git a/docs/man_pages/project/testing/run-android.md b/docs/man_pages/project/testing/run-android.md
@@ -55,6 +55,9 @@ Command | Description
 [emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
 [emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
 [emulate](emulate.html) | You must run the emulate command with a related command.
+[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
+[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices.
+[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
 <% } %>
diff --git a/docs/man_pages/project/testing/run-ios.md b/docs/man_pages/project/testing/run-ios.md
@@ -47,6 +47,9 @@ Command | Description
 [emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
 [emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
 [emulate](emulate.html) | You must run the emulate command with a related command.
+[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
+[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices.
+[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
 <% } %>
diff --git a/docs/man_pages/project/testing/run.md b/docs/man_pages/project/testing/run.md
@@ -31,6 +31,9 @@ Command | Description
 [emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
 [emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
 [emulate](emulate.html) | You must run the emulate command with a related command.
+[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
+[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices.
+[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 <% } %>
