Update documentation

This commit is contained in:
Nick Chan committed 2024-07-24 12:20:19 +08:00
1 parent df636c1db9
commit 8d401680dd
2 files changed
+9 -22

No files matched your search

+7 -17
View File
@@ -2,7 +2,7 @@
.\" Copyright (c) 2024 Nick Chan .\" Copyright (c) 2024 Nick Chan
.\" SPDX-License-Identifier: MIT .\" SPDX-License-Identifier: MIT
.\" .\"
.Dd "30 March 2024" .Dd "24 July 2024"
.Dt palera1n 1 .Dt palera1n 1
.Sh NAME .Sh NAME
.Nm palera1n .Nm palera1n
@@ -155,17 +155,13 @@ Set the effective production fuse to 0, so as to enable hardware debugging featu
Execute the DFU helper to guide the user into putting the device into DFU mode Execute the DFU helper to guide the user into putting the device into DFU mode
then exit. then exit.
.It Fl e , -boot-args Ar boot arguments .It Fl e , -boot-args Ar boot arguments
Specify custom XNU kernel command line. The Specify custom XNU kernel command line. Additionally, the
.Em rootdev=md0
argument is used by
.Nm
and cannot be overriden. Additionally, the
.Em wdt=-1 .Em wdt=-1
argument is used during fakefs setup. argument is used during fakefs setup.
.It Fl E , -enter-recovery .It Fl E , -enter-recovery
Exit after entering recovery mode. Exit after entering recovery mode.
.It Fl f , -fakefs .It Fl f , -fakefs
Proceed in rootful mode. This applies to both full, partial fakefs, as well as realfs. Proceed in rootful mode. Despite its name, this applies to both full, partial fakefs, as well as realfs, and it still applies even when trying to force revert.
.It Fl h , -help .It Fl h , -help
Prints help text. Prints help text.
.It Fl i , -checkra1n-file Ar checkra1n file .It Fl i , -checkra1n-file Ar checkra1n file
@@ -183,10 +179,6 @@ command. If in doubt, use
iOS15 branch or your own fork of it. iOS15 branch or your own fork of it.
.It Fl l , -rootless .It Fl l , -rootless
Proceed in rootless mode. This option is only supported on iOS/iPadOS. Proceed in rootless mode. This option is only supported on iOS/iPadOS.
.It Fl L , -jbinit-log-to-file
This option is not currently supported and is a no-operation in this version of
.Nm
\[char46]
.It Fl n , -exit-recovery .It Fl n , -exit-recovery
Exit recovery mode and exit. Exit recovery mode and exit.
.It Fl o , -override-overlay Ar overlay file .It Fl o , -override-overlay Ar overlay file
@@ -241,13 +233,13 @@ is extracted and executed here. When not set, /tmp is used.
.Sh EXAMPLES .Sh EXAMPLES
To (re-)jailbreak in rootless mode: To (re-)jailbreak in rootless mode:
.Pp .Pp
.Dl "palera1n" .Dl "palera1n -l"
.Pp .Pp
To setup fakefs for rootful mode: To setup fakefs for rootful mode:
.Pp .Pp
.Dl "palera1n -fc" .Dl "palera1n -fc"
.Pp .Pp
After the device has rebooted, follow the following example. After the device has rebooted into recovery mode, follow the following example.
.Pp .Pp
To re-jailbreak in rootful mode: To re-jailbreak in rootful mode:
.Pp .Pp
@@ -304,7 +296,7 @@ option might cause some versions for tvOS to crash and not boot.
Offical Apple USB-C cables as well as some other USB-C cables cannot be used to enter DFU mode. Offical Apple USB-C cables as well as some other USB-C cables cannot be used to enter DFU mode.
USB-A cable with male USB-C to female USB-A adapter works fine. USB-A cable with male USB-C to female USB-A adapter works fine.
.Sh POST INSTALLATION (iOS/iPadOS) .Sh POST INSTALLATION (iOS/iPadOS)
The palera1n loader app will take up to 30 seconds to appear on the homescreen after the The palera1n loader app will take up to 1 minute to appear on the homescreen after the
device has booted. If it does not appear, you can try using the shortcut: device has booted. If it does not appear, you can try using the shortcut:
.Pp .Pp
.Lk https://www.icloud.com/shortcuts/8cd5f489c8854ee0ab9ee38f2e62f87d .Lk https://www.icloud.com/shortcuts/8cd5f489c8854ee0ab9ee38f2e62f87d
@@ -332,7 +324,7 @@ loader app to install additional jailbreak files.
.Bl -tag -width "/var/jb/Library/LaunchDaemons" .Bl -tag -width "/var/jb/Library/LaunchDaemons"
.It Pa /cores .It Pa /cores
The location of the temporary filesystem where jailbreak files are stash during boot. The location of the temporary filesystem where jailbreak files are stashed during boot.
.It Pa /Library/LaunchDaemons .It Pa /Library/LaunchDaemons
The directory where jailbreak-specific The directory where jailbreak-specific
.Xr launchd.plist 5 .Xr launchd.plist 5
@@ -358,8 +350,6 @@ may crash if the machine it is running on:
.Pp .Pp
The exploit may also work less reliably on some hosts, like AMD desktops, or some MediaTek devices. The exploit may also work less reliably on some hosts, like AMD desktops, or some MediaTek devices.
.Pp .Pp
The device may randomly crash and reboot due to launchd using too much memory.
.Pp
The built-in SSH server might be not accessible with password after bootstrapping rootful, The built-in SSH server might be not accessible with password after bootstrapping rootful,
since the bootstrap uses a custom crypt() function that is not supported since the bootstrap uses a custom crypt() function that is not supported
by the built-in SSH server. by the built-in SSH server.
+2 -5
View File
@@ -78,7 +78,7 @@ static int usage(int e, char* prog_name)
#endif #endif
"] [-e boot arguments] [-k Pongo image] [-o overlay file] [-r ramdisk file] [-K KPF file] [-i checkra1n file]\n" "] [-e boot arguments] [-k Pongo image] [-o overlay file] [-r ramdisk file] [-K KPF file] [-i checkra1n file]\n"
"Copyright (C) 2024, palera1n team, All Rights Reserved.\n\n" "Copyright (C) 2024, palera1n team, All Rights Reserved.\n\n"
"iOS/iPadOS/tvOS 15.0-17.5, bridgeOS 5.0-8.3 arm64 jailbreaking tool\n\n" "iOS/iPadOS/tvOS 15.0-18.0, bridgeOS 5.0-9.0 arm64 jailbreaking tool\n\n"
"\t--version\t\t\t\tPrint version\n" "\t--version\t\t\t\tPrint version\n"
"\t--force-revert\t\t\t\tRemove jailbreak\n" "\t--force-revert\t\t\t\tRemove jailbreak\n"
#ifdef DEV_BUILD #ifdef DEV_BUILD
@@ -181,10 +181,7 @@ int optparse(int argc, char* argv[]) {
#endif #endif
break; break;
case 'e': case 'e':
if (strstr(optarg, "rootdev=") != NULL) { if (strlen(optarg) > (sizeof(xargs_cmd) - 0x20)) {
LOG(LOG_FATAL, "The boot arg rootdev= is already used by palera1n and cannot be overriden");
return -1;
} else if (strlen(optarg) > (sizeof(xargs_cmd) - 0x20)) {
LOG(LOG_FATAL, "Boot arguments too long"); LOG(LOG_FATAL, "Boot arguments too long");
return -1; return -1;
} }