From 0bb83c757c99357e972112f0817a36e9db48f753 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Sat, 16 Nov 2002 01:43:46 +0000 Subject: [PATCH] hcidump: Add the manpage for hcidump --- tools/hcidump.1 | 83 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 tools/hcidump.1 diff --git a/tools/hcidump.1 b/tools/hcidump.1 new file mode 100644 index 000000000..5413dc5d0 --- /dev/null +++ b/tools/hcidump.1 @@ -0,0 +1,83 @@ +.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 " " +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 -r " " "\fR,\fP \-\^\-read-dump=" "" +Data is not read from a Bluetooth device, but from file +.IR file . +.I +file +is crated with option +.BR -w . +.TP +.BI -w " " "\fR,\fP \-\^\-save-dump=" "" +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 +.BR -x ", " "\-\^\-hex" +For every packet, not only is the packet type displayed, but also all data in hex. +.TP +.BR -a ", " "\-\^\-ascii" +For every packet, not only is the packet type displayed, but also all data in ASCII. +.TP +.BI -s " " "\fR,\fP \-\^\-snap-len=" "" +Sets max length of processed packets to +.IR len . +.TP +.BI -p " " "\fR,\fP \-\^\-psm=" "" +Sets default Protocol Service Multiplexer to +.IR psm . +.TP +.BR -t ", " "\-\^\-ts" +Prepend a time stamp to every packet. +.TP +.BR -R ", " "\-\^\-raw" +Raw mode: do not display packet type, only data. +.SH FILTERS +.B +filter +is a space-separated list of packet categories: available categories are +.IR hci , +.IR l2cap , +.IR sco , +.IR rfcomm , +.IR sdp , +.I bnep +and +.IR cmtp . +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 +.PP +man page by Fabrizio Gennari -- 2.47.3