ClementTsang/bottom
1
1
Fork 0
mirror of https://github.com/ClementTsang/bottom.git synced 2024-11-09 04:44:55 +03:00
Code Issues Projects Releases Wiki Activity

Deployed 28972a1e to nightly with MkDocs 1.5.3 and mike 2.0.0

Browse Source
This commit is contained in:
github-actions[bot] 2024-07-29 09:04:03 +00:00
parent 4d2a1fa63a
commit 68d74e3c26
34 changed files with 611 additions and 196 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
nightly/404.html
View File

@ -976,11 +976,11 @@
<li class="md-nav__item">
<a href="/bottom/stable/configuration/config-file/theming/" class="md-nav__link">
<a href="/bottom/stable/configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

8
nightly/configuration/command-line-options/index.html
View File

@ -1125,11 +1125,11 @@
<li class="md-nav__item">
<a href="../config-file/theming/" class="md-nav__link">
<a href="../config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>
@ -1806,7 +1806,7 @@ see information on these options by running <code>btm -h</code>, or run <code>bt
</thead>
<tbody>
<tr>
<td><code>--color &lt;COLOR SCHEME&gt;</code></td>
<td><code>--theme &lt;COLOR SCHEME&gt;</code></td>
<td>Use a color scheme, use <code>--help</code> for info.</td>
</tr>
</tbody>
@ -1850,7 +1850,7 @@ see information on these options by running <code>btm -h</code>, or run <code>bt
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">May 27, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 29, 2024</span>
</span>

4
nightly/configuration/config-file/cpu/index.html
View File

@ -983,11 +983,11 @@
<li class="md-nav__item">
<a href="../theming/" class="md-nav__link">
<a href="../styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/configuration/config-file/data-filtering/index.html
View File

@ -995,11 +995,11 @@
<li class="md-nav__item">
<a href="../theming/" class="md-nav__link">
<a href="../styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

17
nightly/configuration/config-file/flags/index.html
View File

@ -18,7 +18,7 @@
<link rel="prev" href="../">
<link rel="next" href="../theming/">
<link rel="next" href="../styling/">
<link rel="icon" href="../../../assets/images/favicon.png">
@ -1005,11 +1005,11 @@
<li class="md-nav__item">
<a href="../theming/" class="md-nav__link">
<a href="../styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>
@ -1545,11 +1545,6 @@ each time:</p>
<td>Disables mouse clicks.</td>
</tr>
<tr>
<td><code>color</code></td>
<td>String (one of ["default", "default-light", "gruvbox", "gruvbox-light", "nord", "nord-light"])</td>
<td>Use a color scheme, use --help for supported values.</td>
</tr>
<tr>
<td><code>enable_cache_memory</code></td>
<td>Boolean</td>
<td>Enable cache and buffer memory stats (not available on Windows).</td>
@ -1646,7 +1641,7 @@ each time:</p>
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">May 27, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 29, 2024</span>
</span>
@ -1699,13 +1694,13 @@ each time:</p>
<a href="../theming/" class="md-footer__link md-footer__link--next" aria-label="Next: Theming">
<a href="../styling/" class="md-footer__link md-footer__link--next" aria-label="Next: Styling">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Theming
Styling
</div>
</div>
<div class="md-footer__button md-icon">

4
nightly/configuration/config-file/index.html
View File

@ -995,11 +995,11 @@
<li class="md-nav__item">
<a href="theming/" class="md-nav__link">
<a href="styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

10
nightly/configuration/config-file/layout/index.html
View File

@ -15,7 +15,7 @@
<link rel="canonical" href="https://clementtsang.github.io/bottom/stable/configuration/config-file/layout/">
<link rel="prev" href="../theming/">
<link rel="prev" href="../styling/">
<link rel="next" href="../data-filtering/">
@ -995,11 +995,11 @@
<li class="md-nav__item">
<a href="../theming/" class="md-nav__link">
<a href="../styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>
@ -1561,7 +1561,7 @@ represents a <em>widget</em>. A widget is represented by having a <code>type</co
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../theming/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Theming">
<a href="../styling/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Styling">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
@ -1571,7 +1571,7 @@ represents a <em>widget</em>. A widget is represented by having a <code>type</co
Previous
</span>
<div class="md-ellipsis">
Theming
Styling
</div>
</div>
</a>

