Description: Add man of ift-extract Author: Nobuhiro Iwamatsu Last-Update: 2013-07-26 diff --git a/doc/ift-extract.1 b/doc/ift-extract.1 index e69de29..7839123 100644 --- a/doc/ift-extract.1 +++ b/doc/ift-extract.1 @@ -0,0 +1,190 @@ +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "I2M19058 1" +.TH I2M19058 1 "2012-01-09" "perl v5.14.2" "GNU Info" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +ift\-extract.info \- ift\-extract.info +.SH "Built-in iSight firmware extractor and patcher" +.IX Header "Built-in iSight firmware extractor and patcher" +ift-extract extract the Built-in iSight firmware from Apple driver +and patch it to avoid some bugs in it. The firmware is then ready to get +loaded into the chip using ift-load. +.PP +* Menu: +.PP +Finding the Apple driver: see \*(L"Driver\*(R" +.PP +Command line options: see \*(L"Options\*(R" +.PP +See also \*(L"Copying\*(R" +.SS "1 Finding the Apple driver" +.IX Subsection "1 Finding the Apple driver" +ift-extract extract Built-in iSight firmware from Apple iSight driver. +This driver is located at +/System/Library/Extensions/IOUSBFamily.kext/Contents/PlugIns/AppleUSBVideoSupport.kext/Contents/MacOS/AppleUSBVideoSupport +on your Mac \s-1OS\s0 X root partition. +.PP +There is several version of this driver depending on driver version +or host architecture (PowerPC or x86). Thus, ift-extract must determine +know the variant of the driver in order to properly extract the +firmware. +.PP +Any AppleUSBVideoSupport file starting with those shipped with iMac +G5 iSight must work. If not, please report unknown AppleUSBVideoSupport +at bugreport mail address with machine type and \s-1OS\s0 X version. +.SS "2 Command line options" +.IX Subsection "2 Command line options" +`\fB\-a\fR' +`\fB\-\-apple\-driver\fR' +Apple driver filename where to extract the firmware. +.PP +`\fB\-d\fR' +`\fB\-\-output\-directory\fR' +The directory where to output the firmware. Defaults to +/lib/firmware. +.PP +`\fB\-f\fR' +`\fB\-\-output\-filename\fR' +The output firmware name. Defaults to isight.fw +.PP +`\fB\-?\fR' +`\fB\-\-help\fR' +Shows option help and quit. +.PP +Since ift-extract defaults to output the firmware to +/lib/firmware/isight.fw, ensure you have the right to do so. +.SS "3 Copying" +.IX Subsection "3 Copying" +isight-firmware-tools is a project developped by A\*~Xtienne Bersac based +on the work of Ronald S. Bultje, Johannes Berg and Ivan N. Zlatev. +.PP +This manual has been written by A\*~Xtienne Bersac. +.PP +Copyright (C) 2007 A\*~Xtienne Bersac