doc/colors_notes.md

   1 <a id="Top"></a>
   2 # Notes on Color usage.
   3
   4 ## Table of Contents
   5  * [style/color](#style_color)
   6  * [Proxspace](#proxspace)
   7  * [help texts](#help-texts)
   8
   9 The client should autodetect color support when starting.
  10
  11 You can also use the command  `pref show` to see and set your personal setting.
  12
  13 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.
  14 We have gradually been introducing this color scheme into the client since we got decent color support on all systems: OSX, Linux, WSL, Proxspace.
  15
  16
  17 ## style/color
  18 ^[Top](#top)
  19 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.
  20
  21 ### Definition
  22 ^[Top](#top)
  23 - blue - system related headers, banner
  24 - white  - normal
  25 - cyan - headers
  26 - red - warning, error,  catastrophic failures
  27 - yellow - informative  (to make things stick out from white blob)
  28 - green - successful,  (to make things stick out from white blob)
  29 - magenta - device side messages
  30
  31
  32 ### Styled header
  33 ^[Top](#top)
  34 ```
  35     PrintAndLogEx(NORMAL, "");
  36     PrintAndLogEx(INFO, "--- " _CYAN_("Tag Information") " ---------------------------");
  37     PrintAndLogEx(INFO, "-------------------------------------------------------------");
  38 ```
  39 For more examples, see also all **-h**  helptext now in the LUA scripts.
  40 For the command help texts using _YELLOW_ for the example makes it very easy to see what is the command vs the description.
  41
  42 ### non styled header
  43 ^[Top](#top)
  44 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.
  45
  46
  47 ## Proxspace
  48 ^[Top](#top)
  49 Proxspace has support for colors.
  50
  51
  52 ## Help texts
  53 ^[Top](#top)
  54 The help text uses a hard coded template deep inside the cliparser.c file.