From f5c4b338f2f3294e15d7ff6ed5e1cb8924840953 Mon Sep 17 00:00:00 2001 From: khcrysalis <97859147+khcrysalis@users.noreply.github.com> Date: Fri, 19 Jul 2024 22:23:52 -0700 Subject: [PATCH] feat: add usage to readme, also available with --help --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index af1dbeb..3713f43 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,38 @@ Jailbreak for A8 through A11, T2 devices, on iOS/iPadOS/tvOS 15.0, bridgeOS 5.0 > USB-C port on Apple Silicon Macs *may* require manual unplugging and replugging of the lightning cable after checkm8 exploit. This problem may be solved by connecting via USB hub, though extensions can vary. +## Usage +``` +Usage: palera1n [-DEhpvVdsSLRnPI] [-e boot arguments] [-k Pongo image] [-o overlay file] [-r ramdisk file] [-K KPF file] [-i checkra1n file] + + --version Print version + --force-revert Remove jailbreak + -d, --demote Demote + -D, --dfuhelper Exit after entering DFU + -e, --boot-args XNU boot arguments + -E, --enter-recovery Enter recovery mode + -h, --help Show this help + -i, --override-checkra1n Override checkra1n + -k, --override-pongo Override Pongo image + -K, --override-kpf Override kernel patchfinder + -L, --jbinit-log-to-file Make jbinit log to /cores/jbinit.log (can be read from sandbox while jailbroken) + -n, --exit-recovery Exit recovery mode + -I, --device-info Print info about the connected device + -o, --override-overlay Override overlay + -p, --pongo-shell Boots to PongoOS shell + -P, --pongo-full Boots to a PongoOS shell with default images already uploaded + -r, --override-ramdisk Override ramdisk + -R, --reboot-device Reboot connected device in normal mode + -s, --safe-mode Enter safe mode + -S, --no-colors Disable colors on the command line + -v, --debug-logging Enable debug logging + This option can be repeated for extra verbosity. + -V, --verbose-boot Verbose boot + +Environmental variables: + TMPDIR temporary diretory (path the built-in checkra1n will be extracted to) +``` + ## Installing Visit https://palera.in