bluez5_utils-5.62/tools/hcidump.1

.\" Man page generated from reStructuredText.
.
.TH HCIDUMP 1 "Nov 12, 2002" "BlueZ" "Linux System Administration"
.SH NAME
hcidump \- Parse HCI data
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBhcidump\fP \-h
.sp
\fBhcidump\fP [OPTIONS ...] [FILTERS]
.SH DESCRIPTION
.sp
\fBhcidump(1)\fP reads raw HCI data coming from and going to a Bluetooth device
(which can be specified with the option \fB\-i\fP, default is the first available
one) and prints to screen commands, events and data in a human\-readable form.
Optionally, the dump can be written to a file rather than parsed, and the dump
file can be parsed in a subsequent moment.
.SH OPTIONS
.INDENT 0.0
.TP
.BI \-i \ <hciX>
Data is read from \fIhciX\fP, which must be the name of an installed Bluetooth
device. If not specified, and if \fB\-r\fP option is not set, data is read from
the first available Bluetooth device.
.TP
.BI \-l \ <len>\fR,\fB \ \-\-snap\-len\fB= <len>
Sets max length of processed packets to \fIlen\fP\&.
.TP
.BI \-p \ <psm>\fR,\fB \ \-\-psm\fB= <psm>
Sets default Protocol Service Multiplexer to \fIpsm\fP\&.
.TP
.BI \-m \ <compid>\fR,\fB \ \-\-manufacturer\fB= <compid>
Sets default company id for manufacturer to \fIcompid\fP\&.
.TP
.BI \-w \ <file>\fR,\fB \ \-\-save\-dump\fB= <file>
Parse output is not printed to screen, instead data read from device is
saved in \fIfile\fP\&. The saved dump file can be subsequently parsed with
option \fB\-r\fP\&.
.TP
.BI \-r \ <file>\fR,\fB \ \-\-read\-dump\fB= <file>
Data is not read from a Bluetooth device, but from \fIfile\fP\&. \fIfile\fP is
created with option \fB\-t\fP, \fB\-\-timestamp\fP prepend a time stamp to every
packet.
.TP
.B \-a\fP,\fB  \-\-ascii
For every packet, not only is the packet type displayed, but also all data
in ASCII.
.TP
.B \-x\fP,\fB  \-\-hex
For every packet, not only is the packet type displayed, but also all data
in hex.
.TP
.B \-X\fP,\fB  \-\-ext
For every packet, not only is the packet type displayed, but also all data
in hex and ASCII.
.TP
.B \-R\fP,\fB  \-\-raw
For every packet, only the raw data is displayed.
.TP
.BI \-C \ <psm>\fR,\fB \ \-\-cmtp\fB= <psm>
Sets the PSM value for the CAPI Message Transport Protocol.
.TP
.BI \-H \ <psm>\fR,\fB \ \-\-hcrp\fB= <psm>
Sets the PSM value for the Hardcopy Control Channel.
.TP
.BI \-O \ <channel>\fR,\fB \ \-\-obex\fB= <channel>
Sets the RFCOMM channel value for the Object Exchange Protocol.
.TP
.BI \-P \ <channel>\fR,\fB \ \-\-ppp\fB= <channel>
Sets the RFCOMM channel value for the Point\-to\-Point Protocol.
.TP
.BI \-D \ <file>\fR,\fB \ \-\-pppdump\fB= <file>
Extract PPP traffic with pppdump format.
.TP
.BI \-A \ <file>\fR,\fB \ \-\-audio\fB= <file>
Extract SCO audio data.
.TP
.B \-Y\fP,\fB  \-\-novendor
Don\(aqt display any vendor commands or events and don\(aqt show any pin code or
link key in plain text.
.TP
.B \-h
Prints usage info and exits
.UNINDENT
.SH FILTERS
.sp
filter is a space\-separated list of packet categories: available categories are
\fIlmp\fP, \fIhci\fP, \fIsco\fP, \fIl2cap\fP, \fIrfcomm\fP, \fIsdp\fP, \fIbnep\fP, \fIcmtp\fP, \fIhidp\fP, \fIhcrp\fP,
\fIavdtp\fP, \fIavctp\fP, \fIobex\fP, \fIcapi\fP and \fIppp\fP\&. If filters are used, only packets
belonging to the specified categories are dumped. By default, all packets are
dumped.
.SH RESOURCES
.sp
\fI\%http://www.bluez.org\fP
.SH REPORTING BUGS
.sp
\fI\%linux\-bluetooth@vger.kernel.org\fP
.SH AUTHOR
Maxim Krasnyansky <maxk@qualcomm.com>, Marcel Holtmann <marcel@holtmann.org>, Fabrizio Gennari <fabrizio.gennari@philips.com>
.SH COPYRIGHT
Free use of this software is granted under ther terms of the GNU
Lesser General Public Licenses (LGPL).
.\" Generated by docutils manpage writer.
.