From 519c38aa5def8be193eab3c556dca0c39e7a7529 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 6 Jan 2023 02:08:43 +0000 Subject: [PATCH] Deployed 33afeb68 to nightly with MkDocs 1.4.1 and mike 1.1.2 --- nightly/404.html | 2 +- .../command-line-flags/index.html | 2 +- .../config-file/data-filtering/index.html | 38 ++++++------ .../config-file/default-config/index.html | 2 +- .../config-file/flags/index.html | 2 +- .../config-file/layout/index.html | 30 +++++----- .../config-file/theming/index.html | 2 +- .../development/build_process/index.html | 2 +- .../development/deploy_process/index.html | 6 +- .../development/dev_env/index.html | 2 +- .../development/logging/index.html | 2 +- .../development/testing/index.html | 2 +- nightly/contribution/documentation/index.html | 12 ++-- .../issues-and-pull-requests/index.html | 2 +- .../packaging-and-distribution/index.html | 8 +-- nightly/index.html | 2 +- nightly/sitemap.xml | 54 +++++++++--------- nightly/sitemap.xml.gz | Bin 480 -> 481 bytes nightly/support/official/index.html | 2 +- nightly/support/unofficial/index.html | 2 +- nightly/troubleshooting/index.html | 22 +++---- nightly/usage/basic-mode/index.html | 10 ++-- nightly/usage/general-usage/index.html | 6 +- nightly/usage/widgets/battery/index.html | 2 +- nightly/usage/widgets/cpu/index.html | 2 +- nightly/usage/widgets/disk/index.html | 2 +- nightly/usage/widgets/memory/index.html | 2 +- nightly/usage/widgets/network/index.html | 2 +- nightly/usage/widgets/process/index.html | 2 +- nightly/usage/widgets/temperature/index.html | 2 +- 30 files changed, 113 insertions(+), 113 deletions(-) diff --git a/nightly/404.html b/nightly/404.html index 8f813e9e..62c4fd13 100644 --- a/nightly/404.html +++ b/nightly/404.html @@ -1002,7 +1002,7 @@
- + diff --git a/nightly/configuration/command-line-flags/index.html b/nightly/configuration/command-line-flags/index.html index 4a5c8d62..59dbaea2 100644 --- a/nightly/configuration/command-line-flags/index.html +++ b/nightly/configuration/command-line-flags/index.html @@ -1246,7 +1246,7 @@ - + diff --git a/nightly/configuration/config-file/data-filtering/index.html b/nightly/configuration/config-file/data-filtering/index.html index 6016d083..e62f5138 100644 --- a/nightly/configuration/config-file/data-filtering/index.html +++ b/nightly/configuration/config-file/data-filtering/index.html @@ -1007,28 +1007,28 @@For example, here's the disk widget with no filter:
The following in the config file would filter out some entries by disk name:
-[disk_filter]
-is_list_ignored = true
-list = ["/dev/sda"]
-regex = true
-case_sensitive = false
-whole_word = false
+[disk_filter]
+is_list_ignored = true
+list = ["/dev/sda"]
+regex = true
+case_sensitive = false
+whole_word = false

If there are two potentially conflicting filters (i.e. when you are using both a disk and mount filter), the filter that explicitly allows an entry takes precedence over a filter that explicitly denies one. So for example, let's say we set a disk filter accepting anything with /dev/sda
, but deny anything with /mnt/.*
or /
. So to do so, we write in the config file:
-[disk_filter]
-is_list_ignored = false
-list = ["/dev/sda"]
-regex = true
-case_sensitive = false
-whole_word = false
+[disk_filter]
+is_list_ignored = false
+list = ["/dev/sda"]
+regex = true
+case_sensitive = false
+whole_word = false
-[mount_filter]
-is_list_ignored = true
-list = ["/mnt/.*", "/"]
-regex = true
-case_sensitive = false
-whole_word = true
+[mount_filter]
+is_list_ignored = true
+list = ["/mnt/.*", "/"]
+regex = true
+case_sensitive = false
+whole_word = true
This gives us:

