diff options
Diffstat (limited to 'docs/html/tools/help')
| -rw-r--r-- | docs/html/tools/help/avd-manager.jd | 19 | ||||
| -rw-r--r-- | docs/html/tools/help/jobb.jd | 102 | ||||
| -rw-r--r-- | docs/html/tools/help/sdk-manager.jd | 67 |
3 files changed, 188 insertions, 0 deletions
diff --git a/docs/html/tools/help/avd-manager.jd b/docs/html/tools/help/avd-manager.jd new file mode 100644 index 0000000..ed90f43 --- /dev/null +++ b/docs/html/tools/help/avd-manager.jd @@ -0,0 +1,19 @@ +page.title=AVD Manager +@jd:body + + +<p>The AVD Manager provides a graphical user interface in which you can create +and manage Android Virtual Devices (AVDs), which are required by the +<a href="{@docRoot}tools/help/emulator.html">Android Emulator</a>.</p> + +<p>You can launch the AVD Manager in one of the following ways:</p> +<ul> + <li>In Eclipse: select <strong>Window > AVD Manager</strong>, or click + the AVD Manager icon in the Eclipse toolbar.</li> + + <li>In other IDEs: Navigate to your SDK's <code>tools/</code> directory and execute + <code>android avd</code>.</li> +</ul> + +<p>For more information, see <a href="{@docRoot}tools/devices/managing-avds.html">Managing +AVDs with AVD Manager</a>. diff --git a/docs/html/tools/help/jobb.jd b/docs/html/tools/help/jobb.jd new file mode 100644 index 0000000..d390ac9 --- /dev/null +++ b/docs/html/tools/help/jobb.jd @@ -0,0 +1,102 @@ +page.title=JOBB +@jd:body + + +<p>The {@code jobb} tool allows you to build encrypted and unencrypted APK expansion files in + Opaque Binary Blob (OBB) format. You can download and mount these expansion files in your + application using {@link android.os.storage.StorageManager} on devices with Android 2.3 (API + Level 9) or higher. OBB files are used to provide additional file assets for Android applications + (such as graphics, sounds and video), separate from an application's APK file. For more + information on using expansion files, see + <a href="{@docRoot}guide/google/play/expansion-files.html">APK Expansion Files</a>.</p> + + +<h2 id="usage">Usage</h2> + +<p>The syntax for running {@code jobb} is as follows:</p> + +<pre> +jobb [-d <directory>][-o <filename>][-pn <package>][-pv <version>] \ + [-k <key>][-ov][-dump <filename>][-v][-about] +</pre> + +<p>You can use the {@code jobb} tool to create an OBB file or extract the contents of an +existing OBB. The following example command creates an OBB file from source files.</p> + +<pre> +$ jobb -d /temp/assets/ -o my-app-assets.obb -k secret-key -pn com.my.app.package -pv 11 +</pre> + +<p>This example shows how to dump (extract) the contents of an existing OBB file:</p> + +<pre> +$ jobb -d /temp/obb-output/ -o my-app-assets.obb -k secret-key +</pre> + + +<h2 id="options">Options</h2> + +<p>The table below lists the command line options for the {@code jobb} tool.</p> + +<table> + <tr> + <th>Option</th> + <th>Description</th> + </tr> + <tr> + <td>{@code -d <directory>}</td> + <td>Set the input directory for creating an OBB file, or the output directory when extracting + ({@code -dump}) an existing file. When creating an OBB file, the contents of the specified + directory and all its sub-directories are included in the OBB file system. + </td> + </tr> + <tr> + <td>{@code -o <filename>}</td> + <td>Specify the filename for the OBB file. This parameter is required when + creating an OBB and extracting (dumping) its contents.</td> + </tr> + <tr> + <td>{@code -pn <package>}</td> + <td>Specify the package name for the application that mounts the OBB file, which corresponds + to the {@code package} value specified in your application's manifest. This parameter is + required when creating an OBB file.</td> + </tr> + <tr> + <td>{@code -pv <version>}</td> + <td>Set the minimum version for the application that can mount the OBB file, which corresponds + to the {@code android:versionCode} value in your application's manifest. This parameter is + required when creating an OBB file.</td> + </tr> + <tr> + <td>{@code -k <key>}</td> + <td>Specify a password for encrypting a new OBB file or decrypting an existing, encypted + OBB file.</td> + </tr> + <tr> + <td>{@code -ov}</td> + <td>Create OBB file that is an overlay of an existing OBB file structure. This option allows + the new package contents to be mounted into the same location as a previous package and is + intended for creating patch versions of previously generated OBB files. Files within an + overlay OBB file replace files that have the same path.</td> + </tr> + <tr> + <td style="white-space: nowrap">{@code -dump <filename>}</td> + <td><p>Extract the contents of the specified OBB file. When using this option, you must also + specify the output directory for the contents using the {@code -d <directory>} + parameter.</p> + + <p class="note"><strong>Note:</strong> When dumping an existing OBB file, you can omit the + {@code -d <directory>} parameter to get a listing of the directories inside the file, + without extracting the contents.</p> + </td> + </tr> + <tr> + <td>{@code -v}</td> + <td>Set verbose output for the tool.</td> + </tr> + <tr> + <td>{@code -about}</td> + <td>Display version and help information for the {@code jobb} tool.</td> + </tr> + +</table> diff --git a/docs/html/tools/help/sdk-manager.jd b/docs/html/tools/help/sdk-manager.jd new file mode 100644 index 0000000..4852b21 --- /dev/null +++ b/docs/html/tools/help/sdk-manager.jd @@ -0,0 +1,67 @@ +page.title=SDK Manager +@jd:body + + +<p>The Android SDK separates tools, platforms, and other components into packages you can + download using the SDK Manager.</p> + +<p>You can launch the SDK Manager in one of the following ways:</p> +<ul> + <li>On Windows, double-click the <code>SDK Manager.exe</code> file at the root of the Android +SDK directory.</li> + <li>On Mac or Linux, open a terminal and navigate to the <code>tools/</code> directory in the +Android SDK, then execute <code>android sdk</code>.</li> +</ul> + +<p>You can select which packages you want to download by toggling the checkboxes on the left, then +click <strong>Install</strong> to install the selected packages.</p> + +<img src="{@docRoot}images/sdk_manager_packages.png" alt="" /> +<p class="img-caption"><strong>Figure 1.</strong> The Android SDK Manager shows the +SDK packages that are available, already installed, or for which an update is available.</p> + + +<h2 id="Recommended">Recommended Packages</h2> + +<p>Here's an outline of the packages required and those we recommend you use: +</p> + +<dl> + <dt>SDK Tools</dt> + <dd><strong>Required.</strong> Your new SDK installation already has the latest version. Make sure +you keep this up to date.</dd> + <dt>SDK Platform-tools</dt> + <dd><strong>Required.</strong> You must install this package when you install the SDK for +the first time.</dd> + <dt>SDK Platform</dt> + <dd><strong>Required.</strong>You must download <em>at least one platform</em> into your +environment so you're able to compile your application. In order to provide the best user experience +on the latest devices, we recommend that you use the latest platform version as your build target. +You'll still be able to run your app on older versions, but you must build against the latest +version in order to use new features when running on devices with the latest version of Android. + <p>To get started, download the latest Android version, plus the lowest version you plan + to support (we recommend Android 2.2 for your lowest version).</p></dd> + <dt>System Image</dt> + <dd>Recommended. Although you might have one or more Android-powered devices on which to test + your app, it's unlikely you have a device for every version of Android your app supports. It's +a good practice to download system images for all versions of Android your app supports and test +your app running on them with the <a href="{@docRoot}tools/devices/emulator.html">Android emulator</a>.</dd> + <dt>Android Support</dt> + <dd>Recommended. Includes a static library that allows you to use some of the latest +Android APIs (such as <a href="{@docRoot}guide/components/fragments.html">fragments</a>, +plus others not included in the framework at all) on devices running +a platform version as old as Android 1.6. All of the activity templates available when creating +a new project with the <a href="{@docRoot}tools/sdk/eclipse-adt.html">ADT Plugin</a> +require this. For more information, read <a +href="{@docRoot}tools/extras/support-library.html">Support Library</a>.</dd> + <dt>SDK Samples</dt> + <dd>Recommended. The samples give you source code that you can use to learn about +Android, load as a project and run, or reuse in your own app. Note that multiple +samples packages are available — one for each Android platform version. When +you are choosing a samples package to download, select the one whose API Level +matches the API Level of the Android platform that you plan to use.</dd> +</dl> + +<p class="note"><strong>Tip:</strong> For easy access to the SDK tools from a command line, add the +location of the SDK's <code>tools/</code> and +<code>platform-tools</code> to your <code>PATH</code> environment variable.</p> |