From 7467a0f002a387ea412368acd7b748cf11bd2fcd Mon Sep 17 00:00:00 2001
From: Scott Main Google Play badges allow you to promote your app with official branding in your
-online ads, promotional materials, or anywhere else you want a link to your app. Google Play badges allow you to promote your app with official branding
+in your online ads, promotional materials, or anywhere else you want a link to your app. In the form below,
input your app's package name or publisher name, choose the badge style,
diff --git a/docs/html/tools/help/adb.jd b/docs/html/tools/help/adb.jd
index d44d54b..47e892e 100644
--- a/docs/html/tools/help/adb.jd
+++ b/docs/html/tools/help/adb.jd
@@ -5,32 +5,27 @@ parent.link=index.html
ADB quickview
-
-
-
In this document
-
-
-
- See also
-
-
+
+
You can find the {@code adb} tool in {@code <sdk>/platform-tools/}.
-When you start an adb client, the client first checks whether there is an adb server process already running. If there isn't, it starts the server process. When the server starts, it binds to local TCP port 5037 and listens for commands sent from adb clients—all adb clients use port 5037 to communicate with the adb server.
+When you start an adb client, the client first checks whether there is an adb server +process already running. If there isn't, it starts the server process. When the server starts, +it binds to local TCP port 5037 and listens for commands sent from adb clients—all adb +clients use port 5037 to communicate with the adb server.
The server then sets up connections to all running emulator/device instances. It locates emulator/device instances by scanning odd-numbered ports in the range 5555 to 5585, the range used by emulators/devices. Where the server finds an adb daemon, it sets up a connection to that port. Note that each emulator/device instance acquires a pair of sequential ports — an even-numbered port for console connections and an odd-numbered port for adb connections. For example:
@@ -55,127 +56,42 @@ three components: Emulator 1, console: 5554As shown, the emulator instance connected to adb on port 5555 is the same as the instance whose console listens on port 5554.
- -Once the server has set up connections to all emulator instances, you can use adb commands to control and access those instances. Because the server manages connections to emulator/device instances and handles commands from multiple adb clients, you can control any emulator/device instance from any client (or from a script).
- -The sections below describe the commands that you can use to access adb capabilities and manage the state of an emulator/device. Note that if you are developing Android applications in Eclipse and have installed the ADT plugin, you do not need to access adb from the command line. The ADT plugin provides a transparent integration of adb into the Eclipse IDE. However, you can still use adb directly as necessary, such as for debugging.
- - - -You can issue adb commands from a command line on your development machine or from a script. The usage is:
- -adb [-d|-e|-s <serialNumber>] <command>- -
When you issue a command, the program invokes an adb client. The client is not specifically associated with any emulator instance, so if multiple emulators/devices are running, you need to use the -d
option to specify the target instance to which the command should be directed. For more information about using this option, see Directing Commands to a Specific Emulator/Device Instance.
Before issuing adb commands, it is helpful to know what emulator/device instances are connected to the adb server. You can generate a list of attached emulators/devices using the devices
command:
adb devices- -
In response, adb prints this status information for each instance:
- -<type>-<consolePort>
.
- Here's an example serial number: emulator-5554
offline
— the instance is not connected to adb or is not responding.device
— the instance is now connected to the adb server. Note that this state does not
- imply that the Android system is fully booted and operational, since the instance connects to adb
- while the system is still booting. However, after boot-up, this is the normal operational state of
- an emulator/device instance.no device
— there is no emulator/device connected.
- The output for each instance is formatted like this:
- -[serialNumber] [state]- -
Here's an example showing the devices
command and its output:
$ adb devices -List of devices attached -emulator-5554 device -emulator-5556 device -emulator-5558 device- - - - - -
If multiple emulator/device instances are running, you need to specify a target instance when issuing adb commands. To so so, use the -s
option in the commands. The usage for the -s
option is:
adb -s <serialNumber> <command>- -
As shown, you specify the target instance for a command using its adb-assigned serial number. You can use the devices
command to obtain the serial numbers of running emulator/device instances.
Here is an example:
- -adb -s emulator-5556 install helloWorld.apk- -
Note that, if you issue a command without specifying a target emulator/device instance using -s
, adb generates an error.
-
-
-
-
You can use adb to copy an application from your development computer and install it on an emulator/device instance. To do so, use the install
command. With the command, you must specify the path to the .apk file that you want to install:
adb install <path_to_apk>- -
For more information about how to create an .apk file that you can install on an emulator/device -instance, see Building and Running
- -Note that, if you are using the Eclipse IDE and have the ADT plugin installed, you do not need to use adb (or aapt) directly to install your application on the emulator/device. Instead, the ADT plugin handles the packaging and installation of the application for you.
- +As shown, the emulator instance connected to adb on port 5555 is the same as the instance +whose console listens on port 5554.
- +Once the server has set up connections to all emulator instances, you can use adb commands to +access those instances. Because the server manages connections to emulator/device +instances and handles commands from multiple adb clients, you can control any emulator/device +instance from any client (or from a script).
-You can use the forward
command to set up arbitrary port forwarding — forwarding of requests on a specific host port to a different port on an emulator/device instance. Here's how you would set up forwarding of host port 6100 to emulator/device port 7100:
adb forward tcp:6100 tcp:7100-
You can also use adb to set up forwarding to named abstract UNIX domain sockets, as illustrated here:
-adb forward tcp:6100 local:logd- -
You can use the adb commands pull
and push
to copy files to and from an emulator/device instance's data file. Unlike the install
command, which only copies an .apk file to a specific location, the pull
and push
commands let you copy arbitrary directories and files to any location in an emulator/device instance.
You can issue adb commands from a command line on your development machine or from a script. +The usage is:
-To copy a file or directory (recursively) from the emulator or device, use
-adb pull <remote> <local>+
+adb [-d|-e|-s <serialNumber>] <command> +-
To copy a file or directory (recursively) to the emulator or device, use
-adb push <local> <remote>+
If there's only one emulator running or only one device connected, the adb command is
+sent to that device by default. If multiple emulators are running and/or multiple devices are
+attached, you need to use the -d
, -e
, or -s
+option to specify the target device to which the command should be directed.
In the commands, <local>
and <remote>
refer to the paths to the target files/directory on your development machine (local) and on the emulator/device instance (remote).
Here's an example:
-adb push foo.txt /sdcard/foo.txt- -
The table below lists all of the supported adb commands and explains their meaning and usage.
- +Adb provides an ash shell that you can use to run a variety of commands on an emulator -or device. The command binaries are stored in the file system of the emulator or device, -in this location:
-/system/bin/...-
You can use the shell
command to issue commands, with or without entering the adb remote shell on the emulator/device.
To issue a single command without entering a remote shell, use the shell
command like this:
adb [-d|-e|-s {<serialNumber>}] shell <shellCommand>+ + +
Before issuing adb commands, it is helpful to know what emulator/device instances are connected to the adb server. You can generate a list of attached emulators/devices using the devices
command:
adb devices+ +
In response, adb prints this status information for each instance:
+ +<type>-<consolePort>
.
+ Here's an example serial number: emulator-5554
offline
— the instance is not connected to adb or is not responding.device
— the instance is now connected to the adb server. Note that this state does not
+ imply that the Android system is fully booted and operational, since the instance connects to adb
+ while the system is still booting. However, after boot-up, this is the normal operational state of
+ an emulator/device instance.no device
— there is no emulator/device connected.
+ The output for each instance is formatted like this:
+ +[serialNumber] [state]+ +
Here's an example showing the devices
command and its output:
adb devices +List of devices attached +emulator-5554 device +emulator-5556 device +emulator-5558 device+ + + + + + +
If multiple emulator/device instances are running, you must specify a target instance
+when issuing adb commands. To do so, use the -s
option in the commands. The usage
+for the -s
option is:
adb -s <serialNumber> <command>+ +
As shown, you specify the target instance for a command using its adb-assigned serial number.
+You can use the devices
command to obtain the serial numbers of running
+emulator/device instances. For example:
adb -s emulator-5556 install helloWorld.apk+ +
Note that, if you issue a command without specifying a target emulator/device instance +while multiple devices are available, adb generates an error. + +
If you have multiple devices available (hardware or emulated), but only one is an emulator, +simply use the {@code -e} option to send commands to the emulator. Likewise if there's multiple +devices but only one hardware device attached, use the {@code -d} option to send commands to +the hardware device. + + + + +
You can use adb to copy an application from your development computer and install it on an emulator/device instance. To do so, use the install
command. With the command, you must specify the path to the .apk file that you want to install:
adb install <path_to_apk>+ +
For more information about how to create an .apk file that you can install on an emulator/device +instance, see Building and Running
+ +Note that, if you are using the Eclipse IDE and have the ADT plugin installed, you do not need to use adb (or aapt) directly to install your application on the emulator/device. Instead, the ADT plugin handles the packaging and installation of the application for you.
+ + + + + + +You can use the forward
command to set up arbitrary port forwarding — forwarding of requests on a specific host port to a different port on an emulator/device instance. Here's how you would set up forwarding of host port 6100 to emulator/device port 7100:
adb forward tcp:6100 tcp:7100+
You can also use adb to set up forwarding to named abstract UNIX domain sockets, as illustrated here:
+adb forward tcp:6100 local:logd+ + + + + +
You can use the adb commands pull
and push
to copy files to
+and from an emulator/device instance. Unlike the install
command,
+which only copies an APK file to a specific location, the pull
and push
+commands let you copy arbitrary directories and files to any location in an
+emulator/device instance.
To copy a file or directory (and its sub-directories) from the emulator or device, use
+adb pull <remote> <local>+ +
To copy a file or directory (and its sub-directories) to the emulator or device, use
+adb push <local> <remote>+ +
In the commands, <local>
and <remote>
refer to the
+paths to the target files/directory on your development machine (local) and on the
+emulator/device instance (remote). For example:
adb push foo.txt /sdcard/foo.txt+ + + + + + + + + +
Adb provides a Unix shell that you can use to run a variety of commands on an emulator
+or connected device. The command binaries are stored in the file system of the emulator or device,
+at /system/bin/...
+
+
Two of the most common command tools are activity manager ({@code am}) and +package manager ({@code pm}).
+ +You can use the shell
command to issue commands, with or without entering
+the adb remote shell on the emulator/device. To issue a single command without entering a
+remote shell, use the shell
command like this:
adb [-d|-e|-s <serialNumber>] shell <shell_command>-
To drop into a remote shell on a emulator/device instance, use the shell
command like this:
Or enter a remote shell on an emulator/device like this:
+ +adb [-d|-e|-s <serialNumber>] shell+ +
When you are ready to exit the remote shell, press CTRL+D or type
+exit
.
Within an adb shell, you can issue commands with the activity manager ({@code am}) tool to +perform various system actions, such as start an activity, force-stop a process, +broadcast an intent, modify the device screen properties, and more. While in a shell, +the syntax is:
++am <command> ++ +
You can also issue an activity manager command directly from adb +without entering a remote shell. For example:
++adb shell am start -a android.intent.action.VIEW ++ + + +
Command | +Description | +
---|---|
+start [options] <INTENT>
+ |
+Start an {@link android.app.Activity} specified by {@code <INTENT>}. See the +Specification for <INTENT> arguments. + Options are: +
|
+
+startservice [options] <INTENT>
+ |
+Start the {@link android.app.Service} specified by {@code <INTENT>}. See the +Specification for <INTENT> arguments. + Options are: +
|
+
+force-stop <PACKAGE>
+ |
+Force stop everything associated with {@code <PACKAGE>} (the app's package name). + | +
+kill [options] <PACKAGE>
+ |
+ Kill all processes associated with {@code <PACKAGE>}
+ (the app's package name). This command kills only
+ processes that are safe to kill and that will not impact the user
+ experience.
+ Options are: +
|
+
+kill-all
+ |
+Kill all background processes. + | +
+broadcast [options] <INTENT>
+ |
+Issue a broadcast intent. See the +Specification for <INTENT> arguments. + Options are: +
|
+
+instrument [options] <COMPONENT>
+ |
+Start monitoring with an {@link android.app.Instrumentation} instance.
+ Typically the target {@code <COMPONENT>}
+ is the form {@code <TEST_PACKAGE>/<RUNNER_CLASS>}. Options are: +
|
+
+profile start <PROCESS> <FILE>
+ |
+Start profiler on {@code <PROCESS>}, write results to {@code <FILE>}. + | +
+profile stop <PROCESS>
+ |
+Stop profiler on {@code <PROCESS>}. + | +
+dumpheap [options] <PROCESS> <FILE>
+ |
+Dump the heap of {@code <PROCESS>}, write to {@code <FILE>}. Options are: +
|
+
+set-debug-app [options] <PACKAGE>
+ |
+Set application {@code <PACKAGE>} to debug. Options are: +
|
+
+clear-debug-app
+ |
+Clear the package previous set for debugging with {@code set-debug-app}. + | +
+monitor [options]
+ |
+Start monitoring for crashes or ANRs. Options are: +
|
+
+screen-compat [on|off] <PACKAGE>
+ |
+Control screen +compatibility mode of {@code <PACKAGE>}. + | +
+display-size [reset|<WxH>]
+ |
+Override emulator/device display size.
+This command is helpful for testing your app across different screen sizes by mimicking a small
+screen resolution using a device with a large screen, and vice versa.
+ Example: |
+
+display-density <dpi>
+ |
+Override emulator/device display density.
+This command is helpful for testing your app across different screen densities on high-density
+screen environment using a low density screen, and vice versa.
+ Example: |
+
+to-uri <INTENT>
+ |
+Print the given intent specification as a URI. See the +Specification for <INTENT> arguments. + |
+
+to-intent-uri <INTENT>
+ |
+Print the given intent specification as an {@code intent:} URI. See the +Specification for <INTENT> arguments. + |
+
Within an adb shell, you can issue commands with the package manager ({@code pm}) tool to +perform actions and queries on application packages installed on the device. While in a shell, +the syntax is:
++pm <command> ++ +
You can also issue a package manager command directly from adb +without entering a remote shell. For example:
++adb shell pm uninstall com.example.MyApp ++ + +
Command | +Description | +
---|---|
+list packages [options] <FILTER>
+ |
+Prints all packages, optionally only
+ those whose package name contains the text in {@code <FILTER>}. Options: +
|
+
+list permission-groups
+ |
+Prints all known permission groups. + | +
+list permissions [options] <GROUP>
+ |
+Prints all known permissions, optionally only
those in {@code <GROUP>}. Options: +
|
+
+list instrumentation
+ |
+List all test packages. Options: +
|
+
+list features
+ |
+Prints all features of the system. + | +
+list libraries
+ |
+Prints all the libraries supported by the current device. + | +
+list users
+ |
+Prints all users on the system. + | +
+path <PACKAGE>
+ |
+Print the path to the APK of the given {@code <PACKAGE>}. + | +
+install [options] <PATH>
+ |
+Installs a package (specified by {@code <PATH>}) to the system. Options: +
|
+
+uninstall [options] <PACKAGE>
+ |
+Removes a package from the system. Options: +
|
+
+clear <PACKAGE>
+ |
+Deletes all data associated with a package. + | +
+enable <PACKAGE_OR_COMPONENT>
+ |
+Enable the given package or component (written as "package/class"). + | +
+disable <PACKAGE_OR_COMPONENT>
+ |
+Disable the given package or component (written as "package/class"). + | +
+disable-user [options] <PACKAGE_OR_COMPONENT>
+ |
+Options: +
|
+
+grant <PACKAGE_PERMISSION>
+ |
+Grant permissions + to applications. Only optional permissions the application has + declared can be granted. + | +
+revoke <PACKAGE_PERMISSION>
+ |
+Revoke permissions + to applications. Only optional permissions the application has + declared can be revoked. + | +
+set-install-location <LOCATION>
+ |
+Changes the default install location. Location values:
+
Note: This is only intended for debugging; using this can cause + applications to break and other undesireable behavior. + |
+
+get-install-location
+ |
+Returns the current install location. Return values:
+
|
+
+set-permission-enforced <PERMISSION> [true|false]
+ |
+Specifies whether the given permission should be enforced. + | +
+trim-caches <DESIRED_FREE_SPACE>
+ |
+Trim cache files to reach the given free space. + | +
+create-user <USER_NAME>
+ |
+Create a new user with the given {@code <USER_NAME>}, + printing the new user identifier of the user. + | +
+remove-user <USER_ID>
+ |
+Remove the user with the given {@code <USER_IDENTIFIER>}, + deleting all data associated with that user + | +
+get-max-users
+ |
+Prints the maximum number of users supported by the device. + | +
adb [-d|-e|-s {<serialNumber>}] shell-
When you are ready to exit the remote shell, use CTRL+D
or exit
to end the shell session.
The sections below provide more information about shell commands that you can use.
- - -From an adb remote shell, you can use the sqlite3 command-line program to @@ -384,7 +1086,7 @@ The tool also gives you the ability to execute SQLite commands on the fly.
Here's an example:
-$ adb -s emulator-5554 shell +adb -s emulator-5554 shell # sqlite3 /data/data/com.example.google.rss.rssexample/databases/rssitems.db SQLite version 3.3.12 Enter ".help" for instructions @@ -394,34 +1096,40 @@ sqlite> .exitOnce you've invoked
sqlite3
, you can issuesqlite3
commands in the shell. To exit and return to the adb remote shell, useexit
orCTRL+D
. - -UI/Application Exerciser Monkey
+ + + +UI/Application Exerciser Monkey
The Monkey is a program that runs on your emulator or device and generates pseudo-random streams of user events such as clicks, touches, or gestures, as well as a number of system-level events. You can use the Monkey to stress-test applications that you are developing, in a random yet repeatable manner.
-The simplest way to use the monkey is with the following command, which will launch your -application and send 500 pseudo-random events to it.
+The simplest way to use the monkey is with the following command, which launches your +application and sends 500 pseudo-random events to it.
-$ adb shell monkey -v -p your.package.name 500+adb shell monkey -v -p your.package.name 500For more information about command options for Monkey, see the complete UI/Application Exerciser Monkey documentation page.
- -Other Shell Commands
-The table below lists several of the adb shell commands available. For a complete list of commands and programs, start an emulator instance and use the
-adb -help
command.adb shell ls /system/bin+Other shell commands
+ +For a list of all the available shell programs, use the following command:
+ +adb shell ls /system/binHelp is available for most of the commands.
+Table 4 lists some of the more common adb shell commands.
+ +
Shell Command | @@ -442,8 +1150,8 @@ application and send 500 pseudo-random events to it.|||
---|---|---|---|
logcat [<option>]... [<filter-spec>]... |
-Enables radio logging and prints output to the screen. | +logcat [option]... [filter-spec]... |
+Enables system and app logging and prints output to the screen. |
The Android logging system provides a mechanism for collecting and viewing system debug output. Logs from various applications and portions of the system are collected in a series of circular buffers, which then can be viewed and filtered by the logcat
command.
You can use the logcat
command to view and follow the contents of the system's log buffers. The general usage is:
[adb] logcat [<option>] ... [<filter-spec>] ...+
[adb] logcat [option] ... [filter-spec] ...
You can use the logcat
command from your development computer or from a remote adb shell in an emulator/device instance. To view log output in your development computer, you use
$ adb logcat+
adb logcat
and from a remote adb shell you use
-# logcat+
logcat
See Reading and Writing Logs for complete information about logcat commend options and filter specifications.
- -In some cases, you might need to terminate the adb server process and then restart it. For example, if adb does not respond to a command, you can terminate the server and restart it and that may resolve the problem.
-To stop the adb server, use the kill-server
. You can then restart the server by issuing any adb command.
To stop the adb server, use the kill-server
command.
+You can then restart the server by issuing any other adb command.