4
nightly/configuration/config-file/processes/index.html
View File

@ -995,11 +995,11 @@
<li class="md-nav__item">
<a href="../theming/" class="md-nav__link">
<a href="../styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

483
nightly/configuration/config-file/theming/index.html → nightly/configuration/config-file/styling/index.html
View File

@ -12,7 +12,7 @@
<meta name="author" content="Clement Tsang">
<link rel="canonical" href="https://clementtsang.github.io/bottom/stable/configuration/config-file/theming/">
<link rel="canonical" href="https://clementtsang.github.io/bottom/stable/configuration/config-file/styling/">
<link rel="prev" href="../flags/">
@ -26,7 +26,7 @@
<title>Theming - bottom</title>
<title>Styling - bottom</title>
@ -80,7 +80,7 @@
<div data-md-component="skip">
<a href="#theming" class="md-skip">
<a href="#styling" class="md-skip">
Skip to content
</a>
@ -118,7 +118,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Theming
Styling
</span>
</div>
@ -1004,16 +1004,175 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Styling
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Theming
Styling
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#precedence" class="md-nav__link">
<span class="md-ellipsis">
Precedence
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#built-in-styles" class="md-nav__link">
<span class="md-ellipsis">
Built-in styles
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#custom-styling" class="md-nav__link">
<span class="md-ellipsis">
Custom styling
</span>
</a>
<nav class="md-nav" aria-label="Custom styling">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#colours" class="md-nav__link">
<span class="md-ellipsis">
Colours
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#text" class="md-nav__link">
<span class="md-ellipsis">
Text
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#configuration" class="md-nav__link">
<span class="md-ellipsis">
Configuration
</span>
</a>
<nav class="md-nav" aria-label="Configuration">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#cpu" class="md-nav__link">
<span class="md-ellipsis">
CPU
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#memory" class="md-nav__link">
<span class="md-ellipsis">
Memory
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#network" class="md-nav__link">
<span class="md-ellipsis">
Network
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#battery" class="md-nav__link">
<span class="md-ellipsis">
Battery
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tables" class="md-nav__link">
<span class="md-ellipsis">
Tables
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#graphs" class="md-nav__link">
<span class="md-ellipsis">
Graphs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#general-widget-settings" class="md-nav__link">
<span class="md-ellipsis">
General widget settings
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
@ -1421,7 +1580,7 @@
<a href="https://github.com/ClementTsang/bottom/edit/main/docs/content/configuration/config-file/theming.md" title="Edit this page" class="md-content__button md-icon">
<a href="https://github.com/ClementTsang/bottom/edit/main/docs/content/configuration/config-file/styling.md" title="Edit this page" class="md-content__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25Z"/></svg>
</a>
@ -1429,126 +1588,280 @@
<h1 id="theming"><a class="toclink" href="#theming">Theming</a></h1>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This section is in progress, and is just copied from the old documentation.</p>
</div>
<p>The config file can be used to set custom colours for parts of the application under the <code>[colors]</code> object. The following labels are customizable with strings that are hex colours, RGB colours, or specific named colours.</p>
<p>Supported named colours are one of the following strings: <code>Reset, Black, Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed, LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White</code>.</p>
<h1 id="styling"><a class="toclink" href="#styling">Styling</a></h1>
<p>Various parts of the bottom can be styled, using either built-in themes or custom theming.</p>
<h2 id="precedence"><a class="toclink" href="#precedence">Precedence</a></h2>
<p>As there are a few ways styles can be applied to bottom, the order of which styles are prioritized are, in order of
highest precedence to lowest precedence:</p>
<ol>
<li>Built-in themes set via command-line args (e.g. <code>btm --theme gruvbox</code>)</li>
<li>Custom themes set via config file</li>
<li>Built-in themes set via config file</li>
</ol>
<p>If nothing is set, it will fall back to the default theme.</p>
<h2 id="built-in-styles"><a class="toclink" href="#built-in-styles">Built-in styles</a></h2>
<p>bottom has a few built-in themes:</p>
<ul>
<li>Default</li>
<li><a href="https://www.nordtheme.com/">Nord</a></li>
<li><a href="https://github.com/morhetz/gruvbox">Gruvbox</a></li>
</ul>
<p>These themes all also have light variants to support terminals using lighter colours.</p>
<p>To set the theme from the command line:</p>
<div class="highlight"><pre><span></span><code>btm<span class="w"> </span>--theme<span class="w"> </span>gruvbox
</code></pre></div>
<p>To set the theme using the config file:</p>
<div class="highlight"><pre><span></span><code><span class="k">[styles]</span>
<span class="n">theme</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;gruvbox&quot;</span>
</code></pre></div>
<h2 id="custom-styling"><a class="toclink" href="#custom-styling">Custom styling</a></h2>
<p>bottom's components can also be individually styled by the user to control the colour of the text style.</p>
<h3 id="colours"><a class="toclink" href="#colours">Colours</a></h3>
<p>You can configure the colours for components with strings that are either hex colours (e.g. <code>"#ffffff"</code>), RGB colours
(e.g. <code>"255, 255, 255"</code>), or named colours. Named colours are one of the following strings:</p>
<ul>
<li><code>"Black"</code></li>
<li><code>"Red"</code></li>
<li><code>"Green"</code></li>
<li><code>"Yellow"</code></li>
<li><code>"Blue"</code></li>
<li><code>"Magenta"</code></li>
<li><code>"Cyan"</code></li>
<li><code>"Gray"</code></li>
<li><code>"DarkGray"</code></li>
<li><code>"LightRed"</code></li>
<li><code>"LightGreen"</code></li>
<li><code>"LightYellow"</code></li>
<li><code>"LightBlue"</code></li>
<li><code>"LightMagenta"</code></li>
<li><code>"LightCyan"</code></li>
<li><code>"White"</code></li>
</ul>
<h3 id="text"><a class="toclink" href="#text">Text</a></h3>
<p>Text can generally be styled using the following TOML table:</p>
<div class="highlight"><pre><span></span><code><span class="k">[field]</span>
<span class="c1"># The foreground colour of text.</span>
<span class="n">color</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;black&quot;</span>
<span class="c1"># The background colour of text.</span>
<span class="n">bg_color</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;blue&quot;</span>
<span class="c1"># Whether to make the text bold.</span>
<span class="n">bold</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">false</span>
<span class="c1"># Inline table version</span>
<span class="n">field</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">color</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s2">&quot;black&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">bg_color</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s2">&quot;blue&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">bold</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="kc">false</span><span class="w"> </span><span class="p">}</span>
</code></pre></div>
<p>All fields are optional; by default if <code>bg_color</code> is not set then there will be no background color.</p>
<h3 id="configuration"><a class="toclink" href="#configuration">Configuration</a></h3>
<h4 id="cpu"><a class="toclink" href="#cpu">CPU</a></h4>
<p>These can be set under <code>[styles.cpu]</code>:</p>
<table>
<thead>
<tr>
<th>Labels</th>
<th>Config field</th>
<th>Details</th>
<th>Example</th>
<th>Examples</th>
</tr>
</thead>
<tbody>
<tr>
<td>Table header colours</td>
<td>Colour of table headers</td>
<td><code>table_header_color="255, 255, 255"</code></td>
<td><code>all_entry_color</code></td>
<td>The colour of the "All" CPU label</td>
<td><code>all_entry_color = "Red"</code></td>
</tr>
<tr>
<td>CPU colour per core</td>
<td>Colour of each core. Read in order.</td>
<td><code>cpu_core_colors=["#ffffff", "white", "255, 255, 255"]</code></td>
<td><code>avg_entry_color</code></td>
<td>The colour of the average CPU label and graph line</td>
<td><code>avg_entry_color = "255, 0, 255"</code></td>
</tr>
<tr>
<td>Average CPU colour</td>
<td>The average CPU color</td>
<td><code>avg_cpu_color="White"</code></td>
<td><code>cpu_core_colors</code></td>
<td>Colour of each CPU threads' label and graph line. Read in order.</td>
<td><code>cpu_core_colors = ["Red", "Blue", "Green"]</code></td>
</tr>
</tbody>
</table>
<h4 id="memory"><a class="toclink" href="#memory">Memory</a></h4>
<p>These can be set under <code>[styles.memory]</code>:</p>
<table>
<thead>
<tr>
<th>Config field</th>
<th>Details</th>
<th>Examples</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>ram</code></td>
<td>The colour of the RAM label and graph line</td>
<td><code>ram = "Red"</code></td>
</tr>
<tr>
<td>All CPUs colour</td>
<td>The colour for the "All" CPU label</td>
<td><code>all_cpu_color="White"</code></td>
<td><code>cache</code></td>
<td>The colour of the cache label and graph line. Does not do anything on Windows.</td>
<td><code>cache = "#ffffff"</code></td>
</tr>
<tr>
<td>RAM</td>
<td>The colour RAM will use</td>
<td><code>ram_color="#ffffff"</code></td>
<td><code>swap</code></td>
<td>The colour of the swap label and graph line</td>
<td><code>swap = "255, 0, 255"</code></td>
</tr>
<tr>
<td>SWAP</td>
<td>The colour SWAP will use</td>
<td><code>swap_color="#ffffff"</code></td>
<td><code>arc</code></td>
<td>The colour of the ARC label and graph line</td>
<td><code>arc = "Blue"</code></td>
</tr>
<tr>
<td>RX</td>
<td>The colour rx will use</td>
<td><code>rx_color="#ffffff"</code></td>
<td><code>gpus</code></td>
<td>Colour of each GPU's memory label and graph line. Read in order.</td>
<td><code>gpus = ["Red", "Blue", "Green"]</code></td>
</tr>
</tbody>
</table>
<h4 id="network"><a class="toclink" href="#network">Network</a></h4>
<p>These can be set under <code>[styles.network]</code>:</p>
<table>
<thead>
<tr>
<th>Config field</th>
<th>Details</th>
<th>Examples</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>rx</code></td>
<td>The colour of the RX (download) label and graph line</td>
<td><code>rx = "Red"</code></td>
</tr>
<tr>
<td>TX</td>
<td>The colour tx will use</td>
<td><code>tx_color="#ffffff"</code></td>
<td><code>tx</code></td>
<td>The colour of the TX (upload) label and graph line.</td>
<td><code>tx = "#ffffff"</code></td>
</tr>
<tr>
<td>Widget title colour</td>
<td>The colour of the label each widget has</td>
<td><code>widget_title_color="#ffffff"</code></td>
<td><code>rx_total</code></td>
<td>The colour of the total RX (download) label in basic mode</td>
<td><code>rx_total = "0, 0, 0"</code></td>
</tr>
<tr>
<td>Border colour</td>
<td>The colour of the border of unselected widgets</td>
<td><code>border_color="#ffffff"</code></td>
<td><code>tx_total</code></td>
<td>The colour of the total TX (upload) label in basic mode</td>
<td><code>tx_total = "#000"</code></td>
</tr>
</tbody>
</table>
<h4 id="battery"><a class="toclink" href="#battery">Battery</a></h4>
<p>These can be set under <code>[styles.battery]</code>:</p>
<table>
<thead>
<tr>
<th>Config field</th>
<th>Details</th>
<th>Examples</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>high_battery</code></td>
<td>The colour of the battery widget bar when the battery is over 50%</td>
<td><code>high_battery = "Red"</code></td>
</tr>
<tr>
<td>Selected border colour</td>
<td>The colour of the border of selected widgets</td>
<td><code>highlighted_border_color="#ffffff"</code></td>
<td><code>medium_battery</code></td>
<td>The colour of the battery widget bar when the battery between 10% to 50%</td>
<td><code>medium_battery = "#ffffff"</code></td>
</tr>
<tr>
<td>Text colour</td>
<td>The colour of most text</td>
<td><code>text_color="#ffffff"</code></td>
<td><code>low_battery</code></td>
<td>The colour of the battery widget bar when the battery is under 10%</td>
<td><code>low_battery = "0, 0, 0"</code></td>
</tr>
</tbody>
</table>
<h4 id="tables"><a class="toclink" href="#tables">Tables</a></h4>
<p>These can be set under <code>[styles.tables]</code>:</p>
<table>
<thead>
<tr>
<th>Config field</th>
<th>Details</th>
<th>Examples</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>headers</code></td>
<td>Text styling for table headers</td>
<td><code>headers = { color = "red", bg_color = "black", bold = true }</code></td>
</tr>
</tbody>
</table>
<h4 id="graphs"><a class="toclink" href="#graphs">Graphs</a></h4>
<p>These can be set under <code>[styles.graphs]</code>:</p>
<table>
<thead>
<tr>
<th>Config field</th>
<th>Details</th>
<th>Examples</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>graph_color</code></td>
<td>The general colour of the parts of the graph</td>
<td><code>graph_color = "white"</code></td>
</tr>
<tr>
<td>Graph colour</td>
<td>The colour of the lines and text of the graph</td>
<td><code>graph_color="#ffffff"</code></td>
<td><code>legend_text</code></td>
<td>Text styling for graph's legend text</td>
<td><code>legend_text = { color = "black", bg_color = "blue", bold = true }</code></td>
</tr>
</tbody>
</table>
<h4 id="general-widget-settings"><a class="toclink" href="#general-widget-settings">General widget settings</a></h4>
<p>These can be set under <code>[styles.widgets]</code>:</p>
<table>
<thead>
<tr>
<th>Config field</th>
<th>Details</th>
<th>Examples</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>border</code></td>
<td>The colour of the widgets' borders</td>
<td><code>border = "white"</code></td>
</tr>
<tr>
<td>Cursor colour</td>
<td>The cursor's colour</td>
<td><code>cursor_color="#ffffff"</code></td>
<td><code>selected_border</code></td>
<td>The colour of a widget's borders when the widget is selected</td>
<td><code>selected_border = "white"</code></td>
</tr>
<tr>
<td>Selected text colour</td>
<td>The colour of text that is selected</td>
<td><code>scroll_entry_text_color="#ffffff"</code></td>
<td><code>widget_title</code></td>
<td>Text styling for a widget's title</td>
<td><code>widget_title = { color = "black", bg_color = "blue", bold = true }</code></td>
</tr>
<tr>
<td>Selected text background colour</td>
<td>The background colour of text that is selected</td>
<td><code>scroll_entry_bg_color="#ffffff"</code></td>
<td><code>text</code></td>
<td>Text styling for text in general</td>
<td><code>text = { color = "black", bg_color = "blue", bold = true }</code></td>
</tr>
<tr>
<td>High battery level colour</td>
<td>The colour used for a high battery level (100% to 50%)</td>
<td><code>high_battery_color="green"</code></td>
<td><code>selected_text</code></td>
<td>Text styling for text when representing something selected</td>
<td><code>selected_text = { color = "black", bg_color = "blue", bold = true }</code></td>
</tr>
<tr>
<td>Medium battery level colour</td>
<td>The colour used for a medium battery level (50% to 10%)</td>
<td><code>medium_battery_color="yellow"</code></td>
</tr>
<tr>
<td>Low battery level colour</td>
<td>The colour used for a low battery level (10% to 0%)</td>
<td><code>low_battery_color="red"</code></td>
</tr>
<tr>
<td>GPU colour per gpu</td>
<td>Colour of each gpu. Read in order.</td>
<td><code>gpu_core_colors=["#ffffff", "white", "255, 255, 255"]</code></td>
</tr>
<tr>
<td>ARC</td>
<td>The colour ARC will use</td>
<td><code>arc_color="#ffffff"</code></td>
<td><code>disabled_text</code></td>
<td>Text styling for text when representing something disabled</td>
<td><code>disabled_text = { color = "black", bg_color = "blue", bold = true }</code></td>
</tr>
</tbody>
</table>
@ -1572,7 +1885,7 @@
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 16, 2022</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 29, 2024</span>
</span>

