diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile.am | 3 | ||||
| -rw-r--r-- | docs/doxygen/custom.css | 3 | ||||
| -rw-r--r-- | docs/idevicecrashreport.1 | 19 | ||||
| -rw-r--r-- | docs/idevicenotificationproxy.1 | 15 | ||||
| -rw-r--r-- | docs/idevicesyslog.1 | 36 |
5 files changed, 59 insertions, 17 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 8156d4f..c9b742f 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am | |||
| @@ -21,6 +21,7 @@ man_MANS = \ | |||
| 21 | idevicesetlocation.1 \ | 21 | idevicesetlocation.1 \ |
| 22 | afcclient.1 | 22 | afcclient.1 |
| 23 | 23 | ||
| 24 | EXTRA_DIST = $(man_MANS) | 24 | EXTRA_DIST = $(man_MANS) \ |
| 25 | doxygen | ||
| 25 | 26 | ||
| 26 | DISTCLEANFILES = html/* html | 27 | DISTCLEANFILES = html/* html |
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 { | |||
| 230 | border: solid 1px rgb(221, 221, 221); | 230 | border: solid 1px rgb(221, 221, 221); |
| 231 | border-radius: 3px; | 231 | border-radius: 3px; |
| 232 | background-color: rgb(248, 248, 248); | 232 | background-color: rgb(248, 248, 248); |
| 233 | color: rgb(0,0,0); | ||
| 233 | } | 234 | } |
| 234 | 235 | ||
| 235 | div.line { | 236 | div.line { |
| @@ -1719,4 +1720,4 @@ th.markdownTableHeadNone { | |||
| 1719 | #projectnumber { | 1720 | #projectnumber { |
| 1720 | font-size: 0.75rem; | 1721 | font-size: 0.75rem; |
| 1721 | } | 1722 | } |
| 1722 | } \ No newline at end of file | 1723 | } |
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. | |||
| 16 | .SH OPTIONS | 16 | .SH OPTIONS |
| 17 | .TP | 17 | .TP |
| 18 | .B \-u, \-\-udid UDID | 18 | .B \-u, \-\-udid UDID |
| 19 | target specific device by UDID. | 19 | Target specific device by UDID. |
| 20 | .TP | 20 | .TP |
| 21 | .B \-n, \-\-network | 21 | .B \-n, \-\-network |
| 22 | connect to network device. | 22 | Connect to network device. |
| 23 | .TP | 23 | .TP |
| 24 | .B \-e, \-\-extract | 24 | .B \-e, \-\-extract |
| 25 | extract raw crash report into separate '.crash' files. | 25 | Extract raw crash report into separate '.crash' files. |
| 26 | .TP | 26 | .TP |
| 27 | .B \-k, \-\-keep | 27 | .B \-k, \-\-keep |
| 28 | copy but do not remove crash reports from device. | 28 | Copy but do not remove crash reports from device. |
| 29 | .TP | 29 | .TP |
| 30 | .B \-d, \-\-debug | 30 | .B \-d, \-\-debug |
| 31 | enable communication debugging. | 31 | Enable communication debugging. |
| 32 | .TP | 32 | .TP |
| 33 | .B \-f, \-\-filter NAME | 33 | .B \-f, \-\-filter NAME |
| 34 | filter crash reports by NAME (case sensitive) | 34 | Filter crash reports by NAME (case sensitive) |
| 35 | .TP | ||
| 36 | .B \-\-remove\-all | ||
| 37 | Remove all crash log files without copying. Can be used with \f[B]-f\f[] to only remove matching files. | ||
| 35 | .TP | 38 | .TP |
| 36 | .B \-h, \-\-help | 39 | .B \-h, \-\-help |
| 37 | prints usage information. | 40 | Prints usage information. |
| 38 | .TP | 41 | .TP |
| 39 | .B \-v, \-\-version | 42 | .B \-v, \-\-version |
| 40 | prints version information. | 43 | Prints version information. |
| 41 | 44 | ||
| 42 | .SH AUTHOR | 45 | .SH AUTHOR |
| 43 | Martin Szulecki | 46 | Martin Szulecki |
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. | |||
| 12 | .SH OPTIONS | 12 | .SH OPTIONS |
| 13 | .TP | 13 | .TP |
| 14 | .B \-u, \-\-udid UDID | 14 | .B \-u, \-\-udid UDID |
| 15 | target specific device by UDID. | 15 | Target specific device by UDID. |
| 16 | .TP | ||
| 17 | .B \-i, \-\-insecure | ||
| 18 | Connect to insecure notification proxy (for non-paired devices). | ||
| 16 | .TP | 19 | .TP |
| 17 | .B \-n, \-\-network | 20 | .B \-n, \-\-network |
| 18 | connect to network device. | 21 | Connect to network device. |
| 19 | .TP | 22 | .TP |
| 20 | .B \-d, \-\-debug | 23 | .B \-d, \-\-debug |
| 21 | enable communication debugging. | 24 | Enable communication debugging. |
| 22 | .TP | 25 | .TP |
| 23 | .B \-h, \-\-help | 26 | .B \-h, \-\-help |
| 24 | prints usage information. | 27 | Prints usage information. |
| 25 | .TP | 28 | .TP |
| 26 | .B \-v, \-\-version | 29 | .B \-v, \-\-version |
| 27 | prints version information. | 30 | Prints version information. |
| 28 | 31 | ||
| 29 | .SH COMMANDS | 32 | .SH COMMANDS |
| 30 | .TP | 33 | .TP |
| @@ -38,6 +41,8 @@ observe notification IDs in the foreground until CTRL+C or signal is received. | |||
| 38 | 41 | ||
| 39 | Martin Szulecki | 42 | Martin Szulecki |
| 40 | 43 | ||
| 44 | Nikias Bassen | ||
| 45 | |||
| 41 | .SH ON THE WEB | 46 | .SH ON THE WEB |
| 42 | https://libimobiledevice.org | 47 | https://libimobiledevice.org |
| 43 | 48 | ||
diff --git a/docs/idevicesyslog.1 b/docs/idevicesyslog.1 index 66ae2e4..5a677b6 100644 --- a/docs/idevicesyslog.1 +++ b/docs/idevicesyslog.1 | |||
| @@ -38,13 +38,45 @@ If FILE already exists, it will be overwritten without warning. | |||
| 38 | .TP | 38 | .TP |
| 39 | .B \-\-colors | 39 | .B \-\-colors |
| 40 | Force writing colored output, e.g. when using \f[B]\-\-output\f[]. | 40 | Force writing colored output, e.g. when using \f[B]\-\-output\f[]. |
| 41 | .TP | ||
| 42 | .B \-\-syslog\-relay | ||
| 43 | Use old syslog_relay service instead of os_trace_relay (iOS 9+). | ||
| 44 | |||
| 45 | .SH COMMANDS | ||
| 46 | .TP | ||
| 47 | .B pidlist | ||
| 48 | Print a list with PID and name of all processes currently running on the device. | ||
| 49 | .TP | ||
| 50 | .B archive PATH | ||
| 51 | Request a logarchive from the device. It will be written in tar format to PATH. To pipe to another process use \- as PATH. | ||
| 52 | Below are some options to restrict the log message data. | ||
| 53 | |||
| 54 | 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: | ||
| 55 | |||
| 56 | \f[B]mkdir test.logarchive && tools/idevicesyslog archive - |tar -C test.logarchive -xv\f[] | ||
| 57 | |||
| 58 | This will also print the filenames while they are extracted. | ||
| 59 | .TP | ||
| 60 | Further options for \f[B]archive\f[]: | ||
| 61 | .TP | ||
| 62 | .B \-\-start\-time VALUE | ||
| 63 | Start time of the log data as UNIX timestamp. Earlier messages will be dropped. | ||
| 64 | .TP | ||
| 65 | .B \-\-age\-limit VALUE | ||
| 66 | Maximum age of the log data, supposedly number of days. | ||
| 67 | .TP | ||
| 68 | .B \-\-size\-limit VALUE | ||
| 69 | Limit the size of the archive. The unit is currently unknown, so feel free to experiment. | ||
| 70 | .TP | ||
| 71 | 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. | ||
| 41 | 72 | ||
| 42 | .SH FILTER OPTIONS | 73 | .SH FILTER OPTIONS |
| 43 | .TP | 74 | .TP |
| 44 | .B \-m, \-\-match STRING | 75 | .B \-m, \-\-match STRING |
| 45 | only print messages that contain STRING | 76 | only print messages that contain STRING |
| 46 | 77 | .TP | |
| 47 | This option will set a filter to only printed log messages that contain the given string. | 78 | .B \-M, \-\-unmatch STRING |
| 79 | print messages that do not contain STRING | ||
| 48 | .TP | 80 | .TP |
| 49 | .B \-t, \-\-trigger STRING | 81 | .B \-t, \-\-trigger STRING |
| 50 | start logging when matching STRING | 82 | start logging when matching STRING |
