| Current File : //usr/share/wireshark/androiddump.html |
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>androiddump - The Wireshark Network Analyzer 2.0.3</title>
<link rel="stylesheet" href="/builds/ul11u3sru-gate/components/wireshark/wireshark-2.0.3/docbook/ws.css" type="text/css" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:perl@solaris-userland.java.net" />
</head>
<body>
<!-- INDEX BEGIN -->
<div name="index">
<p><a name="__index__"></a></p>
<!--
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#description">DESCRIPTION</a></li>
<li><a href="#options">OPTIONS</a></li>
<li><a href="#examples">EXAMPLES</a></li>
<li><a href="#see_also">SEE ALSO</a></li>
<li><a href="#notes">NOTES</a></li>
<li><a href="#authors">AUTHORS</a></li>
</ul>
-->
</div>
<!-- INDEX END -->
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>androiddump - Provide interfaces to capture from Android devices</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<p><strong>androiddump</strong>
[ <strong>--help</strong> ]
[ <strong>--version</strong> ]
[ <strong>--extcap-interfaces</strong> ]
[ <strong>--extcap-dlts</strong> ]
[ <strong>--extcap-interface</strong>=<interface> ]
[ <strong>--extcap-config</strong> ]
[ <strong>--capture</strong> ]
[ <strong>--fifo</strong>=<path to file or pipe> ]
[ <strong>--adb-server-ip</strong>=<IP address> ]
[ <strong>--adb-server-tcp-port</strong>=<TCP port> ]
[ <strong>--logcat-text</strong>=<TRUE or FALSE> ]
[ <strong>--bt-server-tcp-port</strong>=<TCP port> ]
[ <strong>--bt-forward-socket</strong>=<TRUE or FALSE> ]
[ <strong>--bt-local-ip</strong>=<IP address> ]
[ <strong>--bt-local-tcp-port</strong>=<TCP port> ]</p>
<p><strong>androiddump</strong>
<strong>--extcap-interfaces</strong>
[ <strong>--adb-server-ip</strong>=<IP address> ]
[ <strong>--adb-server-tcp-port</strong>=<TCP port> ]</p>
<p><strong>androiddump</strong>
<strong>--extcap-interface</strong>=<interface>
[ <strong>--extcap-dlts</strong> ]</p>
<p><strong>androiddump</strong>
<strong>--extcap-interface</strong>=<interface>
[ <strong>--extcap-config</strong> ]</p>
<p><strong>androiddump</strong>
<strong>--extcap-interface</strong>=<interface>
<strong>--fifo</strong>=<path to file or pipe>
<strong>--capture</strong> </p>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p><strong>Androiddump</strong> is a extcap tool that provide interfaces to capture from
Android device. There is only two requirements:</p>
<p>1. You must have Android SDK and add it PATH environment variable.
PATH should contain directory with tools like "adb" and "android".
Android SDK for various platform are available on:
<a href="https://developer.android.com/sdk/index.html#Other">https://developer.android.com/sdk/index.html#Other</a></p>
<p>2. You must have permission to Android devices.</p>
<p>Supported interfaces:</p>
<ol>
<li><strong><a name="main" class="item">Logcat Main (binary or text)</a></strong>
</li>
<li><strong><a name="system" class="item">Logcat System (binary or text)</a></strong>
</li>
<li><strong><a name="events" class="item">Logcat Events (binary or text)</a></strong>
</li>
<li><strong><a name="radio" class="item">Logcat Radio (binary or text)</a></strong>
</li>
<li><strong><a name="crash" class="item">Logcat Crash (text; Lollipop)</a></strong>
</li>
<li><strong><a name="hcidump" class="item">Bluetooth Hcidump (<Kitkat)</a></strong>
</li>
<li><strong><a name="parser" class="item">Bluetooth Bluedroid External Parser (Kitkat)</a></strong>
</li>
<li><strong><a name="btsnoopnet" class="item">Bluetooth BtsnoopNet (Lollipop)</a></strong>
</li>
</ol>
<p>Please note that it will work also for FirefoxOS.</p>
<p>NOTE: If one of device require ADB Authentication you need accept or reject that
request. Otherwise no devices will be available.</p>
<p>
</p>
<hr />
<h1><a name="options">OPTIONS</a></h1>
<dl>
<dt><strong><a name="help" class="item">--help</a></strong></dt>
<dd>
<p>Print program arguments.</p>
</dd>
<dt><strong><a name="version" class="item">--version</a></strong></dt>
<dd>
<p>Print program version.</p>
</dd>
<dt><strong><a name="extcap_interfaces" class="item">--extcap-interfaces</a></strong></dt>
<dd>
<p>List available interfaces.</p>
</dd>
<dt><strong><a name="extcap_interface_interface" class="item">--extcap-interface=<interface></a></strong></dt>
<dd>
<p>Use specified interfaces.</p>
</dd>
<dt><strong><a name="extcap_dlts" class="item">--extcap-dlts</a></strong></dt>
<dd>
<p>List DLTs of specified interface.</p>
</dd>
<dt><strong><a name="extcap_config" class="item">--extcap-config</a></strong></dt>
<dd>
<p>List configuration options of specified interface.</p>
</dd>
<dt><strong><a name="capture" class="item">--capture</a></strong></dt>
<dd>
<p>Start capturing from specified interface save saved it in place specified by --fifo.</p>
</dd>
<dt><strong><a name="fifo_path_to_file_or_pipe" class="item">--fifo=<path to file or pipe></a></strong></dt>
<dd>
<p>Save captured packet to file or send it through pipe.</p>
</dd>
<dt><strong><a name="adb_server_ip_ip_address" class="item">--adb-server-ip=<IP address></a></strong></dt>
<dd>
<p>Use other then default (127.0.0.1) ADB daemon's IP address.</p>
</dd>
<dt><strong><a name="adb_server_tcp_port_tcp_port" class="item">--adb-server-tcp-port=<TCP port></a></strong></dt>
<dd>
<p>Use other then default (5037) ADB daemon's TCP port.</p>
</dd>
<dt><strong><a name="logcat_text_true_or_false" class="item">--logcat-text=<TRUE or FALSE></a></strong></dt>
<dd>
<p>If TRUE then use text logcat rather then binary. This option has effect only on
Logcat interfaces. This have no effect from Lollipop where is no binary Logcat
available.</p>
<p>Defaults to FALSE.</p>
</dd>
<dt><strong><a name="bt_server_tcp_port_tcp_port" class="item">--bt-server-tcp-port=<TCP port></a></strong></dt>
<dd>
<p>Use other then default Bluetooth server TCP port on Android side.
On Lollipop defaults is 8872, earlier 4330.</p>
</dd>
<dt><strong><a name="bt_forward_socket_true_or_false" class="item">--bt-forward-socket=<TRUE or FALSE></a></strong></dt>
<dd>
<p>If TRUE then socket from Android side is forwarded to host side.</p>
<p>Defaults to FALSE.</p>
</dd>
<dt><strong><a name="bt_local_ip_ip_address" class="item">--bt-local-ip=<IP address></a></strong></dt>
<dd>
<p>Use other then default (127.0.0.1) IP address on host side for forwarded socket.</p>
</dd>
<dt><strong><a name="bt_local_tcp_port_tcp_port" class="item">--bt-local-tcp-port=<TCP port></a></strong></dt>
<dd>
<p>Specify port to be used on host side for forwarded socket.</p>
</dd>
</dl>
<p>
</p>
<hr />
<h1><a name="examples">EXAMPLES</a></h1>
<p>To see program arguments:</p>
<pre>
androiddump --help</pre>
<p>To see program version:</p>
<pre>
androiddump --version</pre>
<p>To see interfaces:</p>
<pre>
androiddump --extcap-interfaces</pre>
<pre>
Example output:
interface {display=Android Logcat Main}{value=android-logcat-main-MSM7627A}
interface {display=Android Logcat System}{value=android-logcat-system-MSM7627A}
interface {display=Android Logcat Radio}{value=android-logcat-radio-MSM7627A}
interface {display=Android Logcat Events}{value=android-logcat-events-MSM7627A}
interface {display=Android Bluetooth Hcidump}{value=android-bluetooth-hcidump-MSM7627A}</pre>
<p>To see interface DLTs:</p>
<pre>
androiddump --extcap-interface=android-bluetooth-hcidump-MSM7627A --extcap-dlts</pre>
<pre>
Example output:
dlt {number=99}{name=BluetoothH4}{display=Bluetooth HCI UART transport layer plus pseudo-header}</pre>
<p>To see interface configuration options:</p>
<pre>
androiddump --extcap-interface=android-bluetooth-hcidump-MSM7627A --extcap-config</pre>
<pre>
Example output:
arg {number=0}{call=--adb-server-ip}{display=ADB Server IP Address}{type=string}{default=127.0.0.1}
arg {number=1}{call=--adb-server-tcp-port}{display=ADB Server TCP Port}{type=integer}{range=0,65535}{default=5037}</pre>
<p>To capture:</p>
<pre>
androiddump --extcap-interface=android-bluetooth-hcidump-MSM7627A --fifo=/tmp/bluetooth.pcapng --capture</pre>
<p>NOTE: To stop capturing CTRL+C/kill/terminate application.</p>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p><code>wireshark(1)</code>, <code>tshark(1)</code>, <code>dumpcap(1)</code>, <code>extcap(4)</code></p>
<p>
</p>
<hr />
<h1><a name="notes">NOTES</a></h1>
<p><strong>Androiddump</strong> is part of the <strong>Wireshark</strong> distribution. The latest version
of <strong>Wireshark</strong> can be found at <a href="https://www.wireshark.org">https://www.wireshark.org</a>.</p>
<p>HTML versions of the Wireshark project man pages are available at:
<a href="https://www.wireshark.org/docs/man-pages">https://www.wireshark.org/docs/man-pages</a>.</p>
<p>
</p>
<hr />
<h1><a name="authors">AUTHORS</a></h1>
<pre>
Original Author
-------- ------
Michal Labedzki <michal.labedzki[AT]tieto.com></pre>
<pre>
Contributors
------------
Roland Knall <rknall[AT]gmail.com></pre>
</body>
</html>