summaryrefslogtreecommitdiff
path: root/tools/hcidump.1
blob: f0aa4d4e6cae557650e1e203da98f2992281affb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
.TH HCIDUMP 1 "Nov 12 2002" BlueZ "Linux System Administration"
.SH NAME
hcidump \- Parse HCI data
.SH SYNOPSIS
.B hcidump [-h]
.br
.B hcidump [option [option...]] [filter]

.SH DESCRIPTION
.LP
.B
hcidump
reads raw HCI data coming from and going to a Bluetooth device (which can be
specified with the option
.BR -i ,
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
.TP
.BI -h
Prints usage info and exits
.TP
.BI -i " <hciX>"
Data is read from
.IR hciX ,
which must be the name of an installed Bluetooth device. If not specified,
and if
.B
-r
option is not set, data is read from the first available Bluetooth device.
.TP
.BI -l " <len>" "\fR,\fP \-\^\-snap-len=" "<len>"
Sets max length of processed packets to
.IR len .
.TP
.BI -p " <psm>" "\fR,\fP \-\^\-psm=" "<psm>"
Sets default Protocol Service Multiplexer to
.IR psm .
.TP
.BI -m " <compid>" "\fR,\fP \-\^\-manufacturer=" "<compid>"
Sets default company id for manufacturer to
.IR compid .
.TP
.BI -w " <file>" "\fR,\fP \-\^\-save-dump=" "<file>"
Parse output is not printed to screen, instead data read from device is saved in file
.IR file .
The saved dump file can be subsequently parsed with option
.BR -r .
.TP
.BI -r " <file>" "\fR,\fP \-\^\-read-dump=" "<file>"
Data is not read from a Bluetooth device, but from file
.IR file .
.I
file
is crated with option
.BR -w .
.TP 
.BI -s " <host>" "\fR,\fP \-\^\-send-dump=" "<host>"
Parse output is not printed to screen, instead data read from device is send to host
.IR host .
.TP 
.BI -n " <host>" "\fR,\fP \-\^\-recv-dump=" "<host>"
Data is not read from a Bluetooth device, but from host
.IR host .
.TP
.BR -t ", " "\-\^\-timestamp"
Prepend a time stamp to every packet.
.TP
.BR -a ", " "\-\^\-ascii"
For every packet, not only is the packet type displayed, but also all data in ASCII.
.TP
.BR -x ", " "\-\^\-hex"
For every packet, not only is the packet type displayed, but also all data in hex.
.TP
.BR -X ", " "\-\^\-ext"
For every packet, not only is the packet type displayed, but also all data in hex and ASCII.
.TP
.BR -R ", " "\-\^\-raw"
For every packet, only the raw data is displayed.
.TP
.BR -C ", " "\-\^\-cmtp=" "<psm>"
Sets the PSM value for the CAPI Message Transport Protocol.
.TP
.BR -H ", " "\-\^\-hcrp=" "<psm>"
Sets the PSM value for the Hardcopy Control Channel.
.TP
.BR -O ", " "\-\^\-obex=" "<channel>"
Sets the RFCOMM channel value for the Object Exchange Protocol.
.TP
.BR -P ", " "\-\^\-ppp=" "<channel>"
Sets the RFCOMM channel value for the Point-to-Point Protocol.
.TP
.BR -D ", " "\-\^\-pppdump=" "<file>"
Extract PPP traffic with pppdump format.
.TP
.BR -A ", " "\-\^\-audio=" "<file>"
Extract SCO audio data.
.TP
.BR -B ", " "\-\^\-btsnoop"
Use the BTSnoop file format.
.TP
.BR -V ", " "\-\^\-verbose"
Enables a more verbose decoding of every packet.
.TP
.BR -Y ", " "\-\^\-novendor"
Don't display any vendor commands or events and don't show any pin code or link key in plain text.
.TP
.BR -N ", " "\-\^\-noappend"
No appending to existing files. Always create new files.
.TP
.BR -4 ", " "\-\^\-ipv4"
Use IPv4 when sending information over the network
.TP
.BR -6 ", " "\-\^\-ipv6"
Use IPv6 when sending information over the network
.SH FILTERS
.B
filter
is a space-separated list of packet categories: available categories are
.IR lmp ,
.IR hci ,
.IR sco ,
.IR l2cap ,
.IR rfcomm ,
.IR sdp ,
.IR bnep ,
.IR cmtp ,
.IR hidp ,
.IR hcrp ,
.IR avdtp ,
.IR avctp ,
.IR obex ,
.IR capi
and
.IR ppp .
If filters are used, only packets belonging to the specified categories are
dumped. By default, all packets are dumped.
.SH AUTHORS
Written by Maxim Krasnyansky <maxk@qualcomm.com>
and Marcel Holtmann <marcel@holtmann.org>
.PP
man page by Fabrizio Gennari <fabrizio.gennari@philips.com>