diff options
author | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | 2024-01-11 05:26:18 +0000 |
---|---|---|
committer | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | 2024-01-11 05:26:18 +0000 |
commit | 2d7dd6c0be9a1b4906e4b0b1a621356d3b4dd362 (patch) | |
tree | 01a8c3257806ade2e8d26a49963444e943d00b48 | |
parent | 2484058114c62cbeedc70e4e37a79d16a4f8b539 (diff) |
Deployed bc2c363a to nightly with MkDocs 1.5.3 and mike 2.0.0
33 files changed, 367 insertions, 167 deletions
diff --git a/nightly/404.html b/nightly/404.html index 91940551..94b1cef1 100644 --- a/nightly/404.html +++ b/nightly/404.html @@ -271,7 +271,7 @@ <li class="md-tabs__item"> - <a href="/bottom/stable/configuration/command-line-flags/" class="md-tabs__link"> + <a href="/bottom/stable/configuration/command-line-options/" class="md-tabs__link"> Configuration @@ -795,7 +795,7 @@ <li class="md-nav__item"> - <a href="/bottom/stable/configuration/command-line-flags/" class="md-nav__link"> + <a href="/bottom/stable/configuration/command-line-options/" class="md-nav__link"> <span class="md-ellipsis"> diff --git a/nightly/configuration/command-line-flags/index.html b/nightly/configuration/command-line-options/index.html index 2eee5a33..b14b7003 100644 --- a/nightly/configuration/command-line-flags/index.html +++ b/nightly/configuration/command-line-options/index.html @@ -12,7 +12,7 @@ <meta name="author" content="Clement Tsang"> - <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/configuration/command-line-flags/"> + <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/configuration/command-line-options/"> <link rel="prev" href="../../usage/widgets/battery/"> @@ -83,7 +83,7 @@ <div data-md-component="skip"> - <a href="#command-line-flags" class="md-skip"> + <a href="#command-line-options" class="md-skip"> Skip to content </a> @@ -817,6 +817,17 @@ + <label class="md-nav__link md-nav__link--active" for="__toc"> + + + <span class="md-ellipsis"> + Command-line Flags + </span> + + + <span class="md-nav__icon md-icon"></span> + </label> + <a href="./" class="md-nav__link md-nav__link--active"> @@ -827,6 +838,95 @@ </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="#general-options" class="md-nav__link"> + General Options + </a> + +</li> + + <li class="md-nav__item"> + <a href="#process-options" class="md-nav__link"> + Process Options + </a> + +</li> + + <li class="md-nav__item"> + <a href="#temperature-options" class="md-nav__link"> + Temperature Options + </a> + +</li> + + <li class="md-nav__item"> + <a href="#cpu-options" class="md-nav__link"> + CPU Options + </a> + +</li> + + <li class="md-nav__item"> + <a href="#memory-options" class="md-nav__link"> + Memory Options + </a> + +</li> + + <li class="md-nav__item"> + <a href="#network-options" class="md-nav__link"> + Network Options + </a> + +</li> + + <li class="md-nav__item"> + <a href="#battery-options" class="md-nav__link"> + Battery Options + </a> + +</li> + + <li class="md-nav__item"> + <a href="#gpu-options" class="md-nav__link"> + GPU Options + </a> + +</li> + + <li class="md-nav__item"> + <a href="#style-options" class="md-nav__link"> + Style Options + </a> + +</li> + + <li class="md-nav__item"> + <a href="#other-options" class="md-nav__link"> + Other Options + </a> + +</li> + + </ul> + +</nav> + </li> @@ -1302,13 +1402,14 @@ -<h1 id="command-line-flags"><a class="toclink" href="#command-line-flags">Command-line Flags</a></h1> -<p>The following flags can be provided to bottom in the command line to change the behaviour of the program. You can also -see information on these flags by running <code>btm -h</code>, or run <code>btm --help</code> to display more detailed information on each flag:</p> +<h1 id="command-line-options"><a class="toclink" href="#command-line-options">Command-line Options</a></h1> +<p>The following options can be provided to bottom in the command line to change the behaviour of the program. You can also +see information on these options by running <code>btm -h</code>, or run <code>btm --help</code> to display more detailed information on each option:</p> +<h2 id="general-options"><a class="toclink" href="#general-options">General Options</a></h2> <table> <thead> <tr> -<th>Flag</th> +<th>Option</th> <th>Behaviour</th> </tr> </thead> @@ -1322,30 +1423,10 @@ see information on these flags by running <code>btm -h</code>, or run <code>btm <td>Hides graphs and uses a more basic look.</td> </tr> <tr> -<td>--battery</td> -<td>Shows the battery widget.</td> -</tr> -<tr> -<td>-S, --case_sensitive</td> -<td>Enables case sensitivity by default.</td> -</tr> -<tr> -<td>-c, --celsius</td> -<td>Sets the temperature type to Celsius.</td> -</tr> -<tr> -<td>--color <COLOR SCHEME></td> -<td>Use a color scheme, use --help for info.</td> -</tr> -<tr> <td>-C, --config <CONFIG PATH></td> <td>Sets the location of the config file.</td> </tr> <tr> -<td>-u, --current_usage</td> -<td>Sets process CPU% to be based on current CPU%.</td> -</tr> -<tr> <td>-t, --default_time_value <TIME></td> <td>Default time value for graphs.</td> </tr> @@ -1358,10 +1439,6 @@ see information on these flags by running <code>btm -h</code>, or run <code>btm <td>Sets the default widget type, use --help for info.</td> </tr> <tr> -<td>--disable_advanced_kill</td> -<td>Hides advanced process killing.</td> -</tr> -<tr> <td>--disable_click</td> <td>Disables mouse clicks.</td> </tr> @@ -1370,49 +1447,152 @@ see information on these flags by running <code>btm -h</code>, or run <code>btm <td>Uses a dot marker for graphs.</td> </tr> <tr> -<td>--enable_cache_memory</td> -<td>Enable collecting and displaying cache and buffer memory.</td> +<td>-e, --expanded</td> +<td>Expand the default widget upon starting the app.</td> </tr> <tr> -<td>--enable_gpu</td> -<td>Enable collecting and displaying GPU usage.</td> +<td>--hide_table_gap</td> +<td>Hides spacing between table headers and entries.</td> </tr> <tr> -<td>-e, --expanded</td> -<td>Expand the default widget upon starting the app.</td> +<td>--hide_time</td> +<td>Hides the time scale.</td> </tr> <tr> -<td>-f, --fahrenheit</td> -<td>Sets the temperature type to Fahrenheit.</td> +<td>-l, --left_legend</td> +<td>Puts the CPU chart legend to the left side.</td> +</tr> +<tr> +<td>-r, --rate <TIME></td> +<td>Sets the data refresh rate.</td> +</tr> +<tr> +<td>--retention <TIME></td> +<td>The timespan of data stored.</td> +</tr> +<tr> +<td>--show_table_scroll_position</td> +<td>Shows the scroll position tracker in table widgets.</td> +</tr> +<tr> +<td>-d, --time_delta <TIME></td> +<td>The amount of time changed upon zooming.</td> +</tr> +</tbody> +</table> +<h2 id="process-options"><a class="toclink" href="#process-options">Process Options</a></h2> +<table> +<thead> +<tr> +<th>Option</th> +<th>Behaviour</th> +</tr> +</thead> +<tbody> +<tr> +<td>-S, --case_sensitive</td> +<td>Enables case sensitivity by default.</td> +</tr> +<tr> +<td>-u, --current_usage</td> +<td>Sets process CPU% to be based on current CPU%.</td> +</tr> +<tr> +<td>--disable_advanced_kill</td> +<td>Hides advanced process killing.</td> </tr> <tr> <td>-g, --group_processes</td> <td>Groups processes with the same name by default.</td> </tr> <tr> -<td>-a, --hide_avg_cpu</td> -<td>Hides the average CPU usage.</td> +<td>--process_command</td> +<td>Show processes as their commands by default.</td> </tr> <tr> -<td>--hide_table_gap</td> -<td>Hides spacing between table headers and entries.</td> +<td>-R, --regex</td> +<td>Enables regex by default.</td> </tr> <tr> -<td>--hide_time</td> -<td>Hides the time scale.</td> +<td>-T, --tree</td> +<td>Defaults the process widget be in tree mode.</td> +</tr> +<tr> +<td>-n, --unnormalized_cpu</td> +<td>Show process CPU% usage without normalizing over the number of cores.</td> +</tr> +<tr> +<td>-W, --whole_word</td> +<td>Enables whole-word matching by default.</td> +</tr> +</tbody> +</table> +<h2 id="temperature-options"><a class="toclink" href="#temperature-options">Temperature Options</a></h2> +<table> +<thead> +<tr> +<th>Option</th> +<th>Behaviour</th> +</tr> +</thead> +<tbody> +<tr> +<td>-c, --celsius</td> +<td>Use Celsius as the temperature unit.</td> +</tr> +<tr> +<td>-f, --fahrenheit</td> +<td>Use Fahrenheit as the temperature unit.</td> </tr> <tr> <td>-k, --kelvin</td> -<td>Sets the temperature type to Kelvin.</td> +<td>Use Kelvin as the temperature unit.</td> +</tr> +</tbody> +</table> +<h2 id="cpu-options"><a class="toclink" href="#cpu-options">CPU Options</a></h2> +<table> +<thead> +<tr> +<th>Option</th> +<th>Behaviour</th> </tr> +</thead> +<tbody> <tr> -<td>-l, --left_legend</td> -<td>Puts the CPU chart legend to the left side.</td> +<td>-a, --hide_avg_cpu</td> +<td>Hides the average CPU usage.</td> +</tr> +</tbody> +</table> +<h2 id="memory-options"><a class="toclink" href="#memory-options">Memory Options</a></h2> +<table> +<thead> +<tr> +<th>Option</th> +<th>Behaviour</th> +</tr> +</thead> +<tbody> +<tr> +<td>--enable_cache_memory</td> +<td>Enable collecting and displaying cache and buffer memory.</td> </tr> <tr> <td>--mem_as_value</td> <td>Defaults to showing process memory usage by value.</td> </tr> +</tbody> +</table> +<h2 id="network-options"><a class="toclink" href="#network-options">Network Options</a></h2> +<table> +<thead> +<tr> +<th>Option</th> +<th>Behaviour</th> +</tr> +</thead> +<tbody> <tr> <td>--network_use_binary_prefix</td> <td>Displays the network widget with binary prefixes.</td> @@ -1426,53 +1606,73 @@ see information on these flags by running <code>btm -h</code>, or run <code>btm <td>Displays the network widget with a log scale.</td> </tr> <tr> -<td>--process_command</td> -<td>Show processes as their commands by default.</td> +<td>--use_old_network_legend</td> +<td>DEPRECATED - uses a separate network legend.</td> </tr> +</tbody> +</table> +<h2 id="battery-options"><a class="toclink" href="#battery-options">Battery Options</a></h2> +<table> +<thead> <tr> -<td>-r, --rate <TIME></td> -<td>Sets the data refresh rate.</td> +<th>Option</th> +<th>Behaviour</th> </tr> +</thead> +<tbody> <tr> -<td>-R, --regex</td> -<td>Enables regex by default.</td> +<td>--battery</td> +<td>Shows the battery widget.</td> </tr> +</tbody> +</table> +<h2 id="gpu-options"><a class="toclink" href="#gpu-options">GPU Options</a></h2> +<table> +<thead> <tr> -<td>--retention <TIME></td> -<td>The timespan of data stored.</td> +<th>Option</th> +<th>Behaviour</th> </tr> +</thead> +<tbody> <tr> -<td>--show_table_scroll_position</td> -<td>Shows the scroll position tracker in table widgets.</td> +<td>--enable_gpu</td> +<td>Enable collecting and displaying GPU usage.</td> </tr> +</tbody> +</table> +<h2 id="style-options"><a class="toclink" href="#style-options">Style Options</a></h2> +<table> +<thead> <tr> -<td>-d, --time_delta <TIME></td> -<td>The amount of time changed upon zooming.</td> +<th>Option</th> +<th>Behaviour</th> </tr> +</thead> +<tbody> <tr> -<td>-T, --tree</td> -<td>Defaults the process widget be in tree mode.</td> +<td>--color <COLOR SCHEME></td> +<td>Use a color scheme, use --help for info.</td> </tr> +</tbody> +</table> +<h2 id="other-options"><a class="toclink" href="#other-options">Other Options</a></h2> +<table> +<thead> <tr> -<td>-n, --unnormalized_cpu</td> -<td>Show process CPU% usage without normalizing over the number of cores.</td> +<th>Option</th> +<th>Behaviour</th> </tr> +</thead> +<tbody> <tr> -<td>--use_old_network_legend</td> -<td>DEPRECATED - uses a separate network legend.</td> +<td>-h, --help</td> +<td>Prints help (see more info with '--help').</td> </tr> <tr> <td>-V, --version</td> <td>Prints version information.</td> </tr> -<tr> -<td>-W, --whole_word</td> -<td>Enables whole-word matching by default.</td> -</tr> -<tr> -<td>-h, --help</td> -<td>Print help (see more with '--help')</td> -</tr> </tbody> </table> diff --git a/nightly/configuration/config-file/cpu/index.html b/nightly/configuration/config-file/cpu/index.html index 244e23e2..df8993d3 100644 --- a/nightly/configuration/config-file/cpu/index.html +++ b/nightly/configuration/config-file/cpu/index.html @@ -278,7 +278,7 @@ <li class="md-tabs__item"> - <a href="../../command-line-flags/" class="md-tabs__link"> + <a href="../../command-line-options/" class="md-tabs__link"> Configuration @@ -802,7 +802,7 @@ <li class="md-nav__item"> - <a href="../../command-line-flags/" class="md-nav__link"> + <a href="../../command-line-options/" class="md-nav__link"> <span class="md-ellipsis"> diff --git a/nightly/configuration/config-file/data-filtering/index.html b/nightly/configuration/config-file/data-filtering/index.html index 67d7a8f7..ad1d4f13 100644 --- a/nightly/configuration/config-file/data-filtering/index.html +++ b/nightly/configuration/config-file/data-filtering/index.html @@ -284,7 +284,7 @@ <li class="md-tabs__item md-tabs__item--active"> - <a href="../../command-line-flags/" class="md-tabs__link"> + <a href="../../command-line-options/" class="md-tabs__link"> Configuration @@ -808,7 +808,7 @@ <li class="md-nav__item"> - <a href="../../command-line-flags/" class="md-nav__link"> + <a href="../../command-line-options/" class="md-nav__link"> <span class="md-ellipsis"> diff --git a/nightly/configuration/config-file/default-config/index.html b/nightly/configuration/config-file/default-config/index.html index 9a839532..ed2fb338 100644 --- a/nightly/configuration/config-file/default-config/index.html +++ b/nightly/configuration/config-file/default-config/index.html @@ -15,7 +15,7 @@ <link rel="canonical" href="https://clementtsang.github.io/bottom/stable/configuration/config-file/default-config/"> - <link rel="prev" href="../../command-line-flags/"> + <link rel="prev" href="../../command-line-options/"> <link rel="next" href="../flags/"> @@ -284,7 +284,7 @@ <li class="md-tabs__item md-tabs__item--active"> - <a href="../../command-line-flags/" class="md-tabs__link"> + <a href="../../command-line-options/" class="md-tabs__link"> Configuration @@ -808,7 +808,7 @@ <li class="md-nav__item"> - <a href="../../command-line-flags/" class="md-nav__link"> + <a href="../../command-line-options/" class="md-nav__link"> <span class="md-ellipsis"> diff --git a/nightly/configuration/config-file/flags/index.html b/nightly/configuration/config-file/flags/index.html index 96181507..f82d0454 100644 --- a/nightly/configuration/config-file/flags/index.html +++ b/nightly/configuration/config-file/flags/index.html @@ -284,7 +284,7 @@ <li class="md-tabs__item md-tabs__item--active"> - <a href="../../command-line-flags/" class="md-tabs__link"> + <a href="../../command-line-options/" class="md-tabs__link"> Configuration @@ -808,7 +808,7 @@ <li class="md-nav__item"> - <a href="../../command-line-flags/" class="md-nav__link"> + <a href="../../command-line-options/" class="md-nav__link"> <span class="md-ellipsis"> @@ -1307,7 +1307,7 @@ <p class="admonition-title">Warning</p> <p>This section is in progress, and is just copied from the old documentation.</p> </div> -<p>Most of the <a href="../../command-line-flags/">command line flags</a> have config file equivalents to avoid having to type them out +<p>Most of the <a href="../../command-line-options/">command line flags</a> have config file equivalents to avoid having to type them out each time:</p> <table> <thead> diff --git a/nightly/configuration/config-file/layout/index.html b/nightly/configuration/config-file/layout/index.html index bc25d7c5..2a5e6153 100644 --- a/nightly/configuration/config-file/layout/index.html +++ b/nightly/configuration/config-file/layout/index.html @@ -284,7 +284,7 @@ <li class="md-tabs__item md-tabs__item--active"> - <a href="../../command-line-flags/" class="md-tabs__link"> + <a href="../../command-line-options/" class="md-tabs__link"> Configuration @@ -808,7 +808,7 @@ <li class="md-nav__item"> - <a href="../../command-line-flags/" class="md-nav__link"> + <a href="../../command-line-options/" class="md-nav__link"> <span class="md-ellipsis"> diff --git a/nightly/configuration/config-file/processes/index.html b/nightly/configuration/config-file/processes/index.html index f5832b52..957623fc 100644 --- a/nightly/configuration/config-file/processes/index.html +++ b/nightly/configuration/config-file/processes/index.html @@ -284,7 +284,7 @@ <li class="md-tabs__item md-tabs__item--active"> - <a href="../../command-line-flags/" class="md-tabs__link"> + <a href="../../command-line-options/" class="md-tabs__link"> Configuration @@ -808,7 +808,7 @@ <li class="md-nav__item"> - <a href="../../command-line-flags/" class="md-nav__link"> + <a href="../../command-line-options/" class="md-nav__link"> <span class="md-ellipsis"> diff --git a/nightly/configuration/config-file/theming/index.html b/nightly/configuration/config-file/theming/index.html index 9c219d0c..63d0c499 100644 --- a/nightly/configuration/config-file/theming/index.html +++ b/nightly/configuration/config-file/theming/index.html @@ -284,7 +284,7 @@ <li class="md-tabs__item md-tabs__item--active"> - <a href="../../command-line-flags/" class="md-tabs__link"> + <a href="../../command-line-options/" class="md-tabs__link"> Configuration @@ -808,7 +808,7 @@ <li class="md-nav__item"> - <a href="../../command-line-flags/" class="md-nav__link"> + <a href="../../command-line-options/" class="md-nav__link"> <span class="md-ellipsis"> diff --git a/nightly/contribution/development/build_process/index.html b/nightly/contribution/development/build_process/index.html index 313a2960..2b84625e 100644 --- a/nightly/contribution/development/build_process/index.html +++ b/nightly/contribution/development/build_process/index.html @@ -282,7 +282,7 @@ <li class="md-tabs__item"> - <a href="../../../configuration/command-line-flags/" class="md-tabs__link"> + <a href="../../../configuration/command-line-options/" class="md-tabs__link"> Configuration @@ -808,7 +808,7 @@ <li class="md-nav__item"> - <a href="../../../configuration/command-line-flags/" class="md-nav__link"> + <a href="../../../configuration/command-line-options/" class="md-nav__link"> <span class="md-ellipsis"> diff --git a/nightly/contribution/development/deploy_process/index.html b/nightly/contribution/development/deploy_process/index.html index 369024e0..874eccf0 100644 --- a/nightly/contribution/development/deploy_process/index.html +++ b/nightly/contribution/development/deploy_process/index.html @@ -282,7 +282,7 @@ <li class="md-tabs__item"> - <a href="../../../configuration/command-line-flags/" class="md-tabs__link"> + <a href="../../../configuration/command-line-options/" class="md-tabs__link"> Configuration @@ -808,7 +808,7 @@ <li class="md-nav__item"> - <a href="../../../configuration/command-line-flags/" class="md-nav__link"> + <a href="../../../configuration/command-line-options/" class="md-nav__link"> <span class="md-ellipsis"> diff --git a/nightly/contribution/development/dev_env/index.html b/nightly/contribution/development/dev_env/index.html index 7c9160ca..5b0265cd 100644 --- a/nightly/contribution/development/dev_env/index.html +++ b/nightly/contribution/development/dev_env/index.html @@ -282,7 +282,7 @@ <li class="md-tabs__item"> - <a href="../../../configuration/command-line-flags/" class="md-tabs__link"> + <a href="../../../configuration/command-line-options/" class="md-tabs__link"> Configuration @@ -808,7 +808,7 @@ <li class="md-nav__item"> - <a href="../../../configuration/command-line-flags/" class="md-nav__link"> + <a href="../../../configuration/command-line-options/" class="md-nav__link"> <span class="md-ellipsis"> |