Difference between revisions of "Template:Keys/doc"

From The iPhone Wiki
Jump to: navigation, search
m (Consistency please.)
(removed "NoUpdateRamdisk" and "RamdiskNotEncrypted", then pulled some info out of the poorly done syntax table and put it above the template)
Line 3: Line 3:
   
 
== Syntax ==
 
== Syntax ==
  +
<!-- Undocumented voodoo:
When using this, delete the sections for items that are not in the firmware the page is for and put <code>TODO</code> in the IV and key tags for the ones that need keys.
 
  +
-- If this is a 1.x firmware, delete the <code>UpdateRamdiskIV</code>, <code>UpdateRamdiskKey</code>, <code>RestoreRamdiskIV</code> and everything after.
  +
--
  +
-- If the build is not 8A293 (4.0), delete the <code>GMRootFSKey</code> parameter.
  +
-->
   
If this is a 1.x firmware, delete the <code>UpdateRamdiskIV</code>, <code>UpdateRamdiskKey</code>, <code>RestoreRamdiskIV</code> and everything after.
+
If the device is not an iPhone or a 3G iPad, delete the <code>Baseband</code> parameter.
   
  +
If the device is an Apple TV, set <code>Version</code> to the marketing version (what the Apple TV reports) and set <code>DisplayVersion</code> to the marketing version with the internal version in parenthesis. For example, [[Brighton 10B144b (AppleTV2,1)|5.2/6.1 (10B144b)]] for the Apple TV 2G sets <code>Version</code> to <code>5.2</code> and <code>DisplayVersion</code> to <code>5.2 (6.1)</code>.
If the build is not 8A293 (4.0), delete the <code>GMRootFSKey</code> tag.
 
   
If the device is not an iPhone or a 3G iPad, delete the <code>Baseband</code> tag.
+
If the device is not an Apple TV, delete the <code>DisplayVersion</code> parameter.
   
  +
For each *, *IV, and *Key section, put the file name on the first line. If the item is the Root FS or a ramdisk, don't put the ".dmg". If that item does not exist in that firmware, delete the section.
If the device is not an Apple TV, delete the <code>DisplayVersion</code> tag.
 
   
  +
For <code>DownloadURL</code>, do '''not''' place anything other than URLs to free firmwares hosted on Apple Inc.'s servers. For beta firmwares, use the URL "displayed" on [[Apple Developer|Apple Developer Center]] as you will still need to log in to download.
<!-- If the device is an Apple TV, set <code>Version</code> to the marketing version (what the Apple TV reports) and set <code>DisplayVersion</code> to the marketing version with the internal version in parenthesis. For example, [[Brighton 10B144b (AppleTV2,1)|5.2/6.1 (10B144b)]] for the Apple TV 2G sets <code>Version</code> to <code>5.2</code> and <code>DisplayVersion</code> to <code>5.2 (6.1)</code>.-->
 
 
<nowiki>{{keys</nowiki>
 
<nowiki>{{keys</nowiki>
 
| Version             = 
 
| Version             = 
Line 25: Line 29:
 
| RootFS           = 
 
| RootFS           = 
 
| RootFSKey           = TODO
 
| RootFSKey           = TODO
| GMRootFSKey         = TODO
+
<!-- | GMRootFSKey         = TODO -->
 
| NoUpdateRamdisk     = 
 
| RamdiskNotEncrypted = 
 
 
 
 
| UpdateRamdisk       = 
 
| UpdateRamdisk       = 
Line 107: Line 108:
 
<nowiki>}}</nowiki>
 
<nowiki>}}</nowiki>
   
  +
== <nowiki>{{{Device}}}</nowiki> Parameter Key ==
== Syntax Explanation ==
 
