summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile.am26
-rw-r--r--docs/afcclient.174
-rw-r--r--docs/doxygen/custom.css1723
-rw-r--r--docs/doxygen/favicon.icobin0 -> 1150 bytes
-rw-r--r--docs/doxygen/folder-open.pngbin0 -> 625 bytes
-rw-r--r--docs/doxygen/folder.pngbin0 -> 498 bytes
-rw-r--r--docs/doxygen/footer.html9
-rw-r--r--docs/doxygen/header.html64
-rw-r--r--docs/doxygen/layout.xml226
-rw-r--r--docs/doxygen/logo-vector-clean.svg1
-rw-r--r--docs/doxygen/text-x-generic.pngbin0 -> 333 bytes
-rw-r--r--docs/idevice_id.158
-rw-r--r--docs/idevicebackup.126
-rw-r--r--docs/idevicebackup2.1104
-rw-r--r--docs/idevicebtlogger.160
-rw-r--r--docs/idevicecrashreport.153
-rw-r--r--docs/idevicedate.121
-rw-r--r--docs/idevicedebug.145
-rw-r--r--docs/idevicedebugserverproxy.149
-rw-r--r--docs/idevicedevmodectl.158
-rw-r--r--docs/idevicediagnostics.162
-rw-r--r--docs/ideviceenterrecovery.114
-rw-r--r--docs/ideviceimagemounter.149
-rw-r--r--docs/ideviceinfo.126
-rw-r--r--docs/idevicename.141
-rw-r--r--docs/idevicenotificationproxy.149
-rw-r--r--docs/idevicepair.161
-rw-r--r--docs/ideviceprovision.158
-rw-r--r--docs/idevicescreenshot.129
-rw-r--r--docs/idevicesetlocation.138
-rw-r--r--docs/idevicesyslog.1154
31 files changed, 3082 insertions, 96 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 69ddb58..c9b742f 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,5 +1,27 @@
1man_MANS = idevice_id.1 ideviceinfo.1 idevicesyslog.1 idevicebackup.1 ideviceimagemounter.1 idevicescreenshot.1 idevicepair.1 ideviceenterrecovery.1 idevicedate.1 1man_MANS = \
2 idevice_id.1 \
3 ideviceinfo.1 \
4 idevicebtlogger.1 \
5 idevicesyslog.1 \
6 idevicebackup.1 \
7 idevicebackup2.1 \
8 ideviceimagemounter.1 \
9 idevicescreenshot.1 \
10 idevicepair.1 \
11 ideviceenterrecovery.1 \
12 idevicedate.1 \
13 ideviceprovision.1 \
14 idevicedebugserverproxy.1 \
15 idevicediagnostics.1 \
16 idevicecrashreport.1 \
17 idevicename.1 \
18 idevicedebug.1 \
19 idevicedevmodectl.1 \
20 idevicenotificationproxy.1 \
21 idevicesetlocation.1 \
22 afcclient.1
2 23
3EXTRA_DIST = $(man_MANS) 24EXTRA_DIST = $(man_MANS) \
25 doxygen
4 26
5DISTCLEANFILES = html/* html 27DISTCLEANFILES = 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 @@
1.TH "afcclient" 1
2.SH NAME
3afcclient \- Interact with AFC/HouseArrest service on a connected device.
4.SH SYNOPSIS
5.B afcclient
6[OPTIONS] [COMMAND ...]
7
8.SH DESCRIPTION
9
10Utility to interact with AFC/HouseArrest service. This allows access to parts
11of the filesystem on an iOS device.
12
13\f[B]afcclient\f[] can be used interactively with a command prompt, or run a single command and exit.
14
15.SH COMMANDS
16.TP
17.B devinfo
18print device information
19.TP
20.B info PATH
21print file attributes of file at PATH
22.TP
23.B ls PATH
24print directory contents of PATH
25.TP
26.B mv OLD NEW
27rename file OLD to NEW
28.TP
29.B mkdir PATH
30create directory at PATH
31.TP
32.B ln [-s] FILE [LINK]
33Create a (symbolic) link to file named LINKNAME. \f[B]NOTE: This feature has been disabled in newer versions of iOS\f[].
34.TP
35.B rm [-rf] PATH
36remove item at PATH
37.TP
38.B get [-rf] PATH [LOCALPATH]
39transfer 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.
40.TP
41.B put [-rf] LOCALPATH [PATH]
42transfer 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.
43.TP
44
45.SH OPTIONS
46.TP
47.B \-u, \-\-udid UDID
48target specific device by UDID
49.TP
50.B \-n, \-\-network
51connect to network device (not recommended, since the connection might be terminated at any time)
52.TP
53.B \--container <appid>
54Access the app container directory of the app with given \f[B]appid\f[]
55.TP
56.B \--documents <appid>
57Access the Documents directory of the app with given \f[B]appid\f[]
58.TP
59.B \-h, \-\-help
60Prints usage information
61.TP
62.B \-d, \-\-debug
63Enable communication debugging
64.TP
65.B \-v, \-\-version
66Prints version information
67
68.SH AUTHOR
69Nikias Bassen
70
71.SH ON THE WEB
72https://libimobiledevice.org
73
74https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/doxygen/custom.css b/docs/doxygen/custom.css
new file mode 100644
index 0000000..e9f1ea8
--- /dev/null
+++ b/docs/doxygen/custom.css
@@ -0,0 +1,1723 @@
1body, table, div, p, dl {
2 font: 14px -apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji;
3 line-height: 1.5;
4}
5
6/* @group Heading Levels */
7
8h1.groupheader {
9 font-size: 28px;
10}
11
12.title {
13 font: inherit;
14 font-size: 2rem;
15 font-weight: bold;
16 margin: 0;
17 padding-bottom: 0.3rem;
18 border-bottom: 1px solid #eaecef;
19}
20
21h2.groupheader {
22 border-bottom: none;
23 color: rgb(36, 41, 46);
24 font-size: 1.5rem;
25 font-weight: bold;
26 margin: 1.75rem 0px 1rem 0px;
27 padding: 0 0.3rem 0 0;
28 border-bottom: 1px solid #eaecef;
29 width: 100%;
30}
31
32h3.groupheader {
33 font-size: 100%;
34}
35
36h1, h2, h3, h4, h5, h6 {
37 -webkit-transition: text-shadow 0.5s linear;
38 -moz-transition: text-shadow 0.5s linear;
39 -ms-transition: text-shadow 0.5s linear;
40 -o-transition: text-shadow 0.5s linear;
41 transition: text-shadow 0.5s linear;
42}
43
44.textblock h1,
45.textblock h2,
46.textblock h3,
47.textblock h4,
48.textblock h5,
49.textblock h6 {
50 margin: 1.75rem 0px 1rem 0px;
51 padding: 0 0.3rem 0 0;
52 border-bottom: 1px solid #eaecef;
53}
54
55h1 {
56 font-size: 1.75rem;
57}
58
59h2 {
60 color: rgb(36, 41, 46);
61 font-size: 1.5rem;
62 font-weight: bold;
63 margin: 1.75rem 0 1rem 0px;
64}
65
66h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow {
67 text-shadow: 0 0 15px #1fa4a9;
68}
69
70dt {
71 font-weight: bold;
72}
73
74div.multicol {
75 -moz-column-gap: 1em;
76 -webkit-column-gap: 1em;
77 -moz-column-count: 3;
78 -webkit-column-count: 3;
79}
80
81p.startli, p.startdd, p.starttd {
82 margin-top: 2px;
83}
84
85p.endli {
86 margin-bottom: 0px;
87}
88
89p.enddd {
90 margin-bottom: 4px;
91}
92
93p.endtd {
94 margin-bottom: 2px;
95}
96
97/* @end */
98
99caption {
100 font-weight: bold;
101}
102
103span.legend {
104 font-size: 70%;
105 text-align: center;
106}
107
108h3.version {
109 font-size: 90%;
110 text-align: center;
111}
112
113div.qindex, div.navtab {
114 background-color: #fff;
115 border: 1px solid #d1d5da;
116 padding: 0;
117 border-radius: 3px;
118 text-align: left;
119}
120
121div.qindex, div.navpath {
122 width: auto;
123 line-height: 140%;
124}
125
126div.navtab {
127 margin-right: 2rem;
128}
129
130@media (max-width: 576px) {
131 .contents td.top:not(.mempage),
132 div.navtab {
133 display: none;
134 }
135}
136
137div.navtab table {
138 border-spacing: 0;
139}
140
141div.navtab table td.navtab {
142 position: relative;
143 display: block;
144 padding: 8px 10px;
145 border-bottom: 1px solid #e1e4e8;
146}
147
148div.navtab table td.navtab:hover {
149 background-color: #f6f8fa;
150}
151
152/* @group Link Styling */
153
154a {
155 color: #005082;
156 font-weight: normal;
157 text-decoration: none;
158}
159
160.contents a:visited {
161 color: #005082;
162}
163
164a:hover {
165 text-decoration: underline;
166}
167
168a.qindex {
169 font-weight: bold;
170}
171
172a.qindexHL {
173 font-weight: bold;
174 background-color: #fff;
175 color: inherit;
176 border: none;
177}
178
179a.qindexHL:before {
180 position: absolute;
181 top: 0;
182 bottom: 0;
183 left: 0;
184 width: 2px;
185 content: "";
186 background-color: #f7ae1a;
187}
188
189.contents a.qindexHL:visited {
190 color: inherit;
191}
192
193a.el {
194 font-weight: normal;
195}
196
197a.elRef {
198}
199
200a.code, a.code:visited {
201 color: #3465a4;
202}
203
204a.codeRef, a.codeRef:visited {
205 color: #3465a4;
206}
207
208/* @end */
209
210dl.el {
211 margin-left: -1cm;
212}
213
214pre.fragment {
215 border: 1px solid rgb(221, 221, 221);
216 border-radius: 3px;
217 background-color: rgb(248, 248, 248);
218 padding: 1rem;
219 margin: 1rem 0px;
220 overflow: auto;
221 word-wrap: break-word;
222 font-size: inherit;
223 line-height: inherit;
224 font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace;
225}
226
227div.fragment {
228 padding: 1rem;
229 margin: 1rem 0px;
230 border: solid 1px rgb(221, 221, 221);
231 border-radius: 3px;
232 background-color: rgb(248, 248, 248);
233 color: rgb(0,0,0);
234}
235
236div.line {
237 font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace;
238 font-size: inherit;
239 min-height: 1rem;
240 line-height: inherit;
241 text-wrap: unrestricted;
242 white-space: -moz-pre-wrap; /* Moz */
243 white-space: -pre-wrap; /* Opera 4-6 */
244 white-space: -o-pre-wrap; /* Opera 7 */
245 white-space: pre-wrap; /* CSS3 */
246 word-wrap: break-word; /* IE 5.5+ */
247 text-indent: initial;
248 padding-left: initial;
249 padding-bottom: 0px;
250 margin: 0px;
251 -webkit-transition-property: background-color, box-shadow;
252 -webkit-transition-duration: 0.5s;
253 -moz-transition-property: background-color, box-shadow;
254 -moz-transition-duration: 0.5s;
255 -ms-transition-property: background-color, box-shadow;
256 -ms-transition-duration: 0.5s;
257 -o-transition-property: background-color, box-shadow;
258 -o-transition-duration: 0.5s;
259 transition-property: background-color, box-shadow;
260 transition-duration: 0.5s;
261 display: inline-block;
262 min-width: 100%;
263}
264
265div.line.glow {
266 background-color: cyan;
267 box-shadow: 0 0 10px cyan;
268}
269
270
271span.lineno {
272 padding-right: 4px;
273 text-align: right;
274 border-right: 2px solid #0F0;
275 background-color: #E8E8E8;
276 white-space: pre;
277}
278span.lineno a {
279 background-color: #D8D8D8;
280}
281
282span.lineno a:hover {
283 background-color: #C8C8C8;
284}
285
286div.ah {
287 background-color: black;
288 font-weight: bold;
289 color: #ffffff;
290 margin-bottom: 3px;
291 margin-top: 3px;
292 padding: 0.2em;
293 border: solid thin #333;
294 border-radius: 0.5em;
295 -webkit-border-radius: .5em;
296 -moz-border-radius: .5em;
297 box-shadow: 2px 2px 3px #999;
298 -webkit-box-shadow: 2px 2px 3px #999;
299 -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
300 background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444));
301 background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000);
302}
303
304div.groupHeader {
305 margin-left: 0px;
306 margin-top: 9px;
307 margin-bottom: 4.7px;
308
309 font-size: 19px;
310 font-weight: normal;
311}
312
313div.groupText {
314 margin-left: 16px;
315 font-style: italic;
316}
317
318body {
319 background-color: white;
320 color: rgb(36, 41, 46);
321 margin: 0;
322}
323
324div.contents {
325 padding: 1rem 2rem;
326 margin: 0;
327}
328
329td.indexkey {
330 background-color: #EBEFF6;
331 font-weight: bold;
332 border: 1px solid #C4CFE5;
333 margin: 2px 0px 2px 0;
334 padding: 2px 10px;
335 white-space: nowrap;
336 vertical-align: top;
337}
338
339td.indexvalue {
340 background-color: #EBEFF6;
341 border: 1px solid #C4CFE5;
342 padding: 2px 10px;
343 margin: 2px 0px;
344}
345
346tr.memlist {
347 background-color: #EEF1F7;
348}
349
350p.formulaDsp {
351 text-align: center;
352}
353
354img.formulaDsp {
355}
356
357img.formulaInl {
358 vertical-align: middle;
359}
360
361div.center {
362 text-align: center;
363 margin-top: 0px;
364 margin-bottom: 0px;
365 padding: 0px;
366}
367
368div.center img {
369 border: 0px;
370}
371
372address.footer {
373 text-align: left;
374 margin-left: 2rem;
375 margin-right: 2rem;
376 margin-bottom: 1rem;
377}
378
379img.footer {
380 border: 0px;
381 vertical-align: middle;
382}
383
384/* @group Code Colorization */
385
386span.keyword {
387 color: #008000;
388}
389
390span.keywordtype {
391 color: #604020;
392}
393
394span.keywordflow {
395 color: #e08000;
396}
397
398span.comment {
399 color: #800000;
400}
401
402span.preprocessor {
403 color: #806020;
404}
405
406span.stringliteral {
407 color: #002080;
408}
409
410span.charliteral {
411 color: #008080;
412}
413
414span.vhdldigit {
415 color: #ff00ff;
416}
417
418span.vhdlchar {
419 color: #000000;
420}
421
422span.vhdlkeyword {
423 color: #700070;
424}
425
426span.vhdllogic {
427 color: #ff0000;
428}
429
430blockquote {
431 background-color: #F7F8FB;
432 border-left: 2px solid #9CAFD4;
433 margin: 0 24px 0 4px;
434 padding: 0 12px 0 16px;
435}
436
437/* @end */
438
439td.tiny {
440 font-size: 75%;
441}
442
443.dirtab {
444 padding: 4px;
445 border-collapse: collapse;
446 border: 1px solid #A3B4D7;
447}
448
449th.dirtab {
450 background: #EBEFF6;
451 font-weight: bold;
452}
453
454hr {
455 height: 0px;
456 border: none;
457 border-top: 1px solid #e1e4e8;
458}
459
460hr.footer {
461 height: 0px;
462 border-top: 1px solid #e1e4e8;
463 margin-left: 2rem;
464 margin-right: 2rem;
465}
466
467/* @group Member Descriptions */
468
469table.memberdecls {
470 border-spacing: inherit;
471 padding: 0px;
472 background-color: transparent;
473 border-color: #c8e1ff;
474}
475
476table.memberdecls tr:not(.heading) {
477 background-color: #f1f8ff;
478}
479
480table.memberdecls tr:not(.heading) td.ititle {
481 background-color: #fff;
482 border: none;
483}
484
485.memberdecls td, .fieldtable tr {
486 -webkit-transition-property: background-color, box-shadow;
487 -webkit-transition-duration: 0.5s;
488 -moz-transition-property: background-color, box-shadow;
489 -moz-transition-duration: 0.5s;
490 -ms-transition-property: background-color, box-shadow;
491 -ms-transition-duration: 0.5s;
492 -o-transition-property: background-color, box-shadow;
493 -o-transition-duration: 0.5s;
494 transition-property: background-color, box-shadow;
495 transition-duration: 0.5s;
496}
497
498.memberdecls td.glow, .fieldtable tr.glow {
499 background-color: #1fa4a9;
500 box-shadow: none;
501}
502
503.mdescLeft, .mdescRight,
504.memItemLeft, .memItemRight,
505.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
506 background-color: transparent;
507 border: none;
508 margin: 0;
509 padding: 1rem 1rem 0.5rem 1rem;
510 font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace;
511}
512
513.mdescLeft,
514.memItemLeft,
515.memTemplItemLeft {
516 border-left: 1px solid #c8e1ff;
517}
518
519.mdescRight,
520.memItemRight,
521.memTemplItemRight {
522 border-right: 1px solid #c8e1ff;
523}
524
525.memberdecls tr:nth-child(2) td {
526 border-top: 1px solid #c8e1ff;
527 padding-bottom: 1rem;
528}
529
530.memberdecls tr:last-child td {
531 border-bottom: none;
532 padding-bottom: 1rem;
533}
534
535.memberdecls tr:nth-last-child(2) td {
536 padding-bottom: 1rem;
537}
538
539.mdescLeft, .mdescRight {
540 padding: 0 1rem 1rem 1rem;
541 color: black;
542
543 /* font-family: "Lucida Grande", "Lucida Sans Unicode", Helvetica, Arial, Verdana, sans-serif; */
544 font-style: normal;
545}
546
547.memSeparator {
548 background-color: #fff;
549 border-top: 1px solid #c8e1ff;
550 border-bottom: 1px solid #c8e1ff;
551 line-height: 0.5rem;
552 margin: 0px;
553 padding: 0px;
554}
555
556tr:last-child .memSeparator {
557 border-bottom: none;
558}
559
560.memItemLeft, .memTemplItemLeft {
561 white-space: nowrap;
562}
563
564.memItemRight {
565 width: 100%;
566}
567
568.mdescRight a.el:first-child,
569.memItemRight a.el:first-child,
570.memTemplItemRight a.el:first-child {
571 font-weight: bold;
572}
573
574.memTemplParams {
575 color: #005082;
576 white-space: nowrap;
577 font-size: 80%;
578}
579
580/* @end */
581
582/* @group Member Details */
583
584/* Styles for detailed member documentation */
585
586.memtitle {
587 padding: 0 0.3rem 0 0;
588 border: none;
589 border-bottom: 1px solid #eaecef;
590 margin: 0 0 1.75rem 0;
591 line-height: inherit;
592 background: none;
593 font-weight: bold;
594 font-size: 2rem;
595 width: 100%;
596 float: left;
597}
598
599.permalink {
600 font-size: 65%;
601 display: inline-block;
602 vertical-align: middle;
603 display: none;
604}
605
606.permalink a:hover {
607 text-decoration: none;
608}
609
610.memtemplate {
611 font-size: 100%;
612 color: black;
613 font-weight: normal;
614 margin-left: 1px;
615}
616
617.memnav {
618 background-color: #EBEFF6;
619 border: 1px solid #A3B4D7;
620 text-align: center;
621 margin: 2px;
622 margin-right: 15px;
623 padding: 2px;
624}
625
626.mempage {
627 width: 100%;
628}
629
630.memitem {
631 padding: 0;
632 margin-bottom: 2rem;
633 margin-right: 0;
634 -webkit-transition: box-shadow 0.5s linear;
635 -moz-transition: box-shadow 0.5s linear;
636 -ms-transition: box-shadow 0.5s linear;
637 -o-transition: box-shadow 0.5s linear;
638 transition: box-shadow 0.5s linear;
639 display: table !important;
640 width: 100%;
641 background-color: #f1f8ff;
642 border-color: #c8e1ff;
643}
644
645.memitem.glow {
646 box-shadow: 0 0 15px #1fa4a9;
647}
648
649.memname {
650 font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace;
651 margin-left: 0px;
652 border-spacing: initial;
653}
654
655.memname td {
656 font-weight: bold;
657 vertical-align: bottom;
658}
659
660.memproto, dl.reflist dt {
661 border: none;
662 border: 1px solid #c8e1ff;
663 padding: 1rem;
664 color: black;
665 font-weight: bold;
666 text-shadow: none;
667 background-image: none;
668 background-color: #f1f8ff;
669 /* opera specific markup */
670 box-shadow: none;
671 border-top-right-radius: 0px;
672 border-top-left-radius: 0px;
673 /* firefox specific markup */
674 -moz-box-shadow: none;
675 -moz-border-radius-topright: 0px;
676 -moz-border-radius-topleft: 0px;
677 /* webkit specific markup */
678 -webkit-box-shadow: none;
679 -webkit-border-top-right-radius: 0px;
680 -webkit-border-top-left-radius: 0px;
681}
682
683.memdoc, dl.reflist dd {
684 border: none;
685 padding: 6px;
686 background-color: #FBFCFD;
687 border-top-width: 0;
688 background-image: none;
689 background-color: #FFFFFF;
690 /* opera specific markup */
691 border-bottom-left-radius: 0px;
692 border-bottom-right-radius: 0px;
693 box-shadow: none;
694 /* firefox specific markup */
695 -moz-border-radius-bottomleft: 0px;
696 -moz-border-radius-bottomright: 0px;
697 -moz-box-shadow: none;
698 /* webkit specific markup */
699 -webkit-border-bottom-left-radius: 0px;
700 -webkit-border-bottom-right-radius: 0px;
701 -webkit-box-shadow: none;
702}
703
704dl.reflist dt {
705 padding: 5px;
706}
707
708dl.reflist dd {
709 margin: 0px 0px 10px 0px;
710 padding: 5px;
711}
712
713.paramkey {
714 text-align: right;
715}
716
717.paramtype {
718 white-space: nowrap;
719}
720
721.paramname {
722 color: #01496d;
723 white-space: nowrap;
724}
725.paramname em {
726 font-style: italic;
727 font-weight: normal;
728}
729.paramname code {
730 line-height: 14px;
731}
732
733.params, .retval, .exception, .tparams {
734 margin-left: 0px;
735 padding-left: 0px;
736}
737
738.params .paramname, .retval .paramname {
739 font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace;
740 font-style: italic;
741 font-weight: normal;
742 text-shadow: none;
743 padding-right: 1rem;
744}
745
746.params .paramtype {
747 font-style: italic;
748 vertical-align: top;
749}
750
751.params .paramdir {
752 font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace;
753 vertical-align: top;
754}
755
756table.mlabels {
757 border-spacing: 0px;
758}
759
760td.mlabels-left {
761 width: 100%;
762 padding: 0px;
763}
764
765td.mlabels-right {
766 vertical-align: middle;
767 padding: 0px;
768 white-space: nowrap;
769}
770
771span.mlabels {
772 margin-left: 8px;
773}
774
775span.mlabel {
776 background-color: rgb(172, 172, 172);;
777 border: none;
778 text-shadow: none;
779 color: white;
780 margin-right: 4px;
781 padding: 2px 3px;
782 border-radius: 4px;
783 font-size: 9pt;
784 white-space: nowrap;
785 vertical-align: middle;
786}
787
788/* @end */
789
790/* these are for tree view when not used as main index */
791
792div.directory {
793 border-top: 1px solid #eaecef;
794 border-left: 1px solid #eaecef;
795 border-right: 1px solid #eaecef;
796 border-bottom: 1px solid #eaecef;
797 margin: 10px 0px;
798 width: 100%;
799}
800
801.directory table {
802 border-collapse:collapse;
803}
804
805.directory td {
806 margin: 0px;
807 padding: 8px;
808 vertical-align: middle;
809 line-height: 1.5rem;
810}
811
812.directory tr {
813 border-top: 1px solid #eaecef;
814}
815
816.directory tr:first-child {
817 border-top: none;
818}
819
820.directory td.entry {
821 white-space: nowrap;
822 padding: 8px;
823}
824
825@media (max-width: 576px) {
826 .directory td.entry > span:first-child {
827 display: none !important;
828 }
829}
830
831.directory td.entry a {
832 outline: none;
833}
834
835.directory td.entry a img {
836 border: none;
837}
838
839.directory td.desc {
840 width: 100%;
841 padding: 8px;
842 border-left: 1px solid rgba(0,0,0,0.05);
843}
844
845.directory tr.even {
846 padding-left: 0;
847 background-color: inherit;
848}
849
850.directory tr:not(.even) {
851 background-color: #f6f8fa;
852}
853
854.directory img {
855 vertical-align: -30%;
856}
857
858.directory .levels {
859 display: none;
860 white-space: nowrap;
861 width: auto;
862 text-align: right;
863 font-size: 0.75rem;
864 font-weight: bold;
865 padding: 8px;
866 border-bottom: 1px solid #eaecef;
867}
868
869.directory .levels span {
870 cursor: pointer;
871 padding: 0 0.5rem;
872 color: #3d578c;
873}
874
875.arrow {
876 color: #6c757d;
877 -webkit-user-select: none;
878 -khtml-user-select: none;
879 -moz-user-select: none;
880 -ms-user-select: none;
881 user-select: none;
882 cursor: pointer;
883 font-size: inherit;
884 display: inline-block;
885 width: 16px;
886 height: 16px;
887}
888
889.icon {
890 display: inline-block;
891 margin: 0;
892
893 font-family: Arial, Helvetica;
894 font-weight: bold;
895 font-size: 0.75rem;
896 text-align: center;
897
898 width: 16px;
899 height: 16px;
900 line-height: 16px;
901
902 border-radius: 4px;
903 background-color: #6194cb;
904 color: white;
905}
906
907.icona {
908 width: 16px;
909 height: 16px;
910 display: inline-block;
911 margin-left: 0.25rem;
912 margin-right: 0.25rem;
913}
914
915.iconfopen {
916 width: 16px;
917 height: 16px;
918 margin-bottom: 0;
919 background-image:url('folder-open.png');
920 background-position: 0px -1px;
921 background-repeat: no-repeat;
922 vertical-align: middle;
923 display: inline-block;
924 margin-left: 0.25rem;
925 margin-right: 0.25rem;
926}
927
928.iconfclosed {
929 width: 16px;
930 height: 16px;
931 margin-bottom: 0;
932 background-image:url('folder.png');
933 background-position: 0px 0px;
934 background-repeat: no-repeat;
935 vertical-align: middle;
936 display: inline-block;
937 margin-left: 0.25rem;
938 margin-right: 0.25rem;
939}
940
941.icondoc {
942 width: 16px;
943 height: 16px;
944 margin-bottom: 0;
945 background-image:url('text-x-generic.png');
946 background-position: 0px 0px;
947 background-repeat: no-repeat;
948 vertical-align: middle;
949 display: inline-block;
950 margin-left: 0.25rem;
951 margin-right: 0.25rem;
952}
953
954/* @end */
955
956div.dynheader {
957 margin-top: 8px;
958 -webkit-touch-callout: none;
959 -webkit-user-select: none;
960 -khtml-user-select: none;
961 -moz-user-select: none;
962 -ms-user-select: none;
963 user-select: none;
964}
965
966address {
967 font-style: normal;
968 color: #2A3D61;
969}
970
971table.doxtable {
972 border-collapse:collapse;
973 margin-top: 4px;
974 margin-bottom: 4px;
975}
976
977table.doxtable td, table.doxtable th {
978 border: 1px solid #2D4068;
979 padding: 3px 7px 2px;
980}
981
982table.doxtable th {
983 background-color: #374F7F;
984 color: #FFFFFF;
985 font-size: 110%;
986 padding-bottom: 4px;
987 padding-top: 5px;
988}
989
990table.fieldtable {
991 margin-bottom: 10px;
992 border: 1px solid #c6cbd1;
993 border-spacing: 0px;
994 -moz-border-radius: 3px;
995 -webkit-border-radius: 3px;
996 border-radius: 3px;
997 -moz-box-shadow: none;
998 -webkit-box-shadow: none;
999 box-shadow: none;
1000 font-size: 1rem;
1001}
1002
1003.fieldtable td, .fieldtable th {
1004 padding: 0.5rem 1rem;
1005}
1006
1007.fieldtable td.fieldtype, .fieldtable td.fieldname {
1008 white-space: nowrap;
1009 border-right: 1px solid #c6cbd1;
1010 border-bottom: 1px solid #c6cbd1;
1011 vertical-align: middle;
1012}
1013
1014.fieldtable td.fieldname {
1015 padding-top: 0.5rem;
1016 font-style: italic;
1017}
1018
1019.fieldtable td.fielddoc {
1020 border-bottom: 1px solid #c6cbd1;
1021}
1022
1023.fieldtable td.fielddoc p {
1024 font-size: 1rem;
1025}
1026
1027.fieldtable td.fielddoc p:first-child {
1028 margin-top: 0px;
1029}
1030
1031.fieldtable td.fielddoc p:last-child {
1032 margin-bottom: 2px;
1033}
1034
1035.fieldtable tr:last-child td {
1036 border-bottom: none;
1037}
1038
1039.fieldtable tbody tr:nth-of-type(odd) {
1040 background-color: #f6f8fa;
1041}
1042
1043.fieldtable th {
1044 background-image: none;
1045 background-repeat:repeat-x;
1046 background-color: #fff;
1047 font-size: inherit;
1048 font-weight: bold;
1049 color: inherit;
1050 padding: 0.5rem 1rem;
1051 text-align: inherit;
1052 -moz-border-radius-topleft: 3px;
1053 -moz-border-radius-topright: 3px;
1054 -webkit-border-top-left-radius: 3px;
1055 -webkit-border-top-right-radius: 3px;
1056 border-top-left-radius: 3px;
1057 border-top-right-radius: 3px;
1058 border-bottom: 1px solid #c6cbd1;
1059}
1060
1061
1062.tabsearch {
1063 top: 0px;
1064 left: 10px;
1065 height: 36px;
1066 background-image: none;
1067 z-index: 101;
1068 overflow: hidden;
1069 font-size: 13px;
1070}
1071
1072.navpath ul {
1073 font-size: 1rem;
1074 background-image: none;
1075 background-repeat: repeat-x;
1076 background-position: 0 -5px;
1077 height:30px;
1078 line-height:30px;
1079 color: inherit;
1080 border: none;
1081 overflow:hidden;
1082 margin:0px;
1083 padding: 0px;
1084}
1085
1086.navpath li {
1087 list-style-type: none;
1088 float: left;
1089 background-image: none;
1090 background-repeat: no-repeat;
1091 background-position: right;
1092 color: inherit;
1093}
1094
1095#top .navpath li+li {
1096 padding-left: .5rem;
1097}
1098
1099#top .navpath li+li::before {
1100 display: inline-block;
1101 padding-right: .5rem;
1102 color: #6c757d;
1103 content: "/";
1104}
1105
1106@media (min-width: 576px) {
1107 address.footer .navpath li+li {
1108 padding-left: .5rem;
1109 }
1110
1111 address.footer .navpath li+li::before {
1112 display: inline-block;
1113 padding-right: .5rem;
1114 color: #6c757d;
1115 content: "/";
1116 }
1117}
1118
1119.navpath li.navelem a {
1120 height:32px;
1121 display: inline-block;
1122 text-decoration: none;
1123 outline: none;
1124 color: inherit;
1125 font-family: inherit;
1126 text-shadow: none;
1127 text-decoration: none;
1128}
1129
1130.navpath li.navelem a:hover {
1131 color: inherit;
1132}
1133
1134address.footer {
1135 text-align: left;
1136 padding-right: 0;
1137}
1138
1139address.footer ul.navpath {
1140 display: inline-block;
1141 padding: 0;
1142}
1143
1144.navpath li.footer {
1145 list-style-type: none;
1146 float: left;
1147 padding-left: 0.5rem;
1148 padding-right: 0;
1149 background-image: none;
1150 background-repeat: no-repeat;
1151 background-position: right;
1152 color: inherit;
1153 font-size: 0.75rem;
1154}
1155
1156div.summary {
1157 float: none;
1158 font-size: 0.75rem;
1159 padding-right: 5px;
1160 width: 100%;
1161 text-align: left;
1162}
1163
1164div.summary a {
1165 white-space: nowrap;
1166}
1167
1168div.ingroups {
1169 font-size: 0.75rem;
1170 width: 50%;
1171 text-align: left;
1172}
1173
1174div.ingroups a {
1175 white-space: nowrap;
1176}
1177
1178div.header {
1179 background-image: none;
1180 background-color: white;
1181 padding: 1rem 2rem 0 2rem;
1182 margin: 0px;
1183 border: none;
1184}
1185
1186div.headertitle {
1187 margin: 1rem 0px 0rem 0px;
1188 padding: 0 0.3rem 0 0;
1189}
1190
1191dl {
1192 padding: 0 0 0 10px;
1193}
1194
1195/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */
1196dl.section {
1197 margin-left: 0px;
1198 padding-left: 0px;
1199}
1200
1201dl.note {
1202 margin-left: 0px;
1203 padding: 1rem;
1204 border-left: 6px solid;
1205 border: 1px solid rgba(27,31,35,.15);
1206 background-color: #fffbdd;
1207 color: #735c0f;
1208}
1209
1210dl.section.note dd {
1211 margin-left: 0;
1212 margin-bottom: 0;
1213}
1214
1215dl.warning, dl.attention {
1216 margin-left: 0px;
1217 padding: 1rem;
1218
1219 border-left: 6px solid;
1220 border-color: #ab2333;
1221}
1222
1223dl.pre, dl.post, dl.invariant {
1224 margin-left:-7px;
1225 padding-left: 3px;
1226 border-left:4px solid;
1227 border-color: #4e9a06;
1228}
1229
1230dl.deprecated {
1231 margin-left: 0px;
1232 padding: 1rem;
1233 border-left: 6px solid;
1234 border-color: #505050;
1235}
1236
1237dl.deprecated dt a.el {
1238}
1239
1240dl.todo {
1241 margin-left: 0px;
1242 padding: 1rem;
1243 border-left:4px solid;
1244 border-color: #04898e;
1245}
1246
1247dl.test {
1248 margin-left:-7px;
1249 padding-left: 3px;
1250 border-left:4px solid;
1251 border-color: #21376d;
1252}
1253
1254dl.bug {
1255 margin-left:-7px;
1256 padding-left: 3px;
1257 border-left:4px solid;
1258 border-color: #8f5902;
1259}
1260
1261dl.section dd {
1262 margin-bottom: 0.5rem;
1263}
1264
1265
1266#projectlogo {
1267 text-align: center;
1268 vertical-align: bottom;
1269 border-collapse: separate;
1270 padding-right: 1rem;
1271}
1272
1273#projectlogo img {
1274 border: 0px none;
1275 width: 8rem;
1276 height: auto;
1277}
1278
1279#projectname {
1280 font: inherit;
1281 font-size: 300%;
1282 margin: 0px;
1283 padding: 2px 0px;
1284}
1285
1286#projectbrief {
1287 font: inherit;
1288 font-size: 120%;
1289 margin: 0px;
1290 padding: 0px;
1291}
1292
1293#projectnumber {
1294 font: inherit;
1295 font-size: 50%;
1296 margin: 0px;
1297 padding: 0px;
1298}
1299
1300#titlearea {
1301 padding: 1rem;
1302 margin: 0px;
1303 width: auto;
1304 border-bottom: none;
1305 background-color: #fafbfc;
1306}
1307
1308.image {
1309 text-align: center;
1310}
1311
1312.dotgraph {
1313 text-align: center;
1314}
1315
1316.mscgraph {
1317 text-align: center;
1318}
1319
1320.caption {
1321 font-weight: bold;
1322}
1323
1324div.zoom {
1325 border: 1px solid #90A5CE;
1326}
1327
1328dl.citelist {
1329 margin-bottom:50px;
1330}
1331
1332dl.citelist dt {
1333 color:#334975;
1334 float:left;
1335 font-weight:bold;
1336 margin-right:10px;
1337 padding:5px;
1338}
1339
1340dl.citelist dd {
1341 margin:2px 0;
1342 padding:5px 0;
1343}
1344
1345div.toc {
1346 padding: 14px 25px;
1347 background-color: #F4F6FA;
1348 border: 1px solid #D8DFEE;
1349 border-radius: 7px 7px 7px 7px;
1350 float: right;
1351 height: auto;
1352 margin: 0 20px 10px 10px;
1353 width: 200px;
1354}
1355
1356div.toc li {
1357 background: url("bdwn.png") no-repeat scroll 0 5px transparent;
1358 font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif;
1359 margin-top: 5px;
1360 padding-left: 10px;
1361 padding-top: 2px;
1362}
1363
1364div.toc h3 {
1365 font: bold 12px/1.2 Arial,FreeSans,sans-serif;
1366 color: #4665A2;
1367 border-bottom: 0 none;
1368 margin: 0;
1369}
1370
1371div.toc ul {
1372 list-style: none outside none;
1373 border: medium none;
1374 padding: 0px;
1375}
1376
1377div.toc li.level1 {
1378 margin-left: 0px;
1379}
1380
1381div.toc li.level2 {
1382 margin-left: 15px;
1383}
1384
1385div.toc li.level3 {
1386 margin-left: 30px;
1387}
1388
1389div.toc li.level4 {
1390 margin-left: 45px;
1391}
1392
1393.inherit_header {
1394 font-weight: bold;
1395 color: gray;
1396 cursor: pointer;
1397 -webkit-touch-callout: none;
1398 -webkit-user-select: none;
1399 -khtml-user-select: none;
1400 -moz-user-select: none;
1401 -ms-user-select: none;
1402 user-select: none;
1403}
1404
1405.inherit_header td {
1406 padding: 6px 0px 2px 5px;
1407}
1408
1409.inherit {
1410 display: none;
1411}
1412
1413tr.heading h2 {
1414 padding-top: 1.75rem;
1415 margin-top: 0;
1416 margin-bottom: 1rem;
1417}
1418
1419@media print
1420{
1421 #top { display: none; }
1422 #side-nav { display: none; }
1423 #nav-path { display: none; }
1424 body { overflow:visible; }
1425 h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
1426 .summary { display: none; }
1427 .memitem { page-break-inside: avoid; }
1428 #doc-content {
1429 margin-left:0 !important;
1430 height:auto !important;
1431 width:auto !important;
1432 overflow:inherit;
1433 display:inline;
1434 }
1435}
1436
1437
1438.tabs, .tabs2, .tabs3 {
1439 background-image: none;
1440 background-color: #fafbfc;
1441 color: #24292e;
1442 padding: 0 1rem;
1443 font-family: inherit;
1444 font-size: inherit;
1445 width: auto;
1446}
1447
1448.tabs {
1449 border-bottom: 1px solid #e1e4e8;
1450}
1451
1452.tablist {
1453 position: relative;
1454 top: 1px;
1455}
1456
1457.tabs2 {
1458 margin-top: 1rem;
1459 border-bottom: 1px solid #e1e4e8;
1460 background-color: #fff;
1461}
1462
1463.tabs3 {
1464 margin-top: 1rem;
1465 border-bottom: 1px solid #e1e4e8;
1466 background-color: #fff;
1467}
1468
1469.tablist li {
1470 background-image: none;
1471}
1472
1473.tablist a {
1474 background-image: none;
1475 text-shadow: none;
1476 color: #586069;
1477 border: 1px solid transparent;
1478 border-top: 3px solid transparent;
1479 border-radius: 3px 3px 0 0;
1480 padding: 0 1rem;
1481}
1482
1483.tablist a:hover {
1484 background-image: none;
1485 text-shadow: none;
1486 color: #24292e;
1487}
1488
1489.tablist li.current a {
1490 text-shadow: none;
1491 background-image: none;
1492 background-color: #fff;
1493 color: #24292e;
1494}
1495
1496#navrow1 .tablist li.current a {
1497 border-color: #f7ae1a #e1e4e8 transparent;
1498}
1499
1500#navrow2 .tablist li.current a {
1501 border-color: #e45e25 #e1e4e8 transparent;
1502}
1503
1504#navrow3 .tablist li.current a {
1505 border-color: #1fa4a9 #e1e4e8 transparent;
1506}
1507
1508#navrow4 .tablist li.current a {
1509 border-color: #01496d #e1e4e8 transparent;
1510}
1511
1512.tabs li.current {
1513 background-color: #fff;
1514}
1515
1516.tabs2 li.current {
1517 background-color: #fff;
1518}
1519
1520.navpath {
1521 border: none;
1522 margin-top: 1rem;
1523 padding: 0 2rem;
1524}
1525
1526.navpath ul {
1527 background-color: transparent;
1528 border: none;
1529}
1530
1531.navpath li {
1532 padding: 0;
1533}
1534
1535.navpath li.navelem a {
1536 color: #005082;
1537 text-shadow: none;
1538 padding: 0 0.25rem;
1539 font-size: 1rem;
1540}
1541
1542.navpath li.navelem a:hover {
1543 color: #005082;
1544 text-shadow: none;
1545 text-decoration: underline;
1546}
1547
1548/* @group Markdown */
1549
1550table.markdownTable td,
1551table.markdownTable th {
1552 border: 1px solid #c6cbd1;
1553 padding: 0.5rem 1rem;
1554}
1555
1556.markdownTable tbody tr:nth-of-type(odd) {
1557 background-color: #f6f8fa;
1558}
1559
1560th.markdownTableHeadLeft,
1561th.markdownTableHeadRight,
1562th.markdownTableHeadCenter,
1563th.markdownTableHeadNone {
1564 background-color: #fff;
1565 color: inherit;
1566 font-size: inherit;
1567 font-weight: bold;
1568 padding: 0.5rem 1rem;
1569 text-align: inherit;
1570 -moz-border-radius-topleft: 3px;
1571 -moz-border-radius-topright: 3px;
1572 -webkit-border-top-left-radius: 3px;
1573 -webkit-border-top-right-radius: 3px;
1574 border-top-left-radius: 3px;
1575 border-top-right-radius: 3px;
1576 border-bottom: 1px solid #c6cbd1;
1577}
1578
1579/* @end */
1580
1581@media (max-width: 576px) {
1582 .navpath {
1583 padding: 0 1rem;
1584 }
1585
1586 .navpath li.navelem a {
1587 padding: 0;
1588 }
1589
1590 div.header {
1591 padding: 1rem 1rem 0 1rem;
1592 }
1593
1594 div.contents {
1595 padding: 1rem 1rem 0 1rem;
1596 }
1597
1598 hr.footer {
1599 margin-left: 1rem;
1600 margin-right: 1rem;
1601 }
1602
1603 address.footer {
1604 margin-left: 1rem;
1605 margin-right: 1rem;
1606 }
1607
1608 .memtitle {
1609 font-size: 1.5rem;
1610 word-break: break-all;
1611 }
1612
1613 .memname td {
1614 float: left;
1615 word-break: break-all;
1616 }
1617
1618 div.memitem {
1619 margin-bottom: 1rem;
1620 }
1621
1622 .memdoc table.params {
1623 word-break: break-word;
1624 }
1625
1626 div.memproto {
1627 display: table;
1628 }
1629
1630 dl.section dt {
1631 margin-bottom: 0.5rem;
1632 }
1633
1634 dl.section dd {
1635 margin-left: 0;
1636 word-break: break-word;
1637 }
1638
1639 .contents > table,
1640 .contents > table thead,
1641 .contents > table tbody,
1642 .contents > table th,
1643 .contents > table td,
1644 .contents > table tr {
1645 display: block;
1646 }
1647
1648 .contents table.directory,
1649 .contents table.directory thead,
1650 .contents table.directory tbody,
1651 .contents table.directory th,
1652 .contents table.directory td {
1653 display: block;
1654 }
1655
1656 .contents table.directory tr {
1657 }
1658
1659 div:not(.PageDoc) .contents table,
1660 div:not(.PageDoc) .contents thead,
1661 div:not(.PageDoc) .contents tbody,
1662 div:not(.PageDoc) .contents th,
1663 div:not(.PageDoc) .contents td,
1664 div:not(.PageDoc) .contents tr {
1665 display: block;
1666 }
1667
1668 .mdescLeft,
1669 .memItemLeft,
1670 .memTemplItemLeft {
1671 text-align: left;
1672 border-left: 1px solid #c8e1ff;
1673 border-right: 1px solid #c8e1ff;
1674 word-break: break-word;
1675 white-space: normal;
1676 padding-bottom: 0;
1677 }
1678
1679 table td.mdescLeft {
1680 display: none;
1681 }
1682
1683 table td.mdescRight,
1684 table td.memItemRight,
1685 table td.memTemplItemRight {
1686 border-top: none !important;
1687 border-left: 1px solid #c8e1ff;
1688 border-right: 1px solid #c8e1ff;
1689 display: table-cell;
1690 word-break: break-word;
1691 padding-top: 0;
1692 }
1693
1694 .directory td.desc {
1695 display: table-cell;
1696 }
1697
1698 dl.params dd {
1699 margin-left: 0;
1700 }
1701
1702 table.params td.paramname {
1703 margin-top: 0.5rem;
1704 }
1705
1706 #projectlogo img {
1707 border: 0px none;
1708 width: 4rem;
1709 height: auto;
1710 }
1711
1712 #projectname {
1713 font-size: 1rem;
1714 }
1715
1716 #projectbrief {
1717 font-size: 0.75rem;
1718 }
1719
1720 #projectnumber {
1721 font-size: 0.75rem;
1722 }
1723}
diff --git a/docs/doxygen/favicon.ico b/docs/doxygen/favicon.ico
new file mode 100644
index 0000000..b542c5b
--- /dev/null
+++ b/docs/doxygen/favicon.ico
Binary files differ
diff --git a/docs/doxygen/folder-open.png b/docs/doxygen/folder-open.png
new file mode 100644
index 0000000..b67403d
--- /dev/null
+++ b/docs/doxygen/folder-open.png
Binary files differ
diff --git a/docs/doxygen/folder.png b/docs/doxygen/folder.png
new file mode 100644
index 0000000..901edc9
--- /dev/null
+++ b/docs/doxygen/folder.png
Binary files differ
diff --git a/docs/doxygen/footer.html b/docs/doxygen/footer.html
new file mode 100644
index 0000000..9eef78d
--- /dev/null
+++ b/docs/doxygen/footer.html
@@ -0,0 +1,9 @@
1<hr class="footer"/>
2<address class="footer">
3 <ul class="navpath">
4 <li class="footer">&copy; 2007-$year <a href="https://libimobiledevice.org">$projectname</a>&nbsp;&nbsp;All rights reserved</li>
5 <li class="footer">Generated on <em>$datetime</em> by <a href="https://www.doxygen.org">doxygen $doxygenversion</a></li>
6 <li class="footer">Icons by <a href="http://tango-project.org/">Tango</a></li>
7 <li class="footer">Design &copy; $year by <a href="https://mirell.com" target="_blank">Mirell</a></li>
8 </ui>
9</address> \ No newline at end of file
diff --git a/docs/doxygen/header.html b/docs/doxygen/header.html
new file mode 100644
index 0000000..bc41a11
--- /dev/null
+++ b/docs/doxygen/header.html
@@ -0,0 +1,64 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="doxygen $doxygenversion"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<!--BEGIN PROJECT_NAME--><title>$title - $projectname $projectnumber</title><!--END PROJECT_NAME-->
9<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
10
11<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
12
13<meta property="og:locale" content="en_US" />
14<meta property="og:type" content="website" />
15<meta property="og:title" content="$projectbrief - $projectname" />
16<meta property="og:url" content="https://libimobiledevice.org/docs/$projectname/$projectnumber/" />
17<meta property="og:site_name" content="$projectname - $projectbrief" />
18<meta name="twitter:card" content="summary_large_image" />
19
20<script type="text/javascript" src="$relpath^jquery.js"></script>
21<script type="text/javascript" src="$relpath^dynsections.js"></script>
22$treeview
23$search
24$mathjax
25<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
26$extrastylesheet
27</head>
28<body>
29<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
30
31<!--BEGIN TITLEAREA-->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <!--BEGIN PROJECT_LOGO-->
37 <td id="projectlogo"><a href="$relpath^index.html"><img alt="Logo" src="$relpath^$projectlogo"/></a></td>
38 <!--END PROJECT_LOGO-->
39 <!--BEGIN PROJECT_NAME-->
40 <td id="projectalign" style="padding-left: 0.5em;">
41 <div id="projectname">$projectname
42 <!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
43 </div>
44 <!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief - <a href="https://libimobiledevice.org"><small>Return to Homepage</small></a></div><!--END PROJECT_BRIEF-->
45 </td>
46 <!--END PROJECT_NAME-->
47 <!--BEGIN !PROJECT_NAME-->
48 <!--BEGIN PROJECT_BRIEF-->
49 <td style="padding-left: 0.5em;">
50 <div id="projectbrief">$projectbrief</div>
51 </td>
52 <!--END PROJECT_BRIEF-->
53 <!--END !PROJECT_NAME-->
54 <!--BEGIN DISABLE_INDEX-->
55 <!--BEGIN SEARCHENGINE-->
56 <td>$searchbox</td>
57 <!--END SEARCHENGINE-->
58 <!--END DISABLE_INDEX-->
59 </tr>
60 </tbody>
61</table>
62</div>
63<!--END TITLEAREA-->
64<!-- end header part --> \ No newline at end of file
diff --git a/docs/doxygen/layout.xml b/docs/doxygen/layout.xml
new file mode 100644
index 0000000..46f068d
--- /dev/null
+++ b/docs/doxygen/layout.xml
@@ -0,0 +1,226 @@
1<doxygenlayout version="1.0">
2 <!-- Generated by doxygen 1.8.16 -->
3 <!-- Navigation index tabs for HTML output -->
4 <navindex>
5 <tab type="mainpage" visible="yes" title="About"/>
6 <tab type="modules" visible="yes" title="" intro=""/>
7 <tab type="namespaces" visible="yes" title="">
8 <tab type="namespacelist" visible="yes" title="" intro=""/>
9 <tab type="namespacemembers" visible="yes" title="" intro=""/>
10 </tab>
11 <tab type="interfaces" visible="yes" title="">
12 <tab type="interfacelist" visible="yes" title="" intro=""/>
13 <tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
14 <tab type="interfacehierarchy" visible="yes" title="" intro=""/>
15 </tab>
16 <tab type="classes" visible="yes" title="">
17 <tab type="classlist" visible="yes" title="" intro=""/>
18 <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
19 <tab type="hierarchy" visible="yes" title="" intro=""/>
20 <tab type="classmembers" visible="yes" title="" intro=""/>
21 </tab>
22 <tab type="structs" visible="yes" title="">
23 <tab type="structlist" visible="yes" title="" intro=""/>
24 <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
25 </tab>
26 <tab type="exceptions" visible="yes" title="">
27 <tab type="exceptionlist" visible="yes" title="" intro=""/>
28 <tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
29 <tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
30 </tab>
31 <tab type="files" visible="yes" title="">
32 <tab type="filelist" visible="yes" title="" intro=""/>
33 <tab type="globals" visible="yes" title="" intro=""/>
34 </tab>
35 <tab type="examples" visible="yes" title="" intro=""/>
36 <tab type="pages" visible="yes" title="" intro=""/>
37 </navindex>
38
39 <!-- Layout definition for a class page -->
40 <class>
41 <briefdescription visible="no"/>
42 <detaileddescription title="Description"/>
43 <includes visible="$SHOW_INCLUDE_FILES"/>
44 <inheritancegraph visible="$CLASS_GRAPH"/>
45 <collaborationgraph visible="$COLLABORATION_GRAPH"/>
46 <memberdecl>
47 <nestedclasses visible="yes" title=""/>
48 <publictypes title=""/>
49 <services title=""/>
50 <interfaces title=""/>
51 <publicslots title=""/>
52 <signals title=""/>
53 <publicmethods title=""/>
54 <publicstaticmethods title=""/>
55 <publicattributes title=""/>
56 <publicstaticattributes title=""/>
57 <protectedtypes title=""/>
58 <protectedslots title=""/>
59 <protectedmethods title=""/>
60 <protectedstaticmethods title=""/>
61 <protectedattributes title=""/>
62 <protectedstaticattributes title=""/>
63 <packagetypes title=""/>
64 <packagemethods title=""/>
65 <packagestaticmethods title=""/>
66 <packageattributes title=""/>
67 <packagestaticattributes title=""/>
68 <properties title=""/>
69 <events title=""/>
70 <privatetypes title=""/>
71 <privateslots title=""/>
72 <privatemethods title=""/>
73 <privatestaticmethods title=""/>
74 <privateattributes title=""/>
75 <privatestaticattributes title=""/>
76 <friends title=""/>
77 <related title="" subtitle=""/>
78 <membergroups visible="yes"/>
79 </memberdecl>
80 <memberdef>
81 <inlineclasses title=""/>
82 <typedefs title=""/>
83 <enums title=""/>
84 <services title=""/>
85 <interfaces title=""/>
86 <constructors title=""/>
87 <functions title=""/>
88 <related title=""/>
89 <variables title=""/>
90 <properties title=""/>
91 <events title=""/>
92 </memberdef>
93 <allmemberslink visible="yes"/>
94 <usedfiles visible="$SHOW_USED_FILES"/>
95 <authorsection visible="yes"/>
96 </class>
97
98 <!-- Layout definition for a namespace page -->
99 <namespace>
100 <briefdescription visible="no"/>
101 <detaileddescription title="Description"/>
102 <memberdecl>
103 <nestednamespaces visible="yes" title=""/>
104 <constantgroups visible="yes" title=""/>
105 <interfaces visible="yes" title=""/>
106 <classes visible="yes" title=""/>
107 <structs visible="yes" title=""/>
108 <exceptions visible="yes" title=""/>
109 <typedefs title=""/>
110 <sequences title=""/>
111 <dictionaries title=""/>
112 <enums title=""/>
113 <functions title=""/>
114 <variables title=""/>
115 <membergroups visible="yes"/>
116 </memberdecl>
117 <memberdef>
118 <inlineclasses title=""/>
119 <typedefs title=""/>
120 <sequences title=""/>
121 <dictionaries title=""/>
122 <enums title=""/>
123 <functions title=""/>
124 <variables title=""/>
125 </memberdef>
126 <authorsection visible="yes"/>
127 </namespace>
128
129 <!-- Layout definition for a file page -->
130 <file>
131 <briefdescription visible="no"/>
132 <detaileddescription title="Description"/>
133 <includes visible="$SHOW_INCLUDE_FILES"/>
134 <includegraph visible="$INCLUDE_GRAPH"/>
135 <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
136 <memberdecl>
137 <interfaces visible="yes" title=""/>
138 <classes visible="yes" title=""/>
139 <structs visible="yes" title=""/>
140 <exceptions visible="yes" title=""/>
141 <namespaces visible="yes" title=""/>
142 <constantgroups visible="yes" title=""/>
143 <defines title=""/>
144 <typedefs title=""/>
145 <sequences title=""/>
146 <dictionaries title=""/>
147 <enums title=""/>
148 <functions title=""/>
149 <variables title=""/>
150 <membergroups visible="yes"/>
151 </memberdecl>
152 <memberdef>
153 <inlineclasses title=""/>
154 <defines title=""/>
155 <typedefs title=""/>
156 <sequences title=""/>
157 <dictionaries title=""/>
158 <enums title=""/>
159 <functions title=""/>
160 <variables title=""/>
161 </memberdef>
162 <authorsection/>
163 <sourcelink visible="yes"/>
164 </file>
165
166 <!-- Layout definition for a group page -->
167 <group>
168 <briefdescription visible="no"/>
169 <detaileddescription title="Description"/>
170 <groupgraph visible="$GROUP_GRAPHS"/>
171 <memberdecl>
172 <nestedgroups visible="yes" title=""/>
173 <dirs visible="yes" title=""/>
174 <files visible="yes" title=""/>
175 <namespaces visible="yes" title=""/>
176 <classes visible="yes" title=""/>
177 <defines title=""/>
178 <typedefs title=""/>
179 <sequences title=""/>
180 <dictionaries title=""/>
181 <enums title=""/>
182 <enumvalues title=""/>
183 <functions title=""/>
184 <variables title=""/>
185 <signals title=""/>
186 <publicslots title=""/>
187 <protectedslots title=""/>
188 <privateslots title=""/>
189 <events title=""/>
190 <properties title=""/>
191 <friends title=""/>
192 <membergroups visible="yes"/>
193 </memberdecl>
194 <memberdef>
195 <pagedocs/>
196 <inlineclasses title=""/>
197 <defines title=""/>
198 <typedefs title=""/>
199 <sequences title=""/>
200 <dictionaries title=""/>
201 <enums title=""/>
202 <enumvalues title=""/>
203 <functions title=""/>
204 <variables title=""/>
205 <signals title=""/>
206 <publicslots title=""/>
207 <protectedslots title=""/>
208 <privateslots title=""/>
209 <events title=""/>
210 <properties title=""/>
211 <friends title=""/>
212 </memberdef>
213 <authorsection visible="yes"/>
214 </group>
215
216 <!-- Layout definition for a directory page -->
217 <directory>
218 <briefdescription visible="no"/>
219 <detaileddescription title="Description"/>
220 <directorygraph visible="yes"/>
221 <memberdecl>
222 <dirs visible="yes"/>
223 <files visible="yes"/>
224 </memberdecl>
225 </directory>
226</doxygenlayout> \ No newline at end of file
diff --git a/docs/doxygen/logo-vector-clean.svg b/docs/doxygen/logo-vector-clean.svg
new file mode 100644
index 0000000..a953115
--- /dev/null
+++ b/docs/doxygen/logo-vector-clean.svg
@@ -0,0 +1 @@
<svg enable-background="new 0 0 283.5 283.5" height="793.7" viewBox="0 0 793.7 793.7" width="793.7" xmlns="http://www.w3.org/2000/svg"><g stroke-width=".10005" transform="matrix(13.831 0 0 13.831 -1173.2 -291.34)"><path d="m94.968 35.193v-10.71l9.2751 5.355z" fill="#f7ae1a"/><path d="m94.968 35.193 9.2751-5.355v10.71z" fill="#e45e25"/><path d="m94.968 42.414 9.2751 5.355-9.2751 5.355z" fill="#d2343e"/><path d="m94.968 53.124 9.2751-5.355v10.71z" fill="#bb2033"/><path d="m94.968 53.124 9.2751 5.355-9.2751 5.355z" fill="#ab2333"/></g><g fill="#2e3436" fill-opacity=".19964" transform="matrix(13.831 0 0 13.831 -1361.02498 -319.002)"><path d="m57.472 29.867h-55.452l27.726-48.023z" stroke-width=".518" transform="matrix(-.16726 .09657 -.09657 -.16726 121.04 71.121)"/><path d="m148.27 69.213h-10.71l5.355-9.2751z" stroke-width=".10005" transform="matrix(-.86603 .5 .5 .86603 211.62 -57.046)"/><path d="m142.92-59.938h-10.71l5.355-9.2751z" stroke-width=".10005" transform="matrix(-.8660254 .5 -.5 -.8660254 211.614597 -57.0459)"/><path d="m57.472 29.867h-55.452l27.726-48.023z" stroke-width=".518" transform="matrix(0 .19314 -.19314 0 132.86 60.576)"/><path d="m57.472 29.867h-55.452l27.726-48.023z" stroke-width=".518" transform="matrix(.16726 .09657 -.09657 .16726 129.64 55.775)"/><path d="m57.472 29.867h-55.452l27.726-48.023z" transform="matrix(0 .19314 -.19314 0 142.13 55.221)"/></g><g transform="matrix(13.831 0 0 13.831 -1173.2 -291.34)"><g stroke-width=".10005"><path d="m94.968 63.834 9.2751-5.355v10.71z" fill="#7b2f44"/><path d="m104.24 69.189 9.2751-5.355-9.2751-5.355z" fill="#21376d"/><path d="m104.24 58.479 9.2751-5.355v10.71z" fill="#005082"/><path d="m113.52 63.834v-10.71l9.2751 5.355z" fill="#023e49"/><path d="m122.79 58.479-9.2751-5.355 9.2751-5.355z" fill="#007e96"/></g><path d="m122.79 58.479v-10.71l9.2751 5.355z" fill="#0a9197"/></g><g fill="#ccc" transform="translate(2.808 194.51)"><polygon/><polygon/></g></svg> \ No newline at end of file
diff --git a/docs/doxygen/text-x-generic.png b/docs/doxygen/text-x-generic.png
new file mode 100644
index 0000000..2d7f2d6
--- /dev/null
+++ b/docs/doxygen/text-x-generic.png
Binary files differ
diff --git a/docs/idevice_id.1 b/docs/idevice_id.1
index c06fb5e..caded75 100644
--- a/docs/idevice_id.1
+++ b/docs/idevice_id.1
@@ -1,49 +1,43 @@
1.TH "idevice_id" 1 1.TH "idevice_id" 1
2.SH NAME 2.SH NAME
3idevice_id \- Prints device name or a list of attached iPhone/iPod Touch devices. 3idevice_id \- List attached devices or print device name of given device.
4.SH SYNOPSIS 4.SH SYNOPSIS
5.B idevice_id 5.B idevice_id
6[OPTIONS] [UUID] 6[OPTIONS] [UDID]
7 7
8.SH DESCRIPTION 8.SH DESCRIPTION
9 9
10Prints device name or a list of attached iPhone/iPod Touch devices. 10\f[B]idevice_id\f[] prints a list of attached devices. If a UDID is given,
11The UUID is a 40-digit hexadecimal number of the device 11the name of the connected device with that UDID will be retrieved.
12for which the name should be retrieved. 12
13Without any options, \f[B]idevice_id\f[] will list all available devices,
14USB and network.
15The output can be further controlled with the following OPTIONS.
13 16
14.SH OPTIONS 17.SH OPTIONS
15.TP 18.TP
16.B \-l, \-\-list 19.B \-l, \-\-list
17list UUID of all attached devices 20List UDIDs of all devices attached via USB.
18.TP 21.TP
22.B \-n, \-\-network
23List UDIDs of all devices available via network.
24.TP
19.B \-d, \-\-debug 25.B \-d, \-\-debug
20enable communication debugging. 26Enable communication debugging.
21.TP 27.TP
22.B \-h, \-\-help 28.B \-h, \-\-help
23prints usage information. 29Prints usage information.
24.TP 30.TP
25 31.B \-v, \-\-version
26.SH AUTHORS 32Prints version information.
27 Zach C. 33.TP
28
29 Jonathan Beck
30
31 Matt Colyer
32
33 Martin Aumueller
34
35 Christophe Fergeau
36
37 Martin S.
38
39 Paul Sladen
40
41 Patrick Walton
42 34
43 Zoltan Balaton 35.SH AUTHOR
36Nikias Bassen
44 37
45 Nikias Bassen 38Man page written to conform with Debian by Julien Lavergne.
46 39
47 Todd Zullinger 40.SH ON THE WEB
41https://libimobiledevice.org
48 42
49Man page written to conform with Debian by Julien Lavergne. 43https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/idevicebackup.1 b/docs/idevicebackup.1
index 5ae867e..6f2a8f9 100644
--- a/docs/idevicebackup.1
+++ b/docs/idevicebackup.1
@@ -1,24 +1,32 @@
1.TH "idevicebackup" 1 1.TH "idevicebackup" 1
2.SH NAME 2.SH NAME
3idevicebackup \- Create or restore backup for iPhone/iPod Touch devices. 3idevicebackup \- Create or restore backup for devices.
4.SH SYNOPSIS 4.SH SYNOPSIS
5.B idevicebackup 5.B idevicebackup
6[OPTIONS] CMD [DIRECTORY] 6[OPTIONS] CMD [DIRECTORY]
7 7
8.SH DESCRIPTION 8.SH DESCRIPTION
9 9
10Create or restore backup from the current or specified directory. 10Create or restore backup in/from the specified directory.
11
12\f[B]NOTE\f[]: This tool is outdated. See idevicebackup2(1) for an updated tool.
11 13
12.SH OPTIONS 14.SH OPTIONS
13.TP 15.TP
14.B \-u, \-\-uuid UUID 16.B \-u, \-\-udid UDID
15target specific device by its 40-digit device UUID. 17target specific device by UDID.
16.TP 18.TP
19.B \-n, \-\-network
20connect to network device.
21.TP
17.B \-d, \-\-debug 22.B \-d, \-\-debug
18enable communication debugging. 23enable communication debugging.
19.TP 24.TP
20.B \-h, \-\-help 25.B \-h, \-\-help
21prints usage information. 26prints usage information.
27.TP
28.B \-v, \-\-version
29prints version information.
22 30
23.SH COMMANDS 31.SH COMMANDS
24.TP 32.TP
@@ -34,3 +42,11 @@ Martin Szulecki
34Nikias Bassen 42Nikias Bassen
35 43
36Man page written to conform with Debian by Julien Lavergne. 44Man page written to conform with Debian by Julien Lavergne.
45
46.SH SEE ALSO
47idevicebackup2(1)
48
49.SH ON THE WEB
50https://libimobiledevice.org
51
52https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/idevicebackup2.1 b/docs/idevicebackup2.1
new file mode 100644
index 0000000..79b6dc4
--- /dev/null
+++ b/docs/idevicebackup2.1
@@ -0,0 +1,104 @@
1.TH "idevicebackup2" 1
2.SH NAME
3idevicebackup2 \- Create or restore backups for devices running iOS 4 or later.
4.SH SYNOPSIS
5.B idevicebackup2
6[OPTIONS] CMD [CMDOPTIONS] DIRECTORY
7
8.SH DESCRIPTION
9
10Create or restore backup in/from the specified directory.
11
12.SH OPTIONS
13.TP
14.B \-u, \-\-udid UDID
15target specific device by UDID.
16.TP
17.B \-s, \-\-source UDID
18use backup data from device specified by UDID.
19.TP
20.B \-i, \-\-interactive
21request passwords interactively on the command line.
22.TP
23.B \-n, \-\-network
24connect to network device.
25.TP
26.B \-d, \-\-debug
27enable communication debugging.
28.TP
29.B \-h, \-\-help
30prints usage information.
31.TP
32.B \-v, \-\-version
33prints version information.
34
35.SH COMMANDS
36.TP
37.B backup
38create backup for the device.
39.TP
40.B \t\-\-full
41force full backup from device.
42.TP
43.B restore
44restore last backup to the device.
45.TP
46.B \t\-\-system
47restore system files, too.
48.TP
49.B \t\-\-no\-reboot
50do NO reboot the system when done.
51.TP
52.B \t\-\-copy
53create a copy of backup folder before restoring.
54.TP
55.B \t\-\-settings
56restore device settings from the backup.
57.TP
58.B \t\-\-remove
59remove items which are not being restored.
60.TP
61.B \t\-\-skip-apps
62do not trigger re-installation of apps after restore.
63.TP
64.B \t\-\-password PWD
65supply the password for the encrypted source backup. If omitted, the password
66will be requested in interactive mode (\f[B]\-i\f[]), or it can be passed using
67the environment variable \f[B]BACKUP_PASSWORD\f[].
68.TP
69.B info
70show details about last completed backup of device.
71.TP
72.B list
73list files of last completed backup in CSV format.
74.TP
75.B unback
76unpack a completed backup in DIRECTORY/_unback_/
77.TP
78.B encryption on|off [PWD]
79enable or disable backup encryption. The password will be requested in
80interactive mode (\f[B]\-i\f[]) if omitted, or it can be passed using the
81environment variable \f[B]BACKUP_PASSWORD\f[].
82.TP
83.B changepw [OLD NEW]
84change backup password on target device. The passwords will be requested in
85interactive mode (\f[B]\-i\f[]) if omitted, or they can be passed using the
86environment variables \f[B]BACKUP_PASSWORD\f[] (old password) and
87\f[B]BACKUP_PASSWORD_NEW\f[] (new password) respectively.
88.TP
89.B cloud on|off
90enable or disable cloud use (requires iCloud account).
91.SH SECURITY CONSIDERATIONS
92Passing passwords on the command line is not advised, since it might reveal
93the backup password to other users via process list or command line history.
94Use interactive mode (\f[B]\-i\f[]) or pass them via environment variable(s)
95as mentioned in the description of the respective commands above.
96.SH AUTHORS
97Martin Szulecki
98
99Nikias Bassen
100
101.SH ON THE WEB
102https://libimobiledevice.org
103
104https://github.com/libimobiledevice/libimobiledevice
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 @@
1.TH "idevicebtlogger" 1
2.SH NAME
3idevicebtlogger \- Capture HCI traffic of a connected device.
4.SH SYNOPSIS
5.B idevicebtlogger
6[OPTIONS]
7<FILE>
8
9.SH DESCRIPTION
10
11Capture 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.
12
13The HCI traffic can be stored in Apple's native PacketLogger format or converted into PCAP format for live feedback in Wireshark.
14
15.SH OPTIONS
16.TP
17.B \-u, \-\-udid UDID
18target specific device by UDID
19.TP
20.B \-n, \-\-network
21connect to network device
22.TP
23.B \-f, \-\-format FORMAT
24set log format: PacketLogger (default), or pcap
25.TP
26.B \-x, \-\-exit
27exit when device disconnects
28.TP
29.B \-d, \-\-debug
30enable communication debugging
31.TP
32.B \-h, \-\-help
33prints usage information
34.TP
35.B \-v, \-\-version
36prints version information.
37
38.SH EXAMPLES
39.TP
40.B idevicebtlogger \-u 00008030\-0000111ABC000DEF
41Capture HCI traffic of device with UDID 00008030-0000111ABC000DEF.
42.TP
43.B idevicebtlogger \-x
44Capture HCI traffic of device and exit when the device is unplugged.
45.TP
46.B idevicebtlogger \-f pcap
47Capture HCI traffic of device in PCAP format.
48.TP
49.B idevicebtlogger -f pcap - | wireshark -k -i -
50Capture HCI traffic and pipe it into Wireshark for live feedback.
51
52.SH AUTHORS
53Geoffrey Kruse
54
55Matthias Ringwald
56
57.SH ON THE WEB
58https://libimobiledevice.org
59
60https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/idevicecrashreport.1 b/docs/idevicecrashreport.1
new file mode 100644
index 0000000..f117c87
--- /dev/null
+++ b/docs/idevicecrashreport.1
@@ -0,0 +1,53 @@
1.TH "idevicecrashreport" 1
2.SH NAME
3idevicecrashreport \- Retrieve crash reports from a device.
4.SH SYNOPSIS
5.B idevicecrashreport
6[OPTIONS] DIRECTORY
7
8.SH DESCRIPTION
9
10Simple utility to move crash reports from a device to a local directory.
11
12The utility outputs lines prefixed with either "Link:", "Copy:" or "Move:"
13depending on whether a symlink was created, a file was copied or moved from
14the device to the target DIRECTORY.
15
16.SH OPTIONS
17.TP
18.B \-u, \-\-udid UDID
19Target specific device by UDID.
20.TP
21.B \-n, \-\-network
22Connect to network device.
23.TP
24.B \-e, \-\-extract
25Extract raw crash report into separate '.crash' files.
26.TP
27.B \-k, \-\-keep
28Copy but do not remove crash reports from device.
29.TP
30.B \-d, \-\-debug
31Enable communication debugging.
32.TP
33.B \-f, \-\-filter NAME
34Filter crash reports by NAME (case sensitive)
35.TP
36.B \-\-remove\-all
37Remove all crash log files without copying. Can be used with \f[B]-f\f[] to only remove matching files.
38.TP
39.B \-h, \-\-help
40Prints usage information.
41.TP
42.B \-v, \-\-version
43Prints version information.
44
45.SH AUTHOR
46Martin Szulecki
47
48Nikias Bassen
49
50.SH ON THE WEB
51https://libimobiledevice.org
52
53https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/idevicedate.1 b/docs/idevicedate.1
index 15c9895..dcdc57e 100644
--- a/docs/idevicedate.1
+++ b/docs/idevicedate.1
@@ -1,22 +1,25 @@
1.TH "idevicedate" 1 1.TH "idevicedate" 1
2.SH NAME 2.SH NAME
3idevicedate \- Display the current date or set it on an iDevice. 3idevicedate \- Display the current date or set it on a device.
4.SH SYNOPSIS 4.SH SYNOPSIS
5.B idevicedate 5.B idevicedate
6[OPTIONS] 6[OPTIONS]
7 7
8.SH DESCRIPTION 8.SH DESCRIPTION
9 9
10Show information about the first connected iPhone/iPod Touch. 10Simple utility to manage the clock on a device.
11 11
12.SH OPTIONS 12.SH OPTIONS
13.TP 13.TP
14.B \-u, \-\-udid UDID
15target specific device by UDID.
16.TP
17.B \-n, \-\-network
18connect to network device.
19.TP
14.B \-d, \-\-debug 20.B \-d, \-\-debug
15enable communication debugging. 21enable communication debugging.
16.TP 22.TP
17.B \-u, \-\-uuid UUID
18target specific device by its 40-digit device UUID.
19.TP
20.B \-s, \-\-set TIMESTAMP 23.B \-s, \-\-set TIMESTAMP
21set UTC time described by TIMESTAMP 24set UTC time described by TIMESTAMP
22.TP 25.TP
@@ -25,6 +28,14 @@ set time of device to current system time
25.TP 28.TP
26.B \-h, \-\-help 29.B \-h, \-\-help
27prints usage information 30prints usage information
31.TP
32.B \-v, \-\-version
33prints version information.
28 34
29.SH AUTHOR 35.SH AUTHOR
30Martin Szulecki 36Martin Szulecki
37
38.SH ON THE WEB
39https://libimobiledevice.org
40
41https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/idevicedebug.1 b/docs/idevicedebug.1
new file mode 100644
index 0000000..7314baa
--- /dev/null
+++ b/docs/idevicedebug.1
@@ -0,0 +1,45 @@
1.TH "idevicedebug" 1
2.SH NAME
3idevicedebug \- Interact with the debugserver service of a device.
4.SH SYNOPSIS
5.B idevicedebug
6[OPTIONS] COMMAND
7
8.SH DESCRIPTION
9
10Interact with the debug service of a device. Currently the only implemented
11command is "run" and allows execution of developer apps and watch the
12stdout/stderr of the process.
13
14.SH OPTIONS
15.TP
16.B \-u, \-\-udid UDID
17target specific device by UDID.
18.TP
19.B \-n, \-\-network
20connect to network device.
21.TP
22.B \-e, \-\-env NAME=VALUE
23set environment variable NAME to VALUE.
24.TP
25.B \-d, \-\-debug
26enable communication debugging.
27.TP
28.B \-h, \-\-help
29prints usage information.
30.TP
31.B \-v, \-\-version
32prints version information.
33
34.SH COMMANDS
35.TP
36.B run BUNDLEID [ARGS...]
37run app with BUNDLEID and optional ARGS on device.
38
39.SH AUTHORS
40Martin Szulecki
41
42.SH ON THE WEB
43https://libimobiledevice.org
44
45https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/idevicedebugserverproxy.1 b/docs/idevicedebugserverproxy.1
new file mode 100644
index 0000000..69200ee
--- /dev/null
+++ b/docs/idevicedebugserverproxy.1
@@ -0,0 +1,49 @@
1.TH "idevicedebugserverproxy" 1
2.SH NAME
3idevicedebugserverproxy \- Remote debugging proxy.
4.SH SYNOPSIS
5.B idevicedebugserverproxy
6[OPTIONS] [PORT]
7
8.SH DESCRIPTION
9
10Proxy a debugserver connection from a device for remote debugging.
11After starting up, clients can connect to PORT and communicate with the remote
12debugserver using the LLVM remote serial debugging protocol.
13Thus connecting using LLDB or a LLVM based gdb to this port would allow
14remote debugging.
15The developer disk image needs to be mounted for this service to be available.
16
17.SH OPTIONS
18.TP
19.B \-u, \-\-udid UDID
20target specific device by UDID.
21.TP
22.B \-n, \-\-network
23connect to network device.
24.TP
25.B \-l, \-\-lldb
26Enable lldb support.
27.TP
28.B \-d, \-\-debug
29enable communication debugging.
30.TP
31.B \-h, \-\-help
32prints usage information.
33.TP
34.B \-v, \-\-version
35prints version information.
36
37.SH USAGE
38.TP
39.B PORT
40The port under which the proxy should listen for connections from clients.
41If omitted, the next available port will be used and printed to stdout.
42
43.SH AUTHORS
44Martin Szulecki
45
46.SH ON THE WEB
47https://libimobiledevice.org
48
49https://github.com/libimobiledevice/libimobiledevice
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 @@
1.TH "idevicedevmodectl" 1
2.SH NAME
3idevicedevmodectl \- Enable Developer Mode on iOS 16+ devices or print the current status.
4.SH SYNOPSIS
5.B idevicedevmodectl
6COMMAND
7[OPTIONS]
8
9.SH DESCRIPTION
10
11Enable Developer Mode on iOS 16+ devices or print the current status.
12
13.SH NOTE
14Passcode-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.
15The \f[B]enable\f[] command will try to enable it, and tell you if that's the case.
16If the menu is not shown, you may use the \f[B]reveal\f[] command to reveal it.
17
18.SH COMMANDS
19.TP
20.B list
21Prints the Developer Mode status of all connected devices, or for a specific one if \f[B]\-\-udid\f[] is given.
22.TP
23.B enable
24Enable Developer Mode (device will reboot), and confirm it after device booted up again.
25.TP
26.B arm
27Arm the Developer Mode (device will reboot)
28.TP
29.B confirm
30Confirm enabling of Developer Mode
31.TP
32.B reveal
33Reveal the Developer Mode menu on the device under Settings -> Privacy & Security
34
35.SH OPTIONS
36.TP
37.B \-u, \-\-udid UDID
38target specific device by UDID
39.TP
40.B \-n, \-\-network
41connect to network device
42.TP
43.B \-d, \-\-debug
44enable communication debugging
45.TP
46.B \-h, \-\-help
47print usage information
48.TP
49.B \-v, \-\-version
50print version information
51
52.SH AUTHORS
53Nikias Bassen
54
55.SH ON THE WEB
56https://libimobiledevice.org
57
58https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/idevicediagnostics.1 b/docs/idevicediagnostics.1
new file mode 100644
index 0000000..2f28b8d
--- /dev/null
+++ b/docs/idevicediagnostics.1
@@ -0,0 +1,62 @@
1.TH "idevicediagnostics" 1
2.SH NAME
3idevicediagnostics \- Interact with the diagnostics interface of a device.
4.SH SYNOPSIS
5.B idevicediagnostics
6[OPTIONS] COMMAND
7
8.SH DESCRIPTION
9
10Interact with the diagnostics interface of a device which allows one to retrieve
11all kinds of information including diagnostics data, mobilegestalt data, remote
12access to the IORegistry and certain commands like restart, shutdown and sleep.
13Only available for iOS 4 and later. Accessing IORegistry is only supported on
14iOS 5 and later.
15
16.SH OPTIONS
17.TP
18.B \-u, \-\-udid UDID
19target specific device by UDID.
20.TP
21.B \-n, \-\-network
22connect to network device.
23.TP
24.B \-d, \-\-debug
25enable communication debugging.
26.TP
27.B \-h, \-\-help
28prints usage information.
29.TP
30.B \-v, \-\-version
31prints version information.
32
33.SH COMMANDS
34.TP
35.B diagnostics [TYPE]
36print diagnostics information from device optionally by TYPE. This includes
37"All", "WiFi", "GasGauge" or "NAND". Default is "All".
38.TP
39.B mobilegestalt KEY [...]
40print values of mobilegestalt keys passed as arguments after the command and
41separated by a space.
42.TP
43.B ioreg [PLANE]
44print IORegistry of device, optionally by PLANE like "IODeviceTree", "IOPower"
45 or "IOService". Only available on iOS 5 and later.
46.TP
47.B shutdown
48shutdown device
49.TP
50.B restart
51restart device
52.TP
53.B sleep
54put device into sleep mode which also disconnects it from the host.
55
56.SH AUTHORS
57Martin Szulecki
58
59.SH ON THE WEB
60https://libimobiledevice.org
61
62https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/ideviceenterrecovery.1 b/docs/ideviceenterrecovery.1
index a543092..d455826 100644
--- a/docs/ideviceenterrecovery.1
+++ b/docs/ideviceenterrecovery.1
@@ -1,13 +1,13 @@
1.TH "ideviceenterrecovery" 1 1.TH "ideviceenterrecovery" 1
2.SH NAME 2.SH NAME
3ideviceenterrecovery \- Makes a device with the supplied 40-digit UUID enter recovery mode immediately. 3ideviceenterrecovery \- Make a device enter recovery mode.
4.SH SYNOPSIS 4.SH SYNOPSIS
5.B ideviceenterrecovery 5.B ideviceenterrecovery
6[OPTIONS] UUID 6[OPTIONS] UDID
7 7
8.SH DESCRIPTION 8.SH DESCRIPTION
9 9
10Makes a device with the supplied 40-digit UUID enter recovery mode immediately. 10Makes a device with the supplied UDID enter recovery mode immediately.
11 11
12.SH OPTIONS 12.SH OPTIONS
13.TP 13.TP
@@ -16,8 +16,16 @@ enable communication debugging.
16.TP 16.TP
17.B \-h, \-\-help 17.B \-h, \-\-help
18prints usage information. 18prints usage information.
19.TP
20.B \-v, \-\-version
21prints version information.
19 22
20.SH AUTHORS 23.SH AUTHORS
21Martin Szulecki 24Martin Szulecki
22 25
23Man page written to conform with Debian by Julien Lavergne. 26Man page written to conform with Debian by Julien Lavergne.
27
28.SH ON THE WEB
29https://libimobiledevice.org
30
31https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/ideviceimagemounter.1 b/docs/ideviceimagemounter.1
index 55d81e9..1fe7e45 100644
--- a/docs/ideviceimagemounter.1
+++ b/docs/ideviceimagemounter.1
@@ -1,24 +1,43 @@
1.TH "ideviceimagemounter" 1 1.TH "ideviceimagemounter" 1
2.SH NAME 2.SH NAME
3ideviceimagemounter \- Mount disk images on the iPhone/iPod Touch. 3ideviceimagemounter \- Mount, list, or unmount a disk image on the device.
4.SH SYNOPSIS 4.SH SYNOPSIS
5.B ideviceimagemounter 5.B ideviceimagemounter
6[OPTIONS] IMAGE_FILE IMAGE_SIGNATURE_FILE 6[OPTIONS] COMMAND [COMMAND OPTIONS]
7 7
8.SH DESCRIPTION 8.SH DESCRIPTION
9 9
10Mounts the specified disk image on the iPhone/iPod Touch device. 10Mount, list, or unmount a disk image on the device.
11
12.SH COMMANDS
13.TP
14.B mount PATH
15Mount the developer disk image at PATH.
16For iOS 17+, PATH is a directory containing a .dmg image, a BuildManifest.plist,
17and a Firmware sub-directory.
18
19For older versions PATH is a .dmg filename with a .dmg.signature file in the same directory, or with
20another parameter pointing to a file elsewhere.
21.TP
22.B list
23List mounted disk images.
24.TP
25.B unmount PATH
26Unmount the image mounted at PATH.
27.TP
28.B devmodestatus
29Query the developer mode status (iOS 16+)
11 30
12.SH OPTIONS 31.SH OPTIONS
13.TP 32.TP
14.B \-d, \-\-debug 33.B \-u, \-\-udid UDID
15enable communication debugging. 34target specific device by UDID.
16.TP 35.TP
17.B \-u, \-\-uuid UUID 36.B \-n, \-\-network
18target specific device by its 40-digit device UUID. 37connect to network device.
19.TP 38.TP
20.B \-l, \-\-list 39.B \-d, \-\-debug
21list mount information 40enable communication debugging.
22.TP 41.TP
23.B \-t, \-\-imagetype NAME 42.B \-t, \-\-imagetype NAME
24the image type to use, default is 'Developer' 43the image type to use, default is 'Developer'
@@ -29,13 +48,15 @@ use XML output
29.B \-h, \-\-help 48.B \-h, \-\-help
30prints usage information 49prints usage information
31.TP 50.TP
32.B IMAGE_FILE 51.B \-v, \-\-version
33the image filename to mount 52prints version information.
34.TP
35.B IMAGE_SIGNATURE_FILE
36corresponding signature file for image filename
37 53
38.SH AUTHOR 54.SH AUTHOR
39Nikias Bassen 55Nikias Bassen
40 56
41Man page written to conform with Debian by Julien Lavergne. 57Man page written to conform with Debian by Julien Lavergne.
58
59.SH ON THE WEB
60https://libimobiledevice.org
61
62https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/ideviceinfo.1 b/docs/ideviceinfo.1
index e350dd0..3944612 100644
--- a/docs/ideviceinfo.1
+++ b/docs/ideviceinfo.1
@@ -1,22 +1,28 @@
1.TH "ideviceinfo" 1 1.TH "ideviceinfo" 1
2.SH NAME 2.SH NAME
3ideviceinfo \- Show information about the first connected iPhone/iPod Touch. 3ideviceinfo \- Show information about the first connected device.
4.SH SYNOPSIS 4.SH SYNOPSIS
5.B ideviceinfo 5.B ideviceinfo
6[OPTIONS] 6[OPTIONS]
7 7
8.SH DESCRIPTION 8.SH DESCRIPTION
9 9
10Show information about the first connected iPhone/iPod Touch. 10Show information about the first connected device.
11 11
12.SH OPTIONS 12.SH OPTIONS
13.TP 13.TP
14.B \-s, \-\-simple
15use a simple connection to avoid auto-pairing with the device.
16.TP
17.B \-u, \-\-udid UDID
18target specific device by UDID.
19.TP
20.B \-n, \-\-network
21connect to network device.
22.TP
14.B \-d, \-\-debug 23.B \-d, \-\-debug
15enable communication debugging. 24enable communication debugging.
16.TP 25.TP
17.B \-u, \-\-uuid UUID
18target specific device by its 40-digit device UUID.
19.TP
20.B \-q, \-\-domain NAME 26.B \-q, \-\-domain NAME
21set domain of query to NAME. Default: None. 27set domain of query to NAME. Default: None.
22.TP 28.TP
@@ -27,9 +33,17 @@ only query key specified by NAME. Default: All keys.
27output information as xml plist instead of key/value pairs. 33output information as xml plist instead of key/value pairs.
28.TP 34.TP
29.B \-h, \-\-help 35.B \-h, \-\-help
30prints usage information 36prints usage information.
37.TP
38.B \-v, \-\-version
39prints version information.
31 40
32.SH AUTHOR 41.SH AUTHOR
33Martin Szulecki 42Martin Szulecki
34 43
35Man page written to conform with Debian by Julien Lavergne. 44Man page written to conform with Debian by Julien Lavergne.
45
46.SH ON THE WEB
47https://libimobiledevice.org
48
49https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/idevicename.1 b/docs/idevicename.1
new file mode 100644
index 0000000..34ce490
--- /dev/null
+++ b/docs/idevicename.1
@@ -0,0 +1,41 @@
1.TH "idevicename" 1
2.SH NAME
3idevicename \- Display the device name or set it to NAME if specified.
4.SH SYNOPSIS
5.B idevicename
6[OPTIONS] [NAME]
7
8.SH DESCRIPTION
9
10Simple utility to manage the device name.
11
12If called without any extra argument this tool will print the current device name.
13
14If
15.B NAME
16is given the device name will be set to the name specified.
17
18.SH OPTIONS
19.TP
20.B \-u, \-\-udid UDID
21target specific device by UDID.
22.TP
23.B \-n, \-\-network
24connect to network device.
25.TP
26.B \-d, \-\-debug
27enable communication debugging.
28.TP
29.B \-h, \-\-help
30prints usage information
31.TP
32.B \-v, \-\-version
33prints version information.
34
35.SH AUTHOR
36Nikias Bassen
37
38.SH ON THE WEB
39https://libimobiledevice.org
40
41https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/idevicenotificationproxy.1 b/docs/idevicenotificationproxy.1
new file mode 100644
index 0000000..627ee5d
--- /dev/null
+++ b/docs/idevicenotificationproxy.1
@@ -0,0 +1,49 @@
1.TH "idevicenotificationproxy" 1
2.SH NAME
3idevicenotificationproxy \- Post or observe notifications on a device.
4.SH SYNOPSIS
5.B idevicenotificationproxy
6[OPTIONS] COMMAND
7
8.SH DESCRIPTION
9
10Post or observe notifications on an iOS device from the command line.
11
12.SH OPTIONS
13.TP
14.B \-u, \-\-udid UDID
15Target specific device by UDID.
16.TP
17.B \-i, \-\-insecure
18Connect to insecure notification proxy (for non-paired devices).
19.TP
20.B \-n, \-\-network
21Connect to network device.
22.TP
23.B \-d, \-\-debug
24Enable communication debugging.
25.TP
26.B \-h, \-\-help
27Prints usage information.
28.TP
29.B \-v, \-\-version
30Prints version information.
31
32.SH COMMANDS
33.TP
34.B post ID [ID...]
35post notification IDs to device and exit.
36.TP
37.B observe ID [ID...]
38observe notification IDs in the foreground until CTRL+C or signal is received.
39
40.SH AUTHORS
41
42Martin Szulecki
43
44Nikias Bassen
45
46.SH ON THE WEB
47https://libimobiledevice.org
48
49https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/idevicepair.1 b/docs/idevicepair.1
index da76b7f..eb6e7d4 100644
--- a/docs/idevicepair.1
+++ b/docs/idevicepair.1
@@ -1,43 +1,80 @@
1.TH "idevicepair" 1 1.TH "idevicepair" 1
2.SH NAME 2.SH NAME
3idevicepair \- Manage pairings with iPhone/iPod Touch/iPad devices and this host. 3idevicepair \- Manage host pairings with devices and usbmuxd.
4.SH SYNOPSIS 4.SH SYNOPSIS
5.B idevicepair 5.B idevicepair
6[OPTIONS] COMMAND 6[OPTIONS] COMMAND
7 7
8.SH DESCRIPTION 8.SH DESCRIPTION
9 9
10Manage pairings with iPhone/iPod Touch/iPad devices and this host. 10Manage host pairings with devices and usbmuxd.
11 11
12.SH OPTIONS 12.SH OPTIONS
13.TP 13.TP
14.B \-u, \-\-uuid UUID 14.B \-u, \-\-udid UDID
15target specific device by its 40-digit device UUID. 15target specific device by UDID.
16.TP 16.TP
17.B \-w, \-\-wireless
18perform wireless pairing (\f[B]see NOTE\f[]).
19.TP
20.B \-n, \-\-network
21connect to network device (\f[B]see NOTE\f[]).
22.TP
17.B \-d, \-\-debug 23.B \-d, \-\-debug
18enable communication debugging. 24enable communication debugging.
19.TP 25.TP
20.B \-h, \-\-help 26.B \-h, \-\-help
21prints usage information. 27prints usage information.
28.TP
29.B \-v, \-\-version
30prints version information.
22 31
23.SH COMMANDS 32.SH COMMANDS
24.TP 33.TP
34.B systembuid
35print the system buid of the usbmuxd host.
36.TP
25.B hostid 37.B hostid
26print the host id of this computer. 38print the host id for target device.
27.TP 39.TP
28.B pair 40.B pair
29pair device with this computer. 41pair device with this host.
30.TP 42.TP
31.B validate 43.B validate
32validate if device is paired with this computer. 44validate if device is paired with this host.
33.TP 45.TP
34.B unpair 46.B unpair
35unpair device with this computer. 47unpair device with this host.
36.TP 48.TP
37.B list 49.B list
38list devices paired with this computer. 50list devices paired with this host.
51
52.SH NOTE
53Pairing over network (wireless pairing) is only supported by Apple TV
54devices. To perform a wireless pairing, you need to use the \f[B]\-w\f[]
55command line switch.
56
57Make sure to put the device into pairing mode first by opening
58Settings > Remotes and Devices > Remote App and Devices.
59
60The pairable device will become visible with a special UDID, and then you
61can run idevicepair like this:
62
63.B idevicepair -u fffc8:ab:cd:12:34:56fff -w pair
64
65idevicepair will then ask for the PIN that the device is displaying and
66continues with the pairing once entered.
67
68Please note that wireless pairing is currently not supported on Linux.
39 69
40.SH AUTHORS 70.SH AUTHORS
41Nikias Bassen 71Nikias Bassen
42 72
43Man page written to conform with Debian by Julien Lavergne. 73Martin Szulecki
74
75Julien Lavergne
76
77.SH ON THE WEB
78https://libimobiledevice.org
79
80https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/ideviceprovision.1 b/docs/ideviceprovision.1
new file mode 100644
index 0000000..3597d6e
--- /dev/null
+++ b/docs/ideviceprovision.1
@@ -0,0 +1,58 @@
1.TH "ideviceprovision" 1
2.SH NAME
3ideviceprovision \- Manage provisioning profiles on a device.
4.SH SYNOPSIS
5.B ideviceprovision
6[OPTIONS] COMMAND
7
8.SH DESCRIPTION
9
10Manage provisioning profiles on a device.
11
12.SH OPTIONS
13.TP
14.B \-u, \-\-udid UDID
15target specific device by UDID.
16.TP
17.B \-n, \-\-network
18connect to network device.
19.TP
20.B \-x, \-\-xml
21print XML output when using the 'dump' command.
22.TP
23.B \-d, \-\-debug
24enable communication debugging.
25.TP
26.B \-h, \-\-help
27prints usage information.
28.TP
29.B \-v, \-\-version
30prints version information.
31
32.SH COMMANDS
33.TP
34.B install FILE
35Install the provisioning profile specified by FILE. A valid ".mobileprovision"
36file is expected.
37.TP
38.B list
39Get a list of all provisioning profiles on the device.
40.TP
41.B copy PATH
42Retrieves all provisioning profiles from the device and stores them into the
43existing directory specified by PATH. The files will be stored
44as "UUID.mobileprovision".
45.TP
46.B remove UUID
47Removes the provisioning profile identified by UUID.
48.TP
49.B dump FILE
50Prints detailed information about the provisioning profile specified by FILE.
51
52.SH AUTHORS
53Nikias Bassen
54
55.SH ON THE WEB
56https://libimobiledevice.org
57
58https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/idevicescreenshot.1 b/docs/idevicescreenshot.1
index cf0ed15..4da78af 100644
--- a/docs/idevicescreenshot.1
+++ b/docs/idevicescreenshot.1
@@ -1,29 +1,44 @@
1.TH "idevicescreenshot" 1 1.TH "idevicescreenshot" 1
2.SH NAME 2.SH NAME
3idevicescreenshot \- Gets a screenshot from the connected iPhone/iPod Touch. 3idevicescreenshot \- Gets a screenshot from the connected device.
4.SH SYNOPSIS 4.SH SYNOPSIS
5.B idevicescreenshot 5.B idevicescreenshot
6[OPTIONS] 6[OPTIONS] [FILE]
7 7
8.SH DESCRIPTION 8.SH DESCRIPTION
9 9
10Gets a screenshot from the connected iPhone/iPod Touch. 10Gets a screenshot from the connected device.
11
12The screenshot is saved as a TIFF image with the given FILE name, where the
13default name is "screenshot-DATE.tiff",
14e.g.: ./screenshot-2013-12-31-23-59-59.tiff
11 15
12NOTE: A mounted developer disk image is required on the device, otherwise 16NOTE: A mounted developer disk image is required on the device, otherwise
13 the screenshotr service is not available. 17the screenshotr service is not available.
14 18
15.SH OPTIONS 19.SH OPTIONS
16.TP 20.TP
21.B \-u, \-\-udid UDID
22target specific device by UDID.
23.TP
24.B \-n, \-\-network
25connect to network device.
26.TP
17.B \-d, \-\-debug 27.B \-d, \-\-debug
18enable communication debugging. 28enable communication debugging.
19.TP 29.TP
20.B \-u, \-\-uuid UUID
21target specific device by its 40-digit device UUID.
22.TP
23.B \-h, \-\-help 30.B \-h, \-\-help
24prints usage information 31prints usage information
32.TP
33.B \-v, \-\-version
34prints version information.
25 35
26.SH AUTHOR 36.SH AUTHOR
27Nikias Bassen 37Nikias Bassen
28 38
29Man page written to conform with Debian by Julien Lavergne. 39Man page written to conform with Debian by Julien Lavergne.
40
41.SH ON THE WEB
42https://libimobiledevice.org
43
44https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/idevicesetlocation.1 b/docs/idevicesetlocation.1
new file mode 100644
index 0000000..941a6e5
--- /dev/null
+++ b/docs/idevicesetlocation.1
@@ -0,0 +1,38 @@
1.TH "idevicesetlocation" 1
2.SH NAME
3idevicesetlocation \- Simulate location on iOS device.
4.SH SYNOPSIS
5.B idevicesetlocation
6[OPTIONS] -- <LAT> <LONG>
7
8.B idevicesetlocation
9[OPTIONS] reset
10
11.SH DESCRIPTION
12
13Simulate location on iOS device with mounted developer disk image.
14
15.SH OPTIONS
16.TP
17.B \-u, \-\-udid UDID
18target specific device by UDID
19.TP
20.B \-n, \-\-network
21connect to network device
22.TP
23.B \-d, \-\-debug
24enable communication debugging
25.TP
26.B \-h, \-\-help
27prints usage information
28.TP
29.B \-v, \-\-version
30prints version information.
31
32.SH AUTHOR
33Nikias Bassen
34
35.SH ON THE WEB
36https://libimobiledevice.org
37
38https://github.com/libimobiledevice/libimobiledevice
diff --git a/docs/idevicesyslog.1 b/docs/idevicesyslog.1
index 178d7c5..5a677b6 100644
--- a/docs/idevicesyslog.1
+++ b/docs/idevicesyslog.1
@@ -1,26 +1,160 @@
1.TH "idevicesyslog" 1 1.TH "idevicesyslog" 1
2.SH NAME 2.SH NAME
3idevicesyslog \- Relay syslog of a connected iPhone/iPod Touch. 3idevicesyslog \- Relay syslog of a connected device.
4.SH SYNOPSIS 4.SH SYNOPSIS
5.B idevicesyslog 5.B idevicesyslog
6[OPTIONS] 6[OPTIONS]
7 7
8.SH DESCRIPTION 8.SH DESCRIPTION
9 9
10Relay syslog of a connected iPhone/iPod Touch. 10Relay syslog of a connected device.
11 11
12.SH OPTIONS 12.SH OPTIONS
13.TP 13.TP
14.B \-u, \-\-udid UDID
15target specific device by UDID
16.TP
17.B \-n, \-\-network
18connect to network device
19.TP
20.B \-x, \-\-exit
21exit when device disconnects
22.TP
14.B \-d, \-\-debug 23.B \-d, \-\-debug
15enable communication debugging. 24enable communication debugging
16.TP 25.TP
17.B \-u, \-\-uuid UUID
18target specific device by its 40-digit device UUID
19.TP
20.B \-h, \-\-help 26.B \-h, \-\-help
21prints usage information. 27prints usage information
28.TP
29.B \-v, \-\-version
30Prints version information.
31.TP
32.B \-\-no\-colors
33disable colored output
34.TP
35.B \-o, \-\-output FILE
36Write to FILE instead of stdout. This will disable writing colored output, but can be re-enabled with \f[B]\-\-colors\f[].
37If FILE already exists, it will be overwritten without warning.
38.TP
39.B \-\-colors
40Force writing colored output, e.g. when using \f[B]\-\-output\f[].
41.TP
42.B \-\-syslog\-relay
43Use old syslog_relay service instead of os_trace_relay (iOS 9+).
44
45.SH COMMANDS
46.TP
47.B pidlist
48Print a list with PID and name of all processes currently running on the device.
49.TP
50.B archive PATH
51Request a logarchive from the device. It will be written in tar format to PATH. To pipe to another process use \- as PATH.
52Below are some options to restrict the log message data.
53
54In 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
58This will also print the filenames while they are extracted.
59.TP
60Further options for \f[B]archive\f[]:
61.TP
62.B \-\-start\-time VALUE
63Start time of the log data as UNIX timestamp. Earlier messages will be dropped.
64.TP
65.B \-\-age\-limit VALUE
66Maximum age of the log data, supposedly number of days.
67.TP
68.B \-\-size\-limit VALUE
69Limit the size of the archive. The unit is currently unknown, so feel free to experiment.
70.TP
71Keep 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.
72
73.SH FILTER OPTIONS
74.TP
75.B \-m, \-\-match STRING
76only print messages that contain STRING
77.TP
78.B \-M, \-\-unmatch STRING
79print messages that do not contain STRING
80.TP
81.B \-t, \-\-trigger STRING
82start logging when matching STRING
83
84When specified, logging will start as soon as a log messages is encountered that contains the given string. See also
85\f[B]\-T, \-\-untrigger\f[]. Other filters are still applied but obviously filtered messages are only printed after logging has started.
86.TP
87.B \-T, \-\-untrigger STRING
88stop logging when matching STRING
22 89
23.SH AUTHOR 90When specified logging will halt as soon as a log message is encountered that contains the given string. See also
24Martin Szulecki 91\f[B]\-t, \-\-trigger\f[]. Other filters are still applied but obviously filtered messages are only printed before logging stops.
92
93NOTE: If no \f[B]\-\-trigger\f[] is given, idevicesyslog will exit after a matching log message was encountered.
94.TP
95.B \-p, \-\-process PROCESS
96only print messages from matching process(es)
97
98PROCESS is a string that can either be a numeric pid or a process name. It also supports multiple process names or pids in one string, separated by | (make sure to use quotes!).
99.TP
100.B \-e, \-\-exclude PROCESS
101print all messages except matching process(es)
102
103PROCESS is a string that can either be a numeric pid or a process name. It also supports multiple process names or pids in one string, separated by | (make sure to use quotes!).
104.TP
105.B \-q, \-\-quiet
106set a filter to exclude common noisy processes
107
108Since the syslog can be quite noisy, this quick command line switch allows silencing a predefined set of commonly known processes. The list of processes that are silenced can be retrieved with \f[B]\-\-quiet\-list\f[].
109.TP
110.B \-\-quiet\-list
111prints the list of processes for \f[B]\-\-quiet\f[] and exits
112.TP
113.B \-k, \-\-kernel
114only print kernel messages
115
116This is actually equivalent to passing \f[B]\-\-process kernel\f[] with the exception that it can be used with \f[B]\-\-quiet\f[] to silence out the noisy process but still get all the kernel log messages.
117.TP
118.B \-K, \-\-no\-kernel
119suppress kernel messages
120
121This is equivalent to passing \f[B]\-\-exclude kernel\f[].
122
123.SH EXAMPLES
124.TP
125.B idevicesyslog \-u 00008030\-0000111ABC000DEF
126Relay syslog of device with UDID 00008030-0000111ABC000DEF.
127.TP
128.B idevicesyslog \-x
129Relay syslog of device and exit when the device is unplugged.
130.TP
131.B idevicesyslog \-m '####' \-e 'identityservicesd' \-K
132Only print log messages that contain the string #### and do NOT originate from identityservicesd or the kernel.
133.TP
134.B idevicesyslog \-p MyApp \-p ReportCrash
135Only print log messages from the process named 'MyApp' and 'ReportCrash'.
136.TP
137.B idevicesyslog \-p 'MyApp|ReportCrash'
138Same as previous example with different syntax.
139.TP
140.B idevicesyslog \-e 'backboardd|CommCenter|mDNSResponder'
141Suppress log messages from backboardd, CommCenter, and mDNSResponder.
142.TP
143.B idevicesyslog \-q \-k
144Suppress log messages from common noisy processes, but DO print kernel log messages.
145.TP
146.B idevicesyslog \-K
147Suppress log messages from kernel, but print everything else
148.TP
149.B idevicesyslog \-t 'backlight on' \-T 'backlight off' \-q
150Start logging when the device turns on backlight and stop logging when it turns backlight off, and suppress noisy processes
151
152.SH AUTHORS
153Nikias Bassen, Martin Szulecki
25 154
26Man page written to conform with Debian by Julien Lavergne. 155Man page written to conform with Debian by Julien Lavergne.
156
157.SH ON THE WEB
158https://libimobiledevice.org
159
160https://github.com/libimobiledevice/libimobiledevice