bottom/docs/widgets.md

# Widgets

## Compatibility

The compatibility of each widget and operating systems are, as of version 0.2.0, as follows:

| OS      | CPU | Memory | Disks | Temperature | Processes | Networks |
| ------- | --- | ------ | ----- | ----------- | --------- | -------- |
| Linux   | ✓   | ✓      | ✓     | ✓           | ✓         | ✓        |
| Windows | ✓   | ✓      | ✓     | ✗           | ✓         | ✓        |
| macOS   | ✓   | ✓      | ✓     | ✓           | ✓         | ✓        |

- Linux is tested on Arch Linux, using Kitty Terminal.

- Windows is tested on Windows 10, using Powershell.

- macOS is tested on macOS Catalina, using the base Terminal and Kitty Terminal.

Some notes about each OS:

### Windows

I advise running the program with the `--dot_marker` or `-m` option, as the braille font seems to not work out of the box on Powershell. You may need to install a font like [FreeMono](https://fonts2u.com/free-monospaced.font) and use a terminal like cmder for font support to work properly, unfortunately.

### macOS

macOS seems to work fine for the most part, barring potential keybind conflicts when trying to switch widgets (`H/J/K/L` seems to have no conflicts).

## Widget information

### CPU

- Supports displaying specific cores (or average CPU usage if enabled); use `/` to allow for selection of cores to display, and `Space` to enable/disable them.

### Memory

- If no SWAP is available (size of 0) then no entry will show for SWAP.

### Disk

- I'm aware that Windows disk names are a bit strange... not sure if there's much I can do about it.

### Temperature

- Temperature sensors are sorted alphabetically and then by temperature (descending).

- Personally I found this to not work on Windows but YMMV.

### Network

- I'm aware that you cannot easily determine which graph line belongs to which entry unless you maximize - this is due to a limitation of tui-rs, and will be solved in a future release of the library.

- The graph is scaled logarithmically, by bytes, kibibytes, mebibytes, and gibibytes. I personally think this is enough for most people, but if you have a use case in which this isn't enough, let me know and I'll add in ways to increase it.

### Processes

- Filtering follows the convention of VS Code in terms of behaviour. For example, even in regex mode, it is not case sensitive if that is not enabled.
[skip travis] Add new documentation file; this is not filled out yet. 2020-02-15 18:16:52 -05:00			`# Widgets`

[skip travis] More documentation updating. Moved compat. chart over to widgets section, rewording, and add note on colour issues on some terminals when setting custom colours. 2020-02-19 21:32:47 -05:00			`## Compatibility`
[skip travis] Update documentation with widget specifics; prepare for release soon... 2020-02-16 21:12:31 -05:00
[skip travis] More documentation updating. Moved compat. chart over to widgets section, rewording, and add note on colour issues on some terminals when setting custom colours. 2020-02-19 21:32:47 -05:00			`The compatibility of each widget and operating systems are, as of version 0.2.0, as follows:`

			`\| OS \| CPU \| Memory \| Disks \| Temperature \| Processes \| Networks \|`
			`\| ------- \| --- \| ------ \| ----- \| ----------- \| --------- \| -------- \|`
			`\| Linux \| ✓ \| ✓ \| ✓ \| ✓ \| ✓ \| ✓ \|`
			`\| Windows \| ✓ \| ✓ \| ✓ \| ✗ \| ✓ \| ✓ \|`
			`\| macOS \| ✓ \| ✓ \| ✓ \| ✓ \| ✓ \| ✓ \|`

			`- Linux is tested on Arch Linux, using Kitty Terminal.`

			`- Windows is tested on Windows 10, using Powershell.`

			`- macOS is tested on macOS Catalina, using the base Terminal and Kitty Terminal.`

Update documentation again. One last build trigger. 2020-02-20 21:24:49 -05:00			`Some notes about each OS:`

			`### Windows`

			I advise running the program with the `--dot_marker` or `-m` option, as the braille font seems to not work out of the box on Powershell. You may need to install a font like [FreeMono](https://fonts2u.com/free-monospaced.font) and use a terminal like cmder for font support to work properly, unfortunately.

			`### macOS`

			macOS seems to work fine for the most part, barring potential keybind conflicts when trying to switch widgets (`H/J/K/L` seems to have no conflicts).

[skip travis] Consistency in captialization. 2020-02-19 21:36:17 -05:00			`## Widget information`
[skip travis] More documentation updating. Moved compat. chart over to widgets section, rewording, and add note on colour issues on some terminals when setting custom colours. 2020-02-19 21:32:47 -05:00
			`### CPU`
[skip travis] Update documentation with widget specifics; prepare for release soon... 2020-02-16 21:12:31 -05:00
			- Supports displaying specific cores (or average CPU usage if enabled); use `/` to allow for selection of cores to display, and `Space` to enable/disable them.

[skip travis] More documentation updating. Moved compat. chart over to widgets section, rewording, and add note on colour issues on some terminals when setting custom colours. 2020-02-19 21:32:47 -05:00			`### Memory`
[skip travis] Update documentation with widget specifics; prepare for release soon... 2020-02-16 21:12:31 -05:00
			`- If no SWAP is available (size of 0) then no entry will show for SWAP.`

[skip travis] More documentation updating. Moved compat. chart over to widgets section, rewording, and add note on colour issues on some terminals when setting custom colours. 2020-02-19 21:32:47 -05:00			`### Disk`
[skip travis] Update documentation with widget specifics; prepare for release soon... 2020-02-16 21:12:31 -05:00
			`- I'm aware that Windows disk names are a bit strange... not sure if there's much I can do about it.`

[skip travis] More documentation updating. Moved compat. chart over to widgets section, rewording, and add note on colour issues on some terminals when setting custom colours. 2020-02-19 21:32:47 -05:00			`### Temperature`
[skip travis] Update documentation with widget specifics; prepare for release soon... 2020-02-16 21:12:31 -05:00
			`- Temperature sensors are sorted alphabetically and then by temperature (descending).`

			`- Personally I found this to not work on Windows but YMMV.`

[skip travis] More documentation updating. Moved compat. chart over to widgets section, rewording, and add note on colour issues on some terminals when setting custom colours. 2020-02-19 21:32:47 -05:00			`### Network`
[skip travis] Update documentation with widget specifics; prepare for release soon... 2020-02-16 21:12:31 -05:00
			`- I'm aware that you cannot easily determine which graph line belongs to which entry unless you maximize - this is due to a limitation of tui-rs, and will be solved in a future release of the library.`

			`- The graph is scaled logarithmically, by bytes, kibibytes, mebibytes, and gibibytes. I personally think this is enough for most people, but if you have a use case in which this isn't enough, let me know and I'll add in ways to increase it.`

[skip travis] More documentation updating. Moved compat. chart over to widgets section, rewording, and add note on colour issues on some terminals when setting custom colours. 2020-02-19 21:32:47 -05:00			`### Processes`
[skip travis] Update documentation with widget specifics; prepare for release soon... 2020-02-16 21:12:31 -05:00
			`- Filtering follows the convention of VS Code in terms of behaviour. For example, even in regex mode, it is not case sensitive if that is not enabled.`