1.8 KiB
Notes on Color usage.
Table of Contents
The client should autodetect color support when starting.
You can also use the command pref show to see and set your personal setting.
Why use colors in the Proxmark client? When everything is white it is hard to extract the important information fast. You also need new-lines for extra space to be easier to read. We have gradually been introducing this color scheme into the client since we got decent color support on all systems: OSX, Linux, WSL, Proxspace.
style/color
^Top The following definition has be crystallized out from these experiments. Its not set in stone yet so take this document as a guideline for how to create unified system scheme.
Definition
^Top
- blue - system related headers, banner
- white - normal
- cyan - headers
- red - warning, error, catastrophic failures
- yellow - informative (to make things stick out from white blob)
- green - successful, (to make things stick out from white blob)
- magenta - device side messages
Styled header
^Top
PrintAndLogEx(NORMAL, "");
PrintAndLogEx(INFO, "--- " _CYAN_("Tag Information") " ---------------------------");
PrintAndLogEx(INFO, "-------------------------------------------------------------");
For more examples, see also all -h helptext now in the LUA scripts. For the command help texts using YELLOW for the example makes it very easy to see what is the command vs the description.
non styled header
^Top Most commands doesn't use a header yet. We added it to make it standout (ie: yellow, green) of the informative tidbits in the output of a command.
Proxspace
^Top Proxspace has support for colors.