[CLI] Update CLI contents 09/156809/1
authorSangJin Kim <sangjin3.kim@samsung.com>
Thu, 19 Oct 2017 05:20:07 +0000 (14:20 +0900)
committerLee Sujin <lee.sujin@samsung.com>
Fri, 20 Oct 2017 05:09:09 +0000 (05:09 +0000)
- Update 'package' command for active signing profile.
- Update 'list'/'build-native' command for add-on framework feature.
- Add 'trust-anchor' command.

Change-Id: Ib162a24d229fbfb54df867f8237b7ccb25e956f6
Signed-off-by: SangJin Kim <sangjin3.kim@samsung.com>
org.tizen.studio/html/common_tools/command_line_interface.htm

index caaa5dd..f8c6144 100644 (file)
@@ -35,6 +35,7 @@
                        <li><a href="#Clean_proj">Cleaning the Project</a></li>
                        <li><a href="#Issue_tizen_cert">Issuing a Tizen Certificate</a></li>
                        <li><a href="#Manage_sec_prof">Managing a Security Profile</a></li>
+                       <li><a href="#Trust_anchor">Using Your Own Certificates</a></li>
                        <li><a href="#Pack_tizen_app">Packaging a Tizen Application with Signing</a></li>
                        <li><a href="#Build_pack_multi_proj">Building and Packaging Multiple Projects</a></li>
                        <li><a href="#Instal_app_target">Installing the Application on a Target</a></li>
@@ -63,6 +64,7 @@ export PATH=$PATH:$&lt;TIZEN_STUDIO&gt;/tools/ide/bin/
                <li><code>default.build.architecture=&lt;x86|arm&gt;</code>: Sets the default executable architecture type.</li>
                <li><code>default.build.compiler=&lt;llvm|gcc&gt;</code>: Sets the default compiler.</li>
                <li><code>default.build.configuration=&lt;Debug|Release&gt;</code>: Sets the default build configuration.</li>
+               <li><code>default.profiles.path=&lt;profiles.xml file path&gt;</code>: Sets the default path of security profile file.</li>
                <li><code>default.sdb.timeout=&lt;timeout value&gt;</code>: Sets the default connection timeout value. The default is 60000 milliseconds.</li>
        </ul>
 <p><strong>Syntax:</strong></p>
@@ -149,8 +151,9 @@ tizen list &lt;option&gt;
  <td>Displays the list of project templates for Tizen Web applications.</td>
  </tr>
  <tr>
- <td><code>rootstrap</code></td>
- <td>Displays the list of available rootstraps. The rootstrap is a set of build configurations, which consists of the profile, platform version, and target architecture.</td>
+ <td><code>rootstrap [rootstrap name]</code></td>
+ <td>Displays the list of available rootstraps. The rootstrap is a set of build configurations, which consists of the profile, platform version, and target architecture.<br/>
+ If you specify the <code>[rootstrap name]</code> argument, a set of frameworks installed for this rootstrap is displayed.</td>
  </tr>
  </tbody></table>
 
@@ -181,6 +184,13 @@ mobile-2.3-device.core             Mobile 2.3, armel
 mobile-2.3-emulator.core       Mobile 2.3, i386
 mobile-2.4-device.core         Mobile 2.4, armel
 mobile-2.4-emulator.core       Mobile 2.4, i386
+wearable-3.0-device.core       Wearable 3.0, armel
+
+&gt; tizen list rootstrap wearable-3.0-device.core
+rootstrap : wearable-3.0-device.core
+[FRAMEWORK NAME]        [TYPE]      [DESCRIPTION]
+Native_API              base        Native_API Libraries
+bixby                   add-on
 </pre>
    </li>
 </ul>
@@ -260,6 +270,7 @@ tizen &lt;sub-command&gt; [options]
                <li><code>-C</code>, <code>--configuration</code>: Specifies the build configuration: <code>Debug</code> (default) or <code>Release</code></li>
                <li><code>-j</code>, <code>--jobs</code>: Specifies the number of parallel builds for the native project.</li>
                <li><code>-r</code>, <code>--rootstrap</code>: Specifies the rootstrap name. The rootstrap contains information on the profile name, platform version, and the target architecture type.</li>
+               <li><code>-f</code>, <code>--framework</code>: Specifies the add-on framework name. If you installed an add-on framework, you can use this option to add the additional build environments (headers and libraries for add-on framework API).</li>
                <li><code>--</code>: Specifies the project directory.</li>
        </ul>
 </td>
@@ -296,6 +307,21 @@ $ tizen build-native -a x86 -c llvm -C Debug -- ~/workspace/basic
 $ ls ~/workspace/basic/Debug
 </pre>
    </li>
+   <li>Build the native project with the default configuration and the bixby add-on framework.
+   <p>Windows&reg;:</p>
+
+<pre class="prettyprint">
+&gt; tizen build-native -f bixby -- C:\Users\workspace\basic
+&gt; dir C:\Users\workspace\basic\Debug
+</pre>
+
+       <p>Ubuntu and macOS:</p>
+
+<pre class="prettyprint">
+$ tizen build-native -f bixby -- ~/workspace/basic
+$ ls ~/workspace/basic/Debug
+</pre>
+   </li>
    <li>Build the native project with a rootstrap.
    <p>Windows&reg;:</p>
 
