bluez5_utils-5.62/monitor/btmon.1

.\" Man page generated from reStructuredText.
.
.TH BTMON 1 "April 2021" "BlueZ" "Linux System Administration"
.SH NAME
btmon \- Bluetooth monitor
.
.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 SYNOPSYS
.sp
\fBbtmon\fP [\fIOPTIONS\fP ...]
.SH DESCRIPTION
.sp
The  btmon(1) command  provides  access  to the Bluetooth subsystem monitor
infrastructure for reading HCI traces.
.SH OPTIONS
.INDENT 0.0
.TP
.BI \-r \ FILE\fR,\fB \ \-\-read \ FILE
Read traces in btsnoop format from \fIFILE\fP\&.
.TP
.BI \-w \ FILE\fR,\fB \ \-\-write \ FILE
Save traces in btsnoop format to \fIFILE\fP\&.
.TP
.BI \-a \ FILE\fR,\fB \ \-\-analyze \ FILE
Analyze traces in btsnoop format from \fIFILE\fP\&.
It displays the devices found in the \fIFILE\fP with
its packets by type.
.TP
.BI \-s \ SOCKET\fR,\fB \ \-\-server \ SOCKET
Start monitor server socket.
.TP
.BI \-p \ PRIORITY\fR,\fB \ \-\-priority \ PRIORITY
Show only priority or lower for user log.
.UNINDENT
.TS
center;
|l|l|.
_
T{
\fIPRIORITY\fP
T}	T{
NAME
T}
_
T{
\fB3\fP
T}	T{
Error
T}
_
T{
\fB4\fP
T}	T{
Warning
T}
_
T{
\fB6\fP
T}	T{
Information (Default)
T}
_
T{
\fB7\fP
T}	T{
Debug. \fBdebug\fP can be used.
T}
_
.TE
.INDENT 0.0
.TP
.BI \-i \ NUM\fR,\fB \ \-\-index \ NUM
Show only specified controller. \fIhciNUM\fP is also
acceptable. This is useful to capture the traces
from the specific controller when the multiple
controllers are presented.
.TP
.BI \-d \ TTY\fR,\fB \ \-\-tty \ TTY
Read data from \fITTY\fP\&.
.TP
.BI \-B \ SPEED\fR,\fB \ \-\-rate \ SPEED
Set TTY speed. The default \fISPEED\fP is 115300
.TP
.BI \-V \ COMPID\fR,\fB \ \-\-vendor \ COMPID
Set the default company identifier. The \fICOMPID\fP is
a unique number assigned by the Bluetooth SIG to
a member company and can be found/searched from the
Bluetooth SIG webpage.
.sp
For example, Intel is 2 and Realtek is 93.
.TP
.B \-M\fP,\fB  \-\-mgmt
Open channel for mgmt events.
.TP
.B \-t\fP,\fB  \-\-time
Show a time instead of time offset.
.TP
.B \-T\fP,\fB  \-\-date
Show a time and date information instead of
time offset.
.TP
.B \-S\fP,\fB  \-\-sco
Dump SCO traffic in raw hex format.
.TP
.B \-A\fP,\fB  \-\-a2dp
Dump A2DP stream traffic in a raw hex format.
.TP
.BI \-E \ IP\fR,\fB \ \-\-ellisys \ IP
Send Ellisys HCI Injection.
.TP
.B \-P\fP,\fB  \-\-no\-pager
Disable pager usage while reading the log file.
.TP
.BI \-J \ OPTIONS\fR,\fB \ \-\-jlink \ OPTIONS
Read data from RTT.  Each options are comma(,)
seprated without spaces.
.UNINDENT
.TS
center;
|l|l|.
_
T{
\fIOPTIONS\fP
T}	T{
Description
T}
_
T{
\fBDEVICE\fP
T}	T{
Required. Set the target device.
T}
_
T{
\fBSERIALNO\fP
T}	T{
(Optional) Set the USB serial number. Default is \fB0\fP\&.
T}
_
T{
\fBINTERFACE\fP
T}	T{
(Optional) Target interface. Default is \fBswd\fP\&.
T}
_
T{
\fBSPEED\fP
T}	T{
(Optional) Set target interface speed in kHz. Default is \fB1000\fP\&.
T}
_
.TE
.INDENT 0.0
.TP
.BI \-R \ OPTIONS\fR,\fB \ \-\-rtt \ OPTIONS
RTT control block parameters. Each options are
comma(,) seprated without spaces.
.UNINDENT
.TS
center;
|l|l|.
_
T{
\fIOPTIONS\fP
T}	T{
Description
T}
_
T{
\fBADDRESS\fP
T}	T{
(Optional) Address of RTT buffer. Default is \fB0x00\fP
T}
_
T{
\fBAREA\fP
T}	T{
(Optional) Size of range to search in RTT buffer. Default is \fB0\fP
T}
_
T{
\fBNAME\fP
T}	T{
(Optional) Buffer name. Default is \fBbtmonitor\fP
T}
_
.TE
.INDENT 0.0
.TP
.BI \-C \ WIDTH\fR,\fB \ \-\-columns \ WIDTH
Output width if not a terminal
.TP
.BI \-c \ MODE\fR,\fB \ \-\-color \ MODE
Set output color. The possible \fIMODE\fP values are:
\fBauto|always|never\fP\&.
.sp
Default value is \fBauto\fP
.TP
.B \-v\fP,\fB  \-\-version
Show version
.TP
.B \-h\fP,\fB  \-\-help
Show help options
.UNINDENT
.SH EXAMPLES
.SS Capture the traces from hci0 to hcidump.log file
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ btmon \-i hci0 \-w hcidump.log
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Open the trace file
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ btmon \-r hcidump.log
.ft P
.fi
.UNINDENT
.UNINDENT
.SH RESOURCES
.sp
\fI\%http://www.bluez.org\fP
.SH REPORTING BUGS
.sp
\fI\%linux\-bluetooth@vger.kernel.org\fP
.SH AUTHOR
Marcel Holtmann <marcel@holtmann.org>, Tedd Ho-Jeong An <tedd.an@intel.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.
.