{| class="wikitable" style="width:100%"
 
|-
 
! Tag
 
! Explanation
 
|-
 
| Version
 
| The version of the build (ex: for [[Durango 8K2 (iPhone2,1)]], you would put <code>4.3.4</code>).
 
|-
 
| DisplayVersion
 
| Alternate version to display. For use with Apple TV firmwares. Should be in the format of "{MarketingVersion} ({InternalVersion})".
 
|-
 
| Build
 
| The build number.
 
|-
 
| Device
 
| [[#Device|See below]].
 
|-
 
| Baseband
 
| The baseband (ex: page is [[Jasper 8C148 (iPad)]], you would put <code>07.10.00</code>). Leave blank if unknown. Remove if not a device with a baseband chip.
 
|-
 
| DownloadURL
 
| Only firmwares available on Apple Inc. owned domains. Public firmware links are available on [[Firmware]]. [[Beta Firmware|beta firmware]] links '''''must''''' be available from the [[Apple Developer|Apple Developer Center]]
 
|-
 
| RootFS
 
| The name of the Root FS file (without the <code>.dmg</code>)
 
|-
 
| RootFSKey
 
| The key for the Root FS
 
|-
 
| GMRootFSKey
 
| The key for the GM Root FS (used only on iOS 4.0 8A293)
 
|-
 
| NoUpdateRamdisk
 
| If this is <code>true</code>, the "Update Ramdisk" section will not be displayed. Remove if there is an update ramdisk.
 
|-
 
| RamdiskNotEncrypted
 
| If this is <code>true</code>, the [[ramdisk]]s will show "Not Encrypted" instead of "IV" and "Key" lines. Remove if the ramdisks are encrypted.
 
|-
 
| UpdateRamdisk
 
| The name of the [[Update Ramdisk]] file (without <code>.dmg</code>) (can be deleted if <code>NoUpdateRamdisk</code> is filled or it is a 1.x firmware)
 
|-
 
| UpdateRamdiskIV
 
| The IV of the Update Ramdisk (can be deleted if <code>NoUpdateRamdisk</code> is filled or it is a 1.x firmware)
 
|-
 
| UpdateRamdiskKey
 
| The Key of the Update Ramdisk (can be deleted if <code>NoUpdateRamdisk</code> is filled or it is a 1.x firmware)
 
|-
 
| RestoreRamdisk
 
| The name of the [[Restore Ramdisk]] file (without <code>.dmg</code>)
 
|-
 
| RestoreRamdiskIV
 
| The IV of the Restore Ramdisk (can be deleted if is a 1.x firmware)
 
|-
 
| RestoreRamdiskKey
 
| The Key of the Restore Ramdisk (can be deleted if is a 1.x firmware)
 
|-
 
| *
 
| The file name for the * (can be deleted if it is a 1.x firmware)
 
|-
 
| *IV
 
| The IV for the * (can be deleted if is a 1.x firmware)
 
|-
 
| *Key
 
| The Key for the * (can be deleted if is a 1.x firmware)
 
|}
 
 
== Device ==
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-

Revision as of 21:46, 8 November 2014

← Go back to the template.

This is the key template for the key pages. When a page uses this template, it is added to the Key Pages category.

Syntax

If the device is not an iPhone or a 3G iPad, delete the Baseband parameter.

If the device is an Apple TV, set Version to the marketing version (what the Apple TV reports) and set DisplayVersion to the marketing version with the internal version in parenthesis. For example, 5.2/6.1 (10B144b) for the Apple TV 2G sets Version to 5.2 and DisplayVersion to 5.2 (6.1).

If the device is not an Apple TV, delete the DisplayVersion parameter.

For each *, *IV, and *Key section, put the file name on the first line. If the item is the Root FS or a ramdisk, don't put the ".dmg". If that item does not exist in that firmware, delete the section.

For DownloadURL, do not place anything other than URLs to free firmwares hosted on Apple Inc.'s servers. For beta firmwares, use the URL "displayed" on Apple Developer Center as you will still need to log in to download.

{{keys
 | Version             = 
 | DisplayVersion      = 
 | Build               = 
 | Device              = 
 | Codename            = 
 | Baseband            = 
 | DownloadURL         = 

 | RootFS              = 
 | RootFSKey           = TODO

 | UpdateRamdisk       = 
 | UpdateRamdiskIV     = TODO
 | UpdateRamdiskKey    = TODO

 | RestoreRamdisk      = 
 | RestoreRamdiskIV    = TODO
 | RestoreRamdiskKey   = TODO

 | AppleLogo           = TODO
 | AppleLogoIV         = TODO
 | AppleLogoKey        = TODO

 | BatteryCharging0    = TODO
 | BatteryCharging0IV  = TODO
 | BatteryCharging0Key = TODO

 | BatteryCharging1    = TODO
 | BatteryCharging1IV  = TODO
 | BatteryCharging1Key = TODO

 | BatteryFull         = TODO
 | BatteryFullIV       = TODO
 | BatteryFullKey      = TODO

 | BatteryLow0         = TODO
 | BatteryLow0IV       = TODO
 | BatteryLow0Key      = TODO

 | BatteryLow1         = TODO
 | BatteryLow1IV       = TODO
 | BatteryLow1Key      = TODO

 | DeviceTree          = TODO
 | DeviceTreeIV        = TODO
 | DeviceTreeKey       = TODO

 | GlyphCharging       = TODO
 | GlyphChargingIV     = TODO
 | GlyphChargingKey    = TODO

 | GlyphPlugin         = TODO
 | GlyphPluginIV       = TODO
 | GlyphPluginKey      = TODO

 | iBEC                = TODO
 | iBECIV              = TODO
 | iBECKey             = TODO

 | iBoot               = TODO
 | iBootIV             = TODO
 | iBootKey            = TODO

 | iBSS                = TODO
 | iBSSIV              = TODO
 | iBSSKey             = TODO

 | Kernelcache         = TODO
 | KernelcacheIV       = TODO
 | KernelcacheKey      = TODO

 | LLB                 = TODO
 | LLBIV               = TODO
 | LLBKey              = TODO

 | NeedService         = TODO
 | NeedServiceIV       = TODO
 | NeedServiceKey      = TODO

 | RecoveryMode        = TODO
 | RecoveryModeIV      = TODO
 | RecoveryModeKey     = TODO

 | SEPFirmware         = TODO
 | SEPFirmwareIV       = TODO
 | SEPFirmwareKey      = TODO
}}

{{{Device}}} Parameter Key

Device Value
Apple TV 2G appletv21
Apple TV 3G AppleTV3,1 appletv31
AppleTV3,2 appletv32
iPad ipad11
iPad 2 iPad2,1 ipad21
iPad2,2 ipad22
iPad2,3 ipad23
iPad2,4 ipad24
iPad 3 iPad3,1 ipad31
iPad3,2 ipad32
iPad3,3 ipad33
iPad 4 iPad3,4 ipad34
iPad3,5 ipad35
iPad3,6 ipad36
iPad Air iPad4,1 ipad41
iPad4,2 ipad42
iPad4,3 ipad43
iPad Air 2 iPad5,3 ipad53
iPad5,4 ipad54
iPad mini 1G iPad2,5 ipad25
iPad2,6 ipad26
iPad2,7 ipad27
iPad mini 2 iPad4,4 ipad44
iPad4,5 ipad45
iPad4,6 ipad46
iPad mini 3 iPad4,7 ipad47
iPad4,8 ipad48
iPad4,9 ipad49
iPhone iphone11
iPhone 3G iphone12
iPhone 3GS iphone21
iPhone 4 iPhone3,1 iphone31
iPhone3,2 iphone32
iPhone3,3 iphone33
iPhone 4S iphone41
iPhone 5 iPhone5,1 iphone51
iPhone5,2 iphone52
iPhone 5c iPhone5,3 iphone53
iPhone5,4 iphone54
iPhone 5s iPhone6,1 iphone61
iPhone6,2 iphone62
iPhone 6 iphone72
iPhone 6 Plus iphone71
iPod touch ipod11
iPod touch 2G ipod21
iPod touch 3G ipod31
iPod touch 4G ipod41
iPod touch 5G ipod51