mirror of
https://github.com/ClementTsang/bottom.git
synced 2025-07-27 15:44:17 +02:00
Deployed f35718b to nightly with MkDocs 1.2.3 and mike 1.1.2
This commit is contained in:
github-actions[bot]
parent
ee46923b9c
commit
75923e9705
@ -916,28 +916,28 @@
|
||||
<p>For example, here's the disk widget with no filter:</p>
|
||||
<p><img alt="Disk no filter" src="../../../assets/screenshots/config/disk-filtering/disk_no_filter.webp" /></p>
|
||||
<p>The following in the config file would filter out some entries by disk name:</p>
|
||||
<div class="highlight"><pre><span></span><code><span class="k">[disk_filter]</span>
|
||||
<span class="n">is_list_ignored</span> <span class="o">=</span> <span class="kc">true</span>
|
||||
<span class="n">list</span> <span class="o">=</span> <span class="p">[</span><span class="s">"/dev/sda"</span><span class="p">]</span>
|
||||
<span class="n">regex</span> <span class="o">=</span> <span class="kc">true</span>
|
||||
<span class="n">case_sensitive</span> <span class="o">=</span> <span class="kc">false</span>
|
||||
<span class="n">whole_word</span> <span class="o">=</span> <span class="kc">false</span>
|
||||
<div class="highlight"><pre><span></span><code><span class="k">[disk_filter]</span><span class="w"></span>
|
||||
<span class="n">is_list_ignored</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="w"></span>
|
||||
<span class="n">list</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s">"/dev/sda"</span><span class="p">]</span><span class="w"></span>
|
||||
<span class="n">regex</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="w"></span>
|
||||
<span class="n">case_sensitive</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">false</span><span class="w"></span>
|
||||
<span class="n">whole_word</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">false</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><img alt="Disk widget with just disk name filter" src="../../../assets/screenshots/config/disk-filtering/disk_name_filter.webp" /></p>
|
||||
<p>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 <code>/dev/sda</code>, but deny anything with <code>/mnt/.*</code> or <code>/</code>. So to do so, we write in the config file:</p>
|
||||
<div class="highlight"><pre><span></span><code><span class="k">[disk_filter]</span>
|
||||
<span class="n">is_list_ignored</span> <span class="o">=</span> <span class="kc">false</span>
|
||||
<span class="n">list</span> <span class="o">=</span> <span class="p">[</span><span class="s">"/dev/sda"</span><span class="p">]</span>
|
||||
<span class="n">regex</span> <span class="o">=</span> <span class="kc">true</span>
|
||||
<span class="n">case_sensitive</span> <span class="o">=</span> <span class="kc">false</span>
|
||||
<span class="n">whole_word</span> <span class="o">=</span> <span class="kc">false</span>
|
||||
<div class="highlight"><pre><span></span><code><span class="k">[disk_filter]</span><span class="w"></span>
|
||||
<span class="n">is_list_ignored</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">false</span><span class="w"></span>
|
||||
<span class="n">list</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s">"/dev/sda"</span><span class="p">]</span><span class="w"></span>
|
||||
<span class="n">regex</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="w"></span>
|
||||
<span class="n">case_sensitive</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">false</span><span class="w"></span>
|
||||
<span class="n">whole_word</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">false</span><span class="w"></span>
|
||||
|
||||
<span class="k">[mount_filter]</span>
|
||||
<span class="n">is_list_ignored</span> <span class="o">=</span> <span class="kc">true</span>
|
||||
<span class="n">list</span> <span class="o">=</span> <span class="p">[</span><span class="s">"/mnt/.*"</span><span class="p">,</span> <span class="s">"/"</span><span class="p">]</span>
|
||||
<span class="n">regex</span> <span class="o">=</span> <span class="kc">true</span>
|
||||
<span class="n">case_sensitive</span> <span class="o">=</span> <span class="kc">false</span>
|
||||
<span class="n">whole_word</span> <span class="o">=</span> <span class="kc">true</span>
|
||||
<span class="k">[mount_filter]</span><span class="w"></span>
|
||||
<span class="n">is_list_ignored</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="w"></span>
|
||||
<span class="n">list</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s">"/mnt/.*"</span><span class="p">,</span><span class="w"> </span><span class="s">"/"</span><span class="p">]</span><span class="w"></span>
|
||||
<span class="n">regex</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="w"></span>
|
||||
<span class="n">case_sensitive</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">false</span><span class="w"></span>
|
||||
<span class="n">whole_word</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p>This gives us:</p>
|
||||
<p><img alt="Disk widget with disk name and mount filter" src="../../../assets/screenshots/config/disk-filtering/disk_name_mount_filter.webp" /></p>
|
||||
|
||||
@ -914,20 +914,20 @@
|
||||
</div>
|
||||
<p>bottom supports customizable layouts via the config file. Currently, layouts are controlled by using TOML objects and arrays.</p>
|
||||
<p>For example, given the sample layout:</p>
|
||||
<div class="highlight"><pre><span></span><code><span class="k">[[row]]</span>
|
||||
<span class="k">[[row.child]]</span>
|
||||
<span class="n">type</span><span class="o">=</span><span class="s">"cpu"</span>
|
||||
<span class="k">[[row]]</span>
|
||||
<span class="n">ratio</span><span class="o">=</span><span class="mi">2</span>
|
||||
<span class="k">[[row.child]]</span>
|
||||
<span class="n">ratio</span><span class="o">=</span><span class="mi">4</span>
|
||||
<span class="n">type</span><span class="o">=</span><span class="s">"mem"</span>
|
||||
<span class="k">[[row.child]]</span>
|
||||
<span class="n">ratio</span><span class="o">=</span><span class="mi">3</span>
|
||||
<span class="k">[[row.child.child]]</span>
|
||||
<span class="n">type</span><span class="o">=</span><span class="s">"temp"</span>
|
||||
<span class="k">[[row.child.child]]</span>
|
||||
<span class="n">type</span><span class="o">=</span><span class="s">"disk"</span>
|
||||
<div class="highlight"><pre><span></span><code><span class="k">[[row]]</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="k">[[row.child]]</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="n">type</span><span class="o">=</span><span class="s">"cpu"</span><span class="w"></span>
|
||||
<span class="k">[[row]]</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="n">ratio</span><span class="o">=</span><span class="mi">2</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="k">[[row.child]]</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="n">ratio</span><span class="o">=</span><span class="mi">4</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="n">type</span><span class="o">=</span><span class="s">"mem"</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="k">[[row.child]]</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="n">ratio</span><span class="o">=</span><span class="mi">3</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="k">[[row.child.child]]</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="n">type</span><span class="o">=</span><span class="s">"temp"</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="k">[[row.child.child]]</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="n">type</span><span class="o">=</span><span class="s">"disk"</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p>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.
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -2,117 +2,117 @@
|
||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/troubleshooting/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/configuration/command-line-flags/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/data-filtering/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/default-config/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/flags/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/layout/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/configuration/config-file/theming/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/contribution/development/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/contribution/documentation/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/contribution/issues-and-pull-requests/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/support/official/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/support/unofficial/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/usage/basic-mode/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/usage/general-usage/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/battery/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/cpu/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/disk/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/memory/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/network/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/process/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://clementtsang.github.io/bottom/nightly/usage/widgets/temperature/</loc>
|
||||
<lastmod>2021-12-27</lastmod>
|
||||
<lastmod>2021-12-31</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
</urlset>
|
||||
Binary file not shown.
@ -438,6 +438,13 @@
|
||||
<nav class="md-nav" aria-label="Known problems">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#linux" class="md-nav__link">
|
||||
Linux
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#windows" class="md-nav__link">
|
||||
Windows
|
||||
@ -967,14 +974,26 @@
|
||||
<p>Furthermore, binaries are expected to be built and tested using the most recent version of stable Rust - if you are manually building
|
||||
bottom from the repo/source, then please try that as well.</p>
|
||||
<h2 id="known-problems"><a class="toclink" href="#known-problems">Known problems</a></h2>
|
||||
<h3 id="linux"><a class="toclink" href="#linux">Linux</a></h3>
|
||||
<ul>
|
||||
<li>If you're using Linux via WSL or WSL2:<ul>
|
||||
<li>You may have issues with getting memory data.</li>
|
||||
<li>Temperature sensors may not be correctly reported.</li>
|
||||
<li>WSL2 will not match Windows' own Task Manager in terms of data.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id="windows"><a class="toclink" href="#windows">Windows</a></h3>
|
||||
<ul>
|
||||
<li>The temperature widget seems to require elevated access in some cases to get data.</li>
|
||||
<li>The battery widget seems to have issues with dual battery systems, like some Thinkpads.</li>
|
||||
<li>If you run on WSL/WSL2, you may have issues with getting memory data.</li>
|
||||
<li>WSL and WSL2 (as far as I know) cannot correctly report temperature sensors.</li>
|
||||
<li>If you are using WSL or WSL2:<ul>
|
||||
<li>You may have issues with getting memory data.</li>
|
||||
<li>Temperature sensors may not be correctly reported.</li>
|
||||
<li>WSL2 will not match Windows' own Task Manager in terms of data.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id="macos"><a class="toclink" href="#macos">macOS</a></h3>
|
||||
<ul>
|
||||
<li>The process widget may require elevated access (ex: <code>sudo btm</code>) to gather all data in some cases. <em>Please note that you should be certain that you trust any software you grant root privileges.</em></li>
|
||||
|
||||
@ -1011,12 +1011,12 @@ at the expense of looking less intricate:</p>
|
||||
<p>It may be handy to refer to the automatically generated config files or the <a href="https://github.com/ClementTsang/bottom/tree/master/sample_configs">sample configuration files</a>.
|
||||
The config files also follow the <a href="https://toml.io/en/">TOML</a> format.</p>
|
||||
<p>Also make sure your config options are under the right table - for example, to set your temperature type, you must set it under the <code>[flags]</code> table:</p>
|
||||
<div class="highlight"><pre><span></span><code><span class="k">[flags]</span>
|
||||
<span class="n">temperature_type</span> <span class="o">=</span> <span class="s">"f"</span>
|
||||
<div class="highlight"><pre><span></span><code><span class="k">[flags]</span><span class="w"></span>
|
||||
<span class="n">temperature_type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"f"</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p>Meanwhile, if you want to set a custom color scheme, it would be under the <code>[colors]</code> table:</p>
|
||||
<div class="highlight"><pre><span></span><code><span class="k">[colors]</span>
|
||||
<span class="n">table_header_color</span><span class="o">=</span><span class="s">"LightBlue"</span>
|
||||
<div class="highlight"><pre><span></span><code><span class="k">[colors]</span><span class="w"></span>
|
||||
<span class="n">table_header_color</span><span class="o">=</span><span class="s">"LightBlue"</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<h3 id="check-the-configuration-file-location"><a class="toclink" href="#check-the-configuration-file-location">Check the configuration file location</a></h3>
|
||||
<p>Make sure bottom is reading the right configuration file. By default, bottom looks for config files at these locations:</p>
|
||||
|
||||
@ -957,8 +957,8 @@
|
||||
btm --basic
|
||||
</code></pre></div>
|
||||
<p>or through the config:</p>
|
||||
<div class="highlight"><pre><span></span><code><span class="k">[flags]</span>
|
||||
<span class="n">basic</span> <span class="o">=</span> <span class="kc">true</span>
|
||||
<div class="highlight"><pre><span></span><code><span class="k">[flags]</span><span class="w"></span>
|
||||
<span class="n">basic</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">true</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<h2 id="notes"><a class="toclink" href="#notes">Notes</a></h2>
|
||||
<p>In this mode, widgets that use tables (temperatures, processes, disks, and batteries) are only shown one at a time.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user