mirror of
https://github.com/palera1n/palera1n.git
synced 2026-11-19 20:03:55 +01:00
docs: do not mention options that does not appear in help menu
This commit is contained in:
1 parent
b0ac19e4d1
commit
52d20c8e5b
2 files changed
+10
-95
No files matched your search
+6
-93
@@ -2,14 +2,14 @@
|
|||||||
.\" Copyright (c) 2023 Nick Chan
|
.\" Copyright (c) 2023 Nick Chan
|
||||||
.\" SPDX-License-Identifier: MIT
|
.\" SPDX-License-Identifier: MIT
|
||||||
.\"
|
.\"
|
||||||
.Dd "20 March 2023"
|
.Dd "2 July 2023"
|
||||||
.Dt palera1n 1
|
.Dt palera1n 1
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
.Nm palera1n
|
.Nm palera1n
|
||||||
.Nd iOS 15.0-16.5 arm64 iOS/iPadOS jailbreaking tool
|
.Nd iOS 15.0-16.5 arm64 iOS/iPadOS jailbreaking tool
|
||||||
.Sh SYNOPSIS
|
.Sh SYNOPSIS
|
||||||
.Nm
|
.Nm
|
||||||
.Op Fl cCdDEfhIlLnpRsSvV
|
.Op Fl dDEhILnpRsSvV
|
||||||
.Op Fl e Ar Boot arguments
|
.Op Fl e Ar Boot arguments
|
||||||
.Op Fl k Ar Pongo image
|
.Op Fl k Ar Pongo image
|
||||||
.Op Fl o Ar overlay file
|
.Op Fl o Ar overlay file
|
||||||
@@ -25,10 +25,6 @@ utilizing the
|
|||||||
.Em checkm8
|
.Em checkm8
|
||||||
bootROM exploit.
|
bootROM exploit.
|
||||||
.Pp
|
.Pp
|
||||||
.Nm
|
|
||||||
is able to jailbreak the device in fakefs-rootful mode, where /
|
|
||||||
is writable, as well as rootless mode, where / cannot be written to.
|
|
||||||
.Pp
|
|
||||||
Due to the nature of the
|
Due to the nature of the
|
||||||
.Em checkm8
|
.Em checkm8
|
||||||
exploit,
|
exploit,
|
||||||
@@ -95,36 +91,7 @@ Prints the program version and exit.
|
|||||||
Remove the jailbreak while keeping user data. Some jailbreak files may remain
|
Remove the jailbreak while keeping user data. Some jailbreak files may remain
|
||||||
after running this command. Additionally, jailbreak apps will remain on the
|
after running this command. Additionally, jailbreak apps will remain on the
|
||||||
home screen on for a while even when the files are deleted as the icon cache
|
home screen on for a while even when the files are deleted as the icon cache
|
||||||
still has their icons. When used with
|
still has their icons.
|
||||||
.Fl f , -fakefs ,
|
|
||||||
this will actually boot the device in rootless mode then delete the jailbreak
|
|
||||||
files. As a result, using the loader app to install the jailbreak environment
|
|
||||||
is not supported when this option is used together with
|
|
||||||
.Fl f , -fakefs
|
|
||||||
\[char46]
|
|
||||||
.It Fl B , -setup-fakefs-partial
|
|
||||||
Like
|
|
||||||
.Fl c , -setup-fakefs
|
|
||||||
but the size of the created fakefs is smaller at the expense of having unwritable
|
|
||||||
parts in rarely-written paths. When jailbreaking 16 GB devices, this option must be used
|
|
||||||
when setting up fakefs for rootful, as they do not have enough storage for full fakefs.
|
|
||||||
This option currently does not work on iOS 16.
|
|
||||||
.It Fl c , -setup-fakefs
|
|
||||||
When used with
|
|
||||||
.Fl f , -fakefs ,
|
|
||||||
creates the new APFS volume required for rootful. Will fail if one already exists.
|
|
||||||
.It Fl C , -clean-fakefs
|
|
||||||
This reverts the fakefs to the
|
|
||||||
.Em orig-fs
|
|
||||||
snapshot that is created when the fakefs
|
|
||||||
is first created, then the device will continue to boot jailbroken. This option
|
|
||||||
allows resetting the rootful environment without deleting the entire fakefs.
|
|
||||||
Note that this option will not work if the fakefs is created in an older version
|
|
||||||
of palera1n that does not create the
|
|
||||||
.Em orig-fs
|
|
||||||
snapshot on the fakefs. This option will also remove some jailbreak files inside
|
|
||||||
of /var. The files in /var will not be deleted when a userspace reboot is done
|
|
||||||
with this flag set.
|
|
||||||
.It Fl d , -demote
|
.It Fl d , -demote
|
||||||
Set the effective production fuse to 0, so as to enable hardware debugging features.
|
Set the effective production fuse to 0, so as to enable hardware debugging features.
|
||||||
.It Fl D , -dfuhelper
|
.It Fl D , -dfuhelper
|
||||||
@@ -135,13 +102,9 @@ Specify custom XNU kernel command line. The
|
|||||||
.Em rootdev=md0
|
.Em rootdev=md0
|
||||||
argument is used by
|
argument is used by
|
||||||
.Nm
|
.Nm
|
||||||
and cannot be overriden. Additionally, the
|
and cannot be overriden.
|
||||||
.Em wdt=-1
|
|
||||||
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
|
|
||||||
Proceed in rootful mode. This applies to both full fakefs and partial fakefs.
|
|
||||||
.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
|
||||||
@@ -157,12 +120,6 @@ root filesystem in paleinfo with
|
|||||||
command. If in doubt, use
|
command. If in doubt, use
|
||||||
.Sy https://github.com/palera1n/PongoOS
|
.Sy https://github.com/palera1n/PongoOS
|
||||||
iOS15 branch or your own fork of it.
|
iOS15 branch or your own fork of it.
|
||||||
.It Fl l , -rootless
|
|
||||||
Proceed in rootless mode, this is the default when neither
|
|
||||||
.Fl l , -rootless
|
|
||||||
and
|
|
||||||
.Fl f , -fakefs
|
|
||||||
is specified.
|
|
||||||
.Fl L , -jbinit-log-to-file
|
.Fl L , -jbinit-log-to-file
|
||||||
Makes jbinit log to
|
Makes jbinit log to
|
||||||
.Em /cores/jbinit.log
|
.Em /cores/jbinit.log
|
||||||
@@ -221,32 +178,10 @@ To (re-)jailbreak in rootless mode:
|
|||||||
.Pp
|
.Pp
|
||||||
.Dl "palera1n"
|
.Dl "palera1n"
|
||||||
.Pp
|
.Pp
|
||||||
To setup fakefs for rootful mode:
|
|
||||||
.Pp
|
|
||||||
.Dl "palera1n -fc"
|
|
||||||
.Pp
|
|
||||||
After the device has rebooted, follow the following example.
|
|
||||||
.Pp
|
|
||||||
To re-jailbreak in rootful mode:
|
|
||||||
.Pp
|
|
||||||
.Dl "palera1n -f"
|
|
||||||
.Pp
|
|
||||||
To remove the jailbreak in rootful mode:
|
|
||||||
.Pp
|
|
||||||
.Dl "palera1n --force-revert -f"
|
|
||||||
.Pp
|
|
||||||
To remove the jailbreak in rootless mode:
|
To remove the jailbreak in rootless mode:
|
||||||
.Pp
|
.Pp
|
||||||
.Dl "palera1n --force-revert"
|
.Dl "palera1n --force-revert"
|
||||||
.Pp
|
.Pp
|
||||||
To verbose boot in rootful mode:
|
|
||||||
.Pp
|
|
||||||
.Dl "palera1n -Vf"
|
|
||||||
.Pp
|
|
||||||
To create a partial fakefs with bind mounts:
|
|
||||||
.Pp
|
|
||||||
.Dl "palera1n -Bf"
|
|
||||||
.Pp
|
|
||||||
To exit recovery mode:
|
To exit recovery mode:
|
||||||
.Pp
|
.Pp
|
||||||
.Dl "palera1n -n"
|
.Dl "palera1n -n"
|
||||||
@@ -260,8 +195,6 @@ To verbose boot, use the
|
|||||||
.Fl V , -verbose-boot
|
.Fl V , -verbose-boot
|
||||||
option when jailbreaking.
|
option when jailbreaking.
|
||||||
.Pp
|
.Pp
|
||||||
Fakefs takes up around 5-10 GB of storage, and take up to 10 minutes to setup.
|
|
||||||
.Pp
|
|
||||||
iOS 15.0 requires DER entitlements, and iOS 15.1 requires hash agility in code signatures.
|
iOS 15.0 requires DER entitlements, and iOS 15.1 requires hash agility in code signatures.
|
||||||
As a result, binaries with the old code signature format need to be resigned with a recent
|
As a result, binaries with the old code signature format need to be resigned with a recent
|
||||||
version of the Procursus fork of
|
version of the Procursus fork of
|
||||||
@@ -269,11 +202,6 @@ version of the Procursus fork of
|
|||||||
before they can be ran on a device jailbroken with
|
before they can be ran on a device jailbroken with
|
||||||
.Nm
|
.Nm
|
||||||
\[char46]
|
\[char46]
|
||||||
.Pp
|
|
||||||
When using rootful mode, the
|
|
||||||
.Fl f , -fakefs
|
|
||||||
flag must be specified at all times. It does not matter whether you want to create fakefs,
|
|
||||||
create partial fakefs, rejailbreak or remove jailbreak.
|
|
||||||
.Sh POST INSTALLATION
|
.Sh POST INSTALLATION
|
||||||
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 30 seconds 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:
|
||||||
@@ -298,18 +226,10 @@ The location of the temporary filesystem where jailbreak files are stash during
|
|||||||
When
|
When
|
||||||
.Fl L
|
.Fl L
|
||||||
is used, the log file of jbinit.
|
is used, the log file of jbinit.
|
||||||
.It Pa /Library/LaunchDaemons
|
|
||||||
The directory where jailbreak-specific
|
|
||||||
.Xr launchd.plist 5
|
|
||||||
property list files should be placed on rootful.
|
|
||||||
.It Pa /var/jb/Library/LaunchDaemons
|
.It Pa /var/jb/Library/LaunchDaemons
|
||||||
The directory where jailbreak-specific
|
The directory where jailbreak-specific
|
||||||
.Xr launchd.plist 5
|
.Xr launchd.plist 5
|
||||||
property list files should be placed on rootless.
|
property list files should be placed on rootless.
|
||||||
.It Pa /etc/rc.d
|
|
||||||
The directory where executable filse that needs to be executed during boot, before
|
|
||||||
daemons are launched, are placed rootful. They are executed after all filesystems
|
|
||||||
has been mounted.
|
|
||||||
.It Pa /var/jb/etc/rc.d
|
.It Pa /var/jb/etc/rc.d
|
||||||
The directory where executable files that needs to be executed during boot, before
|
The directory where executable files that needs to be executed during boot, before
|
||||||
daemons are launched, are placed on rootless. They are executed after all filesystems
|
daemons are launched, are placed on rootless. They are executed after all filesystems
|
||||||
@@ -330,15 +250,8 @@ injects a dylib into launchd to allow the
|
|||||||
.Sy launchctl runstats
|
.Sy launchctl runstats
|
||||||
command to be used on the device.
|
command to be used on the device.
|
||||||
.Sh DEPRECATED AND REMOVED FUNCTIONALITY
|
.Sh DEPRECATED AND REMOVED FUNCTIONALITY
|
||||||
There was an option in
|
.Pp
|
||||||
.Nm
|
The fakefs functionality was removed.
|
||||||
to force create the fakefs even when one already exists (which would overwrite
|
|
||||||
the existing fakefs), by setting the palerain_option_setup_rootful_forced flag
|
|
||||||
in palera1n flags. This option was removed because using
|
|
||||||
.Fl -force-revert
|
|
||||||
and
|
|
||||||
.Fl c
|
|
||||||
at the same time has exactly the same effect.
|
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr launchd 8
|
.Xr launchd 8
|
||||||
.Xr launchd.plist 5
|
.Xr launchd.plist 5
|
||||||
|
|||||||
+4
-2
@@ -60,12 +60,12 @@ static int usage(int e, char* prog_name)
|
|||||||
{
|
{
|
||||||
fprintf(stderr,
|
fprintf(stderr,
|
||||||
"Usage: %s [-"
|
"Usage: %s [-"
|
||||||
"DEhpvVldsSLRnPI"
|
"DEhpvVdsSLRnPI"
|
||||||
#ifdef DEV_BUILD
|
#ifdef DEV_BUILD
|
||||||
"12"
|
"12"
|
||||||
#endif
|
#endif
|
||||||
#ifdef ROOTFUL
|
#ifdef ROOTFUL
|
||||||
"cCfB"
|
"cCfBl"
|
||||||
#endif
|
#endif
|
||||||
#ifdef TUI
|
#ifdef TUI
|
||||||
"t"
|
"t"
|
||||||
@@ -95,7 +95,9 @@ static int usage(int e, char* prog_name)
|
|||||||
"\t-i, --override-checkra1n <file>\t\tOverride checkra1n\n"
|
"\t-i, --override-checkra1n <file>\t\tOverride checkra1n\n"
|
||||||
"\t-k, --override-pongo <file>\t\tOverride Pongo image\n"
|
"\t-k, --override-pongo <file>\t\tOverride Pongo image\n"
|
||||||
"\t-K, --override-kpf <file>\t\tOverride kernel patchfinder\n"
|
"\t-K, --override-kpf <file>\t\tOverride kernel patchfinder\n"
|
||||||
|
#ifdef ROOTFUL
|
||||||
"\t-l, --rootless\t\t\t\tBoots rootless. This is the default\n"
|
"\t-l, --rootless\t\t\t\tBoots rootless. This is the default\n"
|
||||||
|
#endif
|
||||||
"\t-L, --jbinit-log-to-file\t\tMake jbinit log to /cores/jbinit.log (can be read from sandbox while jailbroken)\n"
|
"\t-L, --jbinit-log-to-file\t\tMake jbinit log to /cores/jbinit.log (can be read from sandbox while jailbroken)\n"
|
||||||
"\t-n, --exit-recovery\t\t\tExit recovery mode\n"
|
"\t-n, --exit-recovery\t\t\tExit recovery mode\n"
|
||||||
"\t-I, --device-info\t\t\tPrint info about the connected device\n"
|
"\t-I, --device-info\t\t\tPrint info about the connected device\n"
|
||||||
|
|||||||
Reference in new issue
Block a user