diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile.am | 2 | ||||
| -rw-r--r-- | docs/afcclient.1 | 76 | ||||
| -rw-r--r-- | docs/idevicebackup.1 | 2 | ||||
| -rw-r--r-- | docs/idevicebackup2.1 | 22 | ||||
| -rw-r--r-- | docs/idevicebtlogger.1 | 60 | ||||
| -rw-r--r-- | docs/idevicecrashreport.1 | 3 | ||||
| -rw-r--r-- | docs/idevicedebugserverproxy.1 | 6 | ||||
| -rw-r--r-- | docs/idevicedevmodectl.1 | 58 | ||||
| -rw-r--r-- | docs/idevicepair.1 | 26 | ||||
| -rw-r--r-- | docs/idevicesyslog.1 | 9 |
10 files changed, 255 insertions, 9 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 5ed81fe..4a4c56f 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 \ @@ -15,6 +16,7 @@ man_MANS = \ idevicecrashreport.1 \ idevicename.1 \ idevicedebug.1 \ + idevicedevmodectl.1 \ idevicenotificationproxy.1 \ idevicesetlocation.1 diff --git a/docs/afcclient.1 b/docs/afcclient.1 new file mode 100644 index 0000000..ca7cb86 --- /dev/null +++ b/docs/afcclient.1 @@ -0,0 +1,76 @@ +.TH "afcclient" 1 +.SH NAME +afcclient \- Interact with AFC/HouseArrest service on a connected device. +.SH SYNOPSIS +.B afcclient +[OPTIONS] [COMMAND ...] + +.SH DESCRIPTION + +Utility to interact with AFC/HouseArrest service. This allows access to parts +of the filesystem on an iOS device. + +\f[B]afcclient\f[] can be used interactively with a command prompt, or run a single command and exit. + +.SH COMMANDS +.TP +.B devinfo +print device information +.TP +.B info PATH +print file attributes of file at PATH +.TP +.B ls PATH +print directory contents of PATH +.TP +.B mv OLD NEW +rename file OLD to NEW +.TP +.B mkdir PATH +create directory at PATH +.TP +.B ln [-s] FILE [LINK] +Create a (symbolic) link to file named LINKNAME. \f[B]NOTE: This feature has been disabled in newer versions of iOS\f[]. +.TP +.B rm PATH +remove item at PATH +.TP +.B get PATH [LOCALPATH] +transfer file at PATH from device to LOCALPATH, or current directory if omitted. If LOCALPATH is a directory, the file will be stored inside the directory. +\f[B]WARNING\f[]: Existing files will be overwritten! +.TP +.B put LOCALPATH [PATH] +transfer local file at LOCALPATH to device at PATH, or current directory if omitted. If PATH is a directory, the file will be stored inside the directory. +\f[B]WARNING\f[]: Existing files will be overwritten! +.TP + +.SH OPTIONS +.TP +.B \-u, \-\-udid UDID +target specific device by UDID +.TP +.B \-n, \-\-network +connect to network device (not recommended, since the connection might be terminated at any time) +.TP +.B \--container <appid> +Access the app container directory of the app with given \f[B]appid\f[] +.TP +.B \--documents <appid> +Access the Documents directory of the app with given \f[B]appid\f[] +.TP +.B \-h, \-\-help +Prints usage information +.TP +.B \-d, \-\-debug +Enable communication debugging +.TP +.B \-v, \-\-version +Prints version information + +.SH AUTHOR +Nikias Bassen + +.SH ON THE WEB +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/idevicebackup.1 b/docs/idevicebackup.1 index 3a40f5f..6f2a8f9 100644 --- a/docs/idevicebackup.1 +++ b/docs/idevicebackup.1 @@ -7,7 +7,7 @@ idevicebackup \- Create or restore backup for devices. .SH DESCRIPTION -Create or restore backup from the current or specified directory. +Create or restore backup in/from the specified directory. \f[B]NOTE\f[]: This tool is outdated. See idevicebackup2(1) for an updated tool. diff --git a/docs/idevicebackup2.1 b/docs/idevicebackup2.1 index ba5ef53..79b6dc4 100644 --- a/docs/idevicebackup2.1 +++ b/docs/idevicebackup2.1 @@ -7,7 +7,7 @@ idevicebackup2 \- Create or restore backups for devices running iOS 4 or later. .SH DESCRIPTION -Create or restore backup from the current or specified directory. +Create or restore backup in/from the specified directory. .SH OPTIONS .TP @@ -47,7 +47,7 @@ restore last backup to the device. restore system files, too. .TP .B \t\-\-no\-reboot -reboot the system when done. +do NO reboot the system when done. .TP .B \t\-\-copy create a copy of backup folder before restoring. @@ -62,7 +62,9 @@ remove items which are not being restored. do not trigger re-installation of apps after restore. .TP .B \t\-\-password PWD -supply the password of the source backup. +supply the password for the encrypted source backup. If omitted, the password +will be requested in interactive mode (\f[B]\-i\f[]), or it can be passed using +the environment variable \f[B]BACKUP_PASSWORD\f[]. .TP .B info show details about last completed backup of device. @@ -74,13 +76,23 @@ list files of last completed backup in CSV format. unpack a completed backup in DIRECTORY/_unback_/ .TP .B encryption on|off [PWD] -enable or disable backup encryption. +enable or disable backup encryption. The password will be requested in +interactive mode (\f[B]\-i\f[]) if omitted, or it can be passed using the +environment variable \f[B]BACKUP_PASSWORD\f[]. .TP .B changepw [OLD NEW] -change backup password on target device. +change backup password on target device. The passwords will be requested in +interactive mode (\f[B]\-i\f[]) if omitted, or they can be passed using the +environment variables \f[B]BACKUP_PASSWORD\f[] (old password) and +\f[B]BACKUP_PASSWORD_NEW\f[] (new password) respectively. .TP .B cloud on|off enable or disable cloud use (requires iCloud account). +.SH SECURITY CONSIDERATIONS +Passing passwords on the command line is not advised, since it might reveal +the backup password to other users via process list or command line history. +Use interactive mode (\f[B]\-i\f[]) or pass them via environment variable(s) +as mentioned in the description of the respective commands above. .SH AUTHORS Martin Szulecki diff --git a/docs/idevicebtlogger.1 b/docs/idevicebtlogger.1 new file mode 100644 index 0000000..98a723f --- /dev/null +++ b/docs/idevicebtlogger.1 @@ -0,0 +1,60 @@ +.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 with iOS 13 or higher. See https://www.bluetooth.com/blog/a-new-way-to-debug-iosbluetooth-applications/ for iOS device configuration. + +The HCI traffic can be stored in Apple's native PacketLogger format or converted into PCAP format for live feedback in Wireshark. + +.SH OPTIONS +.TP +.B \-u, \-\-udid UDID +target specific device by UDID +.TP +.B \-n, \-\-network +connect to network device +.TP +.B \-f, \-\-format FORMAT +set log format: PacketLogger (default), or pcap +.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. +.TP +.B idevicebtlogger \-f pcap +Capture HCI traffic of device in PCAP format. +.TP +.B idevicebtlogger -f pcap - | wireshark -k -i - +Capture HCI traffic and pipe it into Wireshark for live feedback. + +.SH AUTHORS +Geoffrey Kruse + +Matthias Ringwald + +.SH ON THE WEB +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/idevicecrashreport.1 b/docs/idevicecrashreport.1 index aba806a..6acd6e9 100644 --- a/docs/idevicecrashreport.1 +++ b/docs/idevicecrashreport.1 @@ -30,6 +30,9 @@ copy but do not remove crash reports from device. .B \-d, \-\-debug enable communication debugging. .TP +.B \-f, \-\-filter NAME +filter crash reports by NAME (case sensitive) +.TP .B \-h, \-\-help prints usage information. .TP diff --git a/docs/idevicedebugserverproxy.1 b/docs/idevicedebugserverproxy.1 index 37502eb..69200ee 100644 --- a/docs/idevicedebugserverproxy.1 +++ b/docs/idevicedebugserverproxy.1 @@ -3,7 +3,7 @@ idevicedebugserverproxy \- Remote debugging proxy. .SH SYNOPSIS .B idevicedebugserverproxy -[OPTIONS] PORT +[OPTIONS] [PORT] .SH DESCRIPTION @@ -22,6 +22,9 @@ target specific device by UDID. .B \-n, \-\-network connect to network device. .TP +.B \-l, \-\-lldb +Enable lldb support. +.TP .B \-d, \-\-debug enable communication debugging. .TP @@ -35,6 +38,7 @@ prints version information. .TP .B PORT The port under which the proxy should listen for connections from clients. +If omitted, the next available port will be used and printed to stdout. .SH AUTHORS Martin Szulecki diff --git a/docs/idevicedevmodectl.1 b/docs/idevicedevmodectl.1 new file mode 100644 index 0000000..5edaa80 --- /dev/null +++ b/docs/idevicedevmodectl.1 @@ -0,0 +1,58 @@ +.TH "idevicedevmodectl" 1 +.SH NAME +idevicedevmodectl \- Enable Developer Mode on iOS 16+ devices or print the current status. +.SH SYNOPSIS +.B idevicedevmodectl +COMMAND +[OPTIONS] + +.SH DESCRIPTION + +Enable Developer Mode on iOS 16+ devices or print the current status. + +.SH NOTE +Passcode-protected devices will NOT allow enabling of Developer Mode from the command line. It has to be enabled on the device itself under Settings -> Privacy & Security -> Developer Mode. +The \f[B]enable\f[] command will try to enable it, and tell you if that's the case. +If the menu is not shown, you may use the \f[B]reveal\f[] command to reveal it. + +.SH COMMANDS +.TP +.B list +Prints the Developer Mode status of all connected devices, or for a specific one if \f[B]\-\-udid\f[] is given. +.TP +.B enable +Enable Developer Mode (device will reboot), and confirm it after device booted up again. +.TP +.B arm +Arm the Developer Mode (device will reboot) +.TP +.B confirm +Confirm enabling of Developer Mode +.TP +.B reveal +Reveal the Developer Mode menu on the device under Settings -> Privacy & Security + +.SH OPTIONS +.TP +.B \-u, \-\-udid UDID +target specific device by UDID +.TP +.B \-n, \-\-network +connect to network device +.TP +.B \-d, \-\-debug +enable communication debugging +.TP +.B \-h, \-\-help +print usage information +.TP +.B \-v, \-\-version +print version information + +.SH AUTHORS +Nikias Bassen + +.SH ON THE WEB +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/idevicepair.1 b/docs/idevicepair.1 index 3576ce9..eb6e7d4 100644 --- a/docs/idevicepair.1 +++ b/docs/idevicepair.1 @@ -13,7 +13,13 @@ Manage host pairings with devices and usbmuxd. .TP .B \-u, \-\-udid UDID target specific device by UDID. -.TP +.TP +.B \-w, \-\-wireless +perform wireless pairing (\f[B]see NOTE\f[]). +.TP +.B \-n, \-\-network +connect to network device (\f[B]see NOTE\f[]). +.TP .B \-d, \-\-debug enable communication debugging. .TP @@ -43,6 +49,24 @@ unpair device with this host. .B list list devices paired with this host. +.SH NOTE +Pairing over network (wireless pairing) is only supported by Apple TV +devices. To perform a wireless pairing, you need to use the \f[B]\-w\f[] +command line switch. + +Make sure to put the device into pairing mode first by opening +Settings > Remotes and Devices > Remote App and Devices. + +The pairable device will become visible with a special UDID, and then you +can run idevicepair like this: + +.B idevicepair -u fffc8:ab:cd:12:34:56fff -w pair + +idevicepair will then ask for the PIN that the device is displaying and +continues with the pairing once entered. + +Please note that wireless pairing is currently not supported on Linux. + .SH AUTHORS Nikias Bassen diff --git a/docs/idevicesyslog.1 b/docs/idevicesyslog.1 index b7d4bab..66ae2e4 100644 --- a/docs/idevicesyslog.1 +++ b/docs/idevicesyslog.1 @@ -27,10 +27,17 @@ enable communication debugging prints usage information .TP .B \-v, \-\-version -prints version information. +Prints version information. .TP .B \-\-no\-colors disable colored output +.TP +.B \-o, \-\-output FILE +Write to FILE instead of stdout. This will disable writing colored output, but can be re-enabled with \f[B]\-\-colors\f[]. +If FILE already exists, it will be overwritten without warning. +.TP +.B \-\-colors +Force writing colored output, e.g. when using \f[B]\-\-output\f[]. .SH FILTER OPTIONS .TP |