@@ -1110,7 +1110,7 @@
-
+
diff --git a/nightly/configuration/config-file/default-config/index.html b/nightly/configuration/config-file/default-config/index.html
index 6ef9d167..f429cdd2 100644
--- a/nightly/configuration/config-file/default-config/index.html
+++ b/nightly/configuration/config-file/default-config/index.html
@@ -1101,7 +1101,7 @@
bottom supports customizable layouts via the config file. Currently, layouts are controlled by using TOML objects and arrays.
For example, given the sample layout:
-[[row]]
- [[row.child]]
- type="cpu"
-[[row]]
- ratio=2
- [[row.child]]
- ratio=4
- type="mem"
- [[row.child]]
- ratio=3
- [[row.child.child]]
- type="temp"
- [[row.child.child]]
- type="disk"
+[[row]]
+ [[row.child]]
+ type="cpu"
+[[row]]
+ ratio=2
+ [[row.child]]
+ ratio=4
+ type="mem"
+ [[row.child]]
+ ratio=3
+ [[row.child.child]]
+ type="temp"
+ [[row.child.child]]
+ type="disk"
This would give a layout that has two rows, with a 1:2 ratio. The first row has only the CPU widget.
The second row is split into two columns with a 4:3 ratio. The first column contains the memory widget.
@@ -1152,7 +1152,7 @@ represents a widget. A widget is represented by having a type
If one does not want to actually update the nightly release, and just want to test the general builds and workflow, one can run the workflow manually on a branch of choice with "mock" set as the parameter. Changing it to anything else will trigger a non-mock run.
This can be manually triggered, though the general use-case is setting a tag of the form x.y.z
(after checking everything is good, of course). For example:
git tag 0.6.9 && git push origin 0.6.9
+git tag 0.6.9 && git push origin 0.6.9
This will automatically trigger the deployment workflow, and create a draft release with the files uploaded. One still needs to fill in the details and release it.
Furthermore, there are some deployments that are handled by maintainers of bottom that this workflow does not automatically finish. These must be manually handled.
@@ -1099,7 +1099,7 @@
If done correctly, there should be a new build on Chocolatey, which will take some time to validate.
crates.io
Validate everything builds properly and works (you should have done this before releasing though). If good, then deploying on crates.io is as simple as:
-cargo publish
+cargo publish
@@ -1179,7 +1179,7 @@
-
+
diff --git a/nightly/contribution/development/dev_env/index.html b/nightly/contribution/development/dev_env/index.html
index 03b2bcec..ba011199 100644
--- a/nightly/contribution/development/dev_env/index.html
+++ b/nightly/contribution/development/dev_env/index.html
@@ -1085,7 +1085,7 @@
For changes to the extended documentation, you'll probably want MkDocs, Material for MkDocs, mdx_truly_sane_lists
, and optionally Mike installed to provide live reloading and preview for your changes. They aren't needed but it'll help with validating your changes.
You can do so through pip
or your system's package managers. If you use pip
, you probably would want to do something like so through a venv:
# Starting from the repo root:
-cd docs/
+cd docs/
# Create venv and activate
-python -m venv venv
-source venv/bin/activate
+python -m venv venv
+source venv/bin/activate
# Install requirements
-pip install -r requirements.txt
+pip install -r requirements.txt
# Run mkdocs
-venv/bin/mkdocs serve
+venv/bin/mkdocs serve
You can also find a nightly build in the releases page, built every day at 00:00 UTC off of the master branch.
If you want to manually build bottom rather than distributing a pre-built binary, you'll need the most recent version of stable Rust, which you can get with:
-rustup update stable
+rustup update stable
You'll then want to build with:
-cargo build --release --locked
+cargo build --release --locked
Manpage and completion generation
bottom uses a build.rs
script to automatically generate
@@ -1080,7 +1080,7 @@ a manpage and shell completions for the following shells:
If you want to generate manpages and/or completion files, set the BTM_GENERATION
env var to a non-empty value. For
example, run something like this:
-BTM_GENERATE=true cargo build --release --locked
+BTM_GENERATE=true cargo build --release --locked
This will automatically generate completion and manpage files in target/tmp/bottom/
. If you wish to regenerate the
files, modify/delete either these files or set BTM_GENERATE
to some other non-empty value to retrigger the build
@@ -1170,7 +1170,7 @@ Once that's done, open a pull request - these will usually be approved of very q
-
+
diff --git a/nightly/index.html b/nightly/index.html
index e4b15942..d0f2a31d 100644
--- a/nightly/index.html
+++ b/nightly/index.html
@@ -1127,7 +1127,7 @@ bottom, whether it be filing issues, writing documentation, creating pull reques
-
+
diff --git a/nightly/sitemap.xml b/nightly/sitemap.xml
index f2841111..e6073070 100644
--- a/nightly/sitemap.xml
+++ b/nightly/sitemap.xml
@@ -2,137 +2,137 @@
https://clementtsang.github.io/bottom/nightly/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/troubleshooting/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/configuration/command-line-flags/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/configuration/config-file/data-filtering/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/configuration/config-file/default-config/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/configuration/config-file/flags/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/configuration/config-file/layout/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/configuration/config-file/theming/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/contribution/documentation/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/contribution/issues-and-pull-requests/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/contribution/development/build_process/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/contribution/development/deploy_process/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/contribution/development/dev_env/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/contribution/development/logging/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/contribution/development/testing/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/support/official/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/support/unofficial/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/usage/basic-mode/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/usage/general-usage/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/usage/widgets/battery/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/usage/widgets/cpu/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/usage/widgets/disk/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/usage/widgets/memory/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/usage/widgets/network/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/usage/widgets/process/
- 2022-12-07
+ 2023-01-06
daily
https://clementtsang.github.io/bottom/nightly/usage/widgets/temperature/
- 2022-12-07
+ 2023-01-06
daily
\ No newline at end of file
diff --git a/nightly/sitemap.xml.gz b/nightly/sitemap.xml.gz
index ba04a4e58596e3c93406f4386fda120b5e7b33a4..52bf1a2c30b1723176ba70ce003830bc0870fba1 100644
GIT binary patch
literal 481
zcmV<70UrJziwFp-g12J=|8r?{Wo=<_E_iKh0Nt0tj+`(IhVT0nBkm#WR;t>HVQ+nc
z_Ph$gglI#Y#?DOV?Hh(wOV5=md2=B)vH8DXtk6IIT*K)CnLNgG^VoLH38KZxM|W<%
zfBULFHP6FCUvePeQ(YYC+$_xLi`LicwI$E6nnW#Tr^znWApPdlUHiEi9!_;^3HI52
z^a1U#WucnJ23R37lZmc%o|iJV9`%UKxa#QL!r`WSy~P|;7~&PD;i-H2pt?uZeXL8~
ze1~OrscB)(@MD;a54T<)Ji9jiTin0PJ6cYOSk@lL|h9
znuBp9m1DEi>;ve@u-Rq|S@3%~@W5sjUa65`wCatTvNKm}Km$akZH4Jd>wCw?tMKTp(cD!t_{tm|jvw3q;~+
zCP)Eq?+EAe0`VfABcO9)Tk(N|YX=j=K_w;3tZ|;b^(IKuU7|GQg^U9|8uC_EB_K<;
zg9zCKwOgX3U;X5uo-Rhi_4nu|Q@l+@rto?qdX=esg%zciO9Z}R7P|4mj%a_2XINA1
Xlw9(EXp{E~0S~_b1mI*k>J$I~0uS}O
literal 480
zcmV<60U!P!iwFqnT##b||8r?{Wo=<_E_iKh0Nt0tZrd;nhVOlfz;{_`F5L#lz3mCs
zb0N#LEL0X%k&2hMpBxukb{;T*)x{z$(*GyZgxo#e)G}*Ztq(7Yc*nVyLheI7(f_-)y
zT|nD!S*WJ50TzhNWTI=G=eZ26M?D}jE;@QQbGYhGZ!z~N4Do_ve>$E{>hYwGPj$(M
z?{1l$Yg(8xy!WH=;o9jtq1X7WeNmIb#_D(2U4+52eVq7$@&aHeBnVTFYYMsDh86
zreGXN<=8AW`2cz}Y_=Ig7W`iBcwjOmu-bj{c|J**1#`v1@;SJ6a#`OAXFrr1$B4FU
zF*}t+0#8(c)YgMj2|?9IR+~vAOfvS(xLQm%p3&2vTOz9qE)XznVR|S&jISx91tRe@
zBcy=WPlR)Mg?JIq5zslYt@w_EYX=j=K_w;3tZ|yW^(IKuU7|GQg^U9|81hzCB_K<;
zg9zCKwOgX3uYPn;PZxvX`g?ShDc+_cQ+PcQy~$L*z=BfCB?7OQg>JmCBii5M8J1K#
WC71jk+T`s*!2K^}ASFNQ6aWC8sOtp)
diff --git a/nightly/support/official/index.html b/nightly/support/official/index.html
index 14abeb47..9ce490c8 100644
--- a/nightly/support/official/index.html
+++ b/nightly/support/official/index.html
@@ -1167,7 +1167,7 @@ bottom from the repo/source, then please try that as well.
This is a known limitation, and you may have to run the program with elevated privileges to work around it - for example:
-sudo btm
+sudo btm
Please note that you should be certain that you trust any software you grant root privileges.
There are measures taken to try to maximize the amount of information obtained without elevated privileges. For example,
@@ -1186,12 +1186,12 @@ on how to run htop without sudo for bottom. However please unde
It may be handy to refer to the automatically generated config files or the sample configuration files.
The config files also follow the TOML format.
Also make sure your config options are under the right table - for example, to set your temperature type, you must set it under the [flags]
table:
-[flags]
-temperature_type = "f"
+[flags]
+temperature_type = "f"
Meanwhile, if you want to set a custom color scheme, it would be under the [colors]
table:
-[colors]
-table_header_color="LightBlue"
+[colors]
+table_header_color="LightBlue"
Check the configuration file location
Make sure bottom is reading the right configuration file. By default, bottom looks for config files at these locations:
@@ -1218,15 +1218,15 @@ The config files also follow the TOML format.<
If you want to use a config file in another location, use the --config
or -C
flags along with the path to the configuration file, like so:
-btm -C path_to_config
+btm -C path_to_config
My installation through snap has some widgets that are blank/show no data
Make sure bottom is given the correct permissions in order to collect data. Snapcraft
explains how to do so, but the TL;DR is:
-sudo snap connect bottom:mount-observe
-sudo snap connect bottom:hardware-observe
-sudo snap connect bottom:system-observe
-sudo snap connect bottom:process-control
+sudo snap connect bottom:mount-observe
+sudo snap connect bottom:hardware-observe
+sudo snap connect bottom:system-observe
+sudo snap connect bottom:process-control
@@ -1291,7 +1291,7 @@ sudo snap connect bottom:process-control
-
+
diff --git a/nightly/usage/basic-mode/index.html b/nightly/usage/basic-mode/index.html
index 975b331c..b2c0c906 100644
--- a/nightly/usage/basic-mode/index.html
+++ b/nightly/usage/basic-mode/index.html
@@ -1041,15 +1041,15 @@
Basic mode can be enabled either through a command line flag:
-btm -b
+btm -b
# or
-btm --basic
+btm --basic
or through the config:
-[flags]
-basic = true
+[flags]
+basic = true
Notes
In this mode, widgets that use tables (temperatures, processes, disks, and batteries) are only shown one at a time.
@@ -1136,7 +1136,7 @@ to switch which widget is shown.
-
+
diff --git a/nightly/usage/general-usage/index.html b/nightly/usage/general-usage/index.html
index da1222ad..b6e8a7e7 100644
--- a/nightly/usage/general-usage/index.html
+++ b/nightly/usage/general-usage/index.html
@@ -1067,10 +1067,10 @@
For help regarding the command-line flags, use:
# For a simple overview of flags
-btm -h
+btm -h
# For more details
-btm --help
+btm --help
You can also see keybinds and basic usage details in bottom by pressing ?, which will open a help menu.
Features
@@ -1264,7 +1264,7 @@ Note that key bindings are generally case-sensitive.
-
+
diff --git a/nightly/usage/widgets/battery/index.html b/nightly/usage/widgets/battery/index.html
index 9c618d0c..713ec0fa 100644
--- a/nightly/usage/widgets/battery/index.html
+++ b/nightly/usage/widgets/battery/index.html
@@ -1176,7 +1176,7 @@
-
+
diff --git a/nightly/usage/widgets/cpu/index.html b/nightly/usage/widgets/cpu/index.html
index 11f1960f..064a681a 100644
--- a/nightly/usage/widgets/cpu/index.html
+++ b/nightly/usage/widgets/cpu/index.html
@@ -1263,7 +1263,7 @@ at the same time, though this may get a bit hard to follow if you have a large n
-
+
diff --git a/nightly/usage/widgets/disk/index.html b/nightly/usage/widgets/disk/index.html
index 784282c5..0da14c37 100644
--- a/nightly/usage/widgets/disk/index.html
+++ b/nightly/usage/widgets/disk/index.html
@@ -1209,7 +1209,7 @@