4
nightly/contribution/development/build_process/index.html
View File

@ -989,11 +989,11 @@
<li class="md-nav__item">
<a href="../../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/contribution/development/deploy_process/index.html
View File

@ -989,11 +989,11 @@
<li class="md-nav__item">
<a href="../../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/contribution/development/dev_env/index.html
View File

@ -989,11 +989,11 @@
<li class="md-nav__item">
<a href="../../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/contribution/development/logging/index.html
View File

@ -989,11 +989,11 @@
<li class="md-nav__item">
<a href="../../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/contribution/development/testing/index.html
View File

@ -989,11 +989,11 @@
<li class="md-nav__item">
<a href="../../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/contribution/documentation/index.html
View File

@ -989,11 +989,11 @@
<li class="md-nav__item">
<a href="../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/contribution/issues-and-pull-requests/index.html
View File

@ -989,11 +989,11 @@
<li class="md-nav__item">
<a href="../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/contribution/packaging-and-distribution/index.html
View File

@ -989,11 +989,11 @@
<li class="md-nav__item">
<a href="../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/index.html
View File

@ -1054,11 +1054,11 @@
<li class="md-nav__item">
<a href="configuration/config-file/theming/" class="md-nav__link">
<a href="configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

2
nightly/search/search_index.json
View File

