From c82bc2aea571caa31467339905cea75cbc7ea59c Mon Sep 17 00:00:00 2001 From: wh201906 Date: Wed, 13 Dec 2023 21:00:11 +0800 Subject: [PATCH] Fix docs Add new PLATFORM_EXTRAS options in 4_Advanced-compilation-parameters.md Fix some help text --- client/src/proxmark3.c | 4 ++-- .../4_Advanced-compilation-parameters.md | 16 ++++++++++++---- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/client/src/proxmark3.c b/client/src/proxmark3.c index 00e93c6d18..6ab2e5edf5 100644 --- a/client/src/proxmark3.c +++ b/client/src/proxmark3.c @@ -596,13 +596,13 @@ static void show_help(bool showFullHelp, char *exec_name) { PrintAndLogEx(NORMAL, " -s/--script-file script file with one Proxmark3 command per line"); PrintAndLogEx(NORMAL, " -i/--interactive enter interactive mode after executing the script or the command"); PrintAndLogEx(NORMAL, " --incognito do not use history, prefs file nor log files"); + PrintAndLogEx(NORMAL, " --ncpu override number of CPU cores"); PrintAndLogEx(NORMAL, "\nOptions in flasher mode:"); PrintAndLogEx(NORMAL, " --flash flash Proxmark3, requires at least one --image"); - PrintAndLogEx(NORMAL, " --reboot-bootloader reboot Proxmark3 into bootloader mode"); + PrintAndLogEx(NORMAL, " --reboot-to-bootloader reboot Proxmark3 into bootloader mode"); PrintAndLogEx(NORMAL, " --unlock-bootloader Enable flashing of bootloader area *DANGEROUS* (need --flash)"); PrintAndLogEx(NORMAL, " --force Enable flashing even if firmware seems to not match client version"); PrintAndLogEx(NORMAL, " --image image to flash. Can be specified several times."); - PrintAndLogEx(NORMAL, " --ncpu override number of CPU cores"); PrintAndLogEx(NORMAL, "\nExamples:"); PrintAndLogEx(NORMAL, "\n to run Proxmark3 client:\n"); PrintAndLogEx(NORMAL, " %s "SERIAL_PORT_EXAMPLE_H" -- runs the pm3 client", exec_name); diff --git a/doc/md/Use_of_Proxmark/4_Advanced-compilation-parameters.md b/doc/md/Use_of_Proxmark/4_Advanced-compilation-parameters.md index 32c7e4116c..406a7bcec1 100644 --- a/doc/md/Use_of_Proxmark/4_Advanced-compilation-parameters.md +++ b/doc/md/Use_of_Proxmark/4_Advanced-compilation-parameters.md @@ -82,13 +82,21 @@ Known issues: Here are the supported values you can assign to `PLATFORM_EXTRAS` in `Makefile.platform`: -| PLATFORM_EXTRAS | DESCRIPTION | -|-----------------|----------------------------------------| -| BTADDON | Proxmark3 rdv4 BT add-on | +| PLATFORM_EXTRAS | DESCRIPTION | +|-----------------|-----------------------------------------| +| BTADDON | Proxmark3 rdv4 BT add-on | +| FLASH | Flash modding for generic Proxmark3 | +| SMARTCARD | Smartcard modding for generic Proxmark3 | By default `PLATFORM_EXTRAS=`. -If you have installed a Blue Shark add-on on your RDV4, define `PLATFORM_EXTRAS=BTADDON` in your `Makefile.platform`. +If you have installed a Blue Shark add-on on your RDV4, define `PLATFORM_EXTRAS=BTADDON` in your `Makefile.platform` to enable it. + +If you did some modding on the `PM3GENERIC` platform, you can define `FLASH` and `SMARTCARD` to enable these features, like +`PLATFORM_EXTRAS=FLASH` + +You can also define multiple options like +`PLATFORM_EXTRAS=FLASH SMARTCARD` ## STANDALONE