From 4b6e0d752e0c33dca71b358f88d2919856c56243 Mon Sep 17 00:00:00 2001
From: Geoffrey Kruse
Date: Sun, 7 Mar 2021 16:18:39 -0800
Subject: idevicebtlogger: Add basic man page

---
 docs/Makefile.am       |  1 +
 docs/idevicebtlogger.1 | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 48 insertions(+)
 create mode 100644 docs/idevicebtlogger.1

(limited to 'docs')

diff --git a/docs/Makefile.am b/docs/Makefile.am
index 5ed81fe..9cdf82e 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,6 +1,7 @@
 man_MANS = \
 	idevice_id.1 \
 	ideviceinfo.1 \
+	idevicebtlogger.1 \
 	idevicesyslog.1 \
 	idevicebackup.1 \
 	idevicebackup2.1 \
diff --git a/docs/idevicebtlogger.1 b/docs/idevicebtlogger.1
new file mode 100644
index 0000000..24903b5
--- /dev/null
+++ b/docs/idevicebtlogger.1
@@ -0,0 +1,47 @@
+.TH "idevicebtlogger" 1
+.SH NAME
+idevicebtlogger \- Capture HCI traffic of a connected device.
+.SH SYNOPSIS
+.B idevicebtlogger
+[OPTIONS]
+<FILE>
+
+.SH DESCRIPTION
+
+Capture HCI traffic of a connected device.  Requires Bluetooth logging profile to be installed on device.
+
+.SH OPTIONS
+.TP
+.B \-u, \-\-udid UDID
+target specific device by UDID
+.TP
+.B \-n, \-\-network
+connect to network device
+.TP
+.B \-x, \-\-exit
+exit when device disconnects
+.TP
+.B \-d, \-\-debug
+enable communication debugging
+.TP
+.B \-h, \-\-help
+prints usage information
+.TP
+.B \-v, \-\-version
+prints version information.
+
+.SH EXAMPLES
+.TP
+.B idevicebtlogger \-u 00008030\-0000111ABC000DEF
+Capture HCI traffic of device with UDID 00008030-0000111ABC000DEF.
+.TP
+.B idevicebtlogger \-x
+Capture HCI traffic of device and exit when the device is unplugged.
+
+.SH AUTHORS
+Geoffrey Kruse
+
+.SH ON THE WEB
+https://libimobiledevice.org
+
+https://github.com/libimobiledevice/libimobiledevice
-- 
cgit v1.1-32-gdbae