From afe934f58591a8b3e7e643e686e227c393241eb2 Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Sun, 4 Aug 2024 11:14:34 +0200 Subject: [PATCH] docs: Add example for quoted option values --- docs/1_usage.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/docs/1_usage.md b/docs/1_usage.md index c9e25b65..48cdeaf4 100644 --- a/docs/1_usage.md +++ b/docs/1_usage.md @@ -16,7 +16,9 @@ java -jar revanced-cli.jar -h java -jar revanced-cli.jar list-patches --with-packages --with-versions --with-options revanced-patches.rvp ``` -## 💉 Patch an app with the default list of patches +## 💉 Patch an app + +To patch an app using the default list of patches, use the `patch` command: ```bash java -jar revanced-cli.jar patch -b revanced-patches.rvp input.apk @@ -28,10 +30,11 @@ You can also use multiple patch bundles: java -jar revanced-cli.jar patch -b revanced-patches.rvp -b another-patches.rvp input.apk ``` -To manually use patches that are not used by default, use the option `-i`. -To not use patches that are used by default, use the option `-e`. -You can also disuse all patches by default by using the option `--exclusive` and then use `-i` to use specific patches. -Keep in mind the name of the patch must be an exact match. Here is an example: +To change the default set of used patches, use the option `-i` or `-e` to use or disuse specific patches. +You can use the `list-patches` command to see which patches are used by default. + +To only use specific patches, you can use the option `--exclusive` combined with `-i`. +Remember that the options `-i` and `-e` match the patch's name exactly. Here is an example: ```bash java -jar revanced-cli.jar patch -b revanced-patches.rvp --exclusive -i "Patch name" -i "Another patch name" input.apk @@ -76,7 +79,7 @@ java -jar revanced-cli.jar patch -b revanced-patches.rvp --exclusive -i "Patch n > adb install input.apk > ``` -Patches can have options that you can set using the option `--set-options`. +Patches can have options you can set using the option `--set-options`. To know the options of a patch, use the option `--with-options` when listing patches: ```bash @@ -114,7 +117,12 @@ java -jar revanced-cli.jar patch -b revanced-patches.rvp --set-options "Patch na > In addition to that, you can escape quotes (`\"`, `\'`) and commas (`\,`) to treat values as string literals: > Integer as string: `\'123\'` > List with an integer, an integer as a string and a string with a comma: `123,\'123\',str\,ing` - +> +> Example command with escaped quotes: +> +> ```bash +> java -jar revanced-cli.jar -b revanced-patches.rvp --set-options "Patch name" -OstringKey=\'1\' input.apk +> ``` ## 📦 Install an app manually ```bash