File diff suppressed because one or more lines are too long

60
nightly/sitemap.xml
View File

@ -2,147 +2,147 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://clementtsang.github.io/bottom/stable/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/troubleshooting/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/configuration/command-line-options/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/configuration/config-file/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/configuration/config-file/cpu/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/configuration/config-file/data-filtering/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/configuration/config-file/flags/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/configuration/config-file/layout/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/configuration/config-file/processes/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/configuration/config-file/theming/</loc>
<lastmod>2024-05-27</lastmod>
<loc>https://clementtsang.github.io/bottom/stable/configuration/config-file/styling/</loc>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/contribution/documentation/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/contribution/issues-and-pull-requests/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/contribution/packaging-and-distribution/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/contribution/development/build_process/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/contribution/development/deploy_process/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/contribution/development/dev_env/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/contribution/development/logging/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/contribution/development/testing/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/support/official/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/support/unofficial/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/usage/basic-mode/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/usage/general-usage/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/usage/widgets/battery/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/usage/widgets/cpu/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/usage/widgets/disk/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/usage/widgets/memory/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/usage/widgets/network/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/usage/widgets/process/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://clementtsang.github.io/bottom/stable/usage/widgets/temperature/</loc>
<lastmod>2024-05-27</lastmod>
<lastmod>2024-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

