diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile.am | 7 | ||||
| -rw-r--r-- | docs/afcclient.1 | 74 | ||||
| -rw-r--r-- | docs/doxygen/custom.css | 3 | ||||
| -rw-r--r-- | docs/idevicebackup2.1 | 2 | ||||
| -rw-r--r-- | docs/idevicecrashreport.1 | 19 | ||||
| -rw-r--r-- | docs/idevicedevmodectl.1 | 58 | ||||
| -rw-r--r-- | docs/ideviceimagemounter.1 | 34 | ||||
| -rw-r--r-- | docs/idevicenotificationproxy.1 | 15 | ||||
| -rw-r--r-- | docs/idevicesyslog.1 | 45 |
9 files changed, 225 insertions, 32 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 9cdf82e..c9b742f 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -16,9 +16,12 @@ man_MANS = \ idevicecrashreport.1 \ idevicename.1 \ idevicedebug.1 \ + idevicedevmodectl.1 \ idevicenotificationproxy.1 \ - idevicesetlocation.1 + idevicesetlocation.1 \ + afcclient.1 -EXTRA_DIST = $(man_MANS) +EXTRA_DIST = $(man_MANS) \ + doxygen DISTCLEANFILES = html/* html diff --git a/docs/afcclient.1 b/docs/afcclient.1 new file mode 100644 index 0000000..a4eeacb --- /dev/null +++ b/docs/afcclient.1 @@ -0,0 +1,74 @@ +.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 [-rf] PATH +remove item at PATH +.TP +.B get [-rf] 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. +.TP +.B put [-rf] 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. +.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/doxygen/custom.css b/docs/doxygen/custom.css index 62183bf..e9f1ea8 100644 --- a/docs/doxygen/custom.css +++ b/docs/doxygen/custom.css @@ -230,6 +230,7 @@ div.fragment { border: solid 1px rgb(221, 221, 221); border-radius: 3px; background-color: rgb(248, 248, 248); + color: rgb(0,0,0); } div.line { @@ -1719,4 +1720,4 @@ th.markdownTableHeadNone { #projectnumber { font-size: 0.75rem; } -}
\ No newline at end of file +} diff --git a/docs/idevicebackup2.1 b/docs/idevicebackup2.1 index abbe38a..79b6dc4 100644 --- a/docs/idevicebackup2.1 +++ b/docs/idevicebackup2.1 @@ -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. diff --git a/docs/idevicecrashreport.1 b/docs/idevicecrashreport.1 index 6acd6e9..f117c87 100644 --- a/docs/idevicecrashreport.1 +++ b/docs/idevicecrashreport.1 @@ -16,28 +16,31 @@ the device to the target DIRECTORY. .SH OPTIONS .TP .B \-u, \-\-udid UDID -target specific device by UDID. +Target specific device by UDID. .TP .B \-n, \-\-network -connect to network device. +Connect to network device. .TP .B \-e, \-\-extract -extract raw crash report into separate '.crash' files. +Extract raw crash report into separate '.crash' files. .TP .B \-k, \-\-keep -copy but do not remove crash reports from device. +Copy but do not remove crash reports from device. .TP .B \-d, \-\-debug -enable communication debugging. +Enable communication debugging. .TP .B \-f, \-\-filter NAME -filter crash reports by NAME (case sensitive) +Filter crash reports by NAME (case sensitive) +.TP +.B \-\-remove\-all +Remove all crash log files without copying. Can be used with \f[B]-f\f[] to only remove matching files. .TP .B \-h, \-\-help -prints usage information. +Prints usage information. .TP .B \-v, \-\-version -prints version information. +Prints version information. .SH AUTHOR 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/ideviceimagemounter.1 b/docs/ideviceimagemounter.1 index 832850a..1fe7e45 100644 --- a/docs/ideviceimagemounter.1 +++ b/docs/ideviceimagemounter.1 @@ -1,13 +1,32 @@ .TH "ideviceimagemounter" 1 .SH NAME -ideviceimagemounter \- Mount disk images on the device. +ideviceimagemounter \- Mount, list, or unmount a disk image on the device. .SH SYNOPSIS .B ideviceimagemounter -[OPTIONS] IMAGE_FILE IMAGE_SIGNATURE_FILE +[OPTIONS] COMMAND [COMMAND OPTIONS] .SH DESCRIPTION -Mounts the specified disk image on the device. +Mount, list, or unmount a disk image on the device. + +.SH COMMANDS +.TP +.B mount PATH +Mount the developer disk image at PATH. +For iOS 17+, PATH is a directory containing a .dmg image, a BuildManifest.plist, +and a Firmware sub-directory. + +For older versions PATH is a .dmg filename with a .dmg.signature file in the same directory, or with +another parameter pointing to a file elsewhere. +.TP +.B list +List mounted disk images. +.TP +.B unmount PATH +Unmount the image mounted at PATH. +.TP +.B devmodestatus +Query the developer mode status (iOS 16+) .SH OPTIONS .TP @@ -20,9 +39,6 @@ connect to network device. .B \-d, \-\-debug enable communication debugging. .TP -.B \-l, \-\-list -list mount information -.TP .B \-t, \-\-imagetype NAME the image type to use, default is 'Developer' .TP @@ -34,12 +50,6 @@ prints usage information .TP .B \-v, \-\-version prints version information. -.TP -.B IMAGE_FILE -the image filename to mount -.TP -.B IMAGE_SIGNATURE_FILE -corresponding signature file for image filename .SH AUTHOR Nikias Bassen diff --git a/docs/idevicenotificationproxy.1 b/docs/idevicenotificationproxy.1 index 56dd0b0..627ee5d 100644 --- a/docs/idevicenotificationproxy.1 +++ b/docs/idevicenotificationproxy.1 @@ -12,19 +12,22 @@ Post or observe notifications on an iOS device from the command line. .SH OPTIONS .TP .B \-u, \-\-udid UDID -target specific device by UDID. +Target specific device by UDID. +.TP +.B \-i, \-\-insecure +Connect to insecure notification proxy (for non-paired devices). .TP .B \-n, \-\-network -connect to network device. +Connect to network device. .TP .B \-d, \-\-debug -enable communication debugging. +Enable communication debugging. .TP .B \-h, \-\-help -prints usage information. +Prints usage information. .TP .B \-v, \-\-version -prints version information. +Prints version information. .SH COMMANDS .TP @@ -38,6 +41,8 @@ observe notification IDs in the foreground until CTRL+C or signal is received. Martin Szulecki +Nikias Bassen + .SH ON THE WEB https://libimobiledevice.org diff --git a/docs/idevicesyslog.1 b/docs/idevicesyslog.1 index b7d4bab..5a677b6 100644 --- a/docs/idevicesyslog.1 +++ b/docs/idevicesyslog.1 @@ -27,17 +27,56 @@ 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[]. +.TP +.B \-\-syslog\-relay +Use old syslog_relay service instead of os_trace_relay (iOS 9+). + +.SH COMMANDS +.TP +.B pidlist +Print a list with PID and name of all processes currently running on the device. +.TP +.B archive PATH +Request a logarchive from the device. It will be written in tar format to PATH. To pipe to another process use \- as PATH. +Below are some options to restrict the log message data. + +In order to view the logarchive in a compatible log viewer, you can pipe the output data to \f[B]tar\f[] and have it extract into a new directory: + +\f[B]mkdir test.logarchive && tools/idevicesyslog archive - |tar -C test.logarchive -xv\f[] + +This will also print the filenames while they are extracted. +.TP +Further options for \f[B]archive\f[]: +.TP +.B \-\-start\-time VALUE +Start time of the log data as UNIX timestamp. Earlier messages will be dropped. +.TP +.B \-\-age\-limit VALUE +Maximum age of the log data, supposedly number of days. +.TP +.B \-\-size\-limit VALUE +Limit the size of the archive. The unit is currently unknown, so feel free to experiment. +.TP +Keep in mind that the device usually only has a backlog of a few minutes so the options might not have the desired effect. This is not a bug. .SH FILTER OPTIONS .TP .B \-m, \-\-match STRING only print messages that contain STRING - -This option will set a filter to only printed log messages that contain the given string. +.TP +.B \-M, \-\-unmatch STRING +print messages that do not contain STRING .TP .B \-t, \-\-trigger STRING start logging when matching STRING |