diff options
| author | ClementTsang <cjhtsang@uwaterloo.ca> | 2020-02-23 13:11:38 -0500 |
|---|---|---|
| committer | ClementTsang <cjhtsang@uwaterloo.ca> | 2020-02-23 13:15:46 -0500 |
| commit | 59238c2687b94df9c42d6dcff957387b66db9668 (patch) | |
| tree | e1060824a5ca4d2e12c96e7d866dec7f7d7eb83e /docs | |
| parent | 6ffe14707d337e57c65a940d4b9d57b4b554525c (diff) | |
Added named colour support + rgb colour support in config files.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config.md | 41 |
1 files changed, 21 insertions, 20 deletions
diff --git a/docs/config.md b/docs/config.md index d2bddeef..08e171bf 100644 --- a/docs/config.md +++ b/docs/config.md @@ -12,26 +12,27 @@ One use of a config file is to set boot flags to execute without having to state ## Colours -Another use is to set colours, under the `[colors]`. The following labels are customizable with hex colour code strings: - -| Labels | Details | Example | -| ------------------------------- | ---------------------------------------------- | --------------------------------------------------- | -| Table header colours | Colour of table headers | `table_header_color="#ffffff"` | -| CPU colour per core | Colour of each core. Read in order. | `cpu_core_colors=["#ffffff", "#000000", "#111111"]` | -| | Looks at 256 colours at most. | -| Average CPU colour | The average CPU color | `avg_cpu_color="#d3869b"` | -| RAM | The colour RAM will use | `ram_color="#ffffff"` | -| SWAP | The colour SWAP will use | `swap_color="#111111"` | -| RX | The colour rx will use | `rx_color="#ffffff"` | -| TX | The colour tx will use | `tx_color="#111111"` | -| Widget title colour | The colour of the label each widget has | `widget_title_color="#ffffff"` | -| Border colour | The colour of the border of unselected widgets | `border_color="#ffffff"` | -| Selected border colour | The colour of the border of selected widgets | `highlighted_border_color="#ffffff"` | -| Text colour | The colour of most text | `text_color="#ffffff"` | -| Graph colour | The colour of the lines and text of the graph | `graph_color="#ffffff"` | -| Cursor colour | The cursor's colour | `cursor_color="#ffffff"` | -| Selected text colour | The colour of text that is selected | `scroll_entry_text_color="#282828"` | -| Selected text background colour | The background colour of text that is selected | `scroll_entry_bg_color="#458588"` | +Another use is to set colours, under the `[colors]`. The following labels are customizable with strings that are hex colours, RGB colours, or specific named colours. + +Supported named colours are one of the following: `Reset, Black, Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed, LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White` + +| Labels | Details | Example | +| ------------------------------- | ---------------------------------------------- | ------------------------------------------------------ | +| Table header colours | Colour of table headers | `table_header_color="256, 256, 256"` | +| CPU colour per core | Colour of each core. Read in order. | `cpu_core_colors=["#ffffff", "blue", "122, 122, 122"]` | +| Average CPU colour | The average CPU color | `avg_cpu_color="Red"` | +| RAM | The colour RAM will use | `ram_color="#ffffff"` | +| SWAP | The colour SWAP will use | `swap_color="#111111"` | +| RX | The colour rx will use | `rx_color="#ffffff"` | +| TX | The colour tx will use | `tx_color="#111111"` | +| Widget title colour | The colour of the label each widget has | `widget_title_color="#ffffff"` | +| Border colour | The colour of the border of unselected widgets | `border_color="#ffffff"` | +| Selected border colour | The colour of the border of selected widgets | `highlighted_border_color="#ffffff"` | +| Text colour | The colour of most text | `text_color="#ffffff"` | +| Graph colour | The colour of the lines and text of the graph | `graph_color="#ffffff"` | +| Cursor colour | The cursor's colour | `cursor_color="#ffffff"` | +| Selected text colour | The colour of text that is selected | `scroll_entry_text_color="#282828"` | +| Selected text background colour | The background colour of text that is selected | `scroll_entry_bg_color="#458588"` | Note some colours may not be compatible with the terminal you are using. For example, macOS's default Terminal does not play nice with many colours. |