BIN
nightly/sitemap.xml.gz
View File

Binary file not shown.

4
nightly/support/official/index.html
View File

@ -1074,11 +1074,11 @@
<li class="md-nav__item">
<a href="../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/support/unofficial/index.html
View File

@ -1041,11 +1041,11 @@
<li class="md-nav__item">
<a href="../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

22
nightly/troubleshooting/index.html
View File

@ -987,11 +987,11 @@
<li class="md-nav__item">
<a href="../configuration/config-file/theming/" class="md-nav__link">
<a href="../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>
@ -1652,16 +1652,20 @@ on how to run htop without sudo for bottom. However, <strong>please</strong> und
<h2 id="my-configuration-file-isnt-working"><a class="toclink" href="#my-configuration-file-isnt-working">My configuration file isn't working</a></h2>
<p>If your configuration files aren't working, here are a few things to try:</p>
<h3 id="check-the-formatting"><a class="toclink" href="#check-the-formatting">Check the formatting</a></h3>
<p>It may be handy to refer to the automatically generated config files or the <a href="https://github.com/ClementTsang/bottom/tree/main/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>
<p>It may be handy to refer to the automatically generated config files or the
<a href="https://github.com/ClementTsang/bottom/tree/main/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="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;f&quot;</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="s2">&quot;LightBlue&quot;</span>
<p>Meanwhile, if you want to set a custom color scheme, it would be under the <code>[styles]</code> table:</p>
<div class="highlight"><pre><span></span><code><span class="k">[styles.tables.headers]</span>
<span class="n">color</span><span class="o">=</span><span class="s2">&quot;LightBlue&quot;</span>
</code></pre></div>
<p>To help validate your configuration files, there is <a href="https://json-schema.org/">JSON Schema</a> support if your IDE/editor
supports it.</p>
<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>
<table>
@ -1717,7 +1721,7 @@ sudo<span class="w"> </span>snap<span class="w"> </span>connect<span class="w">
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">March 2, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 29, 2024</span>
</span>

