diff options
Diffstat (limited to 'docs')
31 files changed, 2639 insertions, 102 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index d788297..8156d4f 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,4 +1,25 @@ -man_MANS = idevice_id.1 ideviceinfo.1 idevicesyslog.1 idevicebackup.1 idevicebackup2.1 ideviceimagemounter.1 idevicescreenshot.1 idevicepair.1 ideviceenterrecovery.1 idevicedate.1 ideviceprovision.1 idevicedebugserverproxy.1 idevicediagnostics.1 idevicecrashreport.1 idevicename.1 idevicedebug.1 idevicenotificationproxy.1 +man_MANS = \ + idevice_id.1 \ + ideviceinfo.1 \ + idevicebtlogger.1 \ + idevicesyslog.1 \ + idevicebackup.1 \ + idevicebackup2.1 \ + ideviceimagemounter.1 \ + idevicescreenshot.1 \ + idevicepair.1 \ + ideviceenterrecovery.1 \ + idevicedate.1 \ + ideviceprovision.1 \ + idevicedebugserverproxy.1 \ + idevicediagnostics.1 \ + idevicecrashreport.1 \ + idevicename.1 \ + idevicedebug.1 \ + idevicedevmodectl.1 \ + idevicenotificationproxy.1 \ + idevicesetlocation.1 \ + afcclient.1 EXTRA_DIST = $(man_MANS) diff --git a/docs/afcclient.1 b/docs/afcclient.1 new file mode 100644 index 0000000..a4eeacb --- /dev/null +++ b/docs/afcclient.1 @@ -0,0 +1,74 @@ +.TH "afcclient" 1 +.SH NAME +afcclient \- Interact with AFC/HouseArrest service on a connected device. +.SH SYNOPSIS +.B afcclient +[OPTIONS] [COMMAND ...] + +.SH DESCRIPTION + +Utility to interact with AFC/HouseArrest service. This allows access to parts +of the filesystem on an iOS device. + +\f[B]afcclient\f[] can be used interactively with a command prompt, or run a single command and exit. + +.SH COMMANDS +.TP +.B devinfo +print device information +.TP +.B info PATH +print file attributes of file at PATH +.TP +.B ls PATH +print directory contents of PATH +.TP +.B mv OLD NEW +rename file OLD to NEW +.TP +.B mkdir PATH +create directory at PATH +.TP +.B ln [-s] FILE [LINK] +Create a (symbolic) link to file named LINKNAME. \f[B]NOTE: This feature has been disabled in newer versions of iOS\f[]. +.TP +.B rm [-rf] PATH +remove item at PATH +.TP +.B get [-rf] PATH [LOCALPATH] +transfer file at PATH from device to LOCALPATH, or current directory if omitted. If LOCALPATH is a directory, the file will be stored inside the directory. +.TP +.B put [-rf] LOCALPATH [PATH] +transfer local file at LOCALPATH to device at PATH, or current directory if omitted. If PATH is a directory, the file will be stored inside the directory. +.TP + +.SH OPTIONS +.TP +.B \-u, \-\-udid UDID +target specific device by UDID +.TP +.B \-n, \-\-network +connect to network device (not recommended, since the connection might be terminated at any time) +.TP +.B \--container <appid> +Access the app container directory of the app with given \f[B]appid\f[] +.TP +.B \--documents <appid> +Access the Documents directory of the app with given \f[B]appid\f[] +.TP +.B \-h, \-\-help +Prints usage information +.TP +.B \-d, \-\-debug +Enable communication debugging +.TP +.B \-v, \-\-version +Prints version information + +.SH AUTHOR +Nikias Bassen + +.SH ON THE WEB +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/doxygen/custom.css b/docs/doxygen/custom.css new file mode 100644 index 0000000..62183bf --- /dev/null +++ b/docs/doxygen/custom.css @@ -0,0 +1,1722 @@ +body, table, div, p, dl { + font: 14px -apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji; + line-height: 1.5; +} + +/* @group Heading Levels */ + +h1.groupheader { + font-size: 28px; +} + +.title { + font: inherit; + font-size: 2rem; + font-weight: bold; + margin: 0; + padding-bottom: 0.3rem; + border-bottom: 1px solid #eaecef; +} + +h2.groupheader { + border-bottom: none; + color: rgb(36, 41, 46); + font-size: 1.5rem; + font-weight: bold; + margin: 1.75rem 0px 1rem 0px; + padding: 0 0.3rem 0 0; + border-bottom: 1px solid #eaecef; + width: 100%; +} + +h3.groupheader { + font-size: 100%; +} + +h1, h2, h3, h4, h5, h6 { + -webkit-transition: text-shadow 0.5s linear; + -moz-transition: text-shadow 0.5s linear; + -ms-transition: text-shadow 0.5s linear; + -o-transition: text-shadow 0.5s linear; + transition: text-shadow 0.5s linear; +} + +.textblock h1, +.textblock h2, +.textblock h3, +.textblock h4, +.textblock h5, +.textblock h6 { + margin: 1.75rem 0px 1rem 0px; + padding: 0 0.3rem 0 0; + border-bottom: 1px solid #eaecef; +} + +h1 { + font-size: 1.75rem; +} + +h2 { + color: rgb(36, 41, 46); + font-size: 1.5rem; + font-weight: bold; + margin: 1.75rem 0 1rem 0px; +} + +h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { + text-shadow: 0 0 15px #1fa4a9; +} + +dt { + font-weight: bold; +} + +div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; +} + +p.startli, p.startdd, p.starttd { + margin-top: 2px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.qindex, div.navtab { + background-color: #fff; + border: 1px solid #d1d5da; + padding: 0; + border-radius: 3px; + text-align: left; +} + +div.qindex, div.navpath { + width: auto; + line-height: 140%; +} + +div.navtab { + margin-right: 2rem; +} + +@media (max-width: 576px) { + .contents td.top:not(.mempage), + div.navtab { + display: none; + } +} + +div.navtab table { + border-spacing: 0; +} + +div.navtab table td.navtab { + position: relative; + display: block; + padding: 8px 10px; + border-bottom: 1px solid #e1e4e8; +} + +div.navtab table td.navtab:hover { + background-color: #f6f8fa; +} + +/* @group Link Styling */ + +a { + color: #005082; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #005082; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: #fff; + color: inherit; + border: none; +} + +a.qindexHL:before { + position: absolute; + top: 0; + bottom: 0; + left: 0; + width: 2px; + content: ""; + background-color: #f7ae1a; +} + +.contents a.qindexHL:visited { + color: inherit; +} + +a.el { + font-weight: normal; +} + +a.elRef { +} + +a.code, a.code:visited { + color: #3465a4; +} + +a.codeRef, a.codeRef:visited { + color: #3465a4; +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +pre.fragment { + border: 1px solid rgb(221, 221, 221); + border-radius: 3px; + background-color: rgb(248, 248, 248); + padding: 1rem; + margin: 1rem 0px; + overflow: auto; + word-wrap: break-word; + font-size: inherit; + line-height: inherit; + font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace; +} + +div.fragment { + padding: 1rem; + margin: 1rem 0px; + border: solid 1px rgb(221, 221, 221); + border-radius: 3px; + background-color: rgb(248, 248, 248); +} + +div.line { + font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace; + font-size: inherit; + min-height: 1rem; + line-height: inherit; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + text-indent: initial; + padding-left: initial; + padding-bottom: 0px; + margin: 0px; + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; + display: inline-block; + min-width: 100%; +} + +div.line.glow { + background-color: cyan; + box-shadow: 0 0 10px cyan; +} + + +span.lineno { + padding-right: 4px; + text-align: right; + border-right: 2px solid #0F0; + background-color: #E8E8E8; + white-space: pre; +} +span.lineno a { + background-color: #D8D8D8; +} + +span.lineno a:hover { + background-color: #C8C8C8; +} + +div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; + box-shadow: 2px 2px 3px #999; + -webkit-box-shadow: 2px 2px 3px #999; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); + background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000); +} + +div.groupHeader { + margin-left: 0px; + margin-top: 9px; + margin-bottom: 4.7px; + + font-size: 19px; + font-weight: normal; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background-color: white; + color: rgb(36, 41, 46); + margin: 0; +} + +div.contents { + padding: 1rem 2rem; + margin: 0; +} + +td.indexkey { + background-color: #EBEFF6; + font-weight: bold; + border: 1px solid #C4CFE5; + margin: 2px 0px 2px 0; + padding: 2px 10px; + white-space: nowrap; + vertical-align: top; +} + +td.indexvalue { + background-color: #EBEFF6; + border: 1px solid #C4CFE5; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #EEF1F7; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { +} + +img.formulaInl { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +address.footer { + text-align: left; + margin-left: 2rem; + margin-right: 2rem; + margin-bottom: 1rem; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000; +} + +span.keywordtype { + color: #604020; +} + +span.keywordflow { + color: #e08000; +} + +span.comment { + color: #800000; +} + +span.preprocessor { + color: #806020; +} + +span.stringliteral { + color: #002080; +} + +span.charliteral { + color: #008080; +} + +span.vhdldigit { + color: #ff00ff; +} + +span.vhdlchar { + color: #000000; +} + +span.vhdlkeyword { + color: #700070; +} + +span.vhdllogic { + color: #ff0000; +} + +blockquote { + background-color: #F7F8FB; + border-left: 2px solid #9CAFD4; + margin: 0 24px 0 4px; + padding: 0 12px 0 16px; +} + +/* @end */ + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #A3B4D7; +} + +th.dirtab { + background: #EBEFF6; + font-weight: bold; +} + +hr { + height: 0px; + border: none; + border-top: 1px solid #e1e4e8; +} + +hr.footer { + height: 0px; + border-top: 1px solid #e1e4e8; + margin-left: 2rem; + margin-right: 2rem; +} + +/* @group Member Descriptions */ + +table.memberdecls { + border-spacing: inherit; + padding: 0px; + background-color: transparent; + border-color: #c8e1ff; +} + +table.memberdecls tr:not(.heading) { + background-color: #f1f8ff; +} + +table.memberdecls tr:not(.heading) td.ititle { + background-color: #fff; + border: none; +} + +.memberdecls td, .fieldtable tr { + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +.memberdecls td.glow, .fieldtable tr.glow { + background-color: #1fa4a9; + box-shadow: none; +} + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: transparent; + border: none; + margin: 0; + padding: 1rem 1rem 0.5rem 1rem; + font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace; +} + +.mdescLeft, +.memItemLeft, +.memTemplItemLeft { + border-left: 1px solid #c8e1ff; +} + +.mdescRight, +.memItemRight, +.memTemplItemRight { + border-right: 1px solid #c8e1ff; +} + +.memberdecls tr:nth-child(2) td { + border-top: 1px solid #c8e1ff; + padding-bottom: 1rem; +} + +.memberdecls tr:last-child td { + border-bottom: none; + padding-bottom: 1rem; +} + +.memberdecls tr:nth-last-child(2) td { + padding-bottom: 1rem; +} + +.mdescLeft, .mdescRight { + padding: 0 1rem 1rem 1rem; + color: black; + + /* font-family: "Lucida Grande", "Lucida Sans Unicode", Helvetica, Arial, Verdana, sans-serif; */ + font-style: normal; +} + +.memSeparator { + background-color: #fff; + border-top: 1px solid #c8e1ff; + border-bottom: 1px solid #c8e1ff; + line-height: 0.5rem; + margin: 0px; + padding: 0px; +} + +tr:last-child .memSeparator { + border-bottom: none; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memItemRight { + width: 100%; +} + +.mdescRight a.el:first-child, +.memItemRight a.el:first-child, +.memTemplItemRight a.el:first-child { + font-weight: bold; +} + +.memTemplParams { + color: #005082; + white-space: nowrap; + font-size: 80%; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtitle { + padding: 0 0.3rem 0 0; + border: none; + border-bottom: 1px solid #eaecef; + margin: 0 0 1.75rem 0; + line-height: inherit; + background: none; + font-weight: bold; + font-size: 2rem; + width: 100%; + float: left; +} + +.permalink { + font-size: 65%; + display: inline-block; + vertical-align: middle; + display: none; +} + +.permalink a:hover { + text-decoration: none; +} + +.memtemplate { + font-size: 100%; + color: black; + font-weight: normal; + margin-left: 1px; +} + +.memnav { + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.mempage { + width: 100%; +} + +.memitem { + padding: 0; + margin-bottom: 2rem; + margin-right: 0; + -webkit-transition: box-shadow 0.5s linear; + -moz-transition: box-shadow 0.5s linear; + -ms-transition: box-shadow 0.5s linear; + -o-transition: box-shadow 0.5s linear; + transition: box-shadow 0.5s linear; + display: table !important; + width: 100%; + background-color: #f1f8ff; + border-color: #c8e1ff; +} + +.memitem.glow { + box-shadow: 0 0 15px #1fa4a9; +} + +.memname { + font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace; + margin-left: 0px; + border-spacing: initial; +} + +.memname td { + font-weight: bold; + vertical-align: bottom; +} + +.memproto, dl.reflist dt { + border: none; + border: 1px solid #c8e1ff; + padding: 1rem; + color: black; + font-weight: bold; + text-shadow: none; + background-image: none; + background-color: #f1f8ff; + /* opera specific markup */ + box-shadow: none; + border-top-right-radius: 0px; + border-top-left-radius: 0px; + /* firefox specific markup */ + -moz-box-shadow: none; + -moz-border-radius-topright: 0px; + -moz-border-radius-topleft: 0px; + /* webkit specific markup */ + -webkit-box-shadow: none; + -webkit-border-top-right-radius: 0px; + -webkit-border-top-left-radius: 0px; +} + +.memdoc, dl.reflist dd { + border: none; + padding: 6px; + background-color: #FBFCFD; + border-top-width: 0; + background-image: none; + background-color: #FFFFFF; + /* opera specific markup */ + border-bottom-left-radius: 0px; + border-bottom-right-radius: 0px; + box-shadow: none; + /* firefox specific markup */ + -moz-border-radius-bottomleft: 0px; + -moz-border-radius-bottomright: 0px; + -moz-box-shadow: none; + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 0px; + -webkit-border-bottom-right-radius: 0px; + -webkit-box-shadow: none; +} + +dl.reflist dt { + padding: 5px; +} + +dl.reflist dd { + margin: 0px 0px 10px 0px; + padding: 5px; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #01496d; + white-space: nowrap; +} +.paramname em { + font-style: italic; + font-weight: normal; +} +.paramname code { + line-height: 14px; +} + +.params, .retval, .exception, .tparams { + margin-left: 0px; + padding-left: 0px; +} + +.params .paramname, .retval .paramname { + font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace; + font-style: italic; + font-weight: normal; + text-shadow: none; + padding-right: 1rem; +} + +.params .paramtype { + font-style: italic; + vertical-align: top; +} + +.params .paramdir { + font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace; + vertical-align: top; +} + +table.mlabels { + border-spacing: 0px; +} + +td.mlabels-left { + width: 100%; + padding: 0px; +} + +td.mlabels-right { + vertical-align: middle; + padding: 0px; + white-space: nowrap; +} + +span.mlabels { + margin-left: 8px; +} + +span.mlabel { + background-color: rgb(172, 172, 172);; + border: none; + text-shadow: none; + color: white; + margin-right: 4px; + padding: 2px 3px; + border-radius: 4px; + font-size: 9pt; + white-space: nowrap; + vertical-align: middle; +} + +/* @end */ + +/* these are for tree view when not used as main index */ + +div.directory { + border-top: 1px solid #eaecef; + border-left: 1px solid #eaecef; + border-right: 1px solid #eaecef; + border-bottom: 1px solid #eaecef; + margin: 10px 0px; + width: 100%; +} + +.directory table { + border-collapse:collapse; +} + +.directory td { + margin: 0px; + padding: 8px; + vertical-align: middle; + line-height: 1.5rem; +} + +.directory tr { + border-top: 1px solid #eaecef; +} + +.directory tr:first-child { + border-top: none; +} + +.directory td.entry { + white-space: nowrap; + padding: 8px; +} + +@media (max-width: 576px) { + .directory td.entry > span:first-child { + display: none !important; + } +} + +.directory td.entry a { + outline: none; +} + +.directory td.entry a img { + border: none; +} + +.directory td.desc { + width: 100%; + padding: 8px; + border-left: 1px solid rgba(0,0,0,0.05); +} + +.directory tr.even { + padding-left: 0; + background-color: inherit; +} + +.directory tr:not(.even) { + background-color: #f6f8fa; +} + +.directory img { + vertical-align: -30%; +} + +.directory .levels { + display: none; + white-space: nowrap; + width: auto; + text-align: right; + font-size: 0.75rem; + font-weight: bold; + padding: 8px; + border-bottom: 1px solid #eaecef; +} + +.directory .levels span { + cursor: pointer; + padding: 0 0.5rem; + color: #3d578c; +} + +.arrow { + color: #6c757d; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + font-size: inherit; + display: inline-block; + width: 16px; + height: 16px; +} + +.icon { + display: inline-block; + margin: 0; + + font-family: Arial, Helvetica; + font-weight: bold; + font-size: 0.75rem; + text-align: center; + + width: 16px; + height: 16px; + line-height: 16px; + + border-radius: 4px; + background-color: #6194cb; + color: white; +} + +.icona { + width: 16px; + height: 16px; + display: inline-block; + margin-left: 0.25rem; + margin-right: 0.25rem; +} + +.iconfopen { + width: 16px; + height: 16px; + margin-bottom: 0; + background-image:url('folder-open.png'); + background-position: 0px -1px; + background-repeat: no-repeat; + vertical-align: middle; + display: inline-block; + margin-left: 0.25rem; + margin-right: 0.25rem; +} + +.iconfclosed { + width: 16px; + height: 16px; + margin-bottom: 0; + background-image:url('folder.png'); + background-position: 0px 0px; + background-repeat: no-repeat; + vertical-align: middle; + display: inline-block; + margin-left: 0.25rem; + margin-right: 0.25rem; +} + +.icondoc { + width: 16px; + height: 16px; + margin-bottom: 0; + background-image:url('text-x-generic.png'); + background-position: 0px 0px; + background-repeat: no-repeat; + vertical-align: middle; + display: inline-block; + margin-left: 0.25rem; + margin-right: 0.25rem; +} + +/* @end */ + +div.dynheader { + margin-top: 8px; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +address { + font-style: normal; + color: #2A3D61; +} + +table.doxtable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +table.fieldtable { + margin-bottom: 10px; + border: 1px solid #c6cbd1; + border-spacing: 0px; + -moz-border-radius: 3px; + -webkit-border-radius: 3px; + border-radius: 3px; + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; + font-size: 1rem; +} + +.fieldtable td, .fieldtable th { + padding: 0.5rem 1rem; +} + +.fieldtable td.fieldtype, .fieldtable td.fieldname { + white-space: nowrap; + border-right: 1px solid #c6cbd1; + border-bottom: 1px solid #c6cbd1; + vertical-align: middle; +} + +.fieldtable td.fieldname { + padding-top: 0.5rem; + font-style: italic; +} + +.fieldtable td.fielddoc { + border-bottom: 1px solid #c6cbd1; +} + +.fieldtable td.fielddoc p { + font-size: 1rem; +} + +.fieldtable td.fielddoc p:first-child { + margin-top: 0px; +} + +.fieldtable td.fielddoc p:last-child { + margin-bottom: 2px; +} + +.fieldtable tr:last-child td { + border-bottom: none; +} + +.fieldtable tbody tr:nth-of-type(odd) { + background-color: #f6f8fa; +} + +.fieldtable th { + background-image: none; + background-repeat:repeat-x; + background-color: #fff; + font-size: inherit; + font-weight: bold; + color: inherit; + padding: 0.5rem 1rem; + text-align: inherit; + -moz-border-radius-topleft: 3px; + -moz-border-radius-topright: 3px; + -webkit-border-top-left-radius: 3px; + -webkit-border-top-right-radius: 3px; + border-top-left-radius: 3px; + border-top-right-radius: 3px; + border-bottom: 1px solid #c6cbd1; +} + + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: none; + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul { + font-size: 1rem; + background-image: none; + background-repeat: repeat-x; + background-position: 0 -5px; + height:30px; + line-height:30px; + color: inherit; + border: none; + overflow:hidden; + margin:0px; + padding: 0px; +} + +.navpath li { + list-style-type: none; + float: left; + background-image: none; + background-repeat: no-repeat; + background-position: right; + color: inherit; +} + +#top .navpath li+li { + padding-left: .5rem; +} + +#top .navpath li+li::before { + display: inline-block; + padding-right: .5rem; + color: #6c757d; + content: "/"; +} + +@media (min-width: 576px) { + address.footer .navpath li+li { + padding-left: .5rem; + } + + address.footer .navpath li+li::before { + display: inline-block; + padding-right: .5rem; + color: #6c757d; + content: "/"; + } +} + +.navpath li.navelem a { + height:32px; + display: inline-block; + text-decoration: none; + outline: none; + color: inherit; + font-family: inherit; + text-shadow: none; + text-decoration: none; +} + +.navpath li.navelem a:hover { + color: inherit; +} + +address.footer { + text-align: left; + padding-right: 0; +} + +address.footer ul.navpath { + display: inline-block; + padding: 0; +} + +.navpath li.footer { + list-style-type: none; + float: left; + padding-left: 0.5rem; + padding-right: 0; + background-image: none; + background-repeat: no-repeat; + background-position: right; + color: inherit; + font-size: 0.75rem; +} + +div.summary { + float: none; + font-size: 0.75rem; + padding-right: 5px; + width: 100%; + text-align: left; +} + +div.summary a { + white-space: nowrap; +} + +div.ingroups { + font-size: 0.75rem; + width: 50%; + text-align: left; +} + +div.ingroups a { + white-space: nowrap; +} + +div.header { + background-image: none; + background-color: white; + padding: 1rem 2rem 0 2rem; + margin: 0px; + border: none; +} + +div.headertitle { + margin: 1rem 0px 0rem 0px; + padding: 0 0.3rem 0 0; +} + +dl { + padding: 0 0 0 10px; +} + +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */ +dl.section { + margin-left: 0px; + padding-left: 0px; +} + +dl.note { + margin-left: 0px; + padding: 1rem; + border-left: 6px solid; + border: 1px solid rgba(27,31,35,.15); + background-color: #fffbdd; + color: #735c0f; +} + +dl.section.note dd { + margin-left: 0; + margin-bottom: 0; +} + +dl.warning, dl.attention { + margin-left: 0px; + padding: 1rem; + + border-left: 6px solid; + border-color: #ab2333; +} + +dl.pre, dl.post, dl.invariant { + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #4e9a06; +} + +dl.deprecated { + margin-left: 0px; + padding: 1rem; + border-left: 6px solid; + border-color: #505050; +} + +dl.deprecated dt a.el { +} + +dl.todo { + margin-left: 0px; + padding: 1rem; + border-left:4px solid; + border-color: #04898e; +} + +dl.test { + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #21376d; +} + +dl.bug { + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #8f5902; +} + +dl.section dd { + margin-bottom: 0.5rem; +} + + +#projectlogo { + text-align: center; + vertical-align: bottom; + border-collapse: separate; + padding-right: 1rem; +} + +#projectlogo img { + border: 0px none; + width: 8rem; + height: auto; +} + +#projectname { + font: inherit; + font-size: 300%; + margin: 0px; + padding: 2px 0px; +} + +#projectbrief { + font: inherit; + font-size: 120%; + margin: 0px; + padding: 0px; +} + +#projectnumber { + font: inherit; + font-size: 50%; + margin: 0px; + padding: 0px; +} + +#titlearea { + padding: 1rem; + margin: 0px; + width: auto; + border-bottom: none; + background-color: #fafbfc; +} + +.image { + text-align: center; +} + +.dotgraph { + text-align: center; +} + +.mscgraph { + text-align: center; +} + +.caption { + font-weight: bold; +} + +div.zoom { + border: 1px solid #90A5CE; +} + +dl.citelist { + margin-bottom:50px; +} + +dl.citelist dt { + color:#334975; + float:left; + font-weight:bold; + margin-right:10px; + padding:5px; +} + +dl.citelist dd { + margin:2px 0; + padding:5px 0; +} + +div.toc { + padding: 14px 25px; + background-color: #F4F6FA; + border: 1px solid #D8DFEE; + border-radius: 7px 7px 7px 7px; + float: right; + height: auto; + margin: 0 20px 10px 10px; + width: 200px; +} + +div.toc li { + background: url("bdwn.png") no-repeat scroll 0 5px transparent; + font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; + margin-top: 5px; + padding-left: 10px; + padding-top: 2px; +} + +div.toc h3 { + font: bold 12px/1.2 Arial,FreeSans,sans-serif; + color: #4665A2; + border-bottom: 0 none; + margin: 0; +} + +div.toc ul { + list-style: none outside none; + border: medium none; + padding: 0px; +} + +div.toc li.level1 { + margin-left: 0px; +} + +div.toc li.level2 { + margin-left: 15px; +} + +div.toc li.level3 { + margin-left: 30px; +} + +div.toc li.level4 { + margin-left: 45px; +} + +.inherit_header { + font-weight: bold; + color: gray; + cursor: pointer; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.inherit_header td { + padding: 6px 0px 2px 5px; +} + +.inherit { + display: none; +} + +tr.heading h2 { + padding-top: 1.75rem; + margin-top: 0; + margin-bottom: 1rem; +} + +@media print +{ + #top { display: none; } + #side-nav { display: none; } + #nav-path { display: none; } + body { overflow:visible; } + h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } + .summary { display: none; } + .memitem { page-break-inside: avoid; } + #doc-content { + margin-left:0 !important; + height:auto !important; + width:auto !important; + overflow:inherit; + display:inline; + } +} + + +.tabs, .tabs2, .tabs3 { + background-image: none; + background-color: #fafbfc; + color: #24292e; + padding: 0 1rem; + font-family: inherit; + font-size: inherit; + width: auto; +} + +.tabs { + border-bottom: 1px solid #e1e4e8; +} + +.tablist { + position: relative; + top: 1px; +} + +.tabs2 { + margin-top: 1rem; + border-bottom: 1px solid #e1e4e8; + background-color: #fff; +} + +.tabs3 { + margin-top: 1rem; + border-bottom: 1px solid #e1e4e8; + background-color: #fff; +} + +.tablist li { + background-image: none; +} + +.tablist a { + background-image: none; + text-shadow: none; + color: #586069; + border: 1px solid transparent; + border-top: 3px solid transparent; + border-radius: 3px 3px 0 0; + padding: 0 1rem; +} + +.tablist a:hover { + background-image: none; + text-shadow: none; + color: #24292e; +} + +.tablist li.current a { + text-shadow: none; + background-image: none; + background-color: #fff; + color: #24292e; +} + +#navrow1 .tablist li.current a { + border-color: #f7ae1a #e1e4e8 transparent; +} + +#navrow2 .tablist li.current a { + border-color: #e45e25 #e1e4e8 transparent; +} + +#navrow3 .tablist li.current a { + border-color: #1fa4a9 #e1e4e8 transparent; +} + +#navrow4 .tablist li.current a { + border-color: #01496d #e1e4e8 transparent; +} + +.tabs li.current { + background-color: #fff; +} + +.tabs2 li.current { + background-color: #fff; +} + +.navpath { + border: none; + margin-top: 1rem; + padding: 0 2rem; +} + +.navpath ul { + background-color: transparent; + border: none; +} + +.navpath li { + padding: 0; +} + +.navpath li.navelem a { + color: #005082; + text-shadow: none; + padding: 0 0.25rem; + font-size: 1rem; +} + +.navpath li.navelem a:hover { + color: #005082; + text-shadow: none; + text-decoration: underline; +} + +/* @group Markdown */ + +table.markdownTable td, +table.markdownTable th { + border: 1px solid #c6cbd1; + padding: 0.5rem 1rem; +} + +.markdownTable tbody tr:nth-of-type(odd) { + background-color: #f6f8fa; +} + +th.markdownTableHeadLeft, +th.markdownTableHeadRight, +th.markdownTableHeadCenter, +th.markdownTableHeadNone { + background-color: #fff; + color: inherit; + font-size: inherit; + font-weight: bold; + padding: 0.5rem 1rem; + text-align: inherit; + -moz-border-radius-topleft: 3px; + -moz-border-radius-topright: 3px; + -webkit-border-top-left-radius: 3px; + -webkit-border-top-right-radius: 3px; + border-top-left-radius: 3px; + border-top-right-radius: 3px; + border-bottom: 1px solid #c6cbd1; +} + +/* @end */ + +@media (max-width: 576px) { + .navpath { + padding: 0 1rem; + } + + .navpath li.navelem a { + padding: 0; + } + + div.header { + padding: 1rem 1rem 0 1rem; + } + + div.contents { + padding: 1rem 1rem 0 1rem; + } + + hr.footer { + margin-left: 1rem; + margin-right: 1rem; + } + + address.footer { + margin-left: 1rem; + margin-right: 1rem; + } + + .memtitle { + font-size: 1.5rem; + word-break: break-all; + } + + .memname td { + float: left; + word-break: break-all; + } + + div.memitem { + margin-bottom: 1rem; + } + + .memdoc table.params { + word-break: break-word; + } + + div.memproto { + display: table; + } + + dl.section dt { + margin-bottom: 0.5rem; + } + + dl.section dd { + margin-left: 0; + word-break: break-word; + } + + .contents > table, + .contents > table thead, + .contents > table tbody, + .contents > table th, + .contents > table td, + .contents > table tr { + display: block; + } + + .contents table.directory, + .contents table.directory thead, + .contents table.directory tbody, + .contents table.directory th, + .contents table.directory td { + display: block; + } + + .contents table.directory tr { + } + + div:not(.PageDoc) .contents table, + div:not(.PageDoc) .contents thead, + div:not(.PageDoc) .contents tbody, + div:not(.PageDoc) .contents th, + div:not(.PageDoc) .contents td, + div:not(.PageDoc) .contents tr { + display: block; + } + + .mdescLeft, + .memItemLeft, + .memTemplItemLeft { + text-align: left; + border-left: 1px solid #c8e1ff; + border-right: 1px solid #c8e1ff; + word-break: break-word; + white-space: normal; + padding-bottom: 0; + } + + table td.mdescLeft { + display: none; + } + + table td.mdescRight, + table td.memItemRight, + table td.memTemplItemRight { + border-top: none !important; + border-left: 1px solid #c8e1ff; + border-right: 1px solid #c8e1ff; + display: table-cell; + word-break: break-word; + padding-top: 0; + } + + .directory td.desc { + display: table-cell; + } + + dl.params dd { + margin-left: 0; + } + + table.params td.paramname { + margin-top: 0.5rem; + } + + #projectlogo img { + border: 0px none; + width: 4rem; + height: auto; + } + + #projectname { + font-size: 1rem; + } + + #projectbrief { + font-size: 0.75rem; + } + + #projectnumber { + font-size: 0.75rem; + } +}
\ No newline at end of file diff --git a/docs/doxygen/favicon.ico b/docs/doxygen/favicon.ico Binary files differnew file mode 100644 index 0000000..b542c5b --- /dev/null +++ b/docs/doxygen/favicon.ico diff --git a/docs/doxygen/folder-open.png b/docs/doxygen/folder-open.png Binary files differnew file mode 100644 index 0000000..b67403d --- /dev/null +++ b/docs/doxygen/folder-open.png diff --git a/docs/doxygen/folder.png b/docs/doxygen/folder.png Binary files differnew file mode 100644 index 0000000..901edc9 --- /dev/null +++ b/docs/doxygen/folder.png 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 @@ +<hr class="footer"/> +<address class="footer"> + <ul class="navpath"> + <li class="footer">© 2007-$year <a href="https://libimobiledevice.org">$projectname</a> All rights reserved</li> + <li class="footer">Generated on <em>$datetime</em> by <a href="https://www.doxygen.org">doxygen $doxygenversion</a></li> + <li class="footer">Icons by <a href="http://tango-project.org/">Tango</a></li> + <li class="footer">Design © $year by <a href="https://mirell.com" target="_blank">Mirell</a></li> + </ui> +</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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="doxygen $doxygenversion"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<!--BEGIN PROJECT_NAME--><title>$title - $projectname $projectnumber</title><!--END PROJECT_NAME--> +<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME--> + +<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/> + +<meta property="og:locale" content="en_US" /> +<meta property="og:type" content="website" /> +<meta property="og:title" content="$projectbrief - $projectname" /> +<meta property="og:url" content="https://libimobiledevice.org/docs/$projectname/$projectnumber/" /> +<meta property="og:site_name" content="$projectname - $projectbrief" /> +<meta name="twitter:card" content="summary_large_image" /> + +<script type="text/javascript" src="$relpath^jquery.js"></script> +<script type="text/javascript" src="$relpath^dynsections.js"></script> +$treeview +$search +$mathjax +<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" /> +$extrastylesheet +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> + +<!--BEGIN TITLEAREA--> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <!--BEGIN PROJECT_LOGO--> + <td id="projectlogo"><a href="$relpath^index.html"><img alt="Logo" src="$relpath^$projectlogo"/></a></td> + <!--END PROJECT_LOGO--> + <!--BEGIN PROJECT_NAME--> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">$projectname + <!--BEGIN PROJECT_NUMBER--> <span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER--> + </div> + <!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief - <a href="https://libimobiledevice.org"><small>Return to Homepage</small></a></div><!--END PROJECT_BRIEF--> + </td> + <!--END PROJECT_NAME--> + <!--BEGIN !PROJECT_NAME--> + <!--BEGIN PROJECT_BRIEF--> + <td style="padding-left: 0.5em;"> + <div id="projectbrief">$projectbrief</div> + </td> + <!--END PROJECT_BRIEF--> + <!--END !PROJECT_NAME--> + <!--BEGIN DISABLE_INDEX--> + <!--BEGIN SEARCHENGINE--> + <td>$searchbox</td> + <!--END SEARCHENGINE--> + <!--END DISABLE_INDEX--> + </tr> + </tbody> +</table> +</div> +<!--END TITLEAREA--> +<!-- 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 @@ +<doxygenlayout version="1.0"> + <!-- Generated by doxygen 1.8.16 --> + <!-- Navigation index tabs for HTML output --> + <navindex> + <tab type="mainpage" visible="yes" title="About"/> + <tab type="modules" visible="yes" title="" intro=""/> + <tab type="namespaces" visible="yes" title=""> + <tab type="namespacelist" visible="yes" title="" intro=""/> + <tab type="namespacemembers" visible="yes" title="" intro=""/> + </tab> + <tab type="interfaces" visible="yes" title=""> + <tab type="interfacelist" visible="yes" title="" intro=""/> + <tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/> + <tab type="interfacehierarchy" visible="yes" title="" intro=""/> + </tab> + <tab type="classes" visible="yes" title=""> + <tab type="classlist" visible="yes" title="" intro=""/> + <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> + <tab type="hierarchy" visible="yes" title="" intro=""/> + <tab type="classmembers" visible="yes" title="" intro=""/> + </tab> + <tab type="structs" visible="yes" title=""> + <tab type="structlist" visible="yes" title="" intro=""/> + <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/> + </tab> + <tab type="exceptions" visible="yes" title=""> + <tab type="exceptionlist" visible="yes" title="" intro=""/> + <tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/> + <tab type="exceptionhierarchy" visible="yes" title="" intro=""/> + </tab> + <tab type="files" visible="yes" title=""> + <tab type="filelist" visible="yes" title="" intro=""/> + <tab type="globals" visible="yes" title="" intro=""/> + </tab> + <tab type="examples" visible="yes" title="" intro=""/> + <tab type="pages" visible="yes" title="" intro=""/> + </navindex> + + <!-- Layout definition for a class page --> + <class> + <briefdescription visible="no"/> + <detaileddescription title="Description"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <inheritancegraph visible="$CLASS_GRAPH"/> + <collaborationgraph visible="$COLLABORATION_GRAPH"/> + <memberdecl> + <nestedclasses visible="yes" title=""/> + <publictypes title=""/> + <services title=""/> + <interfaces title=""/> + <publicslots title=""/> + <signals title=""/> + <publicmethods title=""/> + <publicstaticmethods title=""/> + <publicattributes title=""/> + <publicstaticattributes title=""/> + <protectedtypes title=""/> + <protectedslots title=""/> + <protectedmethods title=""/> + <protectedstaticmethods title=""/> + <protectedattributes title=""/> + <protectedstaticattributes title=""/> + <packagetypes title=""/> + <packagemethods title=""/> + <packagestaticmethods title=""/> + <packageattributes title=""/> + <packagestaticattributes title=""/> + <properties title=""/> + <events title=""/> + <privatetypes title=""/> + <privateslots title=""/> + <privatemethods title=""/> + <privatestaticmethods title=""/> + <privateattributes title=""/> + <privatestaticattributes title=""/> + <friends title=""/> + <related title="" subtitle=""/> + <membergroups visible="yes"/> + </memberdecl> + <memberdef> + <inlineclasses title=""/> + <typedefs title=""/> + <enums title=""/> + <services title=""/> + <interfaces title=""/> + <constructors title=""/> + <functions title=""/> + <related title=""/> + <variables title=""/> + <properties title=""/> + <events title=""/> + </memberdef> + <allmemberslink visible="yes"/> + <usedfiles visible="$SHOW_USED_FILES"/> + <authorsection visible="yes"/> + </class> + + <!-- Layout definition for a namespace page --> + <namespace> + <briefdescription visible="no"/> + <detaileddescription title="Description"/> + <memberdecl> + <nestednamespaces visible="yes" title=""/> + <constantgroups visible="yes" title=""/> + <interfaces visible="yes" title=""/> + <classes visible="yes" title=""/> + <structs visible="yes" title=""/> + <exceptions visible="yes" title=""/> + <typedefs title=""/> + <sequences title=""/> + <dictionaries title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <memberdef> + <inlineclasses title=""/> + <typedefs title=""/> + <sequences title=""/> + <dictionaries title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection visible="yes"/> + </namespace> + + <!-- Layout definition for a file page --> + <file> + <briefdescription visible="no"/> + <detaileddescription title="Description"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <includegraph visible="$INCLUDE_GRAPH"/> + <includedbygraph visible="$INCLUDED_BY_GRAPH"/> + <memberdecl> + <interfaces visible="yes" title=""/> + <classes visible="yes" title=""/> + <structs visible="yes" title=""/> + <exceptions visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <constantgroups visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <sequences title=""/> + <dictionaries title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <memberdef> + <inlineclasses title=""/> + <defines title=""/> + <typedefs title=""/> + <sequences title=""/> + <dictionaries title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection/> + <sourcelink visible="yes"/> + </file> + + <!-- Layout definition for a group page --> + <group> + <briefdescription visible="no"/> + <detaileddescription title="Description"/> + <groupgraph visible="$GROUP_GRAPHS"/> + <memberdecl> + <nestedgroups visible="yes" title=""/> + <dirs visible="yes" title=""/> + <files visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <classes visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <sequences title=""/> + <dictionaries title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + <membergroups visible="yes"/> + </memberdecl> + <memberdef> + <pagedocs/> + <inlineclasses title=""/> + <defines title=""/> + <typedefs title=""/> + <sequences title=""/> + <dictionaries title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + </memberdef> + <authorsection visible="yes"/> + </group> + + <!-- Layout definition for a directory page --> + <directory> + <briefdescription visible="no"/> + <detaileddescription title="Description"/> + <directorygraph visible="yes"/> + <memberdecl> + <dirs visible="yes"/> + <files visible="yes"/> + </memberdecl> + </directory> +</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 Binary files differnew file mode 100644 index 0000000..2d7f2d6 --- /dev/null +++ b/docs/doxygen/text-x-generic.png diff --git a/docs/idevice_id.1 b/docs/idevice_id.1 index e223dcb..caded75 100644 --- a/docs/idevice_id.1 +++ b/docs/idevice_id.1 @@ -1,52 +1,43 @@ .TH "idevice_id" 1 .SH NAME -idevice_id \- Prints device name or a list of attached devices. +idevice_id \- List attached devices or print device name of given device. .SH SYNOPSIS .B idevice_id [OPTIONS] [UDID] .SH DESCRIPTION -Prints device name or a list of attached devices. -UDID is the unique device identifier of the device -for which the name should be retrieved. +\f[B]idevice_id\f[] prints a list of attached devices. If a UDID is given, +the name of the connected device with that UDID will be retrieved. + +Without any options, \f[B]idevice_id\f[] will list all available devices, +USB and network. +The output can be further controlled with the following OPTIONS. .SH OPTIONS .TP .B \-l, \-\-list -list UDID of all attached devices -.TP +List UDIDs of all devices attached via USB. +.TP +.B \-n, \-\-network +List UDIDs of all devices available via network. +.TP .B \-d, \-\-debug -enable communication debugging. -.TP +Enable communication debugging. +.TP .B \-h, \-\-help -prints usage information. -.TP - -.SH AUTHORS - Zach C. - - Jonathan Beck - - Matt Colyer - - Martin Aumueller - - Christophe Fergeau - - Martin S. - - Paul Sladen - - Patrick Walton - - Zoltan Balaton - - Nikias Bassen +Prints usage information. +.TP +.B \-v, \-\-version +Prints version information. +.TP - Todd Zullinger +.SH AUTHOR +Nikias Bassen Man page written to conform with Debian by Julien Lavergne. .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/idevicebackup.1 b/docs/idevicebackup.1 index 517ca2a..6f2a8f9 100644 --- a/docs/idevicebackup.1 +++ b/docs/idevicebackup.1 @@ -7,18 +7,26 @@ idevicebackup \- Create or restore backup for devices. .SH DESCRIPTION -Create or restore backup from the current or specified directory. +Create or restore backup in/from the specified directory. + +\f[B]NOTE\f[]: This tool is outdated. See idevicebackup2(1) for an updated tool. .SH OPTIONS .TP .B \-u, \-\-udid UDID target specific device by UDID. -.TP +.TP +.B \-n, \-\-network +connect to network device. +.TP .B \-d, \-\-debug enable communication debugging. .TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH COMMANDS .TP @@ -35,5 +43,10 @@ Nikias Bassen Man page written to conform with Debian by Julien Lavergne. +.SH SEE ALSO +idevicebackup2(1) + .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/idevicebackup2.1 b/docs/idevicebackup2.1 index 6c40929..79b6dc4 100644 --- a/docs/idevicebackup2.1 +++ b/docs/idevicebackup2.1 @@ -7,7 +7,7 @@ idevicebackup2 \- Create or restore backups for devices running iOS 4 or later. .SH DESCRIPTION -Create or restore backup from the current or specified directory. +Create or restore backup in/from the specified directory. .SH OPTIONS .TP @@ -19,26 +19,35 @@ use backup data from device specified by UDID. .TP .B \-i, \-\-interactive request passwords interactively on the command line. -.TP +.TP +.B \-n, \-\-network +connect to network device. +.TP .B \-d, \-\-debug enable communication debugging. -.TP +.TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH COMMANDS .TP .B backup create backup for the device. .TP +.B \t\-\-full +force full backup from device. +.TP .B restore restore last backup to the device. .TP .B \t\-\-system restore system files, too. .TP -.BI \t\-\-reboot -reboot the system when done. +.B \t\-\-no\-reboot +do NO reboot the system when done. .TP .B \t\-\-copy create a copy of backup folder before restoring. @@ -49,8 +58,13 @@ restore device settings from the backup. .B \t\-\-remove remove items which are not being restored. .TP +.B \t\-\-skip-apps +do not trigger re-installation of apps after restore. +.TP .B \t\-\-password PWD -supply the password of the source backup. +supply the password for the encrypted source backup. If omitted, the password +will be requested in interactive mode (\f[B]\-i\f[]), or it can be passed using +the environment variable \f[B]BACKUP_PASSWORD\f[]. .TP .B info show details about last completed backup of device. @@ -58,18 +72,33 @@ show details about last completed backup of device. .B list list files of last completed backup in CSV format. .TP +.B unback +unpack a completed backup in DIRECTORY/_unback_/ +.TP .B encryption on|off [PWD] -enable or disable backup encryption. +enable or disable backup encryption. The password will be requested in +interactive mode (\f[B]\-i\f[]) if omitted, or it can be passed using the +environment variable \f[B]BACKUP_PASSWORD\f[]. .TP .B changepw [OLD NEW] -change backup password on target device. +change backup password on target device. The passwords will be requested in +interactive mode (\f[B]\-i\f[]) if omitted, or they can be passed using the +environment variables \f[B]BACKUP_PASSWORD\f[] (old password) and +\f[B]BACKUP_PASSWORD_NEW\f[] (new password) respectively. +.TP +.B cloud on|off +enable or disable cloud use (requires iCloud account). +.SH SECURITY CONSIDERATIONS +Passing passwords on the command line is not advised, since it might reveal +the backup password to other users via process list or command line history. +Use interactive mode (\f[B]\-i\f[]) or pass them via environment variable(s) +as mentioned in the description of the respective commands above. .SH AUTHORS Martin Szulecki Nikias Bassen -.SH SEE ALSO -idevicebackup(1) - .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://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 @@ +.TH "idevicebtlogger" 1 +.SH NAME +idevicebtlogger \- Capture HCI traffic of a connected device. +.SH SYNOPSIS +.B idevicebtlogger +[OPTIONS] +<FILE> + +.SH DESCRIPTION + +Capture HCI traffic of a connected device. Requires Bluetooth logging profile to be installed on device with iOS 13 or higher. See https://www.bluetooth.com/blog/a-new-way-to-debug-iosbluetooth-applications/ for iOS device configuration. + +The HCI traffic can be stored in Apple's native PacketLogger format or converted into PCAP format for live feedback in Wireshark. + +.SH OPTIONS +.TP +.B \-u, \-\-udid UDID +target specific device by UDID +.TP +.B \-n, \-\-network +connect to network device +.TP +.B \-f, \-\-format FORMAT +set log format: PacketLogger (default), or pcap +.TP +.B \-x, \-\-exit +exit when device disconnects +.TP +.B \-d, \-\-debug +enable communication debugging +.TP +.B \-h, \-\-help +prints usage information +.TP +.B \-v, \-\-version +prints version information. + +.SH EXAMPLES +.TP +.B idevicebtlogger \-u 00008030\-0000111ABC000DEF +Capture HCI traffic of device with UDID 00008030-0000111ABC000DEF. +.TP +.B idevicebtlogger \-x +Capture HCI traffic of device and exit when the device is unplugged. +.TP +.B idevicebtlogger \-f pcap +Capture HCI traffic of device in PCAP format. +.TP +.B idevicebtlogger -f pcap - | wireshark -k -i - +Capture HCI traffic and pipe it into Wireshark for live feedback. + +.SH AUTHORS +Geoffrey Kruse + +Matthias Ringwald + +.SH ON THE WEB +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/idevicecrashreport.1 b/docs/idevicecrashreport.1 index a3742e7..6acd6e9 100644 --- a/docs/idevicecrashreport.1 +++ b/docs/idevicecrashreport.1 @@ -15,6 +15,12 @@ the device to the target DIRECTORY. .SH OPTIONS .TP +.B \-u, \-\-udid UDID +target specific device by UDID. +.TP +.B \-n, \-\-network +connect to network device. +.TP .B \-e, \-\-extract extract raw crash report into separate '.crash' files. .TP @@ -24,11 +30,14 @@ copy but do not remove crash reports from device. .B \-d, \-\-debug enable communication debugging. .TP -.B \-u, \-\-udid UDID -target specific device by UDID. +.B \-f, \-\-filter NAME +filter crash reports by NAME (case sensitive) .TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH AUTHOR Martin Szulecki @@ -36,4 +45,6 @@ Martin Szulecki Nikias Bassen .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/idevicedate.1 b/docs/idevicedate.1 index adb091a..dcdc57e 100644 --- a/docs/idevicedate.1 +++ b/docs/idevicedate.1 @@ -11,12 +11,15 @@ Simple utility to manage the clock on a device. .SH OPTIONS .TP -.B \-d, \-\-debug -enable communication debugging. -.TP .B \-u, \-\-udid UDID target specific device by UDID. .TP +.B \-n, \-\-network +connect to network device. +.TP +.B \-d, \-\-debug +enable communication debugging. +.TP .B \-s, \-\-set TIMESTAMP set UTC time described by TIMESTAMP .TP @@ -25,9 +28,14 @@ set time of device to current system time .TP .B \-h, \-\-help prints usage information +.TP +.B \-v, \-\-version +prints version information. .SH AUTHOR Martin Szulecki .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/idevicedebug.1 b/docs/idevicedebug.1 index 2024842..7314baa 100644 --- a/docs/idevicedebug.1 +++ b/docs/idevicedebug.1 @@ -12,18 +12,24 @@ command is "run" and allows execution of developer apps and watch the stdout/stderr of the process. .SH OPTIONS -.TP -.B \-e, \-\-env NAME=VALUE -set environment variable NAME to VALUE. .TP .B \-u, \-\-udid UDID target specific device by UDID. -.TP +.TP +.B \-n, \-\-network +connect to network device. +.TP +.B \-e, \-\-env NAME=VALUE +set environment variable NAME to VALUE. +.TP .B \-d, \-\-debug enable communication debugging. -.TP +.TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH COMMANDS .TP @@ -34,4 +40,6 @@ run app with BUNDLEID and optional ARGS on device. Martin Szulecki .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/idevicedebugserverproxy.1 b/docs/idevicedebugserverproxy.1 index e2372e6..69200ee 100644 --- a/docs/idevicedebugserverproxy.1 +++ b/docs/idevicedebugserverproxy.1 @@ -3,7 +3,7 @@ idevicedebugserverproxy \- Remote debugging proxy. .SH SYNOPSIS .B idevicedebugserverproxy -[OPTIONS] PORT +[OPTIONS] [PORT] .SH DESCRIPTION @@ -18,20 +18,32 @@ The developer disk image needs to be mounted for this service to be available. .TP .B \-u, \-\-udid UDID target specific device by UDID. -.TP +.TP +.B \-n, \-\-network +connect to network device. +.TP +.B \-l, \-\-lldb +Enable lldb support. +.TP .B \-d, \-\-debug enable communication debugging. -.TP +.TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH USAGE .TP .B PORT The port under which the proxy should listen for connections from clients. +If omitted, the next available port will be used and printed to stdout. .SH AUTHORS Martin Szulecki .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://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 @@ +.TH "idevicedevmodectl" 1 +.SH NAME +idevicedevmodectl \- Enable Developer Mode on iOS 16+ devices or print the current status. +.SH SYNOPSIS +.B idevicedevmodectl +COMMAND +[OPTIONS] + +.SH DESCRIPTION + +Enable Developer Mode on iOS 16+ devices or print the current status. + +.SH NOTE +Passcode-protected devices will NOT allow enabling of Developer Mode from the command line. It has to be enabled on the device itself under Settings -> Privacy & Security -> Developer Mode. +The \f[B]enable\f[] command will try to enable it, and tell you if that's the case. +If the menu is not shown, you may use the \f[B]reveal\f[] command to reveal it. + +.SH COMMANDS +.TP +.B list +Prints the Developer Mode status of all connected devices, or for a specific one if \f[B]\-\-udid\f[] is given. +.TP +.B enable +Enable Developer Mode (device will reboot), and confirm it after device booted up again. +.TP +.B arm +Arm the Developer Mode (device will reboot) +.TP +.B confirm +Confirm enabling of Developer Mode +.TP +.B reveal +Reveal the Developer Mode menu on the device under Settings -> Privacy & Security + +.SH OPTIONS +.TP +.B \-u, \-\-udid UDID +target specific device by UDID +.TP +.B \-n, \-\-network +connect to network device +.TP +.B \-d, \-\-debug +enable communication debugging +.TP +.B \-h, \-\-help +print usage information +.TP +.B \-v, \-\-version +print version information + +.SH AUTHORS +Nikias Bassen + +.SH ON THE WEB +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/idevicediagnostics.1 b/docs/idevicediagnostics.1 index 8a9b947..2f28b8d 100644 --- a/docs/idevicediagnostics.1 +++ b/docs/idevicediagnostics.1 @@ -7,7 +7,7 @@ idevicediagnostics \- Interact with the diagnostics interface of a device. .SH DESCRIPTION -Interact with the diagnostics interface of a device which allows to retrive +Interact with the diagnostics interface of a device which allows one to retrieve all kinds of information including diagnostics data, mobilegestalt data, remote access to the IORegistry and certain commands like restart, shutdown and sleep. Only available for iOS 4 and later. Accessing IORegistry is only supported on @@ -17,12 +17,18 @@ iOS 5 and later. .TP .B \-u, \-\-udid UDID target specific device by UDID. -.TP +.TP +.B \-n, \-\-network +connect to network device. +.TP .B \-d, \-\-debug enable communication debugging. -.TP +.TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH COMMANDS .TP @@ -32,7 +38,7 @@ print diagnostics information from device optionally by TYPE. This includes .TP .B mobilegestalt KEY [...] print values of mobilegestalt keys passed as arguments after the command and -seperated by a space. +separated by a space. .TP .B ioreg [PLANE] print IORegistry of device, optionally by PLANE like "IODeviceTree", "IOPower" @@ -51,4 +57,6 @@ put device into sleep mode which also disconnects it from the host. Martin Szulecki .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/ideviceenterrecovery.1 b/docs/ideviceenterrecovery.1 index cbceb36..d455826 100644 --- a/docs/ideviceenterrecovery.1 +++ b/docs/ideviceenterrecovery.1 @@ -16,6 +16,9 @@ enable communication debugging. .TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH AUTHORS Martin Szulecki @@ -23,4 +26,6 @@ Martin Szulecki Man page written to conform with Debian by Julien Lavergne. .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/ideviceimagemounter.1 b/docs/ideviceimagemounter.1 index 322bd34..832850a 100644 --- a/docs/ideviceimagemounter.1 +++ b/docs/ideviceimagemounter.1 @@ -11,12 +11,15 @@ Mounts the specified disk image on the device. .SH OPTIONS .TP -.B \-d, \-\-debug -enable communication debugging. -.TP .B \-u, \-\-udid UDID target specific device by UDID. .TP +.B \-n, \-\-network +connect to network device. +.TP +.B \-d, \-\-debug +enable communication debugging. +.TP .B \-l, \-\-list list mount information .TP @@ -29,6 +32,9 @@ use XML output .B \-h, \-\-help prints usage information .TP +.B \-v, \-\-version +prints version information. +.TP .B IMAGE_FILE the image filename to mount .TP @@ -41,4 +47,6 @@ Nikias Bassen Man page written to conform with Debian by Julien Lavergne. .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/ideviceinfo.1 b/docs/ideviceinfo.1 index d4ecbf0..3944612 100644 --- a/docs/ideviceinfo.1 +++ b/docs/ideviceinfo.1 @@ -11,12 +11,18 @@ Show information about the first connected device. .SH OPTIONS .TP -.B \-d, \-\-debug -enable communication debugging. +.B \-s, \-\-simple +use a simple connection to avoid auto-pairing with the device. .TP .B \-u, \-\-udid UDID target specific device by UDID. .TP +.B \-n, \-\-network +connect to network device. +.TP +.B \-d, \-\-debug +enable communication debugging. +.TP .B \-q, \-\-domain NAME set domain of query to NAME. Default: None. .TP @@ -27,7 +33,10 @@ only query key specified by NAME. Default: All keys. output information as xml plist instead of key/value pairs. .TP .B \-h, \-\-help -prints usage information +prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH AUTHOR Martin Szulecki @@ -35,4 +44,6 @@ Martin Szulecki Man page written to conform with Debian by Julien Lavergne. .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/idevicename.1 b/docs/idevicename.1 index ee7cd02..34ce490 100644 --- a/docs/idevicename.1 +++ b/docs/idevicename.1 @@ -17,17 +17,25 @@ is given the device name will be set to the name specified. .SH OPTIONS .TP -.B \-d, \-\-debug -enable communication debugging. -.TP .B \-u, \-\-udid UDID target specific device by UDID. .TP +.B \-n, \-\-network +connect to network device. +.TP +.B \-d, \-\-debug +enable communication debugging. +.TP .B \-h, \-\-help prints usage information +.TP +.B \-v, \-\-version +prints version information. .SH AUTHOR Nikias Bassen .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/idevicenotificationproxy.1 b/docs/idevicenotificationproxy.1 index 19cf02e..56dd0b0 100644 --- a/docs/idevicenotificationproxy.1 +++ b/docs/idevicenotificationproxy.1 @@ -14,11 +14,17 @@ Post or observe notifications on an iOS device from the command line. .B \-u, \-\-udid UDID target specific device by UDID. .TP +.B \-n, \-\-network +connect to network device. +.TP .B \-d, \-\-debug enable communication debugging. .TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH COMMANDS .TP @@ -33,4 +39,6 @@ observe notification IDs in the foreground until CTRL+C or signal is received. Martin Szulecki .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/idevicepair.1 b/docs/idevicepair.1 index 5c567ee..eb6e7d4 100644 --- a/docs/idevicepair.1 +++ b/docs/idevicepair.1 @@ -13,12 +13,21 @@ Manage host pairings with devices and usbmuxd. .TP .B \-u, \-\-udid UDID target specific device by UDID. -.TP +.TP +.B \-w, \-\-wireless +perform wireless pairing (\f[B]see NOTE\f[]). +.TP +.B \-n, \-\-network +connect to network device (\f[B]see NOTE\f[]). +.TP .B \-d, \-\-debug enable communication debugging. -.TP +.TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH COMMANDS .TP @@ -40,6 +49,24 @@ unpair device with this host. .B list list devices paired with this host. +.SH NOTE +Pairing over network (wireless pairing) is only supported by Apple TV +devices. To perform a wireless pairing, you need to use the \f[B]\-w\f[] +command line switch. + +Make sure to put the device into pairing mode first by opening +Settings > Remotes and Devices > Remote App and Devices. + +The pairable device will become visible with a special UDID, and then you +can run idevicepair like this: + +.B idevicepair -u fffc8:ab:cd:12:34:56fff -w pair + +idevicepair will then ask for the PIN that the device is displaying and +continues with the pairing once entered. + +Please note that wireless pairing is currently not supported on Linux. + .SH AUTHORS Nikias Bassen @@ -48,4 +75,6 @@ Martin Szulecki Julien Lavergne .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/ideviceprovision.1 b/docs/ideviceprovision.1 index 5f312a5..3597d6e 100644 --- a/docs/ideviceprovision.1 +++ b/docs/ideviceprovision.1 @@ -13,6 +13,9 @@ Manage provisioning profiles on a device. .TP .B \-u, \-\-udid UDID target specific device by UDID. +.TP +.B \-n, \-\-network +connect to network device. .TP .B \-x, \-\-xml print XML output when using the 'dump' command. @@ -22,6 +25,9 @@ enable communication debugging. .TP .B \-h, \-\-help prints usage information. +.TP +.B \-v, \-\-version +prints version information. .SH COMMANDS .TP @@ -47,4 +53,6 @@ Prints detailed information about the provisioning profile specified by FILE. Nikias Bassen .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/idevicescreenshot.1 b/docs/idevicescreenshot.1 index 7b6794c..4da78af 100644 --- a/docs/idevicescreenshot.1 +++ b/docs/idevicescreenshot.1 @@ -18,14 +18,20 @@ the screenshotr service is not available. .SH OPTIONS .TP -.B \-d, \-\-debug -enable communication debugging. -.TP .B \-u, \-\-udid UDID target specific device by UDID. .TP +.B \-n, \-\-network +connect to network device. +.TP +.B \-d, \-\-debug +enable communication debugging. +.TP .B \-h, \-\-help prints usage information +.TP +.B \-v, \-\-version +prints version information. .SH AUTHOR Nikias Bassen @@ -33,4 +39,6 @@ Nikias Bassen Man page written to conform with Debian by Julien Lavergne. .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://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 @@ +.TH "idevicesetlocation" 1 +.SH NAME +idevicesetlocation \- Simulate location on iOS device. +.SH SYNOPSIS +.B idevicesetlocation +[OPTIONS] -- <LAT> <LONG> + +.B idevicesetlocation +[OPTIONS] reset + +.SH DESCRIPTION + +Simulate location on iOS device with mounted developer disk image. + +.SH OPTIONS +.TP +.B \-u, \-\-udid UDID +target specific device by UDID +.TP +.B \-n, \-\-network +connect to network device +.TP +.B \-d, \-\-debug +enable communication debugging +.TP +.B \-h, \-\-help +prints usage information +.TP +.B \-v, \-\-version +prints version information. + +.SH AUTHOR +Nikias Bassen + +.SH ON THE WEB +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice diff --git a/docs/idevicesyslog.1 b/docs/idevicesyslog.1 index aa24339..66ae2e4 100644 --- a/docs/idevicesyslog.1 +++ b/docs/idevicesyslog.1 @@ -10,20 +10,119 @@ idevicesyslog \- Relay syslog of a connected device. Relay syslog of a connected device. .SH OPTIONS -.TP -.B \-d, \-\-debug -enable communication debugging. .TP .B \-u, \-\-udid UDID -target specific device by UDID. -.TP +target specific device by UDID +.TP +.B \-n, \-\-network +connect to network device +.TP +.B \-x, \-\-exit +exit when device disconnects +.TP +.B \-d, \-\-debug +enable communication debugging +.TP .B \-h, \-\-help -prints usage information. +prints usage information +.TP +.B \-v, \-\-version +Prints version information. +.TP +.B \-\-no\-colors +disable colored output +.TP +.B \-o, \-\-output FILE +Write to FILE instead of stdout. This will disable writing colored output, but can be re-enabled with \f[B]\-\-colors\f[]. +If FILE already exists, it will be overwritten without warning. +.TP +.B \-\-colors +Force writing colored output, e.g. when using \f[B]\-\-output\f[]. + +.SH FILTER OPTIONS +.TP +.B \-m, \-\-match STRING +only print messages that contain STRING + +This option will set a filter to only printed log messages that contain the given string. +.TP +.B \-t, \-\-trigger STRING +start logging when matching STRING + +When specified, logging will start as soon as a log messages is encountered that contains the given string. See also +\f[B]\-T, \-\-untrigger\f[]. Other filters are still applied but obviously filtered messages are only printed after logging has started. +.TP +.B \-T, \-\-untrigger STRING +stop logging when matching STRING + +When specified logging will halt as soon as a log message is encountered that contains the given string. See also +\f[B]\-t, \-\-trigger\f[]. Other filters are still applied but obviously filtered messages are only printed before logging stops. + +NOTE: If no \f[B]\-\-trigger\f[] is given, idevicesyslog will exit after a matching log message was encountered. +.TP +.B \-p, \-\-process PROCESS +only print messages from matching process(es) + +PROCESS 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!). +.TP +.B \-e, \-\-exclude PROCESS +print all messages except matching process(es) + +PROCESS 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!). +.TP +.B \-q, \-\-quiet +set a filter to exclude common noisy processes + +Since 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[]. +.TP +.B \-\-quiet\-list +prints the list of processes for \f[B]\-\-quiet\f[] and exits +.TP +.B \-k, \-\-kernel +only print kernel messages + +This 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. +.TP +.B \-K, \-\-no\-kernel +suppress kernel messages + +This is equivalent to passing \f[B]\-\-exclude kernel\f[]. + +.SH EXAMPLES +.TP +.B idevicesyslog \-u 00008030\-0000111ABC000DEF +Relay syslog of device with UDID 00008030-0000111ABC000DEF. +.TP +.B idevicesyslog \-x +Relay syslog of device and exit when the device is unplugged. +.TP +.B idevicesyslog \-m '####' \-e 'identityservicesd' \-K +Only print log messages that contain the string #### and do NOT originate from identityservicesd or the kernel. +.TP +.B idevicesyslog \-p MyApp \-p ReportCrash +Only print log messages from the process named 'MyApp' and 'ReportCrash'. +.TP +.B idevicesyslog \-p 'MyApp|ReportCrash' +Same as previous example with different syntax. +.TP +.B idevicesyslog \-e 'backboardd|CommCenter|mDNSResponder' +Suppress log messages from backboardd, CommCenter, and mDNSResponder. +.TP +.B idevicesyslog \-q \-k +Suppress log messages from common noisy processes, but DO print kernel log messages. +.TP +.B idevicesyslog \-K +Suppress log messages from kernel, but print everything else +.TP +.B idevicesyslog \-t 'backlight on' \-T 'backlight off' \-q +Start logging when the device turns on backlight and stop logging when it turns backlight off, and suppress noisy processes -.SH AUTHOR -Martin Szulecki +.SH AUTHORS +Nikias Bassen, Martin Szulecki Man page written to conform with Debian by Julien Lavergne. .SH ON THE WEB -http://libimobiledevice.org +https://libimobiledevice.org + +https://github.com/libimobiledevice/libimobiledevice |
