Revert "docs: do not mention options that does not appear in help menu"

This reverts commit 52d20c8e5b.

docs/palera1n.1

@@ -1,15 +1,15 @@
 .\"-
-.\" Copyright (c) 2023 Nick Chan
+.\" Copyright (c) 2024 Nick Chan
 .\" SPDX-License-Identifier: MIT
 .\"
-.Dd "26 October 2023"
+.Dd "23 March 2024"
 .Dt palera1n 1
 .Sh NAME
 .Nm palera1n
 .Nd iOS 15.0-17.1 arm64 iOS/iPadOS jailbreaking tool
 .Sh SYNOPSIS
 .Nm
-.Op Fl dDEhILnpRsSvV
+.Op Fl cCdDEfhIlLnpRsSvV
 .Op Fl e Ar Boot arguments
 .Op Fl k Ar Pongo image
 .Op Fl o Ar overlay file
@@ -25,6 +25,10 @@ utilizing the
 .Em checkm8
 bootROM exploit.
 .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
 .Em checkm8
 exploit,
@@ -91,7 +95,36 @@ Prints the program version and exit.
 Remove the jailbreak while keeping user data. Some jailbreak files may remain
 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
-still has their icons.
+still has their icons. When used with
+.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
 Set the effective production fuse to 0, so as to enable hardware debugging features.
 .It Fl D , -dfuhelper
@@ -102,9 +135,13 @@ Specify custom XNU kernel command line. The
 .Em rootdev=md0
 argument is used by
 .Nm
-and cannot be overriden.
+and cannot be overriden. Additionally, the
+.Em wdt=-1
+argument is used during fakefs setup.
 .It Fl E , -enter-recovery
 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
 Prints help text.
 .It Fl i , -checkra1n-file Ar checkra1n file
@@ -120,6 +157,12 @@ root filesystem in paleinfo with
 command. If in doubt, use
 .Sy https://github.com/palera1n/PongoOS
 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
 Makes jbinit log to
 .Em /cores/jbinit.log
@@ -178,10 +221,32 @@ To (re-)jailbreak in rootless mode:
 .Pp
 .Dl "palera1n"
 .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:
 .Pp
 .Dl "palera1n --force-revert"
 .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:
 .Pp
 .Dl "palera1n -n"
@@ -195,6 +260,8 @@ To verbose boot, use the
 .Fl V , -verbose-boot
 option when jailbreaking.
 .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.
 As a result, binaries with the old code signature format need to be resigned with a recent
 version of the Procursus fork of
@@ -202,6 +269,11 @@ version of the Procursus fork of
 before they can be ran on a device jailbroken with
 .Nm
 \[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
 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:
@@ -226,11 +298,23 @@ The location of the temporary filesystem where jailbreak files are stash during
 When
 .Fl L
 is used, the log file of jbinit.
+<<<<<<< HEAD
 The log file of jbinit.
+||||||| 52d20c8 (docs: do not mention options that does not appear in help menu)
+=======
+.It Pa /Library/LaunchDaemons
+The directory where jailbreak-specific
+.Xr launchd.plist 5
+property list files should be placed on rootful.
+>>>>>>> parent of 52d20c8 (docs: do not mention options that does not appear in help menu)
 .It Pa /var/jb/Library/LaunchDaemons
 The directory where jailbreak-specific
 .Xr launchd.plist 5
 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
 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
@@ -251,8 +335,15 @@ injects a dylib into launchd to allow the
 .Sy launchctl runstats
 command to be used on the device.
 .Sh DEPRECATED AND REMOVED FUNCTIONALITY
-.Pp
-The fakefs functionality was removed.
+There was an option in 
+.Nm
+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
 .Xr launchd 8
 .Xr launchd.plist 5

src/optparse.c

@@ -61,12 +61,12 @@ static int usage(int e, char* prog_name)
 {
 	fprintf(stderr,
 	"Usage: %s [-"
-	"DEhpvVdsSLRnPI"
+	"DEhpvVldsSLRnPI"
 #ifdef DEV_BUILD
 			"12"
 #endif
 #ifdef ROOTFUL
-			"cCfBl"
+			"cCfB"
 #endif
 #ifdef TUI
 			"t"
@@ -96,9 +96,7 @@ static int usage(int e, char* prog_name)
 			"\t-i, --override-checkra1n <file>\t\tOverride checkra1n\n"
 			"\t-k, --override-pongo <file>\t\tOverride Pongo image\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"
-#endif
 			"\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-I, --device-info\t\t\tPrint info about the connected device\n"