mirror of
https://github.com/ClementTsang/bottom
synced 2024-11-10 14:44:18 +00:00
chore: Delete docs folder and update lock
This commit is contained in:
ClementTsang
parent
28c27272d7
commit
99516ca143
4 changed files with 4 additions and 142 deletions
|
|
@ -49,6 +49,7 @@ notifications:
|
|||
|
||||
before_deploy:
|
||||
- cargo install --path . --target $TARGET
|
||||
- cargo update
|
||||
- |
|
||||
if [[ $TRAVIS_OS_NAME == "windows" ]]; then
|
||||
choco install zip;
|
||||
|
|
|
|||
6
Cargo.lock
generated
6
Cargo.lock
generated
|
|
@ -117,7 +117,7 @@ dependencies = [
|
|||
"predicates 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"regex 1.3.6 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"serde 1.0.106 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"sysinfo 0.13.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"sysinfo 0.13.1 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"toml 0.5.6 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"tui 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"typed-builder 0.5.1 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
|
|
@ -1088,7 +1088,7 @@ dependencies = [
|
|||
|
||||
[[package]]
|
||||
name = "sysinfo"
|
||||
version = "0.13.0"
|
||||
version = "0.13.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
dependencies = [
|
||||
"cfg-if 0.1.10 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
|
|
@ -1390,7 +1390,7 @@ dependencies = [
|
|||
"checksum smallvec 1.3.0 (registry+https://github.com/rust-lang/crates.io-index)" = "05720e22615919e4734f6a99ceae50d00226c3c5aca406e102ebc33298214e0a"
|
||||
"checksum strsim 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)" = "8ea5119cdb4c55b55d432abb513a0429384878c15dde60cc77b1c99de1a95a6a"
|
||||
"checksum syn 1.0.17 (registry+https://github.com/rust-lang/crates.io-index)" = "0df0eb663f387145cab623dea85b09c2c5b4b0aef44e945d928e682fce71bb03"
|
||||
"checksum sysinfo 0.13.0 (registry+https://github.com/rust-lang/crates.io-index)" = "66195c6f9e36ea5def8d58565cb0044a65d58df3addbf1358bd4d8719122b3d0"
|
||||
"checksum sysinfo 0.13.1 (registry+https://github.com/rust-lang/crates.io-index)" = "8edb5068ab4f00d7f7e78cae194235a4f45671fb5a19b344731b9ab5478e0a6f"
|
||||
"checksum textwrap 0.11.0 (registry+https://github.com/rust-lang/crates.io-index)" = "d326610f408c7a4eb6f51c37c330e496b08506c9457c9d34287ecc38809fb060"
|
||||
"checksum thread_local 1.0.1 (registry+https://github.com/rust-lang/crates.io-index)" = "d40c6d1b69745a6ec6fb1ca717914848da4b44ae29d9b3080cbee91d72a69b14"
|
||||
"checksum threadpool 1.7.1 (registry+https://github.com/rust-lang/crates.io-index)" = "e2f0c90a5f3459330ac8bc0d2f879c693bb7a2f59689c1083fc4ef83834da865"
|
||||
|
|
|
|||
|
|
@ -1,82 +0,0 @@
|
|||
# Config Files
|
||||
|
||||
## Boot options
|
||||
|
||||
One use of a config file is to set boot flags to execute without having to state them when launching the program.
|
||||
|
||||
- This is set under the `[flags]` section.
|
||||
- These options are generally the same as the long names as other flags (ex: `case_sensitive = true`).
|
||||
- Note that if a flag and an option conflict, the flag has higher precedence (ex: if the `-c` and `temperature_type = kelvin` both exist, the Celsius temperature type is ultimately chosen).
|
||||
- For temperature type, use `temperature_type = "kelvin|k|celsius|c|fahrenheit|f"`.
|
||||
|
||||
## Colours
|
||||
|
||||
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.
|
||||
|
||||
## Layout
|
||||
|
||||
As of 0.3.0, bottom supports custom layouts. Layouts are in the TOML specification, and are arranged by row -> column -> row. For example, the default layout:
|
||||
|
||||
```toml
|
||||
[[row]]
|
||||
ratio=30
|
||||
[[row.child]]
|
||||
type="cpu"
|
||||
[[row]]
|
||||
ratio=40
|
||||
[[row.child]]
|
||||
ratio=4
|
||||
type="mem"
|
||||
[[row.child]]
|
||||
ratio=3
|
||||
[[row.child.child]]
|
||||
type="temp"
|
||||
[[row.child.child]]
|
||||
type="disk"
|
||||
[[row]]
|
||||
ratio=30
|
||||
[[row.child]]
|
||||
type="net"
|
||||
[[row.child]]
|
||||
type="proc"
|
||||
default=true
|
||||
```
|
||||
|
||||
Valid types are:
|
||||
|
||||
- `cpu`
|
||||
- `mem`
|
||||
- `proc`
|
||||
- `net`
|
||||
- `temp`
|
||||
- `disk`
|
||||
- `empty`
|
||||
|
||||
## Default config locations
|
||||
|
||||
bottom will check specific locations by default for a config file. If no file is found, it will be created.
|
||||
|
||||
- For Unix-based systems: `$HOME/.config/bottom/bottom.toml`.
|
||||
- For Windows: `{FOLDERID_RoamingAppData}\bottom\bottom.toml` (for example, `C:\Users\Clement\AppData\Roaming\bottom\bottom.toml`).
|
||||
|
|
@ -1,57 +0,0 @@
|
|||
# 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.
|
||||
Loading…
Reference in a new issue