hcidump.rst 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. =======
  2. hcidump
  3. =======
  4. --------------
  5. Parse HCI data
  6. --------------
  7. :Authors: - Maxim Krasnyansky <maxk@qualcomm.com>
  8. - Marcel Holtmann <marcel@holtmann.org>
  9. - Fabrizio Gennari <fabrizio.gennari@philips.com>
  10. :Version: BlueZ
  11. :Copyright: Free use of this software is granted under ther terms of the GNU
  12. Lesser General Public Licenses (LGPL).
  13. :Date: Nov 12, 2002
  14. :Manual section: 1
  15. :Manual group: Linux System Administration
  16. SYNOPSIS
  17. ========
  18. **hcidump** -h
  19. **hcidump** [OPTIONS ...] [FILTERS]
  20. DESCRIPTION
  21. ===========
  22. **hcidump(1)** reads raw HCI data coming from and going to a Bluetooth device
  23. (which can be specified with the option **-i**, default is the first available
  24. one) and prints to screen commands, events and data in a human-readable form.
  25. Optionally, the dump can be written to a file rather than parsed, and the dump
  26. file can be parsed in a subsequent moment.
  27. OPTIONS
  28. =======
  29. -i <hciX>
  30. Data is read from *hciX*, which must be the name of an installed Bluetooth
  31. device. If not specified, and if **-r** option is not set, data is read from
  32. the first available Bluetooth device.
  33. -l <len>, --snap-len=<len>
  34. Sets max length of processed packets to *len*.
  35. -p <psm>, --psm=<psm>
  36. Sets default Protocol Service Multiplexer to *psm*.
  37. -m <compid>, --manufacturer=<compid>
  38. Sets default company id for manufacturer to *compid*.
  39. -w <file>, --save-dump=<file>
  40. Parse output is not printed to screen, instead data read from device is
  41. saved in *file*. The saved dump file can be subsequently parsed with
  42. option **-r**.
  43. -r <file>, --read-dump=<file>
  44. Data is not read from a Bluetooth device, but from *file*. *file* is
  45. created with option **-t**, **--timestamp** prepend a time stamp to every
  46. packet.
  47. -a, --ascii
  48. For every packet, not only is the packet type displayed, but also all data
  49. in ASCII.
  50. -x, --hex
  51. For every packet, not only is the packet type displayed, but also all data
  52. in hex.
  53. -X, --ext
  54. For every packet, not only is the packet type displayed, but also all data
  55. in hex and ASCII.
  56. -R, --raw
  57. For every packet, only the raw data is displayed.
  58. -C <psm>, --cmtp=<psm>
  59. Sets the PSM value for the CAPI Message Transport Protocol.
  60. -H <psm>, --hcrp=<psm>
  61. Sets the PSM value for the Hardcopy Control Channel.
  62. -O <channel>, --obex=<channel>
  63. Sets the RFCOMM channel value for the Object Exchange Protocol.
  64. -P <channel>, --ppp=<channel>
  65. Sets the RFCOMM channel value for the Point-to-Point Protocol.
  66. -D <file>, --pppdump=<file>
  67. Extract PPP traffic with pppdump format.
  68. -A <file>, --audio=<file>
  69. Extract SCO audio data.
  70. -Y, --novendor
  71. Don't display any vendor commands or events and don't show any pin code or
  72. link key in plain text.
  73. -h
  74. Prints usage info and exits
  75. FILTERS
  76. =======
  77. filter is a space-separated list of packet categories: available categories are
  78. *lmp*, *hci*, *sco*, *l2cap*, *rfcomm*, *sdp*, *bnep*, *cmtp*, *hidp*, *hcrp*,
  79. *avdtp*, *avctp*, *obex*, *capi* and *ppp*. If filters are used, only packets
  80. belonging to the specified categories are dumped. By default, all packets are
  81. dumped.
  82. RESOURCES
  83. =========
  84. http://www.bluez.org
  85. REPORTING BUGS
  86. ==============
  87. linux-bluetooth@vger.kernel.org