From 18a93b10821a01cf1f706013e6a14014a4d3e2a5 Mon Sep 17 00:00:00 2001 From: Nikias Bassen Date: Fri, 5 Jun 2020 20:52:23 +0200 Subject: docs: Update man pages with new command line switches --- docs/idevice_id.1 | 9 ++++++--- docs/idevicebackup.1 | 13 ++++++++++++- docs/idevicebackup2.1 | 13 ++++++++----- docs/idevicecrashreport.1 | 12 +++++++++--- docs/idevicedate.1 | 12 +++++++++--- docs/idevicedebug.1 | 16 +++++++++++----- docs/idevicedebugserverproxy.1 | 10 ++++++++-- docs/idevicediagnostics.1 | 10 ++++++++-- docs/ideviceenterrecovery.1 | 3 +++ docs/ideviceimagemounter.1 | 12 +++++++++--- docs/ideviceinfo.1 | 12 +++++++++--- docs/idevicename.1 | 12 +++++++++--- docs/idevicenotificationproxy.1 | 6 ++++++ docs/idevicepair.1 | 5 ++++- docs/ideviceprovision.1 | 6 ++++++ docs/idevicescreenshot.1 | 12 +++++++++--- docs/idevicesetlocation.1 | 11 +++++++---- docs/idevicesyslog.1 | 5 ++++- 18 files changed, 137 insertions(+), 42 deletions(-) (limited to 'docs') diff --git a/docs/idevice_id.1 b/docs/idevice_id.1 index e0d271d..af9db92 100644 --- a/docs/idevice_id.1 +++ b/docs/idevice_id.1 @@ -15,13 +15,16 @@ for which the name should be retrieved. .TP .B \-l, \-\-list list UDID of all attached devices -.TP +.TP .B \-d, \-\-debug enable communication debugging. -.TP +.TP .B \-h, \-\-help prints usage information. -.TP +.TP +.B \-v, \-\-version +prints version information. +.TP .SH AUTHORS Zach C. diff --git a/docs/idevicebackup.1 b/docs/idevicebackup.1 index a90719f..3a40f5f 100644 --- a/docs/idevicebackup.1 +++ b/docs/idevicebackup.1 @@ -9,16 +9,24 @@ idevicebackup \- Create or restore backup for devices. Create or restore backup from the current or specified directory. +\f[B]NOTE\f[]: This tool is outdated. See idevicebackup2(1) for an updated tool. + .SH OPTIONS .TP .B \-u, \-\-udid UDID target specific device by UDID. -.TP +.TP +.B \-n, \-\-network +connect to network device. +.TP .B \-d, \-\-debug enable communication debugging. .TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH COMMANDS .TP @@ -35,6 +43,9 @@ Nikias Bassen Man page written to conform with Debian by Julien Lavergne. +.SH SEE ALSO +idevicebackup2(1) + .SH ON THE WEB https://libimobiledevice.org diff --git a/docs/idevicebackup2.1 b/docs/idevicebackup2.1 index 0a33126..f4e33ee 100644 --- a/docs/idevicebackup2.1 +++ b/docs/idevicebackup2.1 @@ -19,12 +19,18 @@ use backup data from device specified by UDID. .TP .B \-i, \-\-interactive request passwords interactively on the command line. -.TP +.TP +.B \-n, \-\-network +connect to network device. +.TP .B \-d, \-\-debug enable communication debugging. -.TP +.TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH COMMANDS .TP @@ -68,9 +74,6 @@ Martin Szulecki Nikias Bassen -.SH SEE ALSO -idevicebackup(1) - .SH ON THE WEB https://libimobiledevice.org diff --git a/docs/idevicecrashreport.1 b/docs/idevicecrashreport.1 index ab0097c..aba806a 100644 --- a/docs/idevicecrashreport.1 +++ b/docs/idevicecrashreport.1 @@ -15,6 +15,12 @@ the device to the target DIRECTORY. .SH OPTIONS .TP +.B \-u, \-\-udid UDID +target specific device by UDID. +.TP +.B \-n, \-\-network +connect to network device. +.TP .B \-e, \-\-extract extract raw crash report into separate '.crash' files. .TP @@ -24,11 +30,11 @@ copy but do not remove crash reports from device. .B \-d, \-\-debug enable communication debugging. .TP -.B \-u, \-\-udid UDID -target specific device by UDID. -.TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH AUTHOR Martin Szulecki diff --git a/docs/idevicedate.1 b/docs/idevicedate.1 index 747afa5..dcdc57e 100644 --- a/docs/idevicedate.1 +++ b/docs/idevicedate.1 @@ -11,12 +11,15 @@ Simple utility to manage the clock on a device. .SH OPTIONS .TP -.B \-d, \-\-debug -enable communication debugging. -.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 \-s, \-\-set TIMESTAMP set UTC time described by TIMESTAMP .TP @@ -25,6 +28,9 @@ set time of device to current system time .TP .B \-h, \-\-help prints usage information +.TP +.B \-v, \-\-version +prints version information. .SH AUTHOR Martin Szulecki diff --git a/docs/idevicedebug.1 b/docs/idevicedebug.1 index cf6220a..7314baa 100644 --- a/docs/idevicedebug.1 +++ b/docs/idevicedebug.1 @@ -12,18 +12,24 @@ command is "run" and allows execution of developer apps and watch the stdout/stderr of the process. .SH OPTIONS -.TP -.B \-e, \-\-env NAME=VALUE -set environment variable NAME to VALUE. .TP .B \-u, \-\-udid UDID target specific device by UDID. -.TP +.TP +.B \-n, \-\-network +connect to network device. +.TP +.B \-e, \-\-env NAME=VALUE +set environment variable NAME to VALUE. +.TP .B \-d, \-\-debug enable communication debugging. -.TP +.TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH COMMANDS .TP diff --git a/docs/idevicedebugserverproxy.1 b/docs/idevicedebugserverproxy.1 index c843702..37502eb 100644 --- a/docs/idevicedebugserverproxy.1 +++ b/docs/idevicedebugserverproxy.1 @@ -18,12 +18,18 @@ The developer disk image needs to be mounted for this service to be available. .TP .B \-u, \-\-udid UDID target specific device by UDID. -.TP +.TP +.B \-n, \-\-network +connect to network device. +.TP .B \-d, \-\-debug enable communication debugging. -.TP +.TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH USAGE .TP diff --git a/docs/idevicediagnostics.1 b/docs/idevicediagnostics.1 index 612d940..2f28b8d 100644 --- a/docs/idevicediagnostics.1 +++ b/docs/idevicediagnostics.1 @@ -17,12 +17,18 @@ iOS 5 and later. .TP .B \-u, \-\-udid UDID target specific device by UDID. -.TP +.TP +.B \-n, \-\-network +connect to network device. +.TP .B \-d, \-\-debug enable communication debugging. -.TP +.TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH COMMANDS .TP diff --git a/docs/ideviceenterrecovery.1 b/docs/ideviceenterrecovery.1 index 6ca277d..d455826 100644 --- a/docs/ideviceenterrecovery.1 +++ b/docs/ideviceenterrecovery.1 @@ -16,6 +16,9 @@ enable communication debugging. .TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH AUTHORS Martin Szulecki diff --git a/docs/ideviceimagemounter.1 b/docs/ideviceimagemounter.1 index e88891e..832850a 100644 --- a/docs/ideviceimagemounter.1 +++ b/docs/ideviceimagemounter.1 @@ -11,12 +11,15 @@ Mounts the specified disk image on the device. .SH OPTIONS .TP -.B \-d, \-\-debug -enable communication debugging. -.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 \-l, \-\-list list mount information .TP @@ -29,6 +32,9 @@ use XML output .B \-h, \-\-help prints usage information .TP +.B \-v, \-\-version +prints version information. +.TP .B IMAGE_FILE the image filename to mount .TP diff --git a/docs/ideviceinfo.1 b/docs/ideviceinfo.1 index 90d112c..1d72bb8 100644 --- a/docs/ideviceinfo.1 +++ b/docs/ideviceinfo.1 @@ -11,12 +11,15 @@ Show information about the first connected device. .SH OPTIONS .TP -.B \-d, \-\-debug -enable communication debugging. -.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 \-q, \-\-domain NAME set domain of query to NAME. Default: None. .TP @@ -28,6 +31,9 @@ output information as xml plist instead of key/value pairs. .TP .B \-h, \-\-help prints usage information +.TP +.B \-v, \-\-version +prints version information. .SH AUTHOR Martin Szulecki diff --git a/docs/idevicename.1 b/docs/idevicename.1 index 0380160..34ce490 100644 --- a/docs/idevicename.1 +++ b/docs/idevicename.1 @@ -17,14 +17,20 @@ is given the device name will be set to the name specified. .SH OPTIONS .TP -.B \-d, \-\-debug -enable communication debugging. -.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 prints usage information +.TP +.B \-v, \-\-version +prints version information. .SH AUTHOR Nikias Bassen diff --git a/docs/idevicenotificationproxy.1 b/docs/idevicenotificationproxy.1 index eb0c24f..56dd0b0 100644 --- a/docs/idevicenotificationproxy.1 +++ b/docs/idevicenotificationproxy.1 @@ -14,11 +14,17 @@ Post or observe notifications on an iOS device from the command line. .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 prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH COMMANDS .TP diff --git a/docs/idevicepair.1 b/docs/idevicepair.1 index 1402041..3576ce9 100644 --- a/docs/idevicepair.1 +++ b/docs/idevicepair.1 @@ -16,9 +16,12 @@ target specific device by UDID. .TP .B \-d, \-\-debug enable communication debugging. -.TP +.TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH COMMANDS .TP diff --git a/docs/ideviceprovision.1 b/docs/ideviceprovision.1 index 7933f26..3597d6e 100644 --- a/docs/ideviceprovision.1 +++ b/docs/ideviceprovision.1 @@ -13,6 +13,9 @@ Manage provisioning profiles on a device. .TP .B \-u, \-\-udid UDID target specific device by UDID. +.TP +.B \-n, \-\-network +connect to network device. .TP .B \-x, \-\-xml print XML output when using the 'dump' command. @@ -22,6 +25,9 @@ enable communication debugging. .TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH COMMANDS .TP diff --git a/docs/idevicescreenshot.1 b/docs/idevicescreenshot.1 index 6e945d1..4da78af 100644 --- a/docs/idevicescreenshot.1 +++ b/docs/idevicescreenshot.1 @@ -18,14 +18,20 @@ the screenshotr service is not available. .SH OPTIONS .TP -.B \-d, \-\-debug -enable communication debugging. -.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 prints usage information +.TP +.B \-v, \-\-version +prints version information. .SH AUTHOR Nikias Bassen diff --git a/docs/idevicesetlocation.1 b/docs/idevicesetlocation.1 index 4069739..941a6e5 100644 --- a/docs/idevicesetlocation.1 +++ b/docs/idevicesetlocation.1 @@ -14,17 +14,20 @@ Simulate location on iOS device with mounted developer disk image. .SH OPTIONS .TP -.B \-d, \-\-debug -enable communication debugging -.TP .B \-u, \-\-udid UDID target specific device by UDID .TP .B \-n, \-\-network -connect to network device even if available via USB +connect to network device +.TP +.B \-d, \-\-debug +enable communication debugging .TP .B \-h, \-\-help prints usage information +.TP +.B \-v, \-\-version +prints version information. .SH AUTHOR Nikias Bassen diff --git a/docs/idevicesyslog.1 b/docs/idevicesyslog.1 index 185422e..f098e31 100644 --- a/docs/idevicesyslog.1 +++ b/docs/idevicesyslog.1 @@ -15,7 +15,7 @@ Relay syslog of a connected device. target specific device by UDID .TP .B \-n, \-\-network -connect to network device even if available via USB +connect to network device .TP .B \-x, \-\-exit exit when device disconnects @@ -26,6 +26,9 @@ enable communication debugging .B \-h, \-\-help prints usage information .TP +.B \-v, \-\-version +prints version information. +.TP .B \-\-no\-colors disable colored output -- cgit v1.1-32-gdbae