Skip to content

Commit

Permalink
Merge pull request #2207 from wh201906/doc
Browse files Browse the repository at this point in the history
Fix docs
  • Loading branch information
iceman1001 authored Dec 13, 2023
2 parents c14d675 + c82bc2a commit 4e5b896
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
4 changes: 2 additions & 2 deletions client/src/proxmark3.c
Original file line number Diff line number Diff line change
Expand Up @@ -596,13 +596,13 @@ static void show_help(bool showFullHelp, char *exec_name) {
PrintAndLogEx(NORMAL, " -s/--script-file <cmd_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 <num_cores> 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 <imagefile> image to flash. Can be specified several times.");
PrintAndLogEx(NORMAL, " --ncpu <num_cores> 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);
Expand Down
16 changes: 12 additions & 4 deletions doc/md/Use_of_Proxmark/4_Advanced-compilation-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4e5b896

Please sign in to comment.