4
nightly/usage/basic-mode/index.html
View File

@ -1053,11 +1053,11 @@
<li class="md-nav__item">
<a href="../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/usage/general-usage/index.html
View File

@ -1086,11 +1086,11 @@
<li class="md-nav__item">
<a href="../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/usage/widgets/battery/index.html
View File

@ -1062,11 +1062,11 @@
<li class="md-nav__item">
<a href="../../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/usage/widgets/cpu/index.html
View File

@ -1110,11 +1110,11 @@
<li class="md-nav__item">
<a href="../../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/usage/widgets/disk/index.html
View File

@ -1062,11 +1062,11 @@
<li class="md-nav__item">
<a href="../../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/usage/widgets/memory/index.html
View File

@ -1071,11 +1071,11 @@
<li class="md-nav__item">
<a href="../../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/usage/widgets/network/index.html
View File

@ -1062,11 +1062,11 @@
<li class="md-nav__item">
<a href="../../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/usage/widgets/process/index.html
View File

@ -1221,11 +1221,11 @@
<li class="md-nav__item">
<a href="../../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

4
nightly/usage/widgets/temperature/index.html
View File

@ -1062,11 +1062,11 @@
<li class="md-nav__item">
<a href="../../../configuration/config-file/theming/" class="md-nav__link">
<a href="../../../configuration/config-file/styling/" class="md-nav__link">
<span class="md-ellipsis">
Theming
Styling
</span>

