Skip to content

Commit f5d22fd

Browse files
rosen-vladimirovrosen-vladimirov
committed
Merge pull request #424 from NativeScript/ikoevska/html-help
HTML help
2 parents 93f0ba2 + f88f4cc commit f5d22fd

37 files changed

+646
-382
lines changed

‎docs/man_pages/device/device-android.md‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,22 @@
11
device android
22
==========
33

4-
Usage:
5-
`$ tns device android [--timeout <Milliseconds>]`
6-
Lists all recognized connected physical and running virtual devices with serial number and index.
4+
Usage | Synopsis
5+
------|-------
6+
General | `$ tns device android [--timeout <Milliseconds>]`
77

8-
If a connected Android device is not shown in the list, make sure that you have installed the required Android USB drivers on your system
9-
and that USB debugging is enabled on the device.
8+
Lists all recognized connected Android physical and running virtual devices with serial number and index. <% if(isHtml) { %>If a connected Android device is not shown in the list, make sure that you have installed the required Android USB drivers on your system and that USB debugging is enabled on the device.<% } %>
109

11-
Options:
12-
* `--timeout` - Sets the time in milliseconds for the operation to search for connected devices before completing. The operation will continue to wait and listen for newly connected devices and will list them after the specified time expires. If not set, the default value is 4000.
13-
<% if(isHtml) { %>
10+
### Options
11+
* `--timeout` - Sets the time in milliseconds for the operation to search for connected devices before completing. If not set, the default value is 4000. <% if(isHtml) { %>The operation will continue to wait and listen for newly connected devices and will list them after the specified time expires.
1412

15-
#### Related Commands
13+
### Related Commands
1614

1715
Command | Description
1816
----------|----------
17+
[device](device.html) | Lists all recognized connected devices with serial number and index, grouped by platform.
1918
[device ios](device-ios.html) | Lists all recognized connected iOS devices with serial number and index.
2019
[device list-applications](device-list-applications.html) | Lists the installed applications on all connected Android and iOS devices.
2120
[device log](device-log.html) | Opens the device log stream for a selected connected device.
2221
[device run](device-run.html) | Runs the selected application on a connected Android or iOS device.
23-
[device](device.html) | Lists all recognized connected devices with serial number and index, grouped by platform.
2422
<% } %>

‎docs/man_pages/device/device-ios.md‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,29 @@
11
device ios
22
==========
33

4-
Usage:
5-
`$ tns device ios [--timeout <Milliseconds>]`
4+
Usage | Synopsis
5+
------|-------
6+
General | `$ tns device ios [--timeout <Milliseconds>]`
67

78
Lists all recognized connected iOS devices with serial number and index.
89

9-
Options:
10-
* `--timeout` - Sets the time in milliseconds for the operation to search for connected devices before completing. The operation will continue to wait and listen for newly connected devices and will list them after the specified time expires. If not set, the default value is 4000.
11-
<% if(isHtml) { %>
10+
<% if(isConsole && (isLinux)) { %>WARNING: You can run this command only on Windows and OS X systems. To view the complete help for this command, run `$ tns help device ios`<% } %>
1211

13-
#### Related Commands
12+
<% if((isConsole && (isMacOS||isWindows) || isHtml) { %>
13+
### Options
14+
* `--timeout` - Sets the time in milliseconds for the operation to search for connected devices before completing. If not set, the default value is 4000. <% } %><% if(isHtml) { %>The operation will continue to wait and listen for newly connected devices and will list them after the specified time expires.
15+
16+
### Command Limitations
17+
18+
* You can run `$ tns device ios` on Windows and OS X systems.
19+
20+
### Related Commands
1421

1522
Command | Description
1623
----------|----------
24+
[device](device.html) | Lists all recognized connected devices with serial number and index, grouped by platform.
1725
[device android](device-android.html) | Lists all recognized connected physical and running virtual devices with serial number and index.
1826
[device list-applications](device-list-applications.html) | Lists the installed applications on all connected Android and iOS devices.
1927
[device log](device-log.html) | Opens the device log stream for a selected connected device.
2028
[device run](device-run.html) | Runs the selected application on a connected Android or iOS device.
21-
[device](device.html) | Lists all recognized connected devices with serial number and index, grouped by platform.
2229
<% } %>

‎docs/man_pages/device/device-list-applications.md‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
11
device list-applications
22
==========
33

4-
Usage:
5-
`$ tns device list-applications [--device <Device ID>]`
4+
Usage | Synopsis
5+
------|-------
6+
General | `$ tns device list-applications [--device <Device ID>]`
67

7-
Lists the installed applications on all connected Android and iOS devices.
8+
Lists the installed applications on all connected Android <% if(isWindows || isMacOS) { %>and iOS <% } %>devices.
89

9-
`<Device ID>` is the device index or identifier as listed by run `$ tns device`
10-
Options:
10+
### Options
1111
* `--device` - If multiple devices are connected, sets the device for which you want to list all currently installed applications.
12+
13+
### Attributes
14+
* `<Device ID>` is the device index or identifier as listed by run `$ tns device`
15+
1216
<% if(isHtml) { %>
17+
### Command Limitations
18+
19+
* You cannot work with connected iOS devices on Linux systems.
1320

14-
#### Related Commands
21+
### Related Commands
1522

1623
Command | Description
1724
----------|----------

‎docs/man_pages/device/device-log.md‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,30 @@
11
device log
22
==========
33

4-
Usage:
5-
`$ tns device log --device <Device ID>`
6-
Opens the device log stream for a selected connected device.
4+
Usage | Synopsis
5+
------|-------
6+
General | `$ tns device log [--device <Device ID>]`
77

8-
`<Device ID>` is the device index or identifier as listed by `$ tns device`
9-
Options:
8+
Opens the device log stream for a selected connected Android <% if(isWindows || isMacOS) { %>or iOS <% } %>device.
9+
10+
### Options
1011
* `--device` - If multiple devices are connected, sets the device for which you want to stream the log in the console.
12+
13+
### Attributes
14+
* `<Device ID>` is the device index or identifier as listed by `$ tns device`
15+
1116
<% if(isHtml) { %>
17+
### Command Limitations
1218

13-
#### Related Commands
19+
* You cannot work with connected iOS devices on Linux systems.
20+
21+
### Related Commands
1422

1523
Command | Description
1624
----------|----------
25+
[device](device.html) | Lists all recognized connected devices with serial number and index, grouped by platform.
1726
[device android](device-android.html) | Lists all recognized connected physical and running virtual devices with serial number and index.
1827
[device ios](device-ios.html) | Lists all recognized connected iOS devices with serial number and index.
1928
[device list-applications](device-list-applications.html) | Lists the installed applications on all connected Android and iOS devices.
2029
[device run](device-run.html) | Runs the selected application on a connected Android or iOS device.
21-
[device](device.html) | Lists all recognized connected devices with serial number and index, grouped by platform.
2230
<% } %>

‎docs/man_pages/device/device-run.md‎

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,45 @@
11
device run
22
==========
33

4-
Usage:
5-
`$ tns device run <ApplicationId> [--print-app-output] [--device <Device ID>]`
6-
Runs the selected application on a connected Android or iOS device.
7-
You can run this command on one connected device at a time.
4+
Usage | Synopsis
5+
------|-------
6+
General | `$ tns device run <Application ID> [--device <Device ID>]`
87

9-
`<Application ID> is the application identifier as listed by `$ tns device list-applications`<Device ID>` is the device index or identifier as listed by run `$ tns device`
10-
Prerequisites:
8+
Runs the selected application on a connected Android <% if(isMacOS) { %>or iOS <% } %>device.
9+
10+
<% if(isConsole && (isWindows || isLinux)) { %>WARNING: You can work only with connected Android devices.<% } %>
11+
12+
### Options
13+
* `--device` - If multiple devices are connected, sets the device on which you want to run the app.
14+
15+
### Attributes
16+
* `<Application ID>` is the application identifier as listed by `$ tns device list-applications`
17+
* `<Device ID>` is the device index or identifier as listed by run `$ tns device`
18+
19+
<% if(isHtml) { %>
20+
### Prerequisites
1121
Before running your app on an iOS device, verify that your system and app meet the following requirements.
22+
1223
* You are running the NativeScript CLI on an OS X system.
1324
* You have installed Xcode 5 or later.
14-
* You have built your app with the debug build configuration. Before running your app on an Android device, verify that your app meets the following requirement.
1525
* You have built your app with the debug build configuration.
1626

17-
Options:
18-
* `--print-app-output` - If set, prints the output of the running application.
19-
* `--device` - If multiple devices are connected, sets the device on which you want to run the app. You can run this command on one connected device at a time.
20-
<% if(isHtml) { %>
27+
Before running your app on an Android device, verify that your app meets the following requirement.
2128

22-
#### Related Commands
29+
* You have built your app with the debug build configuration.
30+
31+
### Command Limitations
32+
33+
* You can run this command on one connected device at a time.
34+
* You can run this command for iOS devices only on OS X systems.
35+
36+
### Related Commands
2337

2438
Command | Description
2539
----------|----------
40+
[device](device.html) | Lists all recognized connected devices with serial number and index, grouped by platform.
2641
[device android](device-android.html) | Lists all recognized connected physical and running virtual devices with serial number and index.
2742
[device ios](device-ios.html) | Lists all recognized connected iOS devices with serial number and index.
2843
[device list-applications](device-list-applications.html) | Lists the installed applications on all connected Android and iOS devices.
2944
[device log](device-log.html) | Opens the device log stream for a selected connected device.
30-
[device](device.html) | Lists all recognized connected devices with serial number and index, grouped by platform.
3145
<% } %>

‎docs/man_pages/device/device.md‎

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,26 @@
11
device
22
==========
33

4-
Usage:
5-
`$ tns device [<Command>]`
6-
Lists all recognized connected devices with serial number and index, grouped by platform. In this version of the NativeScript CLI,
7-
you can connect only iOS and Android devices.
4+
Usage | Synopsis
5+
------|---------
6+
General | `$ tns device [<Command>]`
87

9-
`<Command>` is a related command that extends the device command. You can run the following related commands:
8+
Lists all recognized connected Android <% if(isWindows || isMacOS) { %>or iOS devices <% } %>with serial number and index<% if(isWindows || isMacOS) { %>, grouped by platform<% } %>.
9+
10+
### Attributes
11+
`<Command>` extends the `device` command. You can set the following values for this attribute.
1012
* `android` - Lists all recognized connected Android physical and running Android virtual devices.
11-
* `ios` - Lists all recognized connected iOS devices.
13+
<% if(isWindows || isMacOS) { %>* `ios` - Lists all recognized connected iOS devices. <% } %>
1214
* `log` - Opens the device log stream for a selected connected device.
13-
* `list-applications` - Lists the installed applications on all connected Android `<% if(isWindows || isMacOS) { %>or iOS <%}%>`devices.
14-
* `run` - Runs the selected application on a connected Android `<% if(isMacOS) { %>or iOS <%}%>`device.
15+
* `list-applications` - Lists the installed applications on all connected Android <% if(isWindows || isMacOS) { %>or iOS <%}%>devices.
16+
* `run` - Runs the selected application on a connected Android <% if(isMacOS) { %>or iOS <%}%>device.
17+
1518
<% if(isHtml) { %>
19+
### Command Limitations
20+
21+
* You can run `$ tns device ios` on Windows and OS X systems.
1622

17-
#### Related Commands
23+
### Related Commands
1824

1925
Command | Description
2026
----------|----------

‎docs/man_pages/general/autocomplete-disable.md‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,21 @@
11
autocomplete disable
22
==========
33

4-
Usage | Syntax
4+
Usage | Synopsis
55
------|-------
66
General | `$ tns autocomplete disable`
77

8+
Disables command-line completion for bash and zsh shells. You need to restart the shell to complete the operation.
89

9-
Disables autocompletion for bash and zsh.
10-
11-
> NOTE: This will modify your .bash_profile, .bashrc and .zshrc files.
12-
10+
<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files.
1311
<% if(isHtml) { %>
14-
15-
#### Related Commands
12+
### Related Commands
1613

1714
Command | Description
1815
----------|----------
19-
[autocomplete-status](autocomplete-status.html) | Shows if autocompletion is enabled for bash and zsh.
2016
[autocomplete](autocomplete.html) | Asks for confirmation if command line autocompletion should be enabled for bash and zsh.
21-
[autocomplete-enable](autocomplete-enable.html) | Enables autocompletion for bash and zsh.
17+
[autocomplete-status](autocomplete-status.html) | Prints the current status of your command-line completion settings.
18+
[autocomplete-enable](autocomplete-enable.html) |[autocomplete](autocomplete.html) | Configures your current command-line completion settings.
2219
[feature-usage-tracking](feature-usage-tracking.html) | Configures anonymous usage statistics tracking for the NativeScript command-line interface.
2320
[help](help.html) | Lists the available commands or shows information about the selected command.
2421
<% } %>

‎docs/man_pages/general/autocomplete-enable.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
autocomplete enable
22
==========
33

4-
Usage | Syntax
4+
Usage | Synopsis
55
------|-------
66
General | `$ tns autocomplete enable`
77

8+
Enables command-line completion for bash and zsh shells. You need to restart the shell to complete the operation.
89

9-
Enables autocompletion for bash and zsh.
10-
11-
> NOTE: This will modify your .bash_profile, .bashrc and .zshrc files.
12-
10+
<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files.
1311
<% if(isHtml) { %>
14-
15-
#### Related Commands
12+
### Related Commands
1613

1714
Command | Description
1815
----------|----------
16+
[autocomplete](autocomplete.html) | Asks for confirmation if command line autocompletion should be enabled for bash and zsh.
17+
[autocomplete-status](autocomplete-status.html) | Prints the current status of your command-line completion settings.
18+
[autocomplete-disable](autocomplete-disable.html) | Disables command-line completion for bash and zsh shells.
1919
[feature-usage-tracking](feature-usage-tracking.html) | Configures anonymous usage statistics tracking for the NativeScript command-line interface.
2020
[help](help.html) | Lists the available commands or shows information about the selected command.
2121
<% } %>

‎docs/man_pages/general/autocomplete-status.md‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
11
autocomplete status
22
==========
33

4-
Usage | Syntax
4+
Usage | Synopsis
55
------|-------
66
General | `$ tns autocomplete status`
77

8-
9-
Shows if autocompletion is enabled for bash and zsh.
8+
Prints your current command-line completion settings.
109

1110
<% if(isHtml) { %>
12-
13-
#### Related Commands
11+
### Related Commands
1412

1513
Command | Description
1614
----------|----------
17-
[autocomplete](autocomplete.html) | Asks for confirmation if command line autocompletion should be enabled for bash and zsh.
18-
[autocomplete-enable](autocomplete-enable.html) | Enables autocompletion for bash and zsh.
19-
[autocomplete-disable](autocomplete-disable.html) | Disables autocompletion for bash and zsh.
15+
[autocomplete](autocomplete.html) | Prints your current command-line completion settings. If disabled, prompts you to enable it.
16+
[autocomplete-enable](autocomplete-enable.html) |[autocomplete](autocomplete.html) | Configures your current command-line completion settings.
17+
[autocomplete-disable](autocomplete-disable.html) | Disables command-line completion for bash and zsh shells.
2018
[feature-usage-tracking](feature-usage-tracking.html) | Configures anonymous usage statistics tracking for the NativeScript command-line interface.
2119
[help](help.html) | Lists the available commands or shows information about the selected command.
2220
<% } %>

‎docs/man_pages/general/autocomplete.md‎

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,30 @@
11
autocomplete
22
==========
33

4-
Usage | Syntax
4+
Usage | Synopsis
55
------|-------
6-
General | `$ appbuilder autocomplete`
7-
Get status | `$ appbuilder autocomplete status`
8-
Enable | `$ appbuilder autocomplete enable`
9-
Disable | `$ appbuilder autocomplete disable`
6+
General | `$ tns autocomplete [<Command>]`
7+
Get settings | `$ tns autocomplete status`
8+
Enable | `$ tns autocomplete enable`
9+
Disable | `$ tns autocomplete disable`
1010

11+
Prints your current command-line completion settings. If disabled, prompts you to enable it.
1112

12-
Asks for confirmation if command line autocompletion should be enabled for bash and zsh.
13+
<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files.
1314

14-
> NOTE: This will modify your .bash_profile, .bashrc and .zshrc files.
15-
<% if(isHtml) { %>
15+
### Attributes
16+
`<Command>` extends the `autocomplete` command. You can set the following values for this attribute.
17+
* `status` - Prints your current command-line completion settings.
18+
* `enable` - Enables command-line completion. You need to restart the shell to complete the operation.
19+
* `disable` - Disables command-line completion. You need to restart the shell to complete the operation.
1620

17-
#### Related Commands
21+
<% if(isHtml) { %>
22+
### Related Commands
1823

1924
Command | Description
2025
----------|----------
21-
[autocomplete-status](autocomplete-status.html) | Shows if autocompletion is enabled for bash and zsh.
22-
[autocomplete-enable](autocomplete-enable.html) | Enables autocompletion for bash and zsh.
23-
[autocomplete-disable](autocomplete-disable.html) | Disables autocompletion for bash and zsh.
26+
[autocomplete-status](autocomplete-status.html) | Prints the current status of your command-line completion settings.
27+
[autocomplete-enable](autocomplete-enable.html) |[autocomplete](autocomplete.html) | Configures your current command-line completion settings.
28+
[autocomplete-disable](autocomplete-disable.html) | Disables command-line completion for bash and zsh shells.
2429
[feature-usage-tracking](feature-usage-tracking.html) | Configures anonymous usage statistics tracking for the NativeScript command-line interface.
25-
[help](help.html) | Lists the available commands or shows information about the selected command.
2630
<% } %>

0 commit comments

Comments
 (0)