@@ -644,8 +670,100 @@ Succeed to remove 'MyProfile' profile
    </li>
 </ul>
 
+<h2 id="Trust_anchor">Using Your Own Certificates</h2>
+<p>The command is used to assign your own SSL root certificates for HTTPS communication.</p>
+
+<p><strong>Syntax:</strong></p>
+<pre class="prettyprint">
+tizen trust-anchor &lt;sub-command&gt; [options]
+</pre>
+
+<p><strong>Sub-commands:</strong></p>
+
+<table>
+<tbody>
+<tr>
+ <th>Sub-command</th>
+ <th>Description</th>
+</tr>
+ <tr>
+ <td><code>set [options]</code></td>
+ <td>Sets a new user certificate for a project.<br /><br />
+       Options are:
+       <ul>
+               <li><code>-c</code>, <code>--user-certificate-path &lt;certificate path&gt;</code>: Specifies the file path for the user certificate to be set. If you want to set multiple certificates, separate them with a comma.</li>
+               <li><code>-s</code>, <code>--use-system-certs {true|false}</code>: Determines whether to use the system root certificates.</li>
+               <li><code>-- &lt;project path&gt;</code>: Specifies the project directory to set the new certificate for.</li>
+       </ul>
+</td>
+</tr>
+<tr>
+ <td><code>info</code></td>
+ <td>Displays the trust anchor configuration for a project.<br /><br />
+       Options are:
+       <ul>
+               <li><code>-- &lt;project path&gt;</code>: Specifies the project directory to show the trust-anchor configuration of.</li>
+       </ul>
+</td>
+</tr>
+<tr>
+ <td><code>delete [options]</code></td>
+ <td>Deletes the specified user certificate.<br /><br />
+       Options are:
+       <ul>
+               <li><code>-c</code>, <code>--user-certificate-path &lt;certificate name&gt;</code>: Specifies the user certificate file name to be deleted. If you want to delete multiple certificates, separate them with a comma.</li>
+               <li><code>-- &lt;project path&gt;</code>: Specifies the project directory to delete the certificate from.</li>
+       </ul>
+</td>
+</tr>
+<tr>
+ <td><code>unset</code></td>
+ <td>Disables the trust anchor.<br /><br />
+       Options are:
+       <ul>
+               <li><code>-- &lt;project path&gt;</code>: Specifies the project directory to disable the trust anchor for.</li>
+       </ul>
+</td>
+</tr>
+</tbody></table>
+
+<p><strong>Examples:</strong></p>
+<ul>
+   <li>Set a new user certificate, check the trust anchor configuration, set additional certificates, delete certificates, and unset the trust anchor.
+   <p>Windows&reg;:</p>
+
+<pre class="prettyprint">
+&gt; tizen trust-anchor info -- project1
+Trust-Anchor is disabled for the project project1.
+
+&gt; tizen trust-anchor set -c C:\workspace\user1.pem -s true -- project1
+Succeed to set the trust-anchor.
+
+&gt; tizen trust-anchor info -- project1
+use-system-certs: true
+user certificates: user1.pem
+
+&gt; tizen trust-anchor set -c "C:\workspace\user2.pem,C:\workspace\user3.pem,C:\workspace\certdirs" -- project1
+Succeed to add the certificates user2.pem, user3.pem.
+
+&gt; tizen trust-anchor info -- project1
+use-system-certs: true
+user certificates: user1.pem, user2.pem, user3.pem, certdirs1.pem, certdirs2.pem
+
+&gt; tizen trust-anchor delete -c "user2.pem,certdirs1.pem" -- project1
+Succeed to delete the certificates user2.pem, certdirs1.pem.
+
+&gt; tizen trust-anchor unset -- project1
+Succeed to disable the trust-anchor.
+
+&gt; tizen trust-anchor info -- project1
+Trust-Anchor is disabled for this project.
+</pre>
+   </li>
+</ul>
+
 <h2 id="Pack_tizen_app">Packaging a Tizen Application with Signing</h2>
-<p>The command packages the Tizen application with signing. If there is a package file in the options, the package is re-signed. The Tizen application is signed with a certified profile in the <code>profiles.xml</code> file. You can create the default profile from the Tizen Studio, which generates the file in a hidden directory in your workspace (<code>&lt;Your workspace directory&gt;/.metadata/.plugins/org.tizen.common.sign/profiles.xml</code>). Set the path of the <code>profiles.xml</code> file before packaging the Tizen application (by using the tizen <code>cli-config</code> command).</p>
+<p>The command packages the Tizen application with signing. If there is a package file in the options, the package is re-signed. The Tizen application is signed with a certified profile in the <code>profiles.xml</code> file. You can create the default profile from the Tizen Studio, which generates the file in a data directory (<code>&lt;tizen studio data directory&gt;/profile/profiles.xml</code>).</p>
 
 <p><strong>Syntax:</strong></p>
 <pre class="prettyprint">
@@ -666,7 +784,7 @@ tizen package [options]
 </tr>
 <tr>
  <td><code>-s</code>, <code>--sign &lt;security profile&gt;</code></td>
- <td>Specifies the security profile name to use for signing.</td>
+ <td>Specifies the security profile name for signing. If you skip this option, the CLI uses the active profile or the default profile. The default profile is only valid for the Emulator or reference devices.</td>
 </tr>
 <tr>
  <td><code>-S</code>, <code>--strip {on|off}</code></td>