105
versions.json
View File

@ -1 +1,104 @@
[{"version": "0.9.7", "title": "0.9.7 (stable)", "aliases": ["stable"]}, {"version": "0.9.6", "title": "0.9.6", "aliases": []}, {"version": "0.9.5", "title": "0.9.5", "aliases": []}, {"version": "0.9.4", "title": "0.9.4", "aliases": []}, {"version": "0.9.3", "title": "0.9.3", "aliases": []}, {"version": "0.9.2", "title": "0.9.2", "aliases": []}, {"version": "0.9.1", "title": "0.9.1", "aliases": []}, {"version": "0.9.0", "title": "0.9.0", "aliases": []}, {"version": "0.8.0", "title": "0.8.0", "aliases": []}, {"version": "0.7.1", "title": "0.7.1", "aliases": []}, {"version": "0.7.0", "title": "0.7.0", "aliases": []}, {"version": "0.6.8", "title": "0.6.8", "aliases": []}, {"version": "0.6.7", "title": "0.6.7", "aliases": []}, {"version": "0.6.6", "title": "0.6.6", "aliases": []}, {"version": "0.6.5", "title": "0.6.5", "aliases": []}, {"version": "0.6.4", "title": "0.6.4", "aliases": []}, {"version": "0.6.3", "title": "0.6.3", "aliases": []}, {"version": "0.6.2", "title": "0.6.2", "aliases": []}, {"version": "0.6.1", "title": "0.6.1", "aliases": []}, {"version": "nightly", "title": "nightly", "aliases": []}]
[
{
"version": "nightly",
"title": "nightly",
"aliases": []
},
{
"version": "0.9.7",
"title": "0.9.7 (stable)",
"aliases": [
"stable"
]
},
{
"version": "0.9.6",
"title": "0.9.6",
"aliases": []
},
{
"version": "0.9.5",
"title": "0.9.5",
"aliases": []
},
{
"version": "0.9.4",
"title": "0.9.4",
"aliases": []
},
{
"version": "0.9.3",
"title": "0.9.3",
"aliases": []
},
{
"version": "0.9.2",
"title": "0.9.2",
"aliases": []
},
{
"version": "0.9.1",
"title": "0.9.1",
"aliases": []
},
{
"version": "0.9.0",
"title": "0.9.0",
"aliases": []
},
{
"version": "0.8.0",
"title": "0.8.0",
"aliases": []
},
{
"version": "0.7.1",
"title": "0.7.1",
"aliases": []
},
{
"version": "0.7.0",
"title": "0.7.0",
"aliases": []
},
{
"version": "0.6.8",
"title": "0.6.8",
"aliases": []
},
{
"version": "0.6.7",
"title": "0.6.7",
"aliases": []
},
{
"version": "0.6.6",
"title": "0.6.6",
"aliases": []
},
{
"version": "0.6.5",
"title": "0.6.5",
"aliases": []
},
{
"version": "0.6.4",
"title": "0.6.4",
"aliases": []
},
{
"version": "0.6.3",
"title": "0.6.3",
"aliases": []
},
{
"version": "0.6.2",
"title": "0.6.2",
"aliases": []
},
{
"version": "0.6.1",
"title": "0.6.1",
"aliases": []
}
]