diff --git a/0.6.1/404.html b/0.6.1/404.html index 83b1aca7..4294e909 100644 --- a/0.6.1/404.html +++ b/0.6.1/404.html @@ -53,8 +53,6 @@ - - diff --git a/0.6.1/configuration/command-line-flags/index.html b/0.6.1/configuration/command-line-flags/index.html index e8bd6572..fcda29f9 100644 --- a/0.6.1/configuration/command-line-flags/index.html +++ b/0.6.1/configuration/command-line-flags/index.html @@ -55,8 +55,7 @@ - - + diff --git a/0.6.1/configuration/config-file/data-filtering/index.html b/0.6.1/configuration/config-file/data-filtering/index.html index c423539a..df9a1aff 100644 --- a/0.6.1/configuration/config-file/data-filtering/index.html +++ b/0.6.1/configuration/config-file/data-filtering/index.html @@ -55,8 +55,7 @@ - - + diff --git a/0.6.1/configuration/config-file/default-config/index.html b/0.6.1/configuration/config-file/default-config/index.html index ca8088e0..9c1b95a3 100644 --- a/0.6.1/configuration/config-file/default-config/index.html +++ b/0.6.1/configuration/config-file/default-config/index.html @@ -1,852 +1,918 @@ - - - - - - - - - - - - - - - - - - - - - Default Config - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- -
- -
- -
- - - - - + + +
-
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Default Config

    -

    A default config file is automatically generated at the following locations that bottom checks by default:

    - - - - - - - - - - - - - - - - - - - - - -
    OSDefault Config Location
    macOS$HOME/Library/Application Support/bottom/bottom.toml
    ~/.config/bottom/bottom.toml
    $XDG_CONFIG_HOME/bottom/bottom.toml
    Linux~/.config/bottom/bottom.toml
    $XDG_CONFIG_HOME/bottom/bottom.toml
    WindowsC:\Users\<USER>\AppData\Roaming\bottom\bottom.toml
    -

    Furthermore, if a custom config path that does not exist is given (using -C or --config), bottom will attempt to create a default config file at that location.

    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/configuration/config-file/flags/index.html b/0.6.1/configuration/config-file/flags/index.html index fcba2204..bb6f233f 100644 --- a/0.6.1/configuration/config-file/flags/index.html +++ b/0.6.1/configuration/config-file/flags/index.html @@ -1,979 +1,1042 @@ - - - - - - - - - - - - - - - - - - - - - Flags - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Flags

    -
    -

    Warning

    -

    This section is in progress, and is just copied from the old documentation.

    -
    -

    Most of the command line flags have config file equivalents to avoid having to type them out each time:

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeFunctionality
    hide_avg_cpuBooleanHides the average CPU usage.
    dot_markerBooleanUses a dot marker for graphs.
    left_legendBooleanPuts the CPU chart legend to the left side.
    current_usageBooleanSets process CPU% to be based on current CPU%.
    group_processesBooleanGroups processes with the same name by default.
    case_sensitiveBooleanEnables case sensitivity by default.
    whole_wordBooleanEnables whole-word matching by default.
    regexBooleanEnables regex by default.
    basicBooleanHides graphs and uses a more basic look.
    use_old_network_legendBooleanDEPRECATED - uses the older network legend.
    batteryBooleanShows the battery widget.
    rateUnsigned Int (represents milliseconds)Sets a refresh rate in ms.
    default_time_valueUnsigned Int (represents milliseconds)Default time value for graphs in ms.
    time_deltaUnsigned Int (represents milliseconds)The amount in ms changed upon zooming.
    temperature_typeString (one of ["k", "f", "c", "kelvin", "fahrenheit", "celsius"])Sets the temperature unit type.
    default_widget_typeString (one of ["cpu", "proc", "net", "temp", "mem", "disk"], same as layout options)Sets the default widget type, use --help for more info.
    default_widget_countUnsigned Int (represents which default_widget_type)Sets the n'th selected widget type as the default.
    disable_clickBooleanDisables mouse clicks.
    colorString (one of ["default", "default-light", "gruvbox", "gruvbox-light", "nord", "nord-light"])Use a color scheme, use --help for supported values.
    mem_as_valueBooleanDefaults to showing process memory usage by value.
    treeBooleanDefaults to showing the process widget in tree mode.
    show_table_scroll_positionBooleanShows the scroll position tracker in table widgets.
    process_commandBooleanShow processes as their commands by default.
    disable_advanced_killBooleanHides advanced options to stop a process on Unix-like systems.
    network_use_binary_prefixBooleanDisplays the network widget with binary prefixes.
    network_use_bytesBooleanDisplays the network widget using bytes.
    network_use_logBooleanDisplays the network widget with a log scale.
    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/configuration/config-file/layout/index.html b/0.6.1/configuration/config-file/layout/index.html index efcdef7c..33e8f536 100644 --- a/0.6.1/configuration/config-file/layout/index.html +++ b/0.6.1/configuration/config-file/layout/index.html @@ -1,809 +1,867 @@ - - - - - - - - - - - - - - - - - - - - - Layout - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    -
    + +
    -
  • - - Support - -
    • - - - - - - - - -
  • - - Usage - -
    • - - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - +
  • + + Home + +
    • -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Layout

    -
    -

    Warning

    -

    This section is in progress, and is just copied from the old documentation.

    -
    -

    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]]
+                  bottom
+                
+
+                
    
+
+                  
+                    
    
+
+                      
+                        
+                      
+                    
    
+                    
    
+                      ClementTsang/bottom
+                    
    
+                      
+                
    
+
+                
+              
+
    +
    +
    + + + +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + + + + +

    Layout

    +
    +

    Warning

    +

    This section is in progress, and is just copied from the old documentation.

    +
    +

    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]]
@@ -817,87 +875,99 @@
         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. -The second column is split into two rows with a 1:1 ratio. The first is the temperature widget, the second is the disk widget.

    -

    This is what the layout would look like when run:

    -

    Sample layout

    -

    Each [[row]] represents a row in the layout. A row can have any number of child values. Each [[row.child]] -represents either a column or a widget. A column can have any number of child values as well. Each [[row.child.child]] -represents a widget. A widget is represented by having a type field set to a string.

    -

    The following type values are supported:

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    "cpu"CPU chart and legend
    "mem", "memory"Memory chart
    "net", "network"Network chart and legend
    "proc", "process", "processes"Process table and search
    "temp", "temperature"Temperature table
    "disk"Disk table
    "empty"An empty space
    "batt", "battery"Battery statistics
    -

    Each component of the layout accepts a ratio value. If this is not set, it defaults to 1.

    -

    Furthermore, you can have duplicate widgets.

    -

    For an example, look at the default config, which contains the default layout.

    - - - - +     +
    +

    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. + The second column is split into two rows with a 1:1 ratio. The first is the temperature widget, the second + is the disk widget.

    +

    This is what the layout would look like when run:

    +

    Sample layout

    +

    Each [[row]] represents a row in the layout. A row can have any number of + child values. Each [[row.child]] + represents either a column or a widget. A column can have any number of child values + as well. Each [[row.child.child]] + represents a widget. A widget is represented by having a type field set to a string. +

    +

    The following type values are supported:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    "cpu"CPU chart and legend
    "mem", "memory"Memory chart
    "net", "network"Network chart and legend
    "proc", "process", "processes"Process table and search
    "temp", "temperature"Temperature table
    "disk"Disk table
    "empty"An empty space
    "batt", "battery"Battery statistics
    +

    Each component of the layout accepts a ratio value. If this is not set, it defaults to 1. +

    +

    Furthermore, you can have duplicate widgets.

    +

    For an example, look at the default + config, which contains the default layout.

    - - -
    + + + + + + - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/configuration/config-file/theming/index.html b/0.6.1/configuration/config-file/theming/index.html index 572e51eb..09c3955d 100644 --- a/0.6.1/configuration/config-file/theming/index.html +++ b/0.6.1/configuration/config-file/theming/index.html @@ -1,940 +1,1004 @@ - - - - - - - - - - - - - - - - - - - - - Theming - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Theming

    -
    -

    Warning

    -

    This section is in progress, and is just copied from the old documentation.

    -
    -

    The config file can be used to set custom colours for parts of the application under the [colors] object. The following labels are customizable with strings that are hex colours, RGB colours, or specific named colours.

    -

    Supported named colours are one of the following strings: Reset, Black, Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed, LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    LabelsDetailsExample
    Table header coloursColour of table headerstable_header_color="255, 255, 255"
    CPU colour per coreColour of each core. Read in order.cpu_core_colors=["#ffffff", "white", "255, 255, 255"]
    Average CPU colourThe average CPU coloravg_cpu_color="White"
    All CPUs colourThe colour for the "All" CPU labelall_cpu_color="White"
    RAMThe colour RAM will useram_color="#ffffff"
    SWAPThe colour SWAP will useswap_color="#ffffff"
    RXThe colour rx will userx_color="#ffffff"
    TXThe colour tx will usetx_color="#ffffff"
    Widget title colourThe colour of the label each widget haswidget_title_color="#ffffff"
    Border colourThe colour of the border of unselected widgetsborder_color="#ffffff"
    Selected border colourThe colour of the border of selected widgetshighlighted_border_color="#ffffff"
    Text colourThe colour of most texttext_color="#ffffff"
    Graph colourThe colour of the lines and text of the graphgraph_color="#ffffff"
    Cursor colourThe cursor's colourcursor_color="#ffffff"
    Selected text colourThe colour of text that is selectedscroll_entry_text_color="#ffffff"
    Selected text background colourThe background colour of text that is selectedscroll_entry_bg_color="#ffffff"
    High battery level colourThe colour used for a high battery level (100% to 50%)high_battery_color="green"
    Medium battery level colourThe colour used for a medium battery level (50% to 10%)medium_battery_color="yellow"
    Low battery level colourThe colour used for a low battery level (10% to 0%)low_battery_color="red"
    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/contribution/development/index.html b/0.6.1/contribution/development/index.html index 8193ccfc..234ff61e 100644 --- a/0.6.1/contribution/development/index.html +++ b/0.6.1/contribution/development/index.html @@ -1,906 +1,967 @@ - - - - - - - - - - - - - - - - - - - - - Development - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    - + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/contribution/documentation/index.html b/0.6.1/contribution/documentation/index.html index ed0b8616..eae1dcf8 100644 --- a/0.6.1/contribution/documentation/index.html +++ b/0.6.1/contribution/documentation/index.html @@ -1,936 +1,1019 @@ - - - - - - - - - - - - - - - - - - - - - Documentation - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Documentation

    -

    When should documentation changes be done?

    -
      -
    • Whenever a new feature is added, a bug is fixed, or a breaking change is made, it should be documented where appropriate (ex: README.md, changelog, etc.)
      • -
    • New methods of installation are always appreciated and should be documented
      • -
    -

    What pages need documentation?

    -

    There are a few areas where documentation changes are often needed:

    - -

    How should I add documentation?

    -
      -
    1. -

      Fork the repository first and make changes there.

      -
      2. -
    2. -

      Where you're adding documentation will probably affect what you need to do:

      - -
        -
      • For changes to the help menu, try to refer to the existing code within src/constants.rs on how the help menu is generated.
        • -
      -
        -
      • -

        For changes to the extended documentation, you'll want MkDocs, Material for MkDocs, and mdx_truly_sane_lists installed to provide live reloading and preview for your changes. You can do so through pip or your system's package managers. While you don't need these, it'll probably help in making and validating changes.

        -

        You may also want Mike, but it isn't really needed.

        -
        • -
      -
      3. -
    3. -

      Once you have your documentation changes done, submit it as a pull request. For more information regarding that, refer to Issues and Pull Requests.

      -
      4. -
    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/contribution/issues-and-pull-requests/index.html b/0.6.1/contribution/issues-and-pull-requests/index.html index f68a2034..2349670f 100644 --- a/0.6.1/contribution/issues-and-pull-requests/index.html +++ b/0.6.1/contribution/issues-and-pull-requests/index.html @@ -1,942 +1,1017 @@ - - - - - - - - - - - - - - - - - - - - - Issues and Pull Requests - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - -
    -
    -
    - - - -
    -
    -
    - -
    - - - -
  • - - Pull requests - - -
    • - - - - -
    -
    -
    - - -
    -
    - - - - + + +
    +
    + + + +
    +
    +
    + + + + + +
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/contribution/packaging-and-distribution/index.html b/0.6.1/contribution/packaging-and-distribution/index.html index b52d29d9..7aa70edf 100644 --- a/0.6.1/contribution/packaging-and-distribution/index.html +++ b/0.6.1/contribution/packaging-and-distribution/index.html @@ -1,921 +1,1005 @@ - - - - - - - - - - - - - - - - - - - - - Packaging and Distribution - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Packaging and Distribution

    -

    Package maintainers are always welcome and appreciated! Here's some info on how one can help with package distribution and bottom.

    -

    Pre-built binaries

    -

    The latest stable release can be found here, where you can find pre-built binaries in either a tar.gz or zip format. -Binaries here also include automatically generated shell completion files for zsh, bash, fish, and Powershell, which you may want to also install during the packaging -process.

    -

    You can also find a nightly build in the releases page, built every day at 00:00 UTC off of the master branch.

    -

    Building manually

    -

    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
-
    -

    You'll then want to build with:

    -
    cargo build --release --locked
-
    -

    Completion files are automatically generated during this process, and are located in the directory target/release/build/bottom-<gibberish>/out. Note there may be multiple folders that look like target/release/build/bottom-<gibberish>. To programmatically determine which is the right folder, you might want to use something like:

    -
    $(ls target/release/build/bottom-*/out/btm.bash | head -n1 | xargs dirname)
-
    -

    You may find the Arch package install script template useful as a reference.

    -

    Adding an installation source

    -

    Once you've finished your installation source, if you want to mention it in the main bottom repo, fork the repo and add the installation method and any details to -the README.md file under the Installation section. -Once that's done, open a pull request - these will usually be approved of very quickly.

    -

    You can find more info on the contribution process here.

    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/index.html b/0.6.1/index.html index 23fe3ca9..b7a0c94d 100644 --- a/0.6.1/index.html +++ b/0.6.1/index.html @@ -55,8 +55,7 @@ - - + diff --git a/0.6.1/support/index.html b/0.6.1/support/index.html index 0aad0db1..e754347b 100644 --- a/0.6.1/support/index.html +++ b/0.6.1/support/index.html @@ -1,1010 +1,1078 @@ - - - - - - - - - - - - - - - - - - - - - Support - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - -
    -
    - - - -
    -
    -
    - -
    - - - - - - - - -
  • - - Unofficial support - - - - -
    • - - - - -
    -
    -
    - - -
    -
    - - - - + + +
    +
    + + + +
    +
    +
    + + + + + +
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + + + +
  • + + + + + + + + + + + Support + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/troubleshooting/index.html b/0.6.1/troubleshooting/index.html index 5287ad7a..c1a4ef57 100644 --- a/0.6.1/troubleshooting/index.html +++ b/0.6.1/troubleshooting/index.html @@ -1,1005 +1,1097 @@ - - - - - - - - - - - - - - - - - - - - - Troubleshooting - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - + + +
    +
    + + + +
    +
    +
    + + + + + +
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + +
  • + + + + + + + + + + + Troubleshooting + + + + + +
    • + + + + + +
    - - - - - - - - -
    - - + +
    +
    +
    + + Made with + + Material for MkDocs + + +
    + +
    - - +
    + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/usage/basic-mode/index.html b/0.6.1/usage/basic-mode/index.html index 5f3b5581..77eb7c37 100644 --- a/0.6.1/usage/basic-mode/index.html +++ b/0.6.1/usage/basic-mode/index.html @@ -1,908 +1,979 @@ - - - - - - - - - - - - - - - - - - - - - Basic Mode - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    -
    + +
    -
  • - - Support - -
    • - - - - - - - - - - -
  • - - Usage - -
    • - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - +
  • + + Home + +
    • -
    + - - - - - - - -
  • - - - - - - - - - - - Basic Mode - - - - - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Basic Mode

    -

    Basic mode is a special layout that removes all of the graphs and provides an interface that resembles (a very stripped-down version of) htop.

    -
    - A picture of bottom's basic mode. -
    + bottom + -

    Basic mode can be enabled either through a command line flag:

    -
    btm -b
+                
    
+
+                  
+                    
    
+
+                      
+                        
+                      
+                    
    
+                    
    
+                      ClementTsang/bottom
+                    
    
+                      
+                
    
+
+                
+              
+
    +
    +
    + + + +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + + + + +

    Basic Mode

    +

    Basic mode is a special layout that removes all of the graphs and provides an interface that resembles (a + very stripped-down version of) htop.

    +
    + A picture of bottom's basic mode. +
    + +

    Basic mode can be enabled either through a command line flag:

    +
    + 
    btm -b
 
 # or
 
 btm --basic
-
    -

    or through the config:

    -
    [flags]
+
    +
    +

    or through the config:

    +
    + 
    [flags]
 basic = true
-
    -

    Notes

    -

    In this mode, widgets that use tables (temperatures, processes, disks, and batteries) are only shown one at a time. -One can switch between these widgets either by clicking the arrow buttons or by using the general widget selection shortcuts (for example, Ctrl+Left or H) -to switch which widget is shown.

    -

    Also note that in this mode, widget expansion and custom layouts are disabled.

    -

    Key bindings

    -

    Basic mode follows the same key bindings as normal, barring widget expansion being disabled, and that the % key while selecting the memory widget toggles between total usage and percentage.

    - - - - +     +
    +

    Notes

    +

    In this mode, widgets that use tables (temperatures, processes, disks, and batteries) are only shown one + at a time. + One can switch between these widgets either by clicking the arrow buttons or by using the general widget + selection shortcuts (for example, Ctrl+Left or H) + to switch which widget is shown.

    +

    Also note that in this mode, widget expansion and custom layouts are disabled.

    +

    Key bindings

    +

    Basic mode follows the same key bindings as normal, barring widget expansion being disabled, and that the + % key while selecting the memory widget toggles between total usage + and percentage.

    - - -
    + + + + + + - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/usage/general-usage/index.html b/0.6.1/usage/general-usage/index.html index 11e66ef2..8ac7df60 100644 --- a/0.6.1/usage/general-usage/index.html +++ b/0.6.1/usage/general-usage/index.html @@ -1,1050 +1,1149 @@ - - - - - - - - - - - - - - - - - - - - - General Usage - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    -
    - - - - - - -
  • - - - - - - -
    • - - - - - - - - - - - -
  • - - - - - - -
    • - - - - - - - - - - - -
  • - - - - - - -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - - - - - - - -
    -
    -
    - -
    - - - -
  • - - Key bindings - - -
    • - -
  • - - Mouse bindings - - -
    • - - - - -
    -
    - - - -
    -
    - - - - + + +
    +
    + + + +
    +
    +
    + + + + + + +
    +
    +
    + + + +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + + + + +

    General Usage

    +

    You can run bottom with:

    +
    + 
    btm
+
    +
    +

    For help regarding the command-line flags, use:

    +
    + 
    # For a simple overview of flags
 btm -h
 
 # For more details
 btm --help
-
    -

    Features

    -

    Expansion

    -

    By default, bottom is somewhat like a dashboard - a bunch of different widgets, all showing different things, and they all cram together to fit into one terminal.

    -

    If you instead just want to see one widget - maybe you want to look at a graph in more detail, for example - you can "expand" the currently selected -widget using the e key, which will hide all other widgets and make that widget take up all available terminal space.

    -

    You can leave this state by either pressing e again or pressing Esc.

    -

    Widget selection

    -

    To allow for widget-specific keybindings and expansion, there is the idea of widget selection in bottom, where you can focus on a specific widget to work with it. -This can be done with the mouse (just click on the widget of interest) or keyboard (ex: Ctrl+Direction, see Key bindings for alternatives).

    -

    Key bindings

    -

    These are global or common keyboard shortcuts for the application, which you can see in-app through the ? shortcut. -Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    q , Ctrl+cQuit
    EscClose dialog windows, search, widgets, or exit expanded mode
    Ctrl+rReset display and any collected data
    fFreeze/unfreeze updating with new data
    ?Open help menu
    eToggle expanding the currently selected widget
    Ctrl+Up
    Shift+Up
    K
    W    		Select the widget above
    Ctrl+Down
    Shift+Down
    J
    S    		Select the widget below
    Ctrl+Left
    Shift+Left
    H
    A    		Select the widget on the left
    Ctrl+Right
    Shift+Right
    L
    D    		Select the widget on the right
    Up , kMove up within a widget
    Down , jMove down within a widget
    Left
    h
    Alt+h    		Move left within a widget
    Right
    l
    Alt+l    		Move right within a widget
    g+g , HomeJump to the first entry
    G , EndJump to the last entry
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    Left ButtonSelects the widget
    - - - - +     +
    +

    Features

    +

    Expansion

    +

    By default, bottom is somewhat like a dashboard - a bunch of different widgets, all showing different + things, and they all cram together to fit into one terminal.

    +

    If you instead just want to see one widget - maybe you want to look at a graph in more detail, + for example - you can "expand" the currently selected + widget using the e key, which will hide all other + widgets and make that widget take up all available terminal space.

    +

    You can leave this state by either pressing e again or + pressing Esc.

    +

    Widget selection

    +

    To allow for widget-specific keybindings and expansion, there is the idea of widget selection in + bottom, where you can focus on a specific widget to work with it. + This can be done with the mouse (just click on the widget of interest) or keyboard (ex: Ctrl+Direction, see Key bindings for alternatives).

    +

    Key bindings

    +

    These are global or common keyboard shortcuts for the application, which you can see in-app through the + ? shortcut. + Note that key bindings are generally case-sensitive.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    BindingAction
    q , Ctrl+cQuit
    EscClose dialog windows, search, widgets, or exit expanded mode
    Ctrl+rReset display and any collected data
    fFreeze/unfreeze updating with new data
    ?Open help menu
    eToggle expanding the currently selected widget
    Ctrl+Up
    Shift+Up
    + K
    W    		Select the widget above
    Ctrl+Down
    Shift+Down
    + J
    S    		Select the widget below
    Ctrl+Left
    Shift+Left
    + H
    A    		Select the widget on the left
    Ctrl+Right
    Shift+Right +
    L
    D    		Select the widget on the right
    Up , kMove up within a widget
    Down , jMove down within a widget
    Left
    h
    Alt+h    		Move left within a widget
    Right
    l
    Alt+l    		Move right within a widget
    g+g , + HomeJump to the first entry
    G , EndJump to the last entry
    +

    Mouse bindings

    + + + + + + + + + + + + + +
    BindingAction
    Left ButtonSelects the widget
    - -
    -
    + + + + + + - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/usage/widgets/battery/index.html b/0.6.1/usage/widgets/battery/index.html index 62248c92..cbc90848 100644 --- a/0.6.1/usage/widgets/battery/index.html +++ b/0.6.1/usage/widgets/battery/index.html @@ -1,951 +1,1018 @@ - - - - - - - - - - - - - - - - - - - - - Battery Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Battery Widget

    -

    The battery widget provides information about batteries on the system.

    -
    - A picture of an expanded battery widget. -
    + bottom + -

    The battery widget can be enabled through either the --battery flag, the battery = true option in a config file, or specifying the widget in a custom layout.

    -

    Features

    -

    The following data is displayed for batteries:

    -
      -
    • Charge percent
      • -
    • Consumption
      • -
    • Time to empty/charge, based on the current state
      • -
    • Battery health percent
      • -
    -

    The battery widget also supports devices with multiple batteries, and you can switch between them using the keyboard or the mouse.

    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - -
    BindingAction
    Left
    h
    Alt+h    		Moves to the battery entry to the left of the current one
    Right
    l
    Alt+l    		Moves to the battery entry to the right of the current one
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    Left ButtonSelects a battery entry
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/usage/widgets/cpu/index.html b/0.6.1/usage/widgets/cpu/index.html index e4d772f0..2522ba2a 100644 --- a/0.6.1/usage/widgets/cpu/index.html +++ b/0.6.1/usage/widgets/cpu/index.html @@ -1,1082 +1,1152 @@ - - - - - - - - - - - - - - - - - - - - - CPU Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    CPU Widget

    -

    The CPU widget displays a visual representation of CPU usage over a time range.

    -
    - A picture of an expanded CPU widget showing average CPU usage. -
    + bottom + -

    Features

    -

    The CPU widget is composed of two parts: the graph and the legend:

    -
      -
    • The graph displays the usage data for the currently selected entry as a percentage
      • -
    • The legend displays all available entries that can be displayed on the graph along with their last recorded use percentage (except for the "All" option)
      • -
    -

    Users can scroll through the legend using either the keyboard or mouse to select which entry to display on the graph. The "All" option shows every entry -at the same time, though this may get a bit hard to follow if you have a large number of cores/threads.

    -

    One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    -

    Graph

    - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    +Zoom in on chart (decrease time range)
    -Zoom out on chart (increase time range)
    =Reset zoom
    -

    Legend

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    Up , kMove up within a widget
    Down , jMove down within a widget
    g+g , HomeJump to the first entry in the legend
    G , EndJump to the last entry in the legend
    -

    Mouse bindings

    -

    Graph

    - - - - - - - - - - - - - -
    BindingAction
    ScrollScrolling up or down zooms in or out of the graph respectively
    -

    Legend

    - - - - - - - - - - - - - - - - - -
    BindingAction
    ScrollScroll through options to display in the graph
    Left ButtonSelects a CPU thread/average to show in the graph
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/usage/widgets/disk/index.html b/0.6.1/usage/widgets/disk/index.html index c4d9a02d..3435ba76 100644 --- a/0.6.1/usage/widgets/disk/index.html +++ b/0.6.1/usage/widgets/disk/index.html @@ -1,960 +1,1026 @@ - - - - - - - - - - - - - - - - - - - - - Disk Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Disk Widget

    -

    The disk widget provides a table of useful disk and partition information, like I/O per second and total usage.

    -
    - A picture of an expanded disk widget. -
    + bottom + -

    Features

    -

    The disk widget provides the following information:

    -
      -
    • Disk name
      • -
    • Disk mount location
      • -
    • Percentage of space used
      • -
    • Amount of space left
      • -
    • Total amount of space
      • -
    • Read per second
      • -
    • Write per second
      • -
    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    Up , kMove up within a widget
    Down , jMove down within a widget
    g+g , HomeJump to the first entry in the table
    G , EndJump to the last entry in the table
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    Left ButtonSelects an entry in the table
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/usage/widgets/memory/index.html b/0.6.1/usage/widgets/memory/index.html index 7ca0a037..1100a87a 100644 --- a/0.6.1/usage/widgets/memory/index.html +++ b/0.6.1/usage/widgets/memory/index.html @@ -1,949 +1,1010 @@ - - - - - - - - - - - - - - - - - - - - - Memory Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Memory Widget

    -

    The memory widget provides a visual representation of RAM and swap usage over time.

    -
    - A picture of an expanded memory widget. -
    + bottom + -

    Features

    -

    The legend displays the current usage in terms of percentage and actual usage. -If the total RAM or swap available is 0, then it is automatically hidden from the legend and graph.

    -

    One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    +Zoom in on chart (decrease time range)
    -Zoom out on chart (increase time range)
    =Reset zoom
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    ScrollScrolling up or down zooms in or out of the graph respectively
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/usage/widgets/network/index.html b/0.6.1/usage/widgets/network/index.html index b10ab8d3..86cb7915 100644 --- a/0.6.1/usage/widgets/network/index.html +++ b/0.6.1/usage/widgets/network/index.html @@ -1,952 +1,1019 @@ - - - - - - - - - - - - - - - - - - - - - Network Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Network Widget

    -

    The network widget provides a visual representation of network input and output per second, as well as noting the total amount -received and transmitted.

    -
    - A picture of an expanded network widget. -
    + bottom + -

    Features

    -

    The legend displays the current reads and writes per second in bits, as well as the total amount read/written.

    -

    The y-axis automatically scales based on shown read/write values, and by default, is a linear scale based on base-10 units (e.x. kilobit, gigabit, etc.). -Through configuration, the read/write per second unit can be changed to bytes, while the y-axis can be changed to a -log scale and/or use base-2 units (e.x. kibibit, gibibit, etc.).

    -

    One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    +Zoom in on chart (decrease time range)
    -Zoom out on chart (increase time range)
    =Reset zoom
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    ScrollScrolling up or down zooms in or out of the graph respectively
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/usage/widgets/process/index.html b/0.6.1/usage/widgets/process/index.html index 89b4e77c..f133208d 100644 --- a/0.6.1/usage/widgets/process/index.html +++ b/0.6.1/usage/widgets/process/index.html @@ -1,1616 +1,1735 @@ - - - - - - - - - - - - - - - - - - - - - Process Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - -
    -
    -
    - - - -
    -
    -
    - -
    - - - - - - - - -
  • - - Key bindings - - - - -
    • - -
  • - - Mouse bindings - - - - -
    • - - - - -
    -
    -
    - - -
    -
    - - - - + + +
    +
    + + + +
    +
    +
    + + + + + +
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - - + +
    +
    +
    + + Made with + + Material for MkDocs + + +
    + +
    - - +
    + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.1/usage/widgets/temperature/index.html b/0.6.1/usage/widgets/temperature/index.html index 949c40cf..21b0c174 100644 --- a/0.6.1/usage/widgets/temperature/index.html +++ b/0.6.1/usage/widgets/temperature/index.html @@ -1,951 +1,1016 @@ - - - - - - - - - - - - - - - - - - - - - Temperature Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Temperature Widget

    -

    The temperature widget provides a table of temperature sensors and their current temperature.

    -
    - A picture of an expanded temperature widget. -
    + bottom + -

    Features

    -

    The temperature widget provides the sensor name as well as its current temperature.

    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    Up , kMove up within a widget
    Down , jMove down within a widget
    g+g , HomeJump to the first entry in the table
    G , EndJump to the last entry in the table
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    Left ButtonSelects an entry in the table
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/404.html b/0.6.2/404.html index 2f2a2851..b87fa929 100644 --- a/0.6.2/404.html +++ b/0.6.2/404.html @@ -1,795 +1,851 @@ - - - - - - - - - - - - - - - - - - - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + - - - - - - - - - - - - - - - - - - - - - - -
    - -
    -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - - -
    +
    - - - - -
    -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/configuration/command-line-flags/index.html b/0.6.2/configuration/command-line-flags/index.html index 2a7a86d6..c2f33717 100644 --- a/0.6.2/configuration/command-line-flags/index.html +++ b/0.6.2/configuration/command-line-flags/index.html @@ -1,981 +1,1043 @@ - - - - - - - - - - - - - - - - - - - - - Command-line Flags - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Command-line Flags

    -
    -

    Warning

    -

    This section is in progress, and is just copied from the old documentation.

    -
    -

    The following flags can be provided to bottom in the command line to change the behaviour of the program (run btm --help for more information on each flag):

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FlagBehaviour
    --autohide_timeTemporarily shows the time scale in graphs.
    -b, --basicHides graphs and uses a more basic look.
    --batteryShows the battery widget.
    -S, --case_sensitiveEnables case sensitivity by default.
    -c, --celsiusSets the temperature type to Celsius.
    --color <COLOR SCHEME>Use a color scheme, use --help for supported values.
    -C, --config <CONFIG PATH>Sets the location of the config file.
    -u, --current_usageSets process CPU% to be based on current CPU%.
    -t, --default_time_value <MS>Default time value for graphs in ms.
    --default_widget_count <INT>Sets the n'th selected widget type as the default.
    --default_widget_type <WIDGET TYPE>Sets the default widget type, use --help for more info.
    --disable_advanced_killHides advanced options to stop a process on Unix-like systems.
    --disable_clickDisables mouse clicks.
    -m, --dot_markerUses a dot marker for graphs.
    -f, --fahrenheitSets the temperature type to Fahrenheit.
    -g, --groupGroups processes with the same name by default.
    -h, --helpPrints help information. Use --help for more info.
    -a, --hide_avg_cpuHides the average CPU usage.
    --hide_table_gapHides the spacing between table headers and entries.
    --hide_timeCompletely hides the time scaling.
    -k, --kelvinSets the temperature type to Kelvin.
    -l, --left_legendPuts the CPU chart legend to the left side.
    --mem_as_valueDefaults to showing process memory usage by value.
    --network_use_binary_prefixDisplays the network widget with binary prefixes.
    --network_use_bytesDisplays the network widget using bytes.
    --network_use_logDisplays the network widget with a log scale.
    --process_commandShow processes as their commands by default.
    -r, --rate <MS>Sets a refresh rate in ms.
    -R, --regexEnables regex by default.
    --show_table_scroll_positionShows the scroll position tracker in table widgets.
    -d, --time_delta <MS>The amount in ms changed upon zooming.
    -T, --treeDefaults to showing the process widget in tree mode.
    --use_old_network_legendDEPRECATED - uses the older network legend.
    -V, --versionPrints version information.
    -W, --whole_wordEnables whole-word matching by default.
    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/configuration/config-file/data-filtering/index.html b/0.6.2/configuration/config-file/data-filtering/index.html index 1f8fac57..fa7c3cc0 100644 --- a/0.6.2/configuration/config-file/data-filtering/index.html +++ b/0.6.2/configuration/config-file/data-filtering/index.html @@ -1,820 +1,889 @@ - - - - - - - - - - - - - - - - - - - - - Data Filtering - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    -
    + +
    -
  • - - Support - -
    • - - - - - - - - -
  • - - Usage - -
    • - - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - +
  • + + Home + +
    • -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Data Filtering

    -
    -

    Warning

    -

    This section is in progress, and is just copied from the old documentation.

    -
    -

    You can hide specific disks, temperature sensors, and networks by name in the config file via disk_filter and mount_filter, temp_filter, and net_filter respectively. Regex (regex = true), case-sensitivity (case_sensitive = true), and matching only if the entire word matches (whole_word = true) are supported, but are off by default. Filters default to denying entries that match and can be toggled by setting is_list_ignored to false in the config file.

    -

    For example, here's the disk widget with no filter:

    -

    Disk no filter

    -

    The following in the config file would filter out some entries by disk name:

    -
    [disk_filter]
+                  bottom
+                
+
+                
    
+
+                  
+                    
    
+
+                      
+                        
+                      
+                    
    
+                    
    
+                      ClementTsang/bottom
+                    
    
+                      
+                
    
+
+                
+              
+
    +
    +
    + + + +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + + + + +

    Data Filtering

    +
    +

    Warning

    +

    This section is in progress, and is just copied from the old documentation.

    +
    +

    You can hide specific disks, temperature sensors, and networks by name in the config file via + disk_filter and mount_filter, temp_filter, and + net_filter respectively. Regex (regex = true), case-sensitivity + (case_sensitive = true), and matching only if the entire word matches + (whole_word = true) are supported, but are off by default. Filters default to denying entries + that match and can be toggled by setting is_list_ignored to false in the config + file.

    +

    For example, here's the disk widget with no filter:

    +

    Disk 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 widget with just disk name filter

    -

    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]
+
    +
    +

    Disk widget with just disk name filter

    +

    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
@@ -827,35 +896,41 @@
 regex = true
 case_sensitive = false
 whole_word = true
-
    -

    This gives us:

    -

    Disk widget with disk name and mount filter

    - - - - +     +
    +

    This gives us:

    +

    Disk widget with disk name and mount filter

    - - -
    + + + + + + - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/configuration/config-file/default-config/index.html b/0.6.2/configuration/config-file/default-config/index.html index c4fb2a98..e8c5fd9a 100644 --- a/0.6.2/configuration/config-file/default-config/index.html +++ b/0.6.2/configuration/config-file/default-config/index.html @@ -1,852 +1,918 @@ - - - - - - - - - - - - - - - - - - - - - Default Config - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Default Config

    -

    A default config file is automatically generated at the following locations that bottom checks by default:

    - - - - - - - - - - - - - - - - - - - - - -
    OSDefault Config Location
    macOS$HOME/Library/Application Support/bottom/bottom.toml
    ~/.config/bottom/bottom.toml
    $XDG_CONFIG_HOME/bottom/bottom.toml
    Linux~/.config/bottom/bottom.toml
    $XDG_CONFIG_HOME/bottom/bottom.toml
    WindowsC:\Users\<USER>\AppData\Roaming\bottom\bottom.toml
    -

    Furthermore, if a custom config path that does not exist is given (using -C or --config), bottom will attempt to create a default config file at that location.

    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/configuration/config-file/flags/index.html b/0.6.2/configuration/config-file/flags/index.html index 0b66df94..c6454c7e 100644 --- a/0.6.2/configuration/config-file/flags/index.html +++ b/0.6.2/configuration/config-file/flags/index.html @@ -1,979 +1,1042 @@ - - - - - - - - - - - - - - - - - - - - - Flags - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Flags

    -
    -

    Warning

    -

    This section is in progress, and is just copied from the old documentation.

    -
    -

    Most of the command line flags have config file equivalents to avoid having to type them out each time:

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeFunctionality
    hide_avg_cpuBooleanHides the average CPU usage.
    dot_markerBooleanUses a dot marker for graphs.
    left_legendBooleanPuts the CPU chart legend to the left side.
    current_usageBooleanSets process CPU% to be based on current CPU%.
    group_processesBooleanGroups processes with the same name by default.
    case_sensitiveBooleanEnables case sensitivity by default.
    whole_wordBooleanEnables whole-word matching by default.
    regexBooleanEnables regex by default.
    basicBooleanHides graphs and uses a more basic look.
    use_old_network_legendBooleanDEPRECATED - uses the older network legend.
    batteryBooleanShows the battery widget.
    rateUnsigned Int (represents milliseconds)Sets a refresh rate in ms.
    default_time_valueUnsigned Int (represents milliseconds)Default time value for graphs in ms.
    time_deltaUnsigned Int (represents milliseconds)The amount in ms changed upon zooming.
    temperature_typeString (one of ["k", "f", "c", "kelvin", "fahrenheit", "celsius"])Sets the temperature unit type.
    default_widget_typeString (one of ["cpu", "proc", "net", "temp", "mem", "disk"], same as layout options)Sets the default widget type, use --help for more info.
    default_widget_countUnsigned Int (represents which default_widget_type)Sets the n'th selected widget type as the default.
    disable_clickBooleanDisables mouse clicks.
    colorString (one of ["default", "default-light", "gruvbox", "gruvbox-light", "nord", "nord-light"])Use a color scheme, use --help for supported values.
    mem_as_valueBooleanDefaults to showing process memory usage by value.
    treeBooleanDefaults to showing the process widget in tree mode.
    show_table_scroll_positionBooleanShows the scroll position tracker in table widgets.
    process_commandBooleanShow processes as their commands by default.
    disable_advanced_killBooleanHides advanced options to stop a process on Unix-like systems.
    network_use_binary_prefixBooleanDisplays the network widget with binary prefixes.
    network_use_bytesBooleanDisplays the network widget using bytes.
    network_use_logBooleanDisplays the network widget with a log scale.
    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/configuration/config-file/layout/index.html b/0.6.2/configuration/config-file/layout/index.html index d309330c..205e764d 100644 --- a/0.6.2/configuration/config-file/layout/index.html +++ b/0.6.2/configuration/config-file/layout/index.html @@ -1,809 +1,867 @@ - - - - - - - - - - - - - - - - - - - - - Layout - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    -
    + +
    -
  • - - Support - -
    • - - - - - - - - -
  • - - Usage - -
    • - - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - +
  • + + Home + +
    • -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Layout

    -
    -

    Warning

    -

    This section is in progress, and is just copied from the old documentation.

    -
    -

    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]]
+                  bottom
+                
+
+                
    
+
+                  
+                    
    
+
+                      
+                        
+                      
+                    
    
+                    
    
+                      ClementTsang/bottom
+                    
    
+                      
+                
    
+
+                
+              
+
    +
    +
    + + + +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + + + + +

    Layout

    +
    +

    Warning

    +

    This section is in progress, and is just copied from the old documentation.

    +
    +

    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]]
@@ -817,87 +875,99 @@
         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. -The second column is split into two rows with a 1:1 ratio. The first is the temperature widget, the second is the disk widget.

    -

    This is what the layout would look like when run:

    -

    Sample layout

    -

    Each [[row]] represents a row in the layout. A row can have any number of child values. Each [[row.child]] -represents either a column or a widget. A column can have any number of child values as well. Each [[row.child.child]] -represents a widget. A widget is represented by having a type field set to a string.

    -

    The following type values are supported:

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    "cpu"CPU chart and legend
    "mem", "memory"Memory chart
    "net", "network"Network chart and legend
    "proc", "process", "processes"Process table and search
    "temp", "temperature"Temperature table
    "disk"Disk table
    "empty"An empty space
    "batt", "battery"Battery statistics
    -

    Each component of the layout accepts a ratio value. If this is not set, it defaults to 1.

    -

    Furthermore, you can have duplicate widgets.

    -

    For an example, look at the default config, which contains the default layout.

    - - - - +     +
    +

    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. + The second column is split into two rows with a 1:1 ratio. The first is the temperature widget, the second + is the disk widget.

    +

    This is what the layout would look like when run:

    +

    Sample layout

    +

    Each [[row]] represents a row in the layout. A row can have any number of + child values. Each [[row.child]] + represents either a column or a widget. A column can have any number of child values + as well. Each [[row.child.child]] + represents a widget. A widget is represented by having a type field set to a string. +

    +

    The following type values are supported:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    "cpu"CPU chart and legend
    "mem", "memory"Memory chart
    "net", "network"Network chart and legend
    "proc", "process", "processes"Process table and search
    "temp", "temperature"Temperature table
    "disk"Disk table
    "empty"An empty space
    "batt", "battery"Battery statistics
    +

    Each component of the layout accepts a ratio value. If this is not set, it defaults to 1. +

    +

    Furthermore, you can have duplicate widgets.

    +

    For an example, look at the default + config, which contains the default layout.

    - - -
    + + + + + + - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/configuration/config-file/theming/index.html b/0.6.2/configuration/config-file/theming/index.html index d5c286fe..62d9d007 100644 --- a/0.6.2/configuration/config-file/theming/index.html +++ b/0.6.2/configuration/config-file/theming/index.html @@ -1,940 +1,1004 @@ - - - - - - - - - - - - - - - - - - - - - Theming - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Theming

    -
    -

    Warning

    -

    This section is in progress, and is just copied from the old documentation.

    -
    -

    The config file can be used to set custom colours for parts of the application under the [colors] object. The following labels are customizable with strings that are hex colours, RGB colours, or specific named colours.

    -

    Supported named colours are one of the following strings: Reset, Black, Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed, LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    LabelsDetailsExample
    Table header coloursColour of table headerstable_header_color="255, 255, 255"
    CPU colour per coreColour of each core. Read in order.cpu_core_colors=["#ffffff", "white", "255, 255, 255"]
    Average CPU colourThe average CPU coloravg_cpu_color="White"
    All CPUs colourThe colour for the "All" CPU labelall_cpu_color="White"
    RAMThe colour RAM will useram_color="#ffffff"
    SWAPThe colour SWAP will useswap_color="#ffffff"
    RXThe colour rx will userx_color="#ffffff"
    TXThe colour tx will usetx_color="#ffffff"
    Widget title colourThe colour of the label each widget haswidget_title_color="#ffffff"
    Border colourThe colour of the border of unselected widgetsborder_color="#ffffff"
    Selected border colourThe colour of the border of selected widgetshighlighted_border_color="#ffffff"
    Text colourThe colour of most texttext_color="#ffffff"
    Graph colourThe colour of the lines and text of the graphgraph_color="#ffffff"
    Cursor colourThe cursor's colourcursor_color="#ffffff"
    Selected text colourThe colour of text that is selectedscroll_entry_text_color="#ffffff"
    Selected text background colourThe background colour of text that is selectedscroll_entry_bg_color="#ffffff"
    High battery level colourThe colour used for a high battery level (100% to 50%)high_battery_color="green"
    Medium battery level colourThe colour used for a medium battery level (50% to 10%)medium_battery_color="yellow"
    Low battery level colourThe colour used for a low battery level (10% to 0%)low_battery_color="red"
    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/contribution/development/index.html b/0.6.2/contribution/development/index.html index 165cd130..e419a1e3 100644 --- a/0.6.2/contribution/development/index.html +++ b/0.6.2/contribution/development/index.html @@ -1,906 +1,967 @@ - - - - - - - - - - - - - - - - - - - - - Development - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    - + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/contribution/documentation/index.html b/0.6.2/contribution/documentation/index.html index 0f79d57b..b64da872 100644 --- a/0.6.2/contribution/documentation/index.html +++ b/0.6.2/contribution/documentation/index.html @@ -1,936 +1,1019 @@ - - - - - - - - - - - - - - - - - - - - - Documentation - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Documentation

    -

    When should documentation changes be done?

    -
      -
    • Whenever a new feature is added, a bug is fixed, or a breaking change is made, it should be documented where appropriate (ex: README.md, changelog, etc.)
      • -
    • New methods of installation are always appreciated and should be documented
      • -
    -

    What pages need documentation?

    -

    There are a few areas where documentation changes are often needed:

    - -

    How should I add documentation?

    -
      -
    1. -

      Fork the repository first and make changes there.

      -
      2. -
    2. -

      Where you're adding documentation will probably affect what you need to do:

      - -
        -
      • For changes to the help menu, try to refer to the existing code within src/constants.rs on how the help menu is generated.
        • -
      -
        -
      • -

        For changes to the extended documentation, you'll want MkDocs, Material for MkDocs, and mdx_truly_sane_lists installed to provide live reloading and preview for your changes. You can do so through pip or your system's package managers. While you don't need these, it'll probably help in making and validating changes.

        -

        You may also want Mike, but it isn't really needed.

        -
        • -
      -
      3. -
    3. -

      Once you have your documentation changes done, submit it as a pull request. For more information regarding that, refer to Issues and Pull Requests.

      -
      4. -
    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/contribution/issues-and-pull-requests/index.html b/0.6.2/contribution/issues-and-pull-requests/index.html index 826f81b2..fcb65bd2 100644 --- a/0.6.2/contribution/issues-and-pull-requests/index.html +++ b/0.6.2/contribution/issues-and-pull-requests/index.html @@ -1,942 +1,1017 @@ - - - - - - - - - - - - - - - - - - - - - Issues and Pull Requests - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - -
    -
    -
    - - - -
    -
    -
    - -
    - - - -
  • - - Pull requests - - -
    • - - - - -
    -
    -
    - - -
    -
    - - - - + + +
    +
    + + + +
    +
    +
    + + + + + +
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/contribution/packaging-and-distribution/index.html b/0.6.2/contribution/packaging-and-distribution/index.html index 7f01501b..fab2042e 100644 --- a/0.6.2/contribution/packaging-and-distribution/index.html +++ b/0.6.2/contribution/packaging-and-distribution/index.html @@ -1,921 +1,1005 @@ - - - - - - - - - - - - - - - - - - - - - Packaging and Distribution - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Packaging and Distribution

    -

    Package maintainers are always welcome and appreciated! Here's some info on how one can help with package distribution and bottom.

    -

    Pre-built binaries

    -

    The latest stable release can be found here, where you can find pre-built binaries in either a tar.gz or zip format. -Binaries here also include automatically generated shell completion files for zsh, bash, fish, and Powershell, which you may want to also install during the packaging -process.

    -

    You can also find a nightly build in the releases page, built every day at 00:00 UTC off of the master branch.

    -

    Building manually

    -

    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
-
    -

    You'll then want to build with:

    -
    cargo build --release --locked
-
    -

    Completion files are automatically generated during this process, and are located in the directory target/release/build/bottom-<gibberish>/out. Note there may be multiple folders that look like target/release/build/bottom-<gibberish>. To programmatically determine which is the right folder, you might want to use something like:

    -
    $(ls target/release/build/bottom-*/out/btm.bash | head -n1 | xargs dirname)
-
    -

    You may find the Arch package install script template useful as a reference.

    -

    Adding an installation source

    -

    Once you've finished your installation source, if you want to mention it in the main bottom repo, fork the repo and add the installation method and any details to -the README.md file under the Installation section. -Once that's done, open a pull request - these will usually be approved of very quickly.

    -

    You can find more info on the contribution process here.

    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/index.html b/0.6.2/index.html index 1177ffe1..28a425f8 100644 --- a/0.6.2/index.html +++ b/0.6.2/index.html @@ -1,902 +1,966 @@ - - - - - - - - - - - - - - - - - - - - - Home - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - +
  • + + Home + +
    • -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    bottom

    -

    This site serves as documentation for bottom, as well as an extension to the README.md.

    -
    -

    Warning

    -

    Some areas of this documentation is still in progress, and should get better in time. Feel free to suggest/contribute changes!

    -
    -

    Installation

    -
    -

    Tip

    -

    It's probably a good idea to first check out the Support page to see if your system is officially supported!

    -
    -
    -

    Tip

    -

    If you're facing some issues during/after installation, check the Troubleshooting page for some common problems and solutions.

    -
    -

    To install bottom, refer to the installation section of the README.md, -which contains a list of all the installation methods.

    -

    Contribution

    -

    New contributors are always welcome! See the contribution section for how to help contribute to -bottom, whether it be filing issues or creating pull requests.

    - - - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + + + +
  • + + + + + + + + + + + Home + + + + + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/support/index.html b/0.6.2/support/index.html index 72da8452..cf50f482 100644 --- a/0.6.2/support/index.html +++ b/0.6.2/support/index.html @@ -1,1010 +1,1078 @@ - - - - - - - - - - - - - - - - - - - - - Support - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - -
    -
    - - - -
    -
    -
    - -
    - - - - - - - - -
  • - - Unofficial support - - - - -
    • - - - - -
    -
    -
    - - -
    -
    - - - - + + +
    +
    + + + +
    +
    +
    + + + + + +
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + + + +
  • + + + + + + + + + + + Support + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/troubleshooting/index.html b/0.6.2/troubleshooting/index.html index 0573db1e..3eaafce1 100644 --- a/0.6.2/troubleshooting/index.html +++ b/0.6.2/troubleshooting/index.html @@ -1,1005 +1,1097 @@ - - - - - - - - - - - - - - - - - - - - - Troubleshooting - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - + + +
    +
    + + + +
    +
    +
    + + + + + +
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + +
  • + + + + + + + + + + + Troubleshooting + + + + + +
    • + + + + + +
    - - - - - - - - -
    - - + +
    +
    +
    + + Made with + + Material for MkDocs + + +
    + +
    - - +
    + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/usage/basic-mode/index.html b/0.6.2/usage/basic-mode/index.html index d2995032..d3f1b940 100644 --- a/0.6.2/usage/basic-mode/index.html +++ b/0.6.2/usage/basic-mode/index.html @@ -1,908 +1,979 @@ - - - - - - - - - - - - - - - - - - - - - Basic Mode - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    -
    + +
    -
  • - - Support - -
    • - - - - - - - - - - -
  • - - Usage - -
    • - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - +
  • + + Home + +
    • -
    + - - - - - - - -
  • - - - - - - - - - - - Basic Mode - - - - - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Basic Mode

    -

    Basic mode is a special layout that removes all of the graphs and provides an interface that resembles (a very stripped-down version of) htop.

    -
    - A picture of bottom's basic mode. -
    + bottom + -

    Basic mode can be enabled either through a command line flag:

    -
    btm -b
+                
    
+
+                  
+                    
    
+
+                      
+                        
+                      
+                    
    
+                    
    
+                      ClementTsang/bottom
+                    
    
+                      
+                
    
+
+                
+              
+
    +
    +
    + + + +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + + + + +

    Basic Mode

    +

    Basic mode is a special layout that removes all of the graphs and provides an interface that resembles (a + very stripped-down version of) htop.

    +
    + A picture of bottom's basic mode. +
    + +

    Basic mode can be enabled either through a command line flag:

    +
    + 
    btm -b
 
 # or
 
 btm --basic
-
    -

    or through the config:

    -
    [flags]
+
    +
    +

    or through the config:

    +
    + 
    [flags]
 basic = true
-
    -

    Notes

    -

    In this mode, widgets that use tables (temperatures, processes, disks, and batteries) are only shown one at a time. -One can switch between these widgets either by clicking the arrow buttons or by using the general widget selection shortcuts (for example, Ctrl+Left or H) -to switch which widget is shown.

    -

    Also note that in this mode, widget expansion and custom layouts are disabled.

    -

    Key bindings

    -

    Basic mode follows the same key bindings as normal, barring widget expansion being disabled, and that the % key while selecting the memory widget toggles between total usage and percentage.

    - - - - +     +
    +

    Notes

    +

    In this mode, widgets that use tables (temperatures, processes, disks, and batteries) are only shown one + at a time. + One can switch between these widgets either by clicking the arrow buttons or by using the general widget + selection shortcuts (for example, Ctrl+Left or H) + to switch which widget is shown.

    +

    Also note that in this mode, widget expansion and custom layouts are disabled.

    +

    Key bindings

    +

    Basic mode follows the same key bindings as normal, barring widget expansion being disabled, and that the + % key while selecting the memory widget toggles between total usage + and percentage.

    - - -
    + + + + + + - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/usage/general-usage/index.html b/0.6.2/usage/general-usage/index.html index 5ef9a423..d20bdc06 100644 --- a/0.6.2/usage/general-usage/index.html +++ b/0.6.2/usage/general-usage/index.html @@ -1,1050 +1,1149 @@ - - - - - - - - - - - - - - - - - - - - - General Usage - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    -
    - - - - - - -
  • - - - - - - -
    • - - - - - - - - - - - -
  • - - - - - - -
    • - - - - - - - - - - - -
  • - - - - - - -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - - - - - - - -
    -
    -
    - -
    - - - -
  • - - Key bindings - - -
    • - -
  • - - Mouse bindings - - -
    • - - - - -
    -
    - - - -
    -
    - - - - + + +
    +
    + + + +
    +
    +
    + + + + + + +
    +
    +
    + + + +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + + + + +

    General Usage

    +

    You can run bottom with:

    +
    + 
    btm
+
    +
    +

    For help regarding the command-line flags, use:

    +
    + 
    # For a simple overview of flags
 btm -h
 
 # For more details
 btm --help
-
    -

    Features

    -

    Expansion

    -

    By default, bottom is somewhat like a dashboard - a bunch of different widgets, all showing different things, and they all cram together to fit into one terminal.

    -

    If you instead just want to see one widget - maybe you want to look at a graph in more detail, for example - you can "expand" the currently selected -widget using the e key, which will hide all other widgets and make that widget take up all available terminal space.

    -

    You can leave this state by either pressing e again or pressing Esc.

    -

    Widget selection

    -

    To allow for widget-specific keybindings and expansion, there is the idea of widget selection in bottom, where you can focus on a specific widget to work with it. -This can be done with the mouse (just click on the widget of interest) or keyboard (ex: Ctrl+Direction, see Key bindings for alternatives).

    -

    Key bindings

    -

    These are global or common keyboard shortcuts for the application, which you can see in-app through the ? shortcut. -Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    q , Ctrl+cQuit
    EscClose dialog windows, search, widgets, or exit expanded mode
    Ctrl+rReset display and any collected data
    fFreeze/unfreeze updating with new data
    ?Open help menu
    eToggle expanding the currently selected widget
    Ctrl+Up
    Shift+Up
    K
    W    		Select the widget above
    Ctrl+Down
    Shift+Down
    J
    S    		Select the widget below
    Ctrl+Left
    Shift+Left
    H
    A    		Select the widget on the left
    Ctrl+Right
    Shift+Right
    L
    D    		Select the widget on the right
    Up , kMove up within a widget
    Down , jMove down within a widget
    Left
    h
    Alt+h    		Move left within a widget
    Right
    l
    Alt+l    		Move right within a widget
    g+g , HomeJump to the first entry
    G , EndJump to the last entry
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    Left ButtonSelects the widget
    - - - - +     +
    +

    Features

    +

    Expansion

    +

    By default, bottom is somewhat like a dashboard - a bunch of different widgets, all showing different + things, and they all cram together to fit into one terminal.

    +

    If you instead just want to see one widget - maybe you want to look at a graph in more detail, + for example - you can "expand" the currently selected + widget using the e key, which will hide all other + widgets and make that widget take up all available terminal space.

    +

    You can leave this state by either pressing e again or + pressing Esc.

    +

    Widget selection

    +

    To allow for widget-specific keybindings and expansion, there is the idea of widget selection in + bottom, where you can focus on a specific widget to work with it. + This can be done with the mouse (just click on the widget of interest) or keyboard (ex: Ctrl+Direction, see Key bindings for alternatives).

    +

    Key bindings

    +

    These are global or common keyboard shortcuts for the application, which you can see in-app through the + ? shortcut. + Note that key bindings are generally case-sensitive.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    BindingAction
    q , Ctrl+cQuit
    EscClose dialog windows, search, widgets, or exit expanded mode
    Ctrl+rReset display and any collected data
    fFreeze/unfreeze updating with new data
    ?Open help menu
    eToggle expanding the currently selected widget
    Ctrl+Up
    Shift+Up
    + K
    W    		Select the widget above
    Ctrl+Down
    Shift+Down
    + J
    S    		Select the widget below
    Ctrl+Left
    Shift+Left
    + H
    A    		Select the widget on the left
    Ctrl+Right
    Shift+Right +
    L
    D    		Select the widget on the right
    Up , kMove up within a widget
    Down , jMove down within a widget
    Left
    h
    Alt+h    		Move left within a widget
    Right
    l
    Alt+l    		Move right within a widget
    g+g , + HomeJump to the first entry
    G , EndJump to the last entry
    +

    Mouse bindings

    + + + + + + + + + + + + + +
    BindingAction
    Left ButtonSelects the widget
    - -
    -
    + + + + + + - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/usage/widgets/battery/index.html b/0.6.2/usage/widgets/battery/index.html index 5e3199fa..7b8820a2 100644 --- a/0.6.2/usage/widgets/battery/index.html +++ b/0.6.2/usage/widgets/battery/index.html @@ -1,951 +1,1018 @@ - - - - - - - - - - - - - - - - - - - - - Battery Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Battery Widget

    -

    The battery widget provides information about batteries on the system.

    -
    - A picture of an expanded battery widget. -
    + bottom + -

    The battery widget can be enabled through either the --battery flag, the battery = true option in a config file, or specifying the widget in a custom layout.

    -

    Features

    -

    The following data is displayed for batteries:

    -
      -
    • Charge percent
      • -
    • Consumption
      • -
    • Time to empty/charge, based on the current state
      • -
    • Battery health percent
      • -
    -

    The battery widget also supports devices with multiple batteries, and you can switch between them using the keyboard or the mouse.

    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - -
    BindingAction
    Left
    h
    Alt+h    		Moves to the battery entry to the left of the current one
    Right
    l
    Alt+l    		Moves to the battery entry to the right of the current one
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    Left ButtonSelects a battery entry
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/usage/widgets/cpu/index.html b/0.6.2/usage/widgets/cpu/index.html index 529eeec2..fb4c03fd 100644 --- a/0.6.2/usage/widgets/cpu/index.html +++ b/0.6.2/usage/widgets/cpu/index.html @@ -1,1082 +1,1152 @@ - - - - - - - - - - - - - - - - - - - - - CPU Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    CPU Widget

    -

    The CPU widget displays a visual representation of CPU usage over a time range.

    -
    - A picture of an expanded CPU widget showing average CPU usage. -
    + bottom + -

    Features

    -

    The CPU widget is composed of two parts: the graph and the legend:

    -
      -
    • The graph displays the usage data for the currently selected entry as a percentage
      • -
    • The legend displays all available entries that can be displayed on the graph along with their last recorded use percentage (except for the "All" option)
      • -
    -

    Users can scroll through the legend using either the keyboard or mouse to select which entry to display on the graph. The "All" option shows every entry -at the same time, though this may get a bit hard to follow if you have a large number of cores/threads.

    -

    One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    -

    Graph

    - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    +Zoom in on chart (decrease time range)
    -Zoom out on chart (increase time range)
    =Reset zoom
    -

    Legend

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    Up , kMove up within a widget
    Down , jMove down within a widget
    g+g , HomeJump to the first entry in the legend
    G , EndJump to the last entry in the legend
    -

    Mouse bindings

    -

    Graph

    - - - - - - - - - - - - - -
    BindingAction
    ScrollScrolling up or down zooms in or out of the graph respectively
    -

    Legend

    - - - - - - - - - - - - - - - - - -
    BindingAction
    ScrollScroll through options to display in the graph
    Left ButtonSelects a CPU thread/average to show in the graph
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/usage/widgets/disk/index.html b/0.6.2/usage/widgets/disk/index.html index de1bce5f..bbb6ced3 100644 --- a/0.6.2/usage/widgets/disk/index.html +++ b/0.6.2/usage/widgets/disk/index.html @@ -1,960 +1,1026 @@ - - - - - - - - - - - - - - - - - - - - - Disk Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Disk Widget

    -

    The disk widget provides a table of useful disk and partition information, like I/O per second and total usage.

    -
    - A picture of an expanded disk widget. -
    + bottom + -

    Features

    -

    The disk widget provides the following information:

    -
      -
    • Disk name
      • -
    • Disk mount location
      • -
    • Percentage of space used
      • -
    • Amount of space left
      • -
    • Total amount of space
      • -
    • Read per second
      • -
    • Write per second
      • -
    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    Up , kMove up within a widget
    Down , jMove down within a widget
    g+g , HomeJump to the first entry in the table
    G , EndJump to the last entry in the table
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    Left ButtonSelects an entry in the table
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/usage/widgets/memory/index.html b/0.6.2/usage/widgets/memory/index.html index def1de5f..a62d34a9 100644 --- a/0.6.2/usage/widgets/memory/index.html +++ b/0.6.2/usage/widgets/memory/index.html @@ -1,949 +1,1010 @@ - - - - - - - - - - - - - - - - - - - - - Memory Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Memory Widget

    -

    The memory widget provides a visual representation of RAM and swap usage over time.

    -
    - A picture of an expanded memory widget. -
    + bottom + -

    Features

    -

    The legend displays the current usage in terms of percentage and actual usage. -If the total RAM or swap available is 0, then it is automatically hidden from the legend and graph.

    -

    One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    +Zoom in on chart (decrease time range)
    -Zoom out on chart (increase time range)
    =Reset zoom
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    ScrollScrolling up or down zooms in or out of the graph respectively
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/usage/widgets/network/index.html b/0.6.2/usage/widgets/network/index.html index adb851f7..4386e3d0 100644 --- a/0.6.2/usage/widgets/network/index.html +++ b/0.6.2/usage/widgets/network/index.html @@ -1,952 +1,1019 @@ - - - - - - - - - - - - - - - - - - - - - Network Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Network Widget

    -

    The network widget provides a visual representation of network input and output per second, as well as noting the total amount -received and transmitted.

    -
    - A picture of an expanded network widget. -
    + bottom + -

    Features

    -

    The legend displays the current reads and writes per second in bits, as well as the total amount read/written.

    -

    The y-axis automatically scales based on shown read/write values, and by default, is a linear scale based on base-10 units (e.x. kilobit, gigabit, etc.). -Through configuration, the read/write per second unit can be changed to bytes, while the y-axis can be changed to a -log scale and/or use base-2 units (e.x. kibibit, gibibit, etc.).

    -

    One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    +Zoom in on chart (decrease time range)
    -Zoom out on chart (increase time range)
    =Reset zoom
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    ScrollScrolling up or down zooms in or out of the graph respectively
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/usage/widgets/process/index.html b/0.6.2/usage/widgets/process/index.html index d146aa4f..3d9233c0 100644 --- a/0.6.2/usage/widgets/process/index.html +++ b/0.6.2/usage/widgets/process/index.html @@ -1,1616 +1,1736 @@ - - - - - - - - - - - - - - - - - - - - - Process Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - -
    -
    -
    - - - -
    -
    -
    - -
    - - - - - - - - -
  • - - Key bindings - - - - -
    • - -
  • - - Mouse bindings - - - - -
    • - - - - -
    -
    -
    - - -
    -
    - - - - + + +
    +
    + + + +
    +
    +
    + + + + + +
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - - + +
    +
    +
    + + Made with + + Material for MkDocs + + +
    + +
    - - +
    + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.2/usage/widgets/temperature/index.html b/0.6.2/usage/widgets/temperature/index.html index 87efc7e6..d6b29af8 100644 --- a/0.6.2/usage/widgets/temperature/index.html +++ b/0.6.2/usage/widgets/temperature/index.html @@ -1,951 +1,1016 @@ - - - - - - - - - - - - - - - - - - - - - Temperature Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Temperature Widget

    -

    The temperature widget provides a table of temperature sensors and their current temperature.

    -
    - A picture of an expanded temperature widget. -
    + bottom + -

    Features

    -

    The temperature widget provides the sensor name as well as its current temperature.

    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    Up , kMove up within a widget
    Down , jMove down within a widget
    g+g , HomeJump to the first entry in the table
    G , EndJump to the last entry in the table
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    Left ButtonSelects an entry in the table
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/404.html b/0.6.3/404.html index 2381f140..f7b7c6a9 100644 --- a/0.6.3/404.html +++ b/0.6.3/404.html @@ -1,795 +1,852 @@ - - - - - - - - - - - - - - - - - - - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + - - - - - - - - - - - - - - - - - - - - - - -
    - -
    -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - - -
    +
    - - - - -
    -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/configuration/command-line-flags/index.html b/0.6.3/configuration/command-line-flags/index.html index 4d9e47b8..28868405 100644 --- a/0.6.3/configuration/command-line-flags/index.html +++ b/0.6.3/configuration/command-line-flags/index.html @@ -1,981 +1,1043 @@ - - - - - - - - - - - - - - - - - - - - - Command-line Flags - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Command-line Flags

    -
    -

    Warning

    -

    This section is in progress, and is just copied from the old documentation.

    -
    -

    The following flags can be provided to bottom in the command line to change the behaviour of the program (run btm --help for more information on each flag):

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FlagBehaviour
    --autohide_timeTemporarily shows the time scale in graphs.
    -b, --basicHides graphs and uses a more basic look.
    --batteryShows the battery widget.
    -S, --case_sensitiveEnables case sensitivity by default.
    -c, --celsiusSets the temperature type to Celsius.
    --color <COLOR SCHEME>Use a color scheme, use --help for supported values.
    -C, --config <CONFIG PATH>Sets the location of the config file.
    -u, --current_usageSets process CPU% to be based on current CPU%.
    -t, --default_time_value <MS>Default time value for graphs in ms.
    --default_widget_count <INT>Sets the n'th selected widget type as the default.
    --default_widget_type <WIDGET TYPE>Sets the default widget type, use --help for more info.
    --disable_advanced_killHides advanced options to stop a process on Unix-like systems.
    --disable_clickDisables mouse clicks.
    -m, --dot_markerUses a dot marker for graphs.
    -f, --fahrenheitSets the temperature type to Fahrenheit.
    -g, --groupGroups processes with the same name by default.
    -h, --helpPrints help information. Use --help for more info.
    -a, --hide_avg_cpuHides the average CPU usage.
    --hide_table_gapHides the spacing between table headers and entries.
    --hide_timeHides the time scale.
    -k, --kelvinSets the temperature type to Kelvin.
    -l, --left_legendPuts the CPU chart legend to the left side.
    --mem_as_valueDefaults to showing process memory usage by value.
    --network_use_binary_prefixDisplays the network widget with binary prefixes.
    --network_use_bytesDisplays the network widget using bytes.
    --network_use_logDisplays the network widget with a log scale.
    --process_commandShow processes as their commands by default.
    -r, --rate <MS>Sets a refresh rate in ms.
    -R, --regexEnables regex by default.
    --show_table_scroll_positionShows the scroll position tracker in table widgets.
    -d, --time_delta <MS>The amount in ms changed upon zooming.
    -T, --treeDefaults to showing the process widget in tree mode.
    --use_old_network_legendDEPRECATED - uses the older network legend.
    -V, --versionPrints version information.
    -W, --whole_wordEnables whole-word matching by default.
    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/configuration/config-file/data-filtering/index.html b/0.6.3/configuration/config-file/data-filtering/index.html index b2ff5d9f..70486e85 100644 --- a/0.6.3/configuration/config-file/data-filtering/index.html +++ b/0.6.3/configuration/config-file/data-filtering/index.html @@ -1,820 +1,890 @@ - - - - - - - - - - - - - - - - - - - - - Data Filtering - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    -
    + +
    -
  • - - Support - -
    • - - - - - - - - -
  • - - Usage - -
    • - - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - +
  • + + Home + +
    • -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Data Filtering

    -
    -

    Warning

    -

    This section is in progress, and is just copied from the old documentation.

    -
    -

    You can hide specific disks, temperature sensors, and networks by name in the config file via disk_filter and mount_filter, temp_filter, and net_filter respectively. Regex (regex = true), case-sensitivity (case_sensitive = true), and matching only if the entire word matches (whole_word = true) are supported, but are off by default. Filters default to denying entries that match and can be toggled by setting is_list_ignored to false in the config file.

    -

    For example, here's the disk widget with no filter:

    -

    Disk no filter

    -

    The following in the config file would filter out some entries by disk name:

    -
    [disk_filter]
+                  bottom
+                
+
+                
    
+
+                  
+                    
    
+
+                      
+                        
+                      
+                    
    
+                    
    
+                      ClementTsang/bottom
+                    
    
+                      
+                
    
+
+                
+              
+
    +
    +
    + + + +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + + + + +

    Data Filtering

    +
    +

    Warning

    +

    This section is in progress, and is just copied from the old documentation.

    +
    +

    You can hide specific disks, temperature sensors, and networks by name in the config file via + disk_filter and mount_filter, temp_filter, and + net_filter respectively. Regex (regex = true), case-sensitivity + (case_sensitive = true), and matching only if the entire word matches + (whole_word = true) are supported, but are off by default. Filters default to denying entries + that match and can be toggled by setting is_list_ignored to false in the config + file.

    +

    For example, here's the disk widget with no filter:

    +

    Disk 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 widget with just disk name filter

    -

    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]
+
    +
    +

    Disk widget with just disk name filter

    +

    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
@@ -827,35 +897,41 @@
 regex = true
 case_sensitive = false
 whole_word = true
-
    -

    This gives us:

    -

    Disk widget with disk name and mount filter

    - - - - +     +
    +

    This gives us:

    +

    Disk widget with disk name and mount filter

    - - -
    + + + + + + - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/configuration/config-file/default-config/index.html b/0.6.3/configuration/config-file/default-config/index.html index 381543b7..96b280b8 100644 --- a/0.6.3/configuration/config-file/default-config/index.html +++ b/0.6.3/configuration/config-file/default-config/index.html @@ -1,852 +1,918 @@ - - - - - - - - - - - - - - - - - - - - - Default Config - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Default Config

    -

    A default config file is automatically generated at the following locations that bottom checks by default:

    - - - - - - - - - - - - - - - - - - - - - -
    OSDefault Config Location
    macOS$HOME/Library/Application Support/bottom/bottom.toml
    ~/.config/bottom/bottom.toml
    $XDG_CONFIG_HOME/bottom/bottom.toml
    Linux~/.config/bottom/bottom.toml
    $XDG_CONFIG_HOME/bottom/bottom.toml
    WindowsC:\Users\<USER>\AppData\Roaming\bottom\bottom.toml
    -

    Furthermore, if a custom config path that does not exist is given (using -C or --config), bottom will attempt to create a default config file at that location.

    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/configuration/config-file/flags/index.html b/0.6.3/configuration/config-file/flags/index.html index a8851d06..86a3b2e0 100644 --- a/0.6.3/configuration/config-file/flags/index.html +++ b/0.6.3/configuration/config-file/flags/index.html @@ -1,984 +1,1047 @@ - - - - - - - - - - - - - - - - - - - - - Flags - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Flags

    -
    -

    Warning

    -

    This section is in progress, and is just copied from the old documentation.

    -
    -

    Most of the command line flags have config file equivalents to avoid having to type them out each time:

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeFunctionality
    hide_avg_cpuBooleanHides the average CPU usage.
    dot_markerBooleanUses a dot marker for graphs.
    left_legendBooleanPuts the CPU chart legend to the left side.
    current_usageBooleanSets process CPU% to be based on current CPU%.
    group_processesBooleanGroups processes with the same name by default.
    case_sensitiveBooleanEnables case sensitivity by default.
    whole_wordBooleanEnables whole-word matching by default.
    regexBooleanEnables regex by default.
    basicBooleanHides graphs and uses a more basic look.
    use_old_network_legendBooleanDEPRECATED - uses the older network legend.
    batteryBooleanShows the battery widget.
    rateUnsigned Int (represents milliseconds)Sets a refresh rate in ms.
    default_time_valueUnsigned Int (represents milliseconds)Default time value for graphs in ms.
    time_deltaUnsigned Int (represents milliseconds)The amount in ms changed upon zooming.
    hide_timeBooleanHides the time scale.
    temperature_typeString (one of ["k", "f", "c", "kelvin", "fahrenheit", "celsius"])Sets the temperature unit type.
    default_widget_typeString (one of ["cpu", "proc", "net", "temp", "mem", "disk"], same as layout options)Sets the default widget type, use --help for more info.
    default_widget_countUnsigned Int (represents which default_widget_type)Sets the n'th selected widget type as the default.
    disable_clickBooleanDisables mouse clicks.
    colorString (one of ["default", "default-light", "gruvbox", "gruvbox-light", "nord", "nord-light"])Use a color scheme, use --help for supported values.
    mem_as_valueBooleanDefaults to showing process memory usage by value.
    treeBooleanDefaults to showing the process widget in tree mode.
    show_table_scroll_positionBooleanShows the scroll position tracker in table widgets.
    process_commandBooleanShow processes as their commands by default.
    disable_advanced_killBooleanHides advanced options to stop a process on Unix-like systems.
    network_use_binary_prefixBooleanDisplays the network widget with binary prefixes.
    network_use_bytesBooleanDisplays the network widget using bytes.
    network_use_logBooleanDisplays the network widget with a log scale.
    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/configuration/config-file/layout/index.html b/0.6.3/configuration/config-file/layout/index.html index 81988ba7..784af46e 100644 --- a/0.6.3/configuration/config-file/layout/index.html +++ b/0.6.3/configuration/config-file/layout/index.html @@ -1,809 +1,867 @@ - - - - - - - - - - - - - - - - - - - - - Layout - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
    - - - - Skip to content - - -
    -
    - -
    - -
    -
    + +
    -
  • - - Support - -
    • - - - - - - - - -
  • - - Usage - -
    • - - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - +
  • + + Home + +
    • -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Layout

    -
    -

    Warning

    -

    This section is in progress, and is just copied from the old documentation.

    -
    -

    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]]
+                  bottom
+                
+
+                
    
+
+                  
+                    
    
+
+                      
+                        
+                      
+                    
    
+                    
    
+                      ClementTsang/bottom
+                    
    
+                      
+                
    
+
+                
+              
+
    +
    +
    + + + +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + + + + +

    Layout

    +
    +

    Warning

    +

    This section is in progress, and is just copied from the old documentation.

    +
    +

    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]]
@@ -817,87 +875,99 @@
         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. -The second column is split into two rows with a 1:1 ratio. The first is the temperature widget, the second is the disk widget.

    -

    This is what the layout would look like when run:

    -

    Sample layout

    -

    Each [[row]] represents a row in the layout. A row can have any number of child values. Each [[row.child]] -represents either a column or a widget. A column can have any number of child values as well. Each [[row.child.child]] -represents a widget. A widget is represented by having a type field set to a string.

    -

    The following type values are supported:

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    "cpu"CPU chart and legend
    "mem", "memory"Memory chart
    "net", "network"Network chart and legend
    "proc", "process", "processes"Process table and search
    "temp", "temperature"Temperature table
    "disk"Disk table
    "empty"An empty space
    "batt", "battery"Battery statistics
    -

    Each component of the layout accepts a ratio value. If this is not set, it defaults to 1.

    -

    Furthermore, you can have duplicate widgets.

    -

    For an example, look at the default config, which contains the default layout.

    - - - - +     +
    +

    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. + The second column is split into two rows with a 1:1 ratio. The first is the temperature widget, the second + is the disk widget.

    +

    This is what the layout would look like when run:

    +

    Sample layout

    +

    Each [[row]] represents a row in the layout. A row can have any number of + child values. Each [[row.child]] + represents either a column or a widget. A column can have any number of child values + as well. Each [[row.child.child]] + represents a widget. A widget is represented by having a type field set to a string. +

    +

    The following type values are supported:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    "cpu"CPU chart and legend
    "mem", "memory"Memory chart
    "net", "network"Network chart and legend
    "proc", "process", "processes"Process table and search
    "temp", "temperature"Temperature table
    "disk"Disk table
    "empty"An empty space
    "batt", "battery"Battery statistics
    +

    Each component of the layout accepts a ratio value. If this is not set, it defaults to 1. +

    +

    Furthermore, you can have duplicate widgets.

    +

    For an example, look at the default + config, which contains the default layout.

    - - -
    + + + + + + - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/configuration/config-file/theming/index.html b/0.6.3/configuration/config-file/theming/index.html index 0975fd6c..f6f67340 100644 --- a/0.6.3/configuration/config-file/theming/index.html +++ b/0.6.3/configuration/config-file/theming/index.html @@ -1,940 +1,1004 @@ - - - - - - - - - - - - - - - - - - - - - Theming - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Theming

    -
    -

    Warning

    -

    This section is in progress, and is just copied from the old documentation.

    -
    -

    The config file can be used to set custom colours for parts of the application under the [colors] object. The following labels are customizable with strings that are hex colours, RGB colours, or specific named colours.

    -

    Supported named colours are one of the following strings: Reset, Black, Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed, LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    LabelsDetailsExample
    Table header coloursColour of table headerstable_header_color="255, 255, 255"
    CPU colour per coreColour of each core. Read in order.cpu_core_colors=["#ffffff", "white", "255, 255, 255"]
    Average CPU colourThe average CPU coloravg_cpu_color="White"
    All CPUs colourThe colour for the "All" CPU labelall_cpu_color="White"
    RAMThe colour RAM will useram_color="#ffffff"
    SWAPThe colour SWAP will useswap_color="#ffffff"
    RXThe colour rx will userx_color="#ffffff"
    TXThe colour tx will usetx_color="#ffffff"
    Widget title colourThe colour of the label each widget haswidget_title_color="#ffffff"
    Border colourThe colour of the border of unselected widgetsborder_color="#ffffff"
    Selected border colourThe colour of the border of selected widgetshighlighted_border_color="#ffffff"
    Text colourThe colour of most texttext_color="#ffffff"
    Graph colourThe colour of the lines and text of the graphgraph_color="#ffffff"
    Cursor colourThe cursor's colourcursor_color="#ffffff"
    Selected text colourThe colour of text that is selectedscroll_entry_text_color="#ffffff"
    Selected text background colourThe background colour of text that is selectedscroll_entry_bg_color="#ffffff"
    High battery level colourThe colour used for a high battery level (100% to 50%)high_battery_color="green"
    Medium battery level colourThe colour used for a medium battery level (50% to 10%)medium_battery_color="yellow"
    Low battery level colourThe colour used for a low battery level (10% to 0%)low_battery_color="red"
    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/contribution/development/index.html b/0.6.3/contribution/development/index.html index 658c13db..d6eb4e4a 100644 --- a/0.6.3/contribution/development/index.html +++ b/0.6.3/contribution/development/index.html @@ -1,906 +1,967 @@ - - - - - - - - - - - - - - - - - - - - - Development - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    - + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/contribution/documentation/index.html b/0.6.3/contribution/documentation/index.html index dcd9d82f..c8170bd0 100644 --- a/0.6.3/contribution/documentation/index.html +++ b/0.6.3/contribution/documentation/index.html @@ -1,936 +1,1019 @@ - - - - - - - - - - - - - - - - - - - - - Documentation - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Documentation

    -

    When should documentation changes be done?

    -
      -
    • Whenever a new feature is added, a bug is fixed, or a breaking change is made, it should be documented where appropriate (ex: README.md, changelog, etc.)
      • -
    • New methods of installation are always appreciated and should be documented
      • -
    -

    What pages need documentation?

    -

    There are a few areas where documentation changes are often needed:

    - -

    How should I add documentation?

    -
      -
    1. -

      Fork the repository first and make changes there.

      -
      2. -
    2. -

      Where you're adding documentation will probably affect what you need to do:

      - -
        -
      • For changes to the help menu, try to refer to the existing code within src/constants.rs on how the help menu is generated.
        • -
      -
        -
      • -

        For changes to the extended documentation, you'll want MkDocs, Material for MkDocs, and mdx_truly_sane_lists installed to provide live reloading and preview for your changes. You can do so through pip or your system's package managers. While you don't need these, it'll probably help in making and validating changes.

        -

        You may also want Mike, but it isn't really needed.

        -
        • -
      -
      3. -
    3. -

      Once you have your documentation changes done, submit it as a pull request. For more information regarding that, refer to Issues and Pull Requests.

      -
      4. -
    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/contribution/issues-and-pull-requests/index.html b/0.6.3/contribution/issues-and-pull-requests/index.html index b8dea7da..320910bd 100644 --- a/0.6.3/contribution/issues-and-pull-requests/index.html +++ b/0.6.3/contribution/issues-and-pull-requests/index.html @@ -1,942 +1,1017 @@ - - - - - - - - - - - - - - - - - - - - - Issues and Pull Requests - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - -
    -
    -
    - - - -
    -
    -
    - -
    - - - -
  • - - Pull requests - - -
    • - - - - -
    -
    -
    - - -
    -
    - - - - + + +
    +
    + + + +
    +
    +
    + + + + + +
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/contribution/packaging-and-distribution/index.html b/0.6.3/contribution/packaging-and-distribution/index.html index c338d6df..6da6a7c3 100644 --- a/0.6.3/contribution/packaging-and-distribution/index.html +++ b/0.6.3/contribution/packaging-and-distribution/index.html @@ -1,921 +1,1005 @@ - - - - - - - - - - - - - - - - - - - - - Packaging and Distribution - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Packaging and Distribution

    -

    Package maintainers are always welcome and appreciated! Here's some info on how one can help with package distribution and bottom.

    -

    Pre-built binaries

    -

    The latest stable release can be found here, where you can find pre-built binaries in either a tar.gz or zip format. -Binaries here also include automatically generated shell completion files for zsh, bash, fish, and Powershell, which you may want to also install during the packaging -process.

    -

    You can also find a nightly build in the releases page, built every day at 00:00 UTC off of the master branch.

    -

    Building manually

    -

    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
-
    -

    You'll then want to build with:

    -
    cargo build --release --locked
-
    -

    Completion files are automatically generated during this process, and are located in the directory target/release/build/bottom-<gibberish>/out. Note there may be multiple folders that look like target/release/build/bottom-<gibberish>. To programmatically determine which is the right folder, you might want to use something like:

    -
    $(ls target/release/build/bottom-*/out/btm.bash | head -n1 | xargs dirname)
-
    -

    You may find the Arch package install script template useful as a reference.

    -

    Adding an installation source

    -

    Once you've finished your installation source, if you want to mention it in the main bottom repo, fork the repo and add the installation method and any details to -the README.md file under the Installation section. -Once that's done, open a pull request - these will usually be approved of very quickly.

    -

    You can find more info on the contribution process here.

    - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/index.html b/0.6.3/index.html index d3875088..73a9500f 100644 --- a/0.6.3/index.html +++ b/0.6.3/index.html @@ -1,902 +1,966 @@ - - - - - - - - - - - - - - - - - - - - - Home - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - + - - -
    -
    - - - -
    -
    -
    - - - +
  • + + Home + +
    • -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    bottom

    -

    This site serves as documentation for bottom, as well as an extension to the README.md.

    -
    -

    Warning

    -

    Some areas of this documentation are still in progress, and should get better in time. Feel free to suggest/contribute changes!

    -
    -

    Installation

    -
    -

    Tip

    -

    It's probably a good idea to first check out the Support page to see if your system is officially supported!

    -
    -
    -

    Tip

    -

    If you're facing some issues during/after installation, check the Troubleshooting page for some common problems and solutions.

    -
    -

    To install bottom, refer to the installation section of the README.md, -which contains a list of all the installation methods.

    -

    Contribution

    -

    New contributors are always welcome! See the contribution section for how to help contribute to -bottom, whether it be filing issues or creating pull requests.

    - - - - - - + bottom + + +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + + + +
  • + + + + + + + + + + + Home + + + + + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/support/index.html b/0.6.3/support/index.html index ee54c22b..572c7ef0 100644 --- a/0.6.3/support/index.html +++ b/0.6.3/support/index.html @@ -1,1010 +1,1078 @@ - - - - - - - - - - - - - - - - - - - - - Support - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - -
    -
    - - - -
    -
    -
    - -
    - - - - - - - - -
  • - - Unofficial support - - - - -
    • - - - - -
    -
    -
    - - -
    -
    - - - - + + +
    +
    + + + +
    +
    +
    + + + + + +
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + + + +
  • + + + + + + + + + + + Support + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/troubleshooting/index.html b/0.6.3/troubleshooting/index.html index 637eb207..a97fdedf 100644 --- a/0.6.3/troubleshooting/index.html +++ b/0.6.3/troubleshooting/index.html @@ -1,1022 +1,1119 @@ - - - - - - - - - - - - - - - - - - - - - Troubleshooting - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - + + +
    +
    + + + +
    +
    +
    + + + + + +
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + + +
  • + + + + + + + + + + + Troubleshooting + + + + + +
    • + + + + + +
    - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/usage/basic-mode/index.html b/0.6.3/usage/basic-mode/index.html index 126bbab4..05ef8f48 100644 --- a/0.6.3/usage/basic-mode/index.html +++ b/0.6.3/usage/basic-mode/index.html @@ -1,908 +1,979 @@ - - - - - - - - - - - - - - - - - - - - - Basic Mode - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    -
    + +
    -
  • - - Support - -
    • - - - - - - - - - - -
  • - - Usage - -
    • - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - +
  • + + Home + +
    • -
    + - - - - - - - -
  • - - - - - - - - - - - Basic Mode - - - - - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Basic Mode

    -

    Basic mode is a special layout that removes all of the graphs and provides an interface that resembles (a very stripped-down version of) htop.

    -
    - A picture of bottom's basic mode. -
    + bottom + -

    Basic mode can be enabled either through a command line flag:

    -
    btm -b
+                
    
+
+                  
+                    
    
+
+                      
+                        
+                      
+                    
    
+                    
    
+                      ClementTsang/bottom
+                    
    
+                      
+                
    
+
+                
+              
+
    +
    +
    + + + +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + + + + +

    Basic Mode

    +

    Basic mode is a special layout that removes all of the graphs and provides an interface that resembles (a + very stripped-down version of) htop.

    +
    + A picture of bottom's basic mode. +
    + +

    Basic mode can be enabled either through a command line flag:

    +
    + 
    btm -b
 
 # or
 
 btm --basic
-
    -

    or through the config:

    -
    [flags]
+
    +
    +

    or through the config:

    +
    + 
    [flags]
 basic = true
-
    -

    Notes

    -

    In this mode, widgets that use tables (temperatures, processes, disks, and batteries) are only shown one at a time. -One can switch between these widgets either by clicking the arrow buttons or by using the general widget selection shortcuts (for example, Ctrl+Left or H) -to switch which widget is shown.

    -

    Also note that in this mode, widget expansion and custom layouts are disabled.

    -

    Key bindings

    -

    Basic mode follows the same key bindings as normal, barring widget expansion being disabled, and that the % key while selecting the memory widget toggles between total usage and percentage.

    - - - - +     +
    +

    Notes

    +

    In this mode, widgets that use tables (temperatures, processes, disks, and batteries) are only shown one + at a time. + One can switch between these widgets either by clicking the arrow buttons or by using the general widget + selection shortcuts (for example, Ctrl+Left or H) + to switch which widget is shown.

    +

    Also note that in this mode, widget expansion and custom layouts are disabled.

    +

    Key bindings

    +

    Basic mode follows the same key bindings as normal, barring widget expansion being disabled, and that the + % key while selecting the memory widget toggles between total usage + and percentage.

    - - -
    + + + + + + - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/usage/general-usage/index.html b/0.6.3/usage/general-usage/index.html index ebf91bab..b111b2e5 100644 --- a/0.6.3/usage/general-usage/index.html +++ b/0.6.3/usage/general-usage/index.html @@ -1,1050 +1,1149 @@ - - - - - - - - - - - - - - - - - - - - - General Usage - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    -
    - - - - - - -
  • - - - - - - -
    • - - - - - - - - - - - -
  • - - - - - - -
    • - - - - - - - - - - - -
  • - - - - - - -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - - - - - - - -
    -
    -
    - -
    - - - -
  • - - Key bindings - - -
    • - -
  • - - Mouse bindings - - -
    • - - - - -
    -
    - - - -
    -
    - - - - + + +
    +
    + + + +
    +
    +
    + + + + + + +
    +
    +
    + + + +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + + + + +

    General Usage

    +

    You can run bottom with:

    +
    + 
    btm
+
    +
    +

    For help regarding the command-line flags, use:

    +
    + 
    # For a simple overview of flags
 btm -h
 
 # For more details
 btm --help
-
    -

    Features

    -

    Expansion

    -

    By default, bottom is somewhat like a dashboard - a bunch of different widgets, all showing different things, and they all cram together to fit into one terminal.

    -

    If you instead just want to see one widget - maybe you want to look at a graph in more detail, for example - you can "expand" the currently selected -widget using the e key, which will hide all other widgets and make that widget take up all available terminal space.

    -

    You can leave this state by either pressing e again or pressing Esc.

    -

    Widget selection

    -

    To allow for widget-specific keybindings and expansion, there is the idea of widget selection in bottom, where you can focus on a specific widget to work with it. -This can be done with the mouse (just click on the widget of interest) or keyboard (ex: Ctrl+Direction, see Key bindings for alternatives).

    -

    Key bindings

    -

    These are global or common keyboard shortcuts for the application, which you can see in-app through the ? shortcut. -Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    q , Ctrl+cQuit
    EscClose dialog windows, search, widgets, or exit expanded mode
    Ctrl+rReset display and any collected data
    fFreeze/unfreeze updating with new data
    ?Open help menu
    eToggle expanding the currently selected widget
    Ctrl+Up
    Shift+Up
    K
    W    		Select the widget above
    Ctrl+Down
    Shift+Down
    J
    S    		Select the widget below
    Ctrl+Left
    Shift+Left
    H
    A    		Select the widget on the left
    Ctrl+Right
    Shift+Right
    L
    D    		Select the widget on the right
    Up , kMove up within a widget
    Down , jMove down within a widget
    Left
    h
    Alt+h    		Move left within a widget
    Right
    l
    Alt+l    		Move right within a widget
    g+g , HomeJump to the first entry
    G , EndJump to the last entry
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    Left ButtonSelects the widget
    - - - - +     +
    +

    Features

    +

    Expansion

    +

    By default, bottom is somewhat like a dashboard - a bunch of different widgets, all showing different + things, and they all cram together to fit into one terminal.

    +

    If you instead just want to see one widget - maybe you want to look at a graph in more detail, + for example - you can "expand" the currently selected + widget using the e key, which will hide all other + widgets and make that widget take up all available terminal space.

    +

    You can leave this state by either pressing e again or + pressing Esc.

    +

    Widget selection

    +

    To allow for widget-specific keybindings and expansion, there is the idea of widget selection in + bottom, where you can focus on a specific widget to work with it. + This can be done with the mouse (just click on the widget of interest) or keyboard (ex: Ctrl+Direction, see Key bindings for alternatives).

    +

    Key bindings

    +

    These are global or common keyboard shortcuts for the application, which you can see in-app through the + ? shortcut. + Note that key bindings are generally case-sensitive.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    BindingAction
    q , Ctrl+cQuit
    EscClose dialog windows, search, widgets, or exit expanded mode
    Ctrl+rReset display and any collected data
    fFreeze/unfreeze updating with new data
    ?Open help menu
    eToggle expanding the currently selected widget
    Ctrl+Up
    Shift+Up
    + K
    W    		Select the widget above
    Ctrl+Down
    Shift+Down
    + J
    S    		Select the widget below
    Ctrl+Left
    Shift+Left
    + H
    A    		Select the widget on the left
    Ctrl+Right
    Shift+Right +
    L
    D    		Select the widget on the right
    Up , kMove up within a widget
    Down , jMove down within a widget
    Left
    h
    Alt+h    		Move left within a widget
    Right
    l
    Alt+l    		Move right within a widget
    g+g , + HomeJump to the first entry
    G , EndJump to the last entry
    +

    Mouse bindings

    + + + + + + + + + + + + + +
    BindingAction
    Left ButtonSelects the widget
    - -
    -
    + + + + + + - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/usage/widgets/battery/index.html b/0.6.3/usage/widgets/battery/index.html index eb7dc12a..eac529da 100644 --- a/0.6.3/usage/widgets/battery/index.html +++ b/0.6.3/usage/widgets/battery/index.html @@ -1,951 +1,1018 @@ - - - - - - - - - - - - - - - - - - - - - Battery Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Battery Widget

    -

    The battery widget provides information about batteries on the system.

    -
    - A picture of an expanded battery widget. -
    + bottom + -

    The battery widget can be enabled through either the --battery flag, the battery = true option in a config file, or specifying the widget in a custom layout.

    -

    Features

    -

    The following data is displayed for batteries:

    -
      -
    • Charge percent
      • -
    • Consumption
      • -
    • Time to empty/charge, based on the current state
      • -
    • Battery health percent
      • -
    -

    The battery widget also supports devices with multiple batteries, and you can switch between them using the keyboard or the mouse.

    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - -
    BindingAction
    Left
    h
    Alt+h    		Moves to the battery entry to the left of the current one
    Right
    l
    Alt+l    		Moves to the battery entry to the right of the current one
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    Left ButtonSelects a battery entry
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/usage/widgets/cpu/index.html b/0.6.3/usage/widgets/cpu/index.html index 0b7fd56c..2ecf0ab1 100644 --- a/0.6.3/usage/widgets/cpu/index.html +++ b/0.6.3/usage/widgets/cpu/index.html @@ -1,1082 +1,1152 @@ - - - - - - - - - - - - - - - - - - - - - CPU Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    CPU Widget

    -

    The CPU widget displays a visual representation of CPU usage over a time range.

    -
    - A picture of an expanded CPU widget showing average CPU usage. -
    + bottom + -

    Features

    -

    The CPU widget is composed of two parts: the graph and the legend:

    -
      -
    • The graph displays the usage data for the currently selected entry as a percentage
      • -
    • The legend displays all available entries that can be displayed on the graph along with their last recorded use percentage (except for the "All" option)
      • -
    -

    Users can scroll through the legend using either the keyboard or mouse to select which entry to display on the graph. The "All" option shows every entry -at the same time, though this may get a bit hard to follow if you have a large number of cores/threads.

    -

    One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    -

    Graph

    - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    +Zoom in on chart (decrease time range)
    -Zoom out on chart (increase time range)
    =Reset zoom
    -

    Legend

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    Up , kMove up within a widget
    Down , jMove down within a widget
    g+g , HomeJump to the first entry in the legend
    G , EndJump to the last entry in the legend
    -

    Mouse bindings

    -

    Graph

    - - - - - - - - - - - - - -
    BindingAction
    ScrollScrolling up or down zooms in or out of the graph respectively
    -

    Legend

    - - - - - - - - - - - - - - - - - -
    BindingAction
    ScrollScroll through options to display in the graph
    Left ButtonSelects a CPU thread/average to show in the graph
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - - + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/usage/widgets/disk/index.html b/0.6.3/usage/widgets/disk/index.html index a3e074c0..6a0a5599 100644 --- a/0.6.3/usage/widgets/disk/index.html +++ b/0.6.3/usage/widgets/disk/index.html @@ -1,960 +1,1026 @@ - - - - - - - - - - - - - - - - - - - - - Disk Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Disk Widget

    -

    The disk widget provides a table of useful disk and partition information, like I/O per second and total usage.

    -
    - A picture of an expanded disk widget. -
    + bottom + -

    Features

    -

    The disk widget provides the following information:

    -
      -
    • Disk name
      • -
    • Disk mount location
      • -
    • Percentage of space used
      • -
    • Amount of space left
      • -
    • Total amount of space
      • -
    • Read per second
      • -
    • Write per second
      • -
    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    Up , kMove up within a widget
    Down , jMove down within a widget
    g+g , HomeJump to the first entry in the table
    G , EndJump to the last entry in the table
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    Left ButtonSelects an entry in the table
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/usage/widgets/memory/index.html b/0.6.3/usage/widgets/memory/index.html index 9b4b76cb..aca3833c 100644 --- a/0.6.3/usage/widgets/memory/index.html +++ b/0.6.3/usage/widgets/memory/index.html @@ -1,968 +1,1037 @@ - - - - - - - - - - - - - - - - - - - - - Memory Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Memory Widget

    -

    The memory widget provides a visual representation of RAM and swap usage over time.

    -
    - A picture of an expanded memory widget. -
    + bottom + -

    Features

    -

    The legend displays the current usage in terms of percentage and actual usage in binary units (KiB, MiB, GiB, etc.). -If the total RAM or swap available is 0, then it is automatically hidden from the legend and graph.

    -

    One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    +Zoom in on chart (decrease time range)
    -Zoom out on chart (increase time range)
    =Reset zoom
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    ScrollScrolling up or down zooms in or out of the graph respectively
    -

    Calculations

    -

    Memory usage is calculated using the following formula based on values from /proc/meminfo (based on htop's implementation):

    -
    MemTotal - MemFree - Buffers - (Cached + SReclaimable - Shmem)
-
    -

    You can find more info on /proc/meminfo and its fields here.

    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/usage/widgets/network/index.html b/0.6.3/usage/widgets/network/index.html index 725521d2..d7bf64c5 100644 --- a/0.6.3/usage/widgets/network/index.html +++ b/0.6.3/usage/widgets/network/index.html @@ -1,952 +1,1019 @@ - - - - - - - - - - - - - - - - - - - - - Network Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Network Widget

    -

    The network widget provides a visual representation of network input and output per second, as well as noting the total amount -received and transmitted.

    -
    - A picture of an expanded network widget. -
    + bottom + -

    Features

    -

    The legend displays the current reads and writes per second in bits, as well as the total amount read/written.

    -

    The y-axis automatically scales based on shown read/write values, and by default, is a linear scale based on base-10 units (e.x. kilobit, gigabit, etc.). -Through configuration, the read/write per second unit can be changed to bytes, while the y-axis can be changed to a -log scale and/or use base-2 units (e.x. kibibit, gibibit, etc.).

    -

    One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    +Zoom in on chart (decrease time range)
    -Zoom out on chart (increase time range)
    =Reset zoom
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    ScrollScrolling up or down zooms in or out of the graph respectively
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/usage/widgets/process/index.html b/0.6.3/usage/widgets/process/index.html index 7f7ec40c..91408e0a 100644 --- a/0.6.3/usage/widgets/process/index.html +++ b/0.6.3/usage/widgets/process/index.html @@ -1,1616 +1,1736 @@ - - - - - - - - - - - - - - - - - - - - - Process Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    - -
    - -
    - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - -
    -
    -
    - - - -
    -
    -
    - -
    - - - - - - - - -
  • - - Key bindings - - - - -
    • - -
  • - - Mouse bindings - - - - -
    • - - - - -
    -
    -
    - - -
    -
    - - - - + + +
    +
    + + + +
    +
    +
    + + + + + +
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - - + +
    +
    +
    + + Made with + + Material for MkDocs + + +
    + +
    - - +
    + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.3/usage/widgets/temperature/index.html b/0.6.3/usage/widgets/temperature/index.html index 9fafc9ee..d4fd87f3 100644 --- a/0.6.3/usage/widgets/temperature/index.html +++ b/0.6.3/usage/widgets/temperature/index.html @@ -1,951 +1,1016 @@ - - - - - - - - - - - - - - - - - - - - - Temperature Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    - -
    - -
    - - - - - + + +
    -
  • - - Home - -
    • - - - - - -
  • - - Support - -
    • - - - - - - - + - - -
    -
    - - - -
    -
    -
    - - - -
    + - - - - - -
  • - - Basic Mode - -
    • - - - - - - +
    +
    - - - - - - - - -
  • - - - - - -
  • -
    • - - - - - - - - - - -
  • - - Troubleshooting - -
    • - - - - - -
    -
    -
    - - - -
    -
    -
    - - -
    -
    -
    - - -
    -
    - - - - - - -

    Temperature Widget

    -

    The temperature widget provides a table of temperature sensors and their current temperature.

    -
    - A picture of an expanded temperature widget. -
    + bottom + -

    Features

    -

    The temperature widget provides the sensor name as well as its current temperature.

    -

    Key bindings

    -

    Note that key bindings are generally case-sensitive.

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    BindingAction
    Up , kMove up within a widget
    Down , jMove down within a widget
    g+g , HomeJump to the first entry in the table
    G , EndJump to the last entry in the table
    -

    Mouse bindings

    - - - - - - - - - - - - - -
    BindingAction
    Left ButtonSelects an entry in the table
    - - - - +
    + + +
    + + + + +
    +
    + ClementTsang/bottom +
    +     +
    + +
      - -
    + + + + + + +
  • + + Home + +
    • + + + + + + + + + + +
  • + + Support + +
    • + + + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + + +
  • + + + + + + +
    • + + + + + + + + + + +
  • + + Troubleshooting + +
    • + + + + + +
    - - - - - - - - -
    - -
    + + + + + + + + + + + + - - - -
    -
    -
    - - - - - - - - \ No newline at end of file +
    +
    +
    + + + + + + + + + diff --git a/0.6.4/404.html b/0.6.4/404.html index 77013d77..d38b9462 100644 --- a/0.6.4/404.html +++ b/0.6.4/404.html @@ -1,869 +1,926 @@ - - - - - - - - - - - - - - - - - - - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + - - - - - - - - - - - - - - - - - - - - - - -
    - -
    -
    - -
    - - -
    - - -
    - -
    - - - - - - - - - -
    -
    - - - -
    -
    -
    - - - - - - -
    + +
    +
    +
    +
    + Initializing search
    +
      - - - -
      -
      - -

      404 - Not found

      - - -
      +
      - - - - Back to top - - -
      - - - - -
      -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/configuration/command-line-flags/index.html b/0.6.4/configuration/command-line-flags/index.html index 02bfd619..dd7b5970 100644 --- a/0.6.4/configuration/command-line-flags/index.html +++ b/0.6.4/configuration/command-line-flags/index.html @@ -1,1053 +1,1115 @@ - - - - - - - - - - - - - - - - - - - - - Command-line Flags - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - + + + +
      -
    1. - - Home - -
      2. - - - - - -
    2. - - Support - -
      3. - - - - + - - - -
      -
      - - - -
      -
      -
      - - - -
      + - - - - - - - -
    3. - - Basic Mode - -
      4. - - - - - - - - - - - +
      +
      - - - - - - -
    4. - - - - - - - - - - -
      5. - + -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - - - -

      Command-line Flags

      -
      -

      Warning

      -

      This section is in progress, and is just copied from the old documentation.

      -
      -

      The following flags can be provided to bottom in the command line to change the behaviour of the program (run btm --help for more information on each flag):

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      FlagBehaviour
      --autohide_timeTemporarily shows the time scale in graphs.
      -b, --basicHides graphs and uses a more basic look.
      --batteryShows the battery widget.
      -S, --case_sensitiveEnables case sensitivity by default.
      -c, --celsiusSets the temperature type to Celsius.
      --color <COLOR SCHEME>Use a color scheme, use --help for supported values.
      -C, --config <CONFIG PATH>Sets the location of the config file.
      -u, --current_usageSets process CPU% to be based on current CPU%.
      -t, --default_time_value <MS>Default time value for graphs in ms.
      --default_widget_count <INT>Sets the n'th selected widget type as the default.
      --default_widget_type <WIDGET TYPE>Sets the default widget type, use --help for more info.
      --disable_advanced_killHides advanced options to stop a process on Unix-like systems.
      --disable_clickDisables mouse clicks.
      -m, --dot_markerUses a dot marker for graphs.
      -f, --fahrenheitSets the temperature type to Fahrenheit.
      -g, --groupGroups processes with the same name by default.
      -h, --helpPrints help information. Use --help for more info.
      -a, --hide_avg_cpuHides the average CPU usage.
      --hide_table_gapHides the spacing between table headers and entries.
      --hide_timeHides the time scale.
      -k, --kelvinSets the temperature type to Kelvin.
      -l, --left_legendPuts the CPU chart legend to the left side.
      --mem_as_valueDefaults to showing process memory usage by value.
      --network_use_binary_prefixDisplays the network widget with binary prefixes.
      --network_use_bytesDisplays the network widget using bytes.
      --network_use_logDisplays the network widget with a log scale.
      --process_commandShow processes as their commands by default.
      -r, --rate <MS>Sets a refresh rate in ms.
      -R, --regexEnables regex by default.
      --show_table_scroll_positionShows the scroll position tracker in table widgets.
      -d, --time_delta <MS>The amount in ms changed upon zooming.
      -T, --treeDefaults to showing the process widget in tree mode.
      --use_old_network_legendDEPRECATED - uses the older network legend.
      -V, --versionPrints version information.
      -W, --whole_wordEnables whole-word matching by default.
      - - - - + bottom + + +
      + + +
      + + + + +
      +
      + ClementTsang/bottom +
      +       +
      + +
        - -
      + + + + + + +
    5. + + Home + +
      6. + + + + + + + + + + +
    6. + + Support + +
      7. + + + + + + + + + + + +
    7. + + + + + + + + + + +
      8. + + + + + + + + + + + + + +
    8. + + + + + + + + + + +
      9. + + + + + + + + + + + +
    9. + + + + + + + + + + +
      10. + + + + + + + + + + +
    10. + + Troubleshooting + +
      11. + + + + + +
      - - - - Back to top - - - - - -
      - -
      + + + + + + Back to top + + + + + + + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/configuration/config-file/data-filtering/index.html b/0.6.4/configuration/config-file/data-filtering/index.html index 056447da..3572c1ec 100644 --- a/0.6.4/configuration/config-file/data-filtering/index.html +++ b/0.6.4/configuration/config-file/data-filtering/index.html @@ -1,891 +1,961 @@ - - - - - - - - - - - - - - - - - - - - - Data Filtering - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      -
      + +
      -
    11. - - Support - -
      12. - - - - - - - - -
    12. - - Usage - -
      13. - - - - - - - + - - - -
      -
      - - - -
      -
      -
      - - - +
    13. + + Home + +
      14. -
      + - - - - - - - -
    14. - - Basic Mode - -
      15. - - - - - - - - - - - +
      +
      - - - - - - -
    15. - - - - - - - - - - -
      16. - + -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - - - -

      Data Filtering

      -
      -

      Warning

      -

      This section is in progress, and is just copied from the old documentation.

      -
      -

      You can hide specific disks, temperature sensors, and networks by name in the config file via disk_filter and mount_filter, temp_filter, and net_filter respectively. Regex (regex = true), case-sensitivity (case_sensitive = true), and matching only if the entire word matches (whole_word = true) are supported, but are off by default. Filters default to denying entries that match and can be toggled by setting is_list_ignored to false in the config file.

      -

      For example, here's the disk widget with no filter:

      -

      Disk no filter

      -

      The following in the config file would filter out some entries by disk name:

      -
      [disk_filter]
+                  bottom
+                
+
+                
      
+
+                  
+                    
      
+
+                      
+                        
+                      
+                    
      
+                    
      
+                      ClementTsang/bottom
+                    
      
+                        
+                
      
+
+                
+              
+
      +
      +
      + + + +
      +
      +
      + + +
      +
      +
      + + +
      +
      + + + + + + + + + +

      Data Filtering

      +
      +

      Warning

      +

      This section is in progress, and is just copied from the old documentation.

      +
      +

      You can hide specific disks, temperature sensors, and networks by name in the config file via + disk_filter and mount_filter, temp_filter, and + net_filter respectively. Regex (regex = true), case-sensitivity + (case_sensitive = true), and matching only if the entire word matches + (whole_word = true) are supported, but are off by default. Filters default to denying entries + that match and can be toggled by setting is_list_ignored to false in the config + file.

      +

      For example, here's the disk widget with no filter:

      +

      Disk 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 widget with just disk name filter

      -

      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]
+
      +
      +

      Disk widget with just disk name filter

      +

      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
@@ -898,36 +968,42 @@
 regex = true
 case_sensitive = false
 whole_word = true
-
      -

      This gives us:

      -

      Disk widget with disk name and mount filter

      - - - - +       +
      +

      This gives us:

      +

      Disk widget with disk name and mount filter

      - - -
      + + + + + + - - - - Back to top - - - - - - + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/configuration/config-file/default-config/index.html b/0.6.4/configuration/config-file/default-config/index.html index 93bc99be..72ffee4b 100644 --- a/0.6.4/configuration/config-file/default-config/index.html +++ b/0.6.4/configuration/config-file/default-config/index.html @@ -1,924 +1,990 @@ - - - - - - - - - - - - - - - - - - - - - Default Config - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - + + + +
      -
    16. - - Home - -
      17. - - - - - -
    17. - - Support - -
      18. - - - - + - - - -
      -
      - - - -
      -
      -
      - - - -
      + - - - - - - - -
    18. - - Basic Mode - -
      19. - - - - - - - - - - - +
      +
      - - - - - - -
    19. - - - - - - - - - - -
      20. - + -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - - - -

      Default Config

      -

      A default config file is automatically generated at the following locations that bottom checks by default:

      - - - - - - - - - - - - - - - - - - - - - -
      OSDefault Config Location
      macOS$HOME/Library/Application Support/bottom/bottom.toml
      ~/.config/bottom/bottom.toml
      $XDG_CONFIG_HOME/bottom/bottom.toml
      Linux~/.config/bottom/bottom.toml
      $XDG_CONFIG_HOME/bottom/bottom.toml
      WindowsC:\Users\<USER>\AppData\Roaming\bottom\bottom.toml
      -

      Furthermore, if a custom config path that does not exist is given (using -C or --config), bottom will attempt to create a default config file at that location.

      - - - - + bottom + + +
      + + +
      + + + + +
      +
      + ClementTsang/bottom +
      +       +
      + +
        - -
      + + + + + + +
    20. + + Home + +
      21. + + + + + + + + + + +
    21. + + Support + +
      22. + + + + + + + + + + + +
    22. + + + + + + + + + + +
      23. + + + + + + + + + + + + + +
    23. + + + + + + + + + + +
      24. + + + + + + + + + + + +
    24. + + + + + + + + + + +
      25. + + + + + + + + + + +
    25. + + Troubleshooting + +
      26. + + + + + +
      - - - - Back to top - - - - - -
      - -
      + + + + + + Back to top + + + + + + + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/configuration/config-file/flags/index.html b/0.6.4/configuration/config-file/flags/index.html index fa2e89af..4386b034 100644 --- a/0.6.4/configuration/config-file/flags/index.html +++ b/0.6.4/configuration/config-file/flags/index.html @@ -1,1056 +1,1119 @@ - - - - - - - - - - - - - - - - - - - - - Flags - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - + + + +
      -
    26. - - Home - -
      27. - - - - - -
    27. - - Support - -
      28. - - - - + - - - -
      -
      - - - -
      -
      -
      - - - -
      + - - - - - - - -
    28. - - Basic Mode - -
      29. - - - - - - - - - - - +
      +
      - - - - - - -
    29. - - - - - - - - - - -
      30. - + -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - - - -

      Flags

      -
      -

      Warning

      -

      This section is in progress, and is just copied from the old documentation.

      -
      -

      Most of the command line flags have config file equivalents to avoid having to type them out each time:

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      FieldTypeFunctionality
      hide_avg_cpuBooleanHides the average CPU usage.
      dot_markerBooleanUses a dot marker for graphs.
      left_legendBooleanPuts the CPU chart legend to the left side.
      current_usageBooleanSets process CPU% to be based on current CPU%.
      group_processesBooleanGroups processes with the same name by default.
      case_sensitiveBooleanEnables case sensitivity by default.
      whole_wordBooleanEnables whole-word matching by default.
      regexBooleanEnables regex by default.
      basicBooleanHides graphs and uses a more basic look.
      use_old_network_legendBooleanDEPRECATED - uses the older network legend.
      batteryBooleanShows the battery widget.
      rateUnsigned Int (represents milliseconds)Sets a refresh rate in ms.
      default_time_valueUnsigned Int (represents milliseconds)Default time value for graphs in ms.
      time_deltaUnsigned Int (represents milliseconds)The amount in ms changed upon zooming.
      hide_timeBooleanHides the time scale.
      temperature_typeString (one of ["k", "f", "c", "kelvin", "fahrenheit", "celsius"])Sets the temperature unit type.
      default_widget_typeString (one of ["cpu", "proc", "net", "temp", "mem", "disk"], same as layout options)Sets the default widget type, use --help for more info.
      default_widget_countUnsigned Int (represents which default_widget_type)Sets the n'th selected widget type as the default.
      disable_clickBooleanDisables mouse clicks.
      colorString (one of ["default", "default-light", "gruvbox", "gruvbox-light", "nord", "nord-light"])Use a color scheme, use --help for supported values.
      mem_as_valueBooleanDefaults to showing process memory usage by value.
      treeBooleanDefaults to showing the process widget in tree mode.
      show_table_scroll_positionBooleanShows the scroll position tracker in table widgets.
      process_commandBooleanShow processes as their commands by default.
      disable_advanced_killBooleanHides advanced options to stop a process on Unix-like systems.
      network_use_binary_prefixBooleanDisplays the network widget with binary prefixes.
      network_use_bytesBooleanDisplays the network widget using bytes.
      network_use_logBooleanDisplays the network widget with a log scale.
      - - - - + bottom + + +
      + + +
      + + + + +
      +
      + ClementTsang/bottom +
      +       +
      + +
        - -
      + + + + + + +
    30. + + Home + +
      31. + + + + + + + + + + +
    31. + + Support + +
      32. + + + + + + + + + + + +
    32. + + + + + + + + + + +
      33. + + + + + + + + + + + + + +
    33. + + + + + + + + + + +
      34. + + + + + + + + + + + +
    34. + + + + + + + + + + +
      35. + + + + + + + + + + +
    35. + + Troubleshooting + +
      36. + + + + + +
      - - - - Back to top - - - - - -
      - -
      + + + + + + Back to top + + + + + + + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/configuration/config-file/layout/index.html b/0.6.4/configuration/config-file/layout/index.html index 9f1c2a7c..a620a25f 100644 --- a/0.6.4/configuration/config-file/layout/index.html +++ b/0.6.4/configuration/config-file/layout/index.html @@ -1,880 +1,938 @@ - - - - - - - - - - - - - - - - - - - - - Layout - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      -
      + +
      -
    36. - - Support - -
      37. - - - - - - - - -
    37. - - Usage - -
      38. - - - - - - - + - - - -
      -
      - - - -
      -
      -
      - - - +
    38. + + Home + +
      39. -
      + - - - - - - - -
    39. - - Basic Mode - -
      40. - - - - - - - - - - - +
      +
      - - - - - - -
    40. - - - - - - - - - - -
      41. - + -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - - - -

      Layout

      -
      -

      Warning

      -

      This section is in progress, and is just copied from the old documentation.

      -
      -

      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]]
+                  bottom
+                
+
+                
      
+
+                  
+                    
      
+
+                      
+                        
+                      
+                    
      
+                    
      
+                      ClementTsang/bottom
+                    
      
+                        
+                
      
+
+                
+              
+
      +
      +
      + + + +
      +
      +
      + + +
      +
      +
      + + +
      +
      + + + + + + + + + +

      Layout

      +
      +

      Warning

      +

      This section is in progress, and is just copied from the old documentation.

      +
      +

      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]]
@@ -888,88 +946,100 @@
         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. -The second column is split into two rows with a 1:1 ratio. The first is the temperature widget, the second is the disk widget.

      -

      This is what the layout would look like when run:

      -

      Sample layout

      -

      Each [[row]] represents a row in the layout. A row can have any number of child values. Each [[row.child]] -represents either a column or a widget. A column can have any number of child values as well. Each [[row.child.child]] -represents a widget. A widget is represented by having a type field set to a string.

      -

      The following type values are supported:

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      "cpu"CPU chart and legend
      "mem", "memory"Memory chart
      "net", "network"Network chart and legend
      "proc", "process", "processes"Process table and search
      "temp", "temperature"Temperature table
      "disk"Disk table
      "empty"An empty space
      "batt", "battery"Battery statistics
      -

      Each component of the layout accepts a ratio value. If this is not set, it defaults to 1.

      -

      Furthermore, you can have duplicate widgets.

      -

      For an example, look at the default config, which contains the default layout.

      - - - - +       +
      +

      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. + The second column is split into two rows with a 1:1 ratio. The first is the temperature widget, the second + is the disk widget.

      +

      This is what the layout would look like when run:

      +

      Sample layout

      +

      Each [[row]] represents a row in the layout. A row can have any number of + child values. Each [[row.child]] + represents either a column or a widget. A column can have any number of child values + as well. Each [[row.child.child]] + represents a widget. A widget is represented by having a type field set to a string. +

      +

      The following type values are supported:

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      "cpu"CPU chart and legend
      "mem", "memory"Memory chart
      "net", "network"Network chart and legend
      "proc", "process", "processes"Process table and search
      "temp", "temperature"Temperature table
      "disk"Disk table
      "empty"An empty space
      "batt", "battery"Battery statistics
      +

      Each component of the layout accepts a ratio value. If this is not set, it defaults to 1. +

      +

      Furthermore, you can have duplicate widgets.

      +

      For an example, look at the default + config, which contains the default layout.

      - - -
      + + + + + + - - - - Back to top - - - - - - + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/configuration/config-file/theming/index.html b/0.6.4/configuration/config-file/theming/index.html index 666dad52..7148f1af 100644 --- a/0.6.4/configuration/config-file/theming/index.html +++ b/0.6.4/configuration/config-file/theming/index.html @@ -1,1012 +1,1076 @@ - - - - - - - - - - - - - - - - - - - - - Theming - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - + + + +
      -
    41. - - Home - -
      42. - - - - - -
    42. - - Support - -
      43. - - - - + - - - -
      -
      - - - -
      -
      -
      - - - -
      + - - - - - - - -
    43. - - Basic Mode - -
      44. - - - - - - - - - - - +
      +
      - - - - - - -
    44. - - - - - - - - - - -
      45. - + -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - - - -

      Theming

      -
      -

      Warning

      -

      This section is in progress, and is just copied from the old documentation.

      -
      -

      The config file can be used to set custom colours for parts of the application under the [colors] object. The following labels are customizable with strings that are hex colours, RGB colours, or specific named colours.

      -

      Supported named colours are one of the following strings: Reset, Black, Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed, LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White.

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      LabelsDetailsExample
      Table header coloursColour of table headerstable_header_color="255, 255, 255"
      CPU colour per coreColour of each core. Read in order.cpu_core_colors=["#ffffff", "white", "255, 255, 255"]
      Average CPU colourThe average CPU coloravg_cpu_color="White"
      All CPUs colourThe colour for the "All" CPU labelall_cpu_color="White"
      RAMThe colour RAM will useram_color="#ffffff"
      SWAPThe colour SWAP will useswap_color="#ffffff"
      RXThe colour rx will userx_color="#ffffff"
      TXThe colour tx will usetx_color="#ffffff"
      Widget title colourThe colour of the label each widget haswidget_title_color="#ffffff"
      Border colourThe colour of the border of unselected widgetsborder_color="#ffffff"
      Selected border colourThe colour of the border of selected widgetshighlighted_border_color="#ffffff"
      Text colourThe colour of most texttext_color="#ffffff"
      Graph colourThe colour of the lines and text of the graphgraph_color="#ffffff"
      Cursor colourThe cursor's colourcursor_color="#ffffff"
      Selected text colourThe colour of text that is selectedscroll_entry_text_color="#ffffff"
      Selected text background colourThe background colour of text that is selectedscroll_entry_bg_color="#ffffff"
      High battery level colourThe colour used for a high battery level (100% to 50%)high_battery_color="green"
      Medium battery level colourThe colour used for a medium battery level (50% to 10%)medium_battery_color="yellow"
      Low battery level colourThe colour used for a low battery level (10% to 0%)low_battery_color="red"
      - - - - + bottom + + +
      + + +
      + + + + +
      +
      + ClementTsang/bottom +
      +       +
      + +
        - -
      + + + + + + +
    45. + + Home + +
      46. + + + + + + + + + + +
    46. + + Support + +
      47. + + + + + + + + + + + +
    47. + + + + + + + + + + +
      48. + + + + + + + + + + + + + +
    48. + + + + + + + + + + +
      49. + + + + + + + + + + + +
    49. + + + + + + + + + + +
      50. + + + + + + + + + + +
    50. + + Troubleshooting + +
      51. + + + + + +
      - - - - Back to top - - - - - -
      - -
      + + + + + + Back to top + + + + + + + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/contribution/development/index.html b/0.6.4/contribution/development/index.html index 553c2ab8..195d2d72 100644 --- a/0.6.4/contribution/development/index.html +++ b/0.6.4/contribution/development/index.html @@ -1,978 +1,1039 @@ - - - - - - - - - - - - - - - - - - - - - Development - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - + + + +
      -
    51. - - Home - -
      52. - - - - - -
    52. - - Support - -
      53. - - - - + - - - -
      -
      - - - -
      -
      -
      - - - -
      + - - - - - - - -
    53. - - Basic Mode - -
      54. - - - - - - - - - - - +
      +
      - - - - -
    54. - - - - - - - - - - -
      55. - + -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      - + + + + + + +
    55. + + Home + +
      56. + + + + + + + + + + +
    56. + + Support + +
      57. + + + + + + + + + + + +
    57. + + + + + + + + + + +
      58. + + + + + + + + + + + +
    58. + + + + + + + + + + +
      59. + + + + + + + + + + + + + +
    59. + + + + + + + + + + +
      60. + + + + + + + + + + +
    60. + + Troubleshooting + +
      61. + + + + + +
      - - - - Back to top - - - - - -
      + + + + + + Back to top + + + + + + + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/contribution/documentation/index.html b/0.6.4/contribution/documentation/index.html index a89622b1..ae4f7501 100644 --- a/0.6.4/contribution/documentation/index.html +++ b/0.6.4/contribution/documentation/index.html @@ -1,1008 +1,1091 @@ - - - - - - - - - - - - - - - - - - - - - Documentation - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - + + + +
      -
    61. - - Home - -
      62. - - - - - -
    62. - - Support - -
      63. - - - - + - - - -
      -
      - - - -
      -
      -
      - - - -
      + - - - - - - - -
    63. - - Basic Mode - -
      64. - - - - - - - - - - - +
      +
      - - - - -
    64. - - - - - - - - - - -
      65. - + -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - - - -

      Documentation

      -

      When should documentation changes be done?

      -
        -
      • Whenever a new feature is added, a bug is fixed, or a breaking change is made, it should be documented where appropriate (ex: README.md, changelog, etc.)
        • -
      • New methods of installation are always appreciated and should be documented
        • -
      -

      What pages need documentation?

      -

      There are a few areas where documentation changes are often needed:

      - -

      How should I add documentation?

      -
        -
      1. -

        Fork the repository first and make changes there.

        -
        2. -
      2. -

        Where you're adding documentation will probably affect what you need to do:

        - -
          -
        • For changes to the help menu, try to refer to the existing code within src/constants.rs on how the help menu is generated.
          • -
        -
          -
        • -

          For changes to the extended documentation, you'll want MkDocs, Material for MkDocs, and mdx_truly_sane_lists installed to provide live reloading and preview for your changes. You can do so through pip or your system's package managers. While you don't need these, it'll probably help in making and validating changes.

          -

          You may also want Mike, but it isn't really needed.

          -
          • -
        -
        3. -
      3. -

        Once you have your documentation changes done, submit it as a pull request. For more information regarding that, refer to Issues and Pull Requests.

        -
        4. -
      - - - - + bottom + + +
      + + +
      + + + + +
      +
      + ClementTsang/bottom +
      +       +
      + +
        - -
      + + + + + + +
    65. + + Home + +
      66. + + + + + + + + + + +
    66. + + Support + +
      67. + + + + + + + + + + + +
    67. + + + + + + + + + + +
      68. + + + + + + + + + + + +
    68. + + + + + + + + + + +
      69. + + + + + + + + + + + + + +
    69. + + + + + + + + + + +
      70. + + + + + + + + + + +
    70. + + Troubleshooting + +
      71. + + + + + +
      - - - - Back to top - - - - - -
      + + + + + + Back to top + + + + + + + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/contribution/issues-and-pull-requests/index.html b/0.6.4/contribution/issues-and-pull-requests/index.html index 4d660fba..108fecbf 100644 --- a/0.6.4/contribution/issues-and-pull-requests/index.html +++ b/0.6.4/contribution/issues-and-pull-requests/index.html @@ -1,1014 +1,1089 @@ - - - - - - - - - - - - - - - - - - - - - Issues and Pull Requests - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - - - - -
      -
      - - - -
      -
      -
      - - - - - -
      -
      -
      - - - -
      -
      -
      - -
      - - - -
    71. - - Pull requests - - -
      72. - - - - -
      -
      -
      - - -
      -
      - - - - + + + +
      +
      + + + +
      +
      +
      + + + + + +
      + + + + + + +
    72. + + Home + +
      73. + + + + + + + + + + +
    73. + + Support + +
      74. + + + + + + + + + + + +
    74. + + + + + + + + + + +
      75. + + + + + + + + + + + +
    75. + + + + + + + + + + +
      76. + + + + + + + + + + + + + +
    76. + + + + + + + + + + +
      77. + + + + + + + + + + +
    77. + + Troubleshooting + +
      78. + + + + + +
      - - - - Back to top - - - - - - + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/contribution/packaging-and-distribution/index.html b/0.6.4/contribution/packaging-and-distribution/index.html index dc04d336..90f1c684 100644 --- a/0.6.4/contribution/packaging-and-distribution/index.html +++ b/0.6.4/contribution/packaging-and-distribution/index.html @@ -1,993 +1,1077 @@ - - - - - - - - - - - - - - - - - - - - - Packaging and Distribution - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - + + + +
      -
    78. - - Home - -
      79. - - - - - -
    79. - - Support - -
      80. - - - - + - - - -
      -
      - - - -
      -
      -
      - - - -
      + - - - - - - - -
    80. - - Basic Mode - -
      81. - - - - - - - - - - - +
      +
      - - - - -
    81. - - - - - - - - - - -
      82. - + -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - - - -

      Packaging and Distribution

      -

      Package maintainers are always welcome and appreciated! Here's some info on how one can help with package distribution and bottom.

      -

      Pre-built binaries

      -

      The latest stable release can be found here, where you can find pre-built binaries in either a tar.gz or zip format. -Binaries here also include automatically generated shell completion files for zsh, bash, fish, and Powershell, which you may want to also install during the packaging -process.

      -

      You can also find a nightly build in the releases page, built every day at 00:00 UTC off of the master branch.

      -

      Building manually

      -

      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
-
      -

      You'll then want to build with:

      -
      cargo build --release --locked
-
      -

      Completion files are automatically generated during this process, and are located in the directory target/release/build/bottom-<gibberish>/out. Note there may be multiple folders that look like target/release/build/bottom-<gibberish>. To programmatically determine which is the right folder, you might want to use something like:

      -
      $(ls target/release/build/bottom-*/out/btm.bash | head -n1 | xargs dirname)
-
      -

      You may find the Arch package install script template useful as a reference.

      -

      Adding an installation source

      -

      Once you've finished your installation source, if you want to mention it in the main bottom repo, fork the repo and add the installation method and any details to -the README.md file under the Installation section. -Once that's done, open a pull request - these will usually be approved of very quickly.

      -

      You can find more info on the contribution process here.

      - - - - + bottom + + +
      + + +
      + + + + +
      +
      + ClementTsang/bottom +
      +       +
      + +
        - -
      + + + + + + +
    82. + + Home + +
      83. + + + + + + + + + + +
    83. + + Support + +
      84. + + + + + + + + + + + +
    84. + + + + + + + + + + +
      85. + + + + + + + + + + + +
    85. + + + + + + + + + + +
      86. + + + + + + + + + + + + + +
    86. + + + + + + + + + + +
      87. + + + + + + + + + + +
    87. + + Troubleshooting + +
      88. + + + + + +
      - - - - Back to top - - - - - -
      - -
      + + + + + + Back to top + + + + + + + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/index.html b/0.6.4/index.html index 3776f922..c4b2d74a 100644 --- a/0.6.4/index.html +++ b/0.6.4/index.html @@ -1,974 +1,1037 @@ - - - - - - - - - - - - - - - - - - - - - Home - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - + + + +
      -
    88. - - Home - -
      89. - - - - - -
    89. - - Support - -
      90. - - - - + - - - -
      -
      - - - -
      -
      -
      - - - +
    90. + + Home + +
      91. -
      + - - - - - - - -
    91. - - Basic Mode - -
      92. - - - - - - - - - - - +
      +
      - - - - -
    92. - - - - - - - - - - -
      93. - + -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - - - -

      bottom

      -

      This site serves as extended documentation for bottom alongside the README.md.

      -
      -

      Warning

      -

      Some areas of this documentation are still in progress. Feel free to suggest/contribute changes!

      -
      -

      Installation

      -
      -

      Tip

      -

      It's probably a good idea to first check out the Support page to see if your system is officially supported!

      -
      -
      -

      Tip

      -

      If you're facing some issues during/after installation, check the Troubleshooting page for some common problems and solutions.

      -
      -

      To install bottom, refer to the installation section of the README.md, -which contains a list of all the installation methods.

      -

      Contribution

      -

      New contributors are always welcome! See the contribution section for how to help contribute to -bottom, whether it be filing issues or creating pull requests.

      - - - - - - + bottom + + +
      + + +
      + + + + +
      +
      + ClementTsang/bottom +
      +       +
      + +
        - -
      + + + + + + + + +
    93. + + + + + + + + + + + Home + + + + + +
      94. + + + + + + + + + + +
    94. + + Support + +
      95. + + + + + + + + + + + +
    95. + + + + + + + + + + +
      96. + + + + + + + + + + + +
    96. + + + + + + + + + + +
      97. + + + + + + + + + + + +
    97. + + + + + + + + + + +
      98. + + + + + + + + + + +
    98. + + Troubleshooting + +
      99. + + + + + +
      - - - - Back to top - - - - - -
      - -
      + + + + + + Back to top + + + + + + + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/support/index.html b/0.6.4/support/index.html index 094b6032..76b748db 100644 --- a/0.6.4/support/index.html +++ b/0.6.4/support/index.html @@ -1,1084 +1,1155 @@ - - - - - - - - - - - - - - - - - - - - - Support - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - - - - -
      -
      - - - -
      -
      -
      - - - - - -
      -
      -
      - - - -
      -
      -
      - -
      - - - - - - - - -
    99. - - Unofficial support - - - - -
      100. - - - - -
      -
      -
      - - -
      -
      - - - - + + + +
      +
      + + + +
      +
      +
      + + + + + +
      + + + + + + +
    100. + + Home + +
      101. + + + + + + + + + + + + +
    101. + + + + + + + + + + + Support + + + + + +
      102. + + + + + + + + + + + +
    102. + + + + + + + + + + +
      103. + + + + + + + + + + + +
    103. + + + + + + + + + + +
      104. + + + + + + + + + + + +
    104. + + + + + + + + + + +
      105. + + + + + + + + + + +
    105. + + Troubleshooting + +
      106. + + + + + +
      - - - - Back to top - - - - - -
      - - + +
      +
      +
      + + + Made with + + Material for MkDocs + + + +
      + +
      - - +
      + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/troubleshooting/index.html b/0.6.4/troubleshooting/index.html index 7174f8a4..5a4a518d 100644 --- a/0.6.4/troubleshooting/index.html +++ b/0.6.4/troubleshooting/index.html @@ -1,1094 +1,1191 @@ - - - - - - - - - - - - - - - - - - - - - Troubleshooting - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - - - - -
      -
      - - - -
      -
      -
      - - - - - - -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - + + + +
      +
      + + + +
      +
      +
      + + + + + +
      + + + + + + +
    106. + + Home + +
      107. + + + + + + + + + + +
    107. + + Support + +
      108. + + + + + + + + + + + +
    108. + + + + + + + + + + +
      109. + + + + + + + + + + + +
    109. + + + + + + + + + + +
      110. + + + + + + + + + + + +
    110. + + + + + + + + + + +
      111. + + + + + + + + + + + + +
    111. + + + + + + + + + + + Troubleshooting + + + + + +
      112. + + + + + +
      - - - - Back to top - - - - - - + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/usage/basic-mode/index.html b/0.6.4/usage/basic-mode/index.html index d348a572..df03544b 100644 --- a/0.6.4/usage/basic-mode/index.html +++ b/0.6.4/usage/basic-mode/index.html @@ -1,980 +1,1051 @@ - - - - - - - - - - - - - - - - - - - - - Basic Mode - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      -
      + +
      -
    112. - - Support - -
      113. - - - - - - - - - - -
    113. - - Usage - -
      114. - - - - - + - - - -
      -
      - - - -
      -
      -
      - - - +
    114. + + Home + +
      115. -
      + - - - - - - - - - -
    115. - - - - - - - - - - - Basic Mode - - - - - -
      116. - - - - - - - - - - - +
      +
      - - - - -
    116. - - - - - - - - - - -
      117. - + -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - - - -

      Basic Mode

      -

      Basic mode is a special layout that removes all of the graphs and provides an interface that resembles (a very stripped-down version of) htop.

      -
      - A picture of bottom's basic mode. -
      + bottom + -

      Basic mode can be enabled either through a command line flag:

      -
      btm -b
+                
      
+
+                  
+                    
      
+
+                      
+                        
+                      
+                    
      
+                    
      
+                      ClementTsang/bottom
+                    
      
+                        
+                
      
+
+                
+              
+
      +
      +
      + + + +
      +
      +
      + + +
      +
      +
      + + +
      +
      + + + + + + + + + +

      Basic Mode

      +

      Basic mode is a special layout that removes all of the graphs and provides an interface that resembles (a + very stripped-down version of) htop.

      +
      + A picture of bottom's basic mode. +
      + +

      Basic mode can be enabled either through a command line flag:

      +
      + 
      btm -b
 
 # or
 
 btm --basic
-
      -

      or through the config:

      -
      [flags]
+
      +
      +

      or through the config:

      +
      + 
      [flags]
 basic = true
-
      -

      Notes

      -

      In this mode, widgets that use tables (temperatures, processes, disks, and batteries) are only shown one at a time. -One can switch between these widgets either by clicking the arrow buttons or by using the general widget selection shortcuts (for example, Ctrl+Left or H) -to switch which widget is shown.

      -

      Also note that in this mode, widget expansion and custom layouts are disabled.

      -

      Key bindings

      -

      Basic mode follows the same key bindings as normal, barring widget expansion being disabled, and that the % key while selecting the memory widget toggles between total usage and percentage.

      - - - - +       +
      +

      Notes

      +

      In this mode, widgets that use tables (temperatures, processes, disks, and batteries) are only shown one + at a time. + One can switch between these widgets either by clicking the arrow buttons or by using the general widget + selection shortcuts (for example, Ctrl+Left or H) + to switch which widget is shown.

      +

      Also note that in this mode, widget expansion and custom layouts are disabled.

      +

      Key bindings

      +

      Basic mode follows the same key bindings as normal, barring widget expansion being disabled, and that the + % key while selecting the memory widget toggles between total usage + and percentage.

      - - -
      + + + + + + - - - - Back to top - - - - - - + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/usage/general-usage/index.html b/0.6.4/usage/general-usage/index.html index 268877c3..062afb22 100644 --- a/0.6.4/usage/general-usage/index.html +++ b/0.6.4/usage/general-usage/index.html @@ -1,1122 +1,1221 @@ - - - - - - - - - - - - - - - - - - - - - General Usage - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      -
      - - - - - - - -
    117. - - Memory Widget - -
      118. - +
      - - - - - - - -
    118. - - Network Widget - -
      119. - - - - - - - - -
    119. - - Process Widget - -
      120. - - - - - - - - -
    120. - - Disk Widget - -
      121. - - - - - - - - -
    121. - - Temperature Widget - -
      122. - - - - - - - - -
    122. - - Battery Widget - -
      123. - + - - - - - - - - - - -
    123. - - Basic Mode - -
      124. - - - - - - - - - - - - - - - - - - -
    124. - - - - - - - - - - -
      125. - - - - - - - - - - - -
    125. - - - - - - - - - - -
      126. - - - - - - - - - - -
    126. - - Troubleshooting - -
      127. - - - - - -
      - - - - - -
      -
      -
      - -
      - - - -
    127. - - Key bindings - - -
      128. - -
    128. - - Mouse bindings - - -
      129. - - - - -
      -
      - - - -
      -
      - - - - + + + +
      +
      + + + +
      +
      +
      + + + + + + +
      +
      +
      + + + +
      +
      +
      + + +
      +
      +
      + + +
      +
      + + + + + + + + + +

      General Usage

      +

      You can run bottom with:

      +
      + 
      btm
+
      +
      +

      For help regarding the command-line flags, use:

      +
      + 
      # For a simple overview of flags
 btm -h
 
 # For more details
 btm --help
-
      -

      Features

      -

      Expansion

      -

      By default, bottom is somewhat like a dashboard - a bunch of different widgets, all showing different things, and they all cram together to fit into one terminal.

      -

      If you instead just want to see one widget - maybe you want to look at a graph in more detail, for example - you can "expand" the currently selected -widget using the e key, which will hide all other widgets and make that widget take up all available terminal space.

      -

      You can leave this state by either pressing e again or pressing Esc.

      -

      Widget selection

      -

      To allow for widget-specific keybindings and expansion, there is the idea of widget selection in bottom, where you can focus on a specific widget to work with it. -This can be done with the mouse (just click on the widget of interest) or keyboard (ex: Ctrl+Direction, see Key bindings for alternatives).

      -

      Key bindings

      -

      These are global or common keyboard shortcuts for the application, which you can see in-app through the ? shortcut. -Note that key bindings are generally case-sensitive.

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      BindingAction
      q , Ctrl+cQuit
      EscClose dialog windows, search, widgets, or exit expanded mode
      Ctrl+rReset display and any collected data
      fFreeze/unfreeze updating with new data
      ?Open help menu
      eToggle expanding the currently selected widget
      Ctrl+Up
      Shift+Up
      K
      W      		Select the widget above
      Ctrl+Down
      Shift+Down
      J
      S      		Select the widget below
      Ctrl+Left
      Shift+Left
      H
      A      		Select the widget on the left
      Ctrl+Right
      Shift+Right
      L
      D      		Select the widget on the right
      Up , kMove up within a widget
      Down , jMove down within a widget
      Left
      h
      Alt+h      		Move left within a widget
      Right
      l
      Alt+l      		Move right within a widget
      g+g , HomeJump to the first entry
      G , EndJump to the last entry
      -

      Mouse bindings

      - - - - - - - - - - - - - -
      BindingAction
      Left ButtonSelects the widget
      - - - - +       +
      +

      Features

      +

      Expansion

      +

      By default, bottom is somewhat like a dashboard - a bunch of different widgets, all showing different + things, and they all cram together to fit into one terminal.

      +

      If you instead just want to see one widget - maybe you want to look at a graph in more detail, + for example - you can "expand" the currently selected + widget using the e key, which will hide all other + widgets and make that widget take up all available terminal space.

      +

      You can leave this state by either pressing e again or + pressing Esc.

      +

      Widget selection

      +

      To allow for widget-specific keybindings and expansion, there is the idea of widget selection in + bottom, where you can focus on a specific widget to work with it. + This can be done with the mouse (just click on the widget of interest) or keyboard (ex: Ctrl+Direction, see Key bindings for alternatives).

      +

      Key bindings

      +

      These are global or common keyboard shortcuts for the application, which you can see in-app through the + ? shortcut. + Note that key bindings are generally case-sensitive.

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      BindingAction
      q , Ctrl+cQuit
      EscClose dialog windows, search, widgets, or exit expanded mode
      Ctrl+rReset display and any collected data
      fFreeze/unfreeze updating with new data
      ?Open help menu
      eToggle expanding the currently selected widget
      Ctrl+Up
      Shift+Up
      + K
      W      		Select the widget above
      Ctrl+Down
      Shift+Down
      + J
      S      		Select the widget below
      Ctrl+Left
      Shift+Left
      + H
      A      		Select the widget on the left
      Ctrl+Right
      Shift+Right +
      L
      D      		Select the widget on the right
      Up , kMove up within a widget
      Down , jMove down within a widget
      Left
      h
      Alt+h      		Move left within a widget
      Right
      l
      Alt+l      		Move right within a widget
      g+g , + HomeJump to the first entry
      G , EndJump to the last entry
      +

      Mouse bindings

      + + + + + + + + + + + + + +
      BindingAction
      Left ButtonSelects the widget
      - -
      -
      + + + + + + - - - - Back to top - - - - - - + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/usage/widgets/battery/index.html b/0.6.4/usage/widgets/battery/index.html index 22619153..7417491f 100644 --- a/0.6.4/usage/widgets/battery/index.html +++ b/0.6.4/usage/widgets/battery/index.html @@ -1,1027 +1,1095 @@ - - - - - - - - - - - - - - - - - - - - - Battery Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - + + + +
      -
    129. - - Home - -
      130. - - - - - -
    130. - - Support - -
      131. - - - - - - + - - - -
      -
      - - - -
      -
      -
      - - - -
      + - - - - - - - -
    131. - - Basic Mode - -
      132. - - - - - - - - - - - +
      +
      - - - - -
    132. - - - - - - - - - - -
      133. - + -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - - - -

      Battery Widget

      -
      -

      Warning

      -

      The battery features are unavailable if the binary is compiled with the battery feature disabled!

      -
      -

      The battery widget provides information about batteries on the system.

      -
      - A picture of an expanded battery widget. -
      + bottom + -

      The battery widget can be enabled through either the --battery flag, the battery = true option in a config file, or specifying the widget in a custom layout.

      -

      Features

      -

      The following data is displayed for batteries:

      -
        -
      • Charge percent
        • -
      • Consumption
        • -
      • Time to empty/charge, based on the current state
        • -
      • Battery health percent
        • -
      -

      The battery widget also supports devices with multiple batteries, and you can switch between them using the keyboard or the mouse.

      -

      Key bindings

      -

      Note that key bindings are generally case-sensitive.

      - - - - - - - - - - - - - - - - - -
      BindingAction
      Left
      h
      Alt+h      		Moves to the battery entry to the left of the current one
      Right
      l
      Alt+l      		Moves to the battery entry to the right of the current one
      -

      Mouse bindings

      - - - - - - - - - - - - - -
      BindingAction
      Left ButtonSelects a battery entry
      - - - - +
      + + +
      + + + + +
      +
      + ClementTsang/bottom +
      +       +
      + +
        - -
      + + + + + + +
    133. + + Home + +
      134. + + + + + + + + + + +
    134. + + Support + +
      135. + + + + + + + + + + + + + +
    135. + + + + + + + + + + +
      136. + + + + + + + + + + + +
    136. + + + + + + + + + + +
      137. + + + + + + + + + + + +
    137. + + + + + + + + + + +
      138. + + + + + + + + + + +
    138. + + Troubleshooting + +
      139. + + + + + +
      - - - - Back to top - - - - - -
      - -
      + + + + + + Back to top + + + + + + + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/usage/widgets/cpu/index.html b/0.6.4/usage/widgets/cpu/index.html index 90351411..a2c4eb09 100644 --- a/0.6.4/usage/widgets/cpu/index.html +++ b/0.6.4/usage/widgets/cpu/index.html @@ -1,1154 +1,1224 @@ - - - - - - - - - - - - - - - - - - - - - CPU Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - - - - -
      -
      - - - -
      -
      -
      - - - - - - -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - - - -

      CPU Widget

      -

      The CPU widget displays a visual representation of CPU usage over a time range.

      -
      - A picture of an expanded CPU widget showing average CPU usage. -
      + bottom + -

      Features

      -

      The CPU widget is composed of two parts: the graph and the legend:

      -
        -
      • The graph displays the usage data for the currently selected entry as a percentage
        • -
      • The legend displays all available entries that can be displayed on the graph along with their last recorded use percentage (except for the "All" option)
        • -
      -

      Users can scroll through the legend using either the keyboard or mouse to select which entry to display on the graph. The "All" option shows every entry -at the same time, though this may get a bit hard to follow if you have a large number of cores/threads.

      -

      One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

      -

      Key bindings

      -

      Note that key bindings are generally case-sensitive.

      -

      Graph

      - - - - - - - - - - - - - - - - - - - - - -
      BindingAction
      +Zoom in on chart (decrease time range)
      -Zoom out on chart (increase time range)
      =Reset zoom
      -

      Legend

      - - - - - - - - - - - - - - - - - - - - - - - - - -
      BindingAction
      Up , kMove up within a widget
      Down , jMove down within a widget
      g+g , HomeJump to the first entry in the legend
      G , EndJump to the last entry in the legend
      -

      Mouse bindings

      -

      Graph

      - - - - - - - - - - - - - -
      BindingAction
      ScrollScrolling up or down zooms in or out of the graph respectively
      -

      Legend

      - - - - - - - - - - - - - - - - - -
      BindingAction
      ScrollScroll through options to display in the graph
      Left ButtonSelects a CPU thread/average to show in the graph
      - - - - +
      + + +
      + + + + +
      +
      + ClementTsang/bottom +
      +       +
      + +
        - -
      + + + + + + +
    139. + + Home + +
      140. + + + + + + + + + + +
    140. + + Support + +
      141. + + + + + + + + + + + + + +
    141. + + + + + + + + + + +
      142. + + + + + + + + + + + +
    142. + + + + + + + + + + +
      143. + + + + + + + + + + + +
    143. + + + + + + + + + + +
      144. + + + + + + + + + + +
    144. + + Troubleshooting + +
      145. + + + + + +
      - - - - Back to top - - - - - - + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/usage/widgets/disk/index.html b/0.6.4/usage/widgets/disk/index.html index 0493930d..20f6d914 100644 --- a/0.6.4/usage/widgets/disk/index.html +++ b/0.6.4/usage/widgets/disk/index.html @@ -1,1032 +1,1098 @@ - - - - - - - - - - - - - - - - - - - - - Disk Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - + + + +
      -
    145. - - Home - -
      146. - - - - - -
    146. - - Support - -
      147. - - - - - - + - - - -
      -
      - - - -
      -
      -
      - - - -
      + - - - - - - - -
    147. - - Basic Mode - -
      148. - - - - - - - - - - - +
      +
      - - - - -
    148. - - - - - - - - - - -
      149. - + -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - - - -

      Disk Widget

      -

      The disk widget provides a table of useful disk and partition information, like I/O per second and total usage.

      -
      - A picture of an expanded disk widget. -
      + bottom + -

      Features

      -

      The disk widget provides the following information:

      -
        -
      • Disk name
        • -
      • Disk mount location
        • -
      • Percentage of space used
        • -
      • Amount of space left
        • -
      • Total amount of space
        • -
      • Read per second
        • -
      • Write per second
        • -
      -

      Key bindings

      -

      Note that key bindings are generally case-sensitive.

      - - - - - - - - - - - - - - - - - - - - - - - - - -
      BindingAction
      Up , kMove up within a widget
      Down , jMove down within a widget
      g+g , HomeJump to the first entry in the table
      G , EndJump to the last entry in the table
      -

      Mouse bindings

      - - - - - - - - - - - - - -
      BindingAction
      Left ButtonSelects an entry in the table
      - - - - +
      + + +
      + + + + +
      +
      + ClementTsang/bottom +
      +       +
      + +
        - -
      + + + + + + +
    149. + + Home + +
      150. + + + + + + + + + + +
    150. + + Support + +
      151. + + + + + + + + + + + + + +
    151. + + + + + + + + + + +
      152. + + + + + + + + + + + +
    152. + + + + + + + + + + +
      153. + + + + + + + + + + + +
    153. + + + + + + + + + + +
      154. + + + + + + + + + + +
    154. + + Troubleshooting + +
      155. + + + + + +
      - - - - Back to top - - - - - -
      - -
      + + + + + + Back to top + + + + + + + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/usage/widgets/memory/index.html b/0.6.4/usage/widgets/memory/index.html index 307d9742..ea0557fe 100644 --- a/0.6.4/usage/widgets/memory/index.html +++ b/0.6.4/usage/widgets/memory/index.html @@ -1,1040 +1,1109 @@ - - - - - - - - - - - - - - - - - - - - - Memory Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - + + + +
      -
    155. - - Home - -
      156. - - - - - -
    156. - - Support - -
      157. - - - - - - + - - - -
      -
      - - - -
      -
      -
      - - - -
      + - - - - - - - -
    157. - - Basic Mode - -
      158. - - - - - - - - - - - +
      +
      - - - - -
    158. - - - - - - - - - - -
      159. - + -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - - - -

      Memory Widget

      -

      The memory widget provides a visual representation of RAM and swap usage over time.

      -
      - A picture of an expanded memory widget. -
      + bottom + -

      Features

      -

      The legend displays the current usage in terms of percentage and actual usage in binary units (KiB, MiB, GiB, etc.). -If the total RAM or swap available is 0, then it is automatically hidden from the legend and graph.

      -

      One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

      -

      Key bindings

      -

      Note that key bindings are generally case-sensitive.

      - - - - - - - - - - - - - - - - - - - - - -
      BindingAction
      +Zoom in on chart (decrease time range)
      -Zoom out on chart (increase time range)
      =Reset zoom
      -

      Mouse bindings

      - - - - - - - - - - - - - -
      BindingAction
      ScrollScrolling up or down zooms in or out of the graph respectively
      -

      Calculations

      -

      Memory usage is calculated using the following formula based on values from /proc/meminfo (based on htop's implementation):

      -
      MemTotal - MemFree - Buffers - (Cached + SReclaimable - Shmem)
-
      -

      You can find more info on /proc/meminfo and its fields here.

      - - - - +
      + + +
      + + + + +
      +
      + ClementTsang/bottom +
      +       +
      + +
        - -
      + + + + + + +
    159. + + Home + +
      160. + + + + + + + + + + +
    160. + + Support + +
      161. + + + + + + + + + + + + + +
    161. + + + + + + + + + + +
      162. + + + + + + + + + + + +
    162. + + + + + + + + + + +
      163. + + + + + + + + + + + +
    163. + + + + + + + + + + +
      164. + + + + + + + + + + +
    164. + + Troubleshooting + +
      165. + + + + + +
      - - - - Back to top - - - - - -
      - -
      + + + + + + Back to top + + + + + + + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/usage/widgets/network/index.html b/0.6.4/usage/widgets/network/index.html index 8d193b6d..c54f6bbd 100644 --- a/0.6.4/usage/widgets/network/index.html +++ b/0.6.4/usage/widgets/network/index.html @@ -1,1024 +1,1091 @@ - - - - - - - - - - - - - - - - - - - - - Network Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - + + + +
      -
    165. - - Home - -
      166. - - - - - -
    166. - - Support - -
      167. - - - - - - + - - - -
      -
      - - - -
      -
      -
      - - - -
      + - - - - - - - -
    167. - - Basic Mode - -
      168. - - - - - - - - - - - +
      +
      - - - - -
    168. - - - - - - - - - - -
      169. - + -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - - - -

      Network Widget

      -

      The network widget provides a visual representation of network input and output per second, as well as noting the total amount -received and transmitted.

      -
      - A picture of an expanded network widget. -
      + bottom + -

      Features

      -

      The legend displays the current reads and writes per second in bits, as well as the total amount read/written.

      -

      The y-axis automatically scales based on shown read/write values, and by default, is a linear scale based on base-10 units (e.x. kilobit, gigabit, etc.). -Through configuration, the read/write per second unit can be changed to bytes, while the y-axis can be changed to a -log scale and/or use base-2 units (e.x. kibibit, gibibit, etc.).

      -

      One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

      -

      Key bindings

      -

      Note that key bindings are generally case-sensitive.

      - - - - - - - - - - - - - - - - - - - - - -
      BindingAction
      +Zoom in on chart (decrease time range)
      -Zoom out on chart (increase time range)
      =Reset zoom
      -

      Mouse bindings

      - - - - - - - - - - - - - -
      BindingAction
      ScrollScrolling up or down zooms in or out of the graph respectively
      - - - - +
      + + +
      + + + + +
      +
      + ClementTsang/bottom +
      +       +
      + +
        - -
      + + + + + + +
    169. + + Home + +
      170. + + + + + + + + + + +
    170. + + Support + +
      171. + + + + + + + + + + + + + +
    171. + + + + + + + + + + +
      172. + + + + + + + + + + + +
    172. + + + + + + + + + + +
      173. + + + + + + + + + + + +
    173. + + + + + + + + + + +
      174. + + + + + + + + + + +
    174. + + Troubleshooting + +
      175. + + + + + +
      - - - - Back to top - - - - - -
      - -
      + + + + + + Back to top + + + + + + + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/usage/widgets/process/index.html b/0.6.4/usage/widgets/process/index.html index 01543692..d1785ead 100644 --- a/0.6.4/usage/widgets/process/index.html +++ b/0.6.4/usage/widgets/process/index.html @@ -1,1688 +1,1808 @@ - - - - - - - - - - - - - - - - - - - - - Process Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - - - - -
      -
      - - - -
      -
      -
      - - - - - -
      -
      -
      - - - -
      -
      -
      - -
      - - - - - - - - -
    175. - - Key bindings - - - - -
      176. - -
    176. - - Mouse bindings - - - - -
      177. - - - - -
      -
      -
      - - -
      -
      - - - - + + + +
      +
      + + + +
      +
      +
      + + + + + +
      + + + + + + +
    177. + + Home + +
      178. + + + + + + + + + + +
    178. + + Support + +
      179. + + + + + + + + + + + + + +
    179. + + + + + + + + + + +
      180. + + + + + + + + + + + +
    180. + + + + + + + + + + +
      181. + + + + + + + + + + + +
    181. + + + + + + + + + + +
      182. + + + + + + + + + + +
    182. + + Troubleshooting + +
      183. + + + + + +
      - - - - Back to top - - - - - -
      - - + +
      +
      +
      + + + Made with + + Material for MkDocs + + + +
      + +
      - - +
      + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.4/usage/widgets/temperature/index.html b/0.6.4/usage/widgets/temperature/index.html index 659430b7..7f7af3eb 100644 --- a/0.6.4/usage/widgets/temperature/index.html +++ b/0.6.4/usage/widgets/temperature/index.html @@ -1,1023 +1,1088 @@ - - - - - - - - - - - - - - - - - - - - - Temperature Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
      - -
      - - -
      - - -
      - -
      - - - - - - + + + +
      -
    183. - - Home - -
      184. - - - - - -
    184. - - Support - -
      185. - - - - - - + - - - -
      -
      - - - -
      -
      -
      - - - -
      + - - - - - - - -
    185. - - Basic Mode - -
      186. - - - - - - - - - - - +
      +
      - - - - -
    186. - - - - - - - - - - -
      187. - + -
      -
      -
      - - - -
      -
      -
      - - -
      -
      -
      - - -
      -
      - - - - - - -

      Temperature Widget

      -

      The temperature widget provides a table of temperature sensors and their current temperature.

      -
      - A picture of an expanded temperature widget. -
      + bottom + -

      Features

      -

      The temperature widget provides the sensor name as well as its current temperature.

      -

      Key bindings

      -

      Note that key bindings are generally case-sensitive.

      - - - - - - - - - - - - - - - - - - - - - - - - - -
      BindingAction
      Up , kMove up within a widget
      Down , jMove down within a widget
      g+g , HomeJump to the first entry in the table
      G , EndJump to the last entry in the table
      -

      Mouse bindings

      - - - - - - - - - - - - - -
      BindingAction
      Left ButtonSelects an entry in the table
      - - - - +
      + + +
      + + + + +
      +
      + ClementTsang/bottom +
      +       +
      + +
        - -
      + + + + + + +
    187. + + Home + +
      188. + + + + + + + + + + +
    188. + + Support + +
      189. + + + + + + + + + + + + + +
    189. + + + + + + + + + + +
      190. + + + + + + + + + + + +
    190. + + + + + + + + + + +
      191. + + + + + + + + + + + +
    191. + + + + + + + + + + +
      192. + + + + + + + + + + +
    192. + + Troubleshooting + +
      193. + + + + + +
      - - - - Back to top - - - - - -
      - -
      + + + + + + Back to top + + + + + + + - - - -
      -
      -
      - - - - - - - - \ No newline at end of file +
      +
      +
      + + + + + + + + + diff --git a/0.6.5/404.html b/0.6.5/404.html index 4efe85a7..88077840 100644 --- a/0.6.5/404.html +++ b/0.6.5/404.html @@ -1,869 +1,926 @@ - - - - - - - - - - - - - - - - - - - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + - - - - - - - - - - - - - - - - - - - - - - -
      - -
      -
      - -
      - - -
      - - -
      - -
      - - - - - - - - - -
      -
      - - - -
      -
      -
      - - - - - - -
      + +
      +
      +
      +
      + Initializing search
      +
        - - - -
        -
        - -

        404 - Not found

        - - -
        +
        - - - - Back to top - - -
        - - - - -
        -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/configuration/command-line-flags/index.html b/0.6.5/configuration/command-line-flags/index.html index 9f9e65ef..8c223d30 100644 --- a/0.6.5/configuration/command-line-flags/index.html +++ b/0.6.5/configuration/command-line-flags/index.html @@ -1,1053 +1,1115 @@ - - - - - - - - - - - - - - - - - - - - - Command-line Flags - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - + + + +
        -
      1. - - Home - -
        2. - - - - - -
      2. - - Support - -
        3. - - - - + - - - -
        -
        - - - -
        -
        -
        - - - -
        + - - - - - - - -
      3. - - Basic Mode - -
        4. - - - - - - - - - - - +
        +
        - - - - - - -
      4. - - - - - - - - - - -
        5. - + -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - - - -

        Command-line Flags

        -
        -

        Warning

        -

        This section is in progress, and is just copied from the old documentation.

        -
        -

        The following flags can be provided to bottom in the command line to change the behaviour of the program (run btm --help for more information on each flag):

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        FlagBehaviour
        --autohide_timeTemporarily shows the time scale in graphs.
        -b, --basicHides graphs and uses a more basic look.
        --batteryShows the battery widget.
        -S, --case_sensitiveEnables case sensitivity by default.
        -c, --celsiusSets the temperature type to Celsius.
        --color <COLOR SCHEME>Use a color scheme, use --help for supported values.
        -C, --config <CONFIG PATH>Sets the location of the config file.
        -u, --current_usageSets process CPU% to be based on current CPU%.
        -t, --default_time_value <MS>Default time value for graphs in ms.
        --default_widget_count <INT>Sets the n'th selected widget type as the default.
        --default_widget_type <WIDGET TYPE>Sets the default widget type, use --help for more info.
        --disable_advanced_killHides advanced options to stop a process on Unix-like systems.
        --disable_clickDisables mouse clicks.
        -m, --dot_markerUses a dot marker for graphs.
        -f, --fahrenheitSets the temperature type to Fahrenheit.
        -g, --groupGroups processes with the same name by default.
        -h, --helpPrints help information. Use --help for more info.
        -a, --hide_avg_cpuHides the average CPU usage.
        --hide_table_gapHides the spacing between table headers and entries.
        --hide_timeHides the time scale.
        -k, --kelvinSets the temperature type to Kelvin.
        -l, --left_legendPuts the CPU chart legend to the left side.
        --mem_as_valueDefaults to showing process memory usage by value.
        --network_use_binary_prefixDisplays the network widget with binary prefixes.
        --network_use_bytesDisplays the network widget using bytes.
        --network_use_logDisplays the network widget with a log scale.
        --process_commandShow processes as their commands by default.
        -r, --rate <MS>Sets a refresh rate in ms.
        -R, --regexEnables regex by default.
        --show_table_scroll_positionShows the scroll position tracker in table widgets.
        -d, --time_delta <MS>The amount in ms changed upon zooming.
        -T, --treeDefaults to showing the process widget in tree mode.
        --use_old_network_legendDEPRECATED - uses the older network legend.
        -V, --versionPrints version information.
        -W, --whole_wordEnables whole-word matching by default.
        - - - - + bottom + + +
        + + +
        + + + + +
        +
        + ClementTsang/bottom +
        +         +
        + +
          - -
        + + + + + + +
      5. + + Home + +
        6. + + + + + + + + + + +
      6. + + Support + +
        7. + + + + + + + + + + + +
      7. + + + + + + + + + + +
        8. + + + + + + + + + + + + + +
      8. + + + + + + + + + + +
        9. + + + + + + + + + + + +
      9. + + + + + + + + + + +
        10. + + + + + + + + + + +
      10. + + Troubleshooting + +
        11. + + + + + +
        - - - - Back to top - - - - - -
        - -
        + + + + + + Back to top + + + + + + + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/configuration/config-file/data-filtering/index.html b/0.6.5/configuration/config-file/data-filtering/index.html index 99f2bf84..da35c43a 100644 --- a/0.6.5/configuration/config-file/data-filtering/index.html +++ b/0.6.5/configuration/config-file/data-filtering/index.html @@ -1,891 +1,961 @@ - - - - - - - - - - - - - - - - - - - - - Data Filtering - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        -
        + +
        -
      11. - - Support - -
        12. - - - - - - - - -
      12. - - Usage - -
        13. - - - - - - - + - - - -
        -
        - - - -
        -
        -
        - - - +
      13. + + Home + +
        14. -
        + - - - - - - - -
      14. - - Basic Mode - -
        15. - - - - - - - - - - - +
        +
        - - - - - - -
      15. - - - - - - - - - - -
        16. - + -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - - - -

        Data Filtering

        -
        -

        Warning

        -

        This section is in progress, and is just copied from the old documentation.

        -
        -

        You can hide specific disks, temperature sensors, and networks by name in the config file via disk_filter and mount_filter, temp_filter, and net_filter respectively. Regex (regex = true), case-sensitivity (case_sensitive = true), and matching only if the entire word matches (whole_word = true) are supported, but are off by default. Filters default to denying entries that match and can be toggled by setting is_list_ignored to false in the config file.

        -

        For example, here's the disk widget with no filter:

        -

        Disk no filter

        -

        The following in the config file would filter out some entries by disk name:

        -
        [disk_filter]
+                  bottom
+                
+
+                
        
+
+                  
+                    
        
+
+                      
+                        
+                      
+                    
        
+                    
        
+                      ClementTsang/bottom
+                    
        
+                          
+                
        
+
+                
+              
+
        +
        +
        + + + +
        +
        +
        + + +
        +
        +
        + + +
        +
        + + + + + + + + + +

        Data Filtering

        +
        +

        Warning

        +

        This section is in progress, and is just copied from the old documentation.

        +
        +

        You can hide specific disks, temperature sensors, and networks by name in the config file via + disk_filter and mount_filter, temp_filter, and + net_filter respectively. Regex (regex = true), case-sensitivity + (case_sensitive = true), and matching only if the entire word matches + (whole_word = true) are supported, but are off by default. Filters default to denying entries + that match and can be toggled by setting is_list_ignored to false in the config + file.

        +

        For example, here's the disk widget with no filter:

        +

        Disk 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 widget with just disk name filter

        -

        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]
+
        +
        +

        Disk widget with just disk name filter

        +

        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
@@ -898,36 +968,42 @@
 regex = true
 case_sensitive = false
 whole_word = true
-
        -

        This gives us:

        -

        Disk widget with disk name and mount filter

        - - - - +         +
        +

        This gives us:

        +

        Disk widget with disk name and mount filter

        - - -
        + + + + + + - - - - Back to top - - - - - - + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/configuration/config-file/default-config/index.html b/0.6.5/configuration/config-file/default-config/index.html index 329f31be..6f272536 100644 --- a/0.6.5/configuration/config-file/default-config/index.html +++ b/0.6.5/configuration/config-file/default-config/index.html @@ -1,924 +1,990 @@ - - - - - - - - - - - - - - - - - - - - - Default Config - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - + + + +
        -
      16. - - Home - -
        17. - - - - - -
      17. - - Support - -
        18. - - - - + - - - -
        -
        - - - -
        -
        -
        - - - -
        + - - - - - - - -
      18. - - Basic Mode - -
        19. - - - - - - - - - - - +
        +
        - - - - - - -
      19. - - - - - - - - - - -
        20. - + -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - - - -

        Default Config

        -

        A default config file is automatically generated at the following locations that bottom checks by default:

        - - - - - - - - - - - - - - - - - - - - - -
        OSDefault Config Location
        macOS$HOME/Library/Application Support/bottom/bottom.toml
        ~/.config/bottom/bottom.toml
        $XDG_CONFIG_HOME/bottom/bottom.toml
        Linux~/.config/bottom/bottom.toml
        $XDG_CONFIG_HOME/bottom/bottom.toml
        WindowsC:\Users\<USER>\AppData\Roaming\bottom\bottom.toml
        -

        Furthermore, if a custom config path that does not exist is given (using -C or --config), bottom will attempt to create a default config file at that location.

        - - - - + bottom + + +
        + + +
        + + + + +
        +
        + ClementTsang/bottom +
        +         +
        + +
          - -
        + + + + + + +
      20. + + Home + +
        21. + + + + + + + + + + +
      21. + + Support + +
        22. + + + + + + + + + + + +
      22. + + + + + + + + + + +
        23. + + + + + + + + + + + + + +
      23. + + + + + + + + + + +
        24. + + + + + + + + + + + +
      24. + + + + + + + + + + +
        25. + + + + + + + + + + +
      25. + + Troubleshooting + +
        26. + + + + + +
        - - - - Back to top - - - - - -
        - -
        + + + + + + Back to top + + + + + + + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/configuration/config-file/flags/index.html b/0.6.5/configuration/config-file/flags/index.html index 44bf636f..76891400 100644 --- a/0.6.5/configuration/config-file/flags/index.html +++ b/0.6.5/configuration/config-file/flags/index.html @@ -1,1056 +1,1119 @@ - - - - - - - - - - - - - - - - - - - - - Flags - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - + + + +
        -
      26. - - Home - -
        27. - - - - - -
      27. - - Support - -
        28. - - - - + - - - -
        -
        - - - -
        -
        -
        - - - -
        + - - - - - - - -
      28. - - Basic Mode - -
        29. - - - - - - - - - - - +
        +
        - - - - - - -
      29. - - - - - - - - - - -
        30. - + -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - - - -

        Flags

        -
        -

        Warning

        -

        This section is in progress, and is just copied from the old documentation.

        -
        -

        Most of the command line flags have config file equivalents to avoid having to type them out each time:

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        FieldTypeFunctionality
        hide_avg_cpuBooleanHides the average CPU usage.
        dot_markerBooleanUses a dot marker for graphs.
        left_legendBooleanPuts the CPU chart legend to the left side.
        current_usageBooleanSets process CPU% to be based on current CPU%.
        group_processesBooleanGroups processes with the same name by default.
        case_sensitiveBooleanEnables case sensitivity by default.
        whole_wordBooleanEnables whole-word matching by default.
        regexBooleanEnables regex by default.
        basicBooleanHides graphs and uses a more basic look.
        use_old_network_legendBooleanDEPRECATED - uses the older network legend.
        batteryBooleanShows the battery widget.
        rateUnsigned Int (represents milliseconds)Sets a refresh rate in ms.
        default_time_valueUnsigned Int (represents milliseconds)Default time value for graphs in ms.
        time_deltaUnsigned Int (represents milliseconds)The amount in ms changed upon zooming.
        hide_timeBooleanHides the time scale.
        temperature_typeString (one of ["k", "f", "c", "kelvin", "fahrenheit", "celsius"])Sets the temperature unit type.
        default_widget_typeString (one of ["cpu", "proc", "net", "temp", "mem", "disk"], same as layout options)Sets the default widget type, use --help for more info.
        default_widget_countUnsigned Int (represents which default_widget_type)Sets the n'th selected widget type as the default.
        disable_clickBooleanDisables mouse clicks.
        colorString (one of ["default", "default-light", "gruvbox", "gruvbox-light", "nord", "nord-light"])Use a color scheme, use --help for supported values.
        mem_as_valueBooleanDefaults to showing process memory usage by value.
        treeBooleanDefaults to showing the process widget in tree mode.
        show_table_scroll_positionBooleanShows the scroll position tracker in table widgets.
        process_commandBooleanShow processes as their commands by default.
        disable_advanced_killBooleanHides advanced options to stop a process on Unix-like systems.
        network_use_binary_prefixBooleanDisplays the network widget with binary prefixes.
        network_use_bytesBooleanDisplays the network widget using bytes.
        network_use_logBooleanDisplays the network widget with a log scale.
        - - - - + bottom + + +
        + + +
        + + + + +
        +
        + ClementTsang/bottom +
        +         +
        + +
          - -
        + + + + + + +
      30. + + Home + +
        31. + + + + + + + + + + +
      31. + + Support + +
        32. + + + + + + + + + + + +
      32. + + + + + + + + + + +
        33. + + + + + + + + + + + + + +
      33. + + + + + + + + + + +
        34. + + + + + + + + + + + +
      34. + + + + + + + + + + +
        35. + + + + + + + + + + +
      35. + + Troubleshooting + +
        36. + + + + + +
        - - - - Back to top - - - - - -
        - -
        + + + + + + Back to top + + + + + + + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/configuration/config-file/layout/index.html b/0.6.5/configuration/config-file/layout/index.html index 8990a8dc..c482d66d 100644 --- a/0.6.5/configuration/config-file/layout/index.html +++ b/0.6.5/configuration/config-file/layout/index.html @@ -1,880 +1,938 @@ - - - - - - - - - - - - - - - - - - - - - Layout - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        -
        + +
        -
      36. - - Support - -
        37. - - - - - - - - -
      37. - - Usage - -
        38. - - - - - - - + - - - -
        -
        - - - -
        -
        -
        - - - +
      38. + + Home + +
        39. -
        + - - - - - - - -
      39. - - Basic Mode - -
        40. - - - - - - - - - - - +
        +
        - - - - - - -
      40. - - - - - - - - - - -
        41. - + -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - - - -

        Layout

        -
        -

        Warning

        -

        This section is in progress, and is just copied from the old documentation.

        -
        -

        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]]
+                  bottom
+                
+
+                
        
+
+                  
+                    
        
+
+                      
+                        
+                      
+                    
        
+                    
        
+                      ClementTsang/bottom
+                    
        
+                          
+                
        
+
+                
+              
+
        +
        +
        + + + +
        +
        +
        + + +
        +
        +
        + + +
        +
        + + + + + + + + + +

        Layout

        +
        +

        Warning

        +

        This section is in progress, and is just copied from the old documentation.

        +
        +

        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]]
@@ -888,88 +946,100 @@
         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. -The second column is split into two rows with a 1:1 ratio. The first is the temperature widget, the second is the disk widget.

        -

        This is what the layout would look like when run:

        -

        Sample layout

        -

        Each [[row]] represents a row in the layout. A row can have any number of child values. Each [[row.child]] -represents either a column or a widget. A column can have any number of child values as well. Each [[row.child.child]] -represents a widget. A widget is represented by having a type field set to a string.

        -

        The following type values are supported:

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        "cpu"CPU chart and legend
        "mem", "memory"Memory chart
        "net", "network"Network chart and legend
        "proc", "process", "processes"Process table and search
        "temp", "temperature"Temperature table
        "disk"Disk table
        "empty"An empty space
        "batt", "battery"Battery statistics
        -

        Each component of the layout accepts a ratio value. If this is not set, it defaults to 1.

        -

        Furthermore, you can have duplicate widgets.

        -

        For an example, look at the default config, which contains the default layout.

        - - - - +         +
        +

        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. + The second column is split into two rows with a 1:1 ratio. The first is the temperature widget, the second + is the disk widget.

        +

        This is what the layout would look like when run:

        +

        Sample layout

        +

        Each [[row]] represents a row in the layout. A row can have any number of + child values. Each [[row.child]] + represents either a column or a widget. A column can have any number of child values + as well. Each [[row.child.child]] + represents a widget. A widget is represented by having a type field set to a string. +

        +

        The following type values are supported:

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        "cpu"CPU chart and legend
        "mem", "memory"Memory chart
        "net", "network"Network chart and legend
        "proc", "process", "processes"Process table and search
        "temp", "temperature"Temperature table
        "disk"Disk table
        "empty"An empty space
        "batt", "battery"Battery statistics
        +

        Each component of the layout accepts a ratio value. If this is not set, it defaults to 1. +

        +

        Furthermore, you can have duplicate widgets.

        +

        For an example, look at the default + config, which contains the default layout.

        - - -
        + + + + + + - - - - Back to top - - - - - - + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/configuration/config-file/theming/index.html b/0.6.5/configuration/config-file/theming/index.html index c6738df6..9b1b995b 100644 --- a/0.6.5/configuration/config-file/theming/index.html +++ b/0.6.5/configuration/config-file/theming/index.html @@ -1,1012 +1,1076 @@ - - - - - - - - - - - - - - - - - - - - - Theming - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - + + + +
        -
      41. - - Home - -
        42. - - - - - -
      42. - - Support - -
        43. - - - - + - - - -
        -
        - - - -
        -
        -
        - - - -
        + - - - - - - - -
      43. - - Basic Mode - -
        44. - - - - - - - - - - - +
        +
        - - - - - - -
      44. - - - - - - - - - - -
        45. - + -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - - - -

        Theming

        -
        -

        Warning

        -

        This section is in progress, and is just copied from the old documentation.

        -
        -

        The config file can be used to set custom colours for parts of the application under the [colors] object. The following labels are customizable with strings that are hex colours, RGB colours, or specific named colours.

        -

        Supported named colours are one of the following strings: Reset, Black, Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed, LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White.

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        LabelsDetailsExample
        Table header coloursColour of table headerstable_header_color="255, 255, 255"
        CPU colour per coreColour of each core. Read in order.cpu_core_colors=["#ffffff", "white", "255, 255, 255"]
        Average CPU colourThe average CPU coloravg_cpu_color="White"
        All CPUs colourThe colour for the "All" CPU labelall_cpu_color="White"
        RAMThe colour RAM will useram_color="#ffffff"
        SWAPThe colour SWAP will useswap_color="#ffffff"
        RXThe colour rx will userx_color="#ffffff"
        TXThe colour tx will usetx_color="#ffffff"
        Widget title colourThe colour of the label each widget haswidget_title_color="#ffffff"
        Border colourThe colour of the border of unselected widgetsborder_color="#ffffff"
        Selected border colourThe colour of the border of selected widgetshighlighted_border_color="#ffffff"
        Text colourThe colour of most texttext_color="#ffffff"
        Graph colourThe colour of the lines and text of the graphgraph_color="#ffffff"
        Cursor colourThe cursor's colourcursor_color="#ffffff"
        Selected text colourThe colour of text that is selectedscroll_entry_text_color="#ffffff"
        Selected text background colourThe background colour of text that is selectedscroll_entry_bg_color="#ffffff"
        High battery level colourThe colour used for a high battery level (100% to 50%)high_battery_color="green"
        Medium battery level colourThe colour used for a medium battery level (50% to 10%)medium_battery_color="yellow"
        Low battery level colourThe colour used for a low battery level (10% to 0%)low_battery_color="red"
        - - - - + bottom + + +
        + + +
        + + + + +
        +
        + ClementTsang/bottom +
        +         +
        + +
          - -
        + + + + + + +
      45. + + Home + +
        46. + + + + + + + + + + +
      46. + + Support + +
        47. + + + + + + + + + + + +
      47. + + + + + + + + + + +
        48. + + + + + + + + + + + + + +
      48. + + + + + + + + + + +
        49. + + + + + + + + + + + +
      49. + + + + + + + + + + +
        50. + + + + + + + + + + +
      50. + + Troubleshooting + +
        51. + + + + + +
        - - - - Back to top - - - - - -
        - -
        + + + + + + Back to top + + + + + + + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/contribution/development/index.html b/0.6.5/contribution/development/index.html index ea86278d..2e25c656 100644 --- a/0.6.5/contribution/development/index.html +++ b/0.6.5/contribution/development/index.html @@ -1,978 +1,1039 @@ - - - - - - - - - - - - - - - - - - - - - Development - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - + + + +
        -
      51. - - Home - -
        52. - - - - - -
      52. - - Support - -
        53. - - - - + - - - -
        -
        - - - -
        -
        -
        - - - -
        + - - - - - - - -
      53. - - Basic Mode - -
        54. - - - - - - - - - - - +
        +
        - - - - -
      54. - - - - - - - - - - -
        55. - + -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        - + + + + + + +
      55. + + Home + +
        56. + + + + + + + + + + +
      56. + + Support + +
        57. + + + + + + + + + + + +
      57. + + + + + + + + + + +
        58. + + + + + + + + + + + +
      58. + + + + + + + + + + +
        59. + + + + + + + + + + + + + +
      59. + + + + + + + + + + +
        60. + + + + + + + + + + +
      60. + + Troubleshooting + +
        61. + + + + + +
        - - - - Back to top - - - - - -
        + + + + + + Back to top + + + + + + + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/contribution/documentation/index.html b/0.6.5/contribution/documentation/index.html index c552cfe1..81e4d5bd 100644 --- a/0.6.5/contribution/documentation/index.html +++ b/0.6.5/contribution/documentation/index.html @@ -1,1008 +1,1091 @@ - - - - - - - - - - - - - - - - - - - - - Documentation - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - + + + +
        -
      61. - - Home - -
        62. - - - - - -
      62. - - Support - -
        63. - - - - + - - - -
        -
        - - - -
        -
        -
        - - - -
        + - - - - - - - -
      63. - - Basic Mode - -
        64. - - - - - - - - - - - +
        +
        - - - - -
      64. - - - - - - - - - - -
        65. - + -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - - - -

        Documentation

        -

        When should documentation changes be done?

        -
          -
        • Whenever a new feature is added, a bug is fixed, or a breaking change is made, it should be documented where appropriate (ex: README.md, changelog, etc.)
          • -
        • New methods of installation are always appreciated and should be documented
          • -
        -

        What pages need documentation?

        -

        There are a few areas where documentation changes are often needed:

        - -

        How should I add documentation?

        -
          -
        1. -

          Fork the repository first and make changes there.

          -
          2. -
        2. -

          Where you're adding documentation will probably affect what you need to do:

          - -
            -
          • For changes to the help menu, try to refer to the existing code within src/constants.rs on how the help menu is generated.
            • -
          -
            -
          • -

            For changes to the extended documentation, you'll want MkDocs, Material for MkDocs, and mdx_truly_sane_lists installed to provide live reloading and preview for your changes. You can do so through pip or your system's package managers. While you don't need these, it'll probably help in making and validating changes.

            -

            You may also want Mike, but it isn't really needed.

            -
            • -
          -
          3. -
        3. -

          Once you have your documentation changes done, submit it as a pull request. For more information regarding that, refer to Issues and Pull Requests.

          -
          4. -
        - - - - + bottom + + +
        + + +
        + + + + +
        +
        + ClementTsang/bottom +
        +         +
        + +
          - -
        + + + + + + +
      65. + + Home + +
        66. + + + + + + + + + + +
      66. + + Support + +
        67. + + + + + + + + + + + +
      67. + + + + + + + + + + +
        68. + + + + + + + + + + + +
      68. + + + + + + + + + + +
        69. + + + + + + + + + + + + + +
      69. + + + + + + + + + + +
        70. + + + + + + + + + + +
      70. + + Troubleshooting + +
        71. + + + + + +
        - - - - Back to top - - - - - -
        + + + + + + Back to top + + + + + + + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/contribution/issues-and-pull-requests/index.html b/0.6.5/contribution/issues-and-pull-requests/index.html index 9cc7202d..76294dd8 100644 --- a/0.6.5/contribution/issues-and-pull-requests/index.html +++ b/0.6.5/contribution/issues-and-pull-requests/index.html @@ -1,1014 +1,1089 @@ - - - - - - - - - - - - - - - - - - - - - Issues and Pull Requests - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - - - - -
        -
        - - - -
        -
        -
        - - - - - -
        -
        -
        - - - -
        -
        -
        - -
        - - - -
      71. - - Pull requests - - -
        72. - - - - -
        -
        -
        - - -
        -
        - - - - + + + +
        +
        + + + +
        +
        +
        + + + + + +
        + + + + + + +
      72. + + Home + +
        73. + + + + + + + + + + +
      73. + + Support + +
        74. + + + + + + + + + + + +
      74. + + + + + + + + + + +
        75. + + + + + + + + + + + +
      75. + + + + + + + + + + +
        76. + + + + + + + + + + + + + +
      76. + + + + + + + + + + +
        77. + + + + + + + + + + +
      77. + + Troubleshooting + +
        78. + + + + + +
        - - - - Back to top - - - - - - + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/contribution/packaging-and-distribution/index.html b/0.6.5/contribution/packaging-and-distribution/index.html index ad7413a3..c70b0853 100644 --- a/0.6.5/contribution/packaging-and-distribution/index.html +++ b/0.6.5/contribution/packaging-and-distribution/index.html @@ -1,993 +1,1077 @@ - - - - - - - - - - - - - - - - - - - - - Packaging and Distribution - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - + + + +
        -
      78. - - Home - -
        79. - - - - - -
      79. - - Support - -
        80. - - - - + - - - -
        -
        - - - -
        -
        -
        - - - -
        + - - - - - - - -
      80. - - Basic Mode - -
        81. - - - - - - - - - - - +
        +
        - - - - -
      81. - - - - - - - - - - -
        82. - + -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - - - -

        Packaging and Distribution

        -

        Package maintainers are always welcome and appreciated! Here's some info on how one can help with package distribution and bottom.

        -

        Pre-built binaries

        -

        The latest stable release can be found here, where you can find pre-built binaries in either a tar.gz or zip format. -Binaries here also include automatically generated shell completion files for zsh, bash, fish, and Powershell, which you may want to also install during the packaging -process.

        -

        You can also find a nightly build in the releases page, built every day at 00:00 UTC off of the master branch.

        -

        Building manually

        -

        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
-
        -

        You'll then want to build with:

        -
        cargo build --release --locked
-
        -

        Completion files are automatically generated during this process, and are located in the directory target/release/build/bottom-<gibberish>/out. Note there may be multiple folders that look like target/release/build/bottom-<gibberish>. To programmatically determine which is the right folder, you might want to use something like:

        -
        $(ls target/release/build/bottom-*/out/btm.bash | head -n1 | xargs dirname)
-
        -

        You may find the Arch package install script template useful as a reference.

        -

        Adding an installation source

        -

        Once you've finished your installation source, if you want to mention it in the main bottom repo, fork the repo and add the installation method and any details to -the README.md file under the Installation section. -Once that's done, open a pull request - these will usually be approved of very quickly.

        -

        You can find more info on the contribution process here.

        - - - - + bottom + + +
        + + +
        + + + + +
        +
        + ClementTsang/bottom +
        +         +
        + +
          - -
        + + + + + + +
      82. + + Home + +
        83. + + + + + + + + + + +
      83. + + Support + +
        84. + + + + + + + + + + + +
      84. + + + + + + + + + + +
        85. + + + + + + + + + + + +
      85. + + + + + + + + + + +
        86. + + + + + + + + + + + + + +
      86. + + + + + + + + + + +
        87. + + + + + + + + + + +
      87. + + Troubleshooting + +
        88. + + + + + +
        - - - - Back to top - - - - - -
        - -
        + + + + + + Back to top + + + + + + + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/index.html b/0.6.5/index.html index 1f8f702a..cf562587 100644 --- a/0.6.5/index.html +++ b/0.6.5/index.html @@ -1,974 +1,1038 @@ - - - - - - - - - - - - - - - - - - - - - Home - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - + + + +
        -
      88. - - Home - -
        89. - - - - - -
      89. - - Support - -
        90. - - - - + - - - -
        -
        - - - -
        -
        -
        - - - +
      90. + + Home + +
        91. -
        + - - - - - - - -
      91. - - Basic Mode - -
        92. - - - - - - - - - - - +
        +
        - - - - -
      92. - - - - - - - - - - -
        93. - + -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - - - -

        bottom

        -

        This site serves as extended documentation for bottom alongside the README.md.

        -
        -

        Warning

        -

        Some areas of this documentation are still in progress and may be missing details. Feel free to suggest/contribute changes!

        -
        -

        Installation

        -
        -

        Tip

        -

        It is a good idea to first check out the Support page to see if your system is officially supported!

        -
        -
        -

        Tip

        -

        If you're facing some issues during/after installation, check out the Troubleshooting page for some common problems and solutions.

        -
        -

        To install bottom, refer to the installation section of the README.md, -which contains a list of all the installation methods.

        -

        Contribution

        -

        New contributors are always welcome! See the contribution section for how to contribute to -bottom, whether it be filing issues, writing documentation, creating pull requests, etc.

        - - - - - - + bottom + + +
        + + +
        + + + + +
        +
        + ClementTsang/bottom +
        +         +
        + +
          - -
        + + + + + + + + +
      93. + + + + + + + + + + + Home + + + + + +
        94. + + + + + + + + + + +
      94. + + Support + +
        95. + + + + + + + + + + + +
      95. + + + + + + + + + + +
        96. + + + + + + + + + + + +
      96. + + + + + + + + + + +
        97. + + + + + + + + + + + +
      97. + + + + + + + + + + +
        98. + + + + + + + + + + +
      98. + + Troubleshooting + +
        99. + + + + + +
        - - - - Back to top - - - - - -
        - -
        + + + + + + Back to top + + + + + + + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/support/index.html b/0.6.5/support/index.html index a9ddac58..ffa0dffd 100644 --- a/0.6.5/support/index.html +++ b/0.6.5/support/index.html @@ -1,1084 +1,1155 @@ - - - - - - - - - - - - - - - - - - - - - Support - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - - - - -
        -
        - - - -
        -
        -
        - - - - - -
        -
        -
        - - - -
        -
        -
        - -
        - - - - - - - - -
      99. - - Unofficial support - - - - -
        100. - - - - -
        -
        -
        - - -
        -
        - - - - + + + +
        +
        + + + +
        +
        +
        + + + + + +
        + + + + + + +
      100. + + Home + +
        101. + + + + + + + + + + + + +
      101. + + + + + + + + + + + Support + + + + + +
        102. + + + + + + + + + + + +
      102. + + + + + + + + + + +
        103. + + + + + + + + + + + +
      103. + + + + + + + + + + +
        104. + + + + + + + + + + + +
      104. + + + + + + + + + + +
        105. + + + + + + + + + + +
      105. + + Troubleshooting + +
        106. + + + + + +
        - - - - Back to top - - - - - -
        - - + +
        +
        +
        + + + Made with + + Material for MkDocs + + + +
        + +
        - - +
        + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/troubleshooting/index.html b/0.6.5/troubleshooting/index.html index 630a29dd..89afd547 100644 --- a/0.6.5/troubleshooting/index.html +++ b/0.6.5/troubleshooting/index.html @@ -1,1094 +1,1191 @@ - - - - - - - - - - - - - - - - - - - - - Troubleshooting - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - - - - -
        -
        - - - -
        -
        -
        - - - - - - -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - + + + +
        +
        + + + +
        +
        +
        + + + + + +
        + + + + + + +
      106. + + Home + +
        107. + + + + + + + + + + +
      107. + + Support + +
        108. + + + + + + + + + + + +
      108. + + + + + + + + + + +
        109. + + + + + + + + + + + +
      109. + + + + + + + + + + +
        110. + + + + + + + + + + + +
      110. + + + + + + + + + + +
        111. + + + + + + + + + + + + +
      111. + + + + + + + + + + + Troubleshooting + + + + + +
        112. + + + + + +
        - - - - Back to top - - - - - - + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/usage/basic-mode/index.html b/0.6.5/usage/basic-mode/index.html index 4ac30f15..b9e7533e 100644 --- a/0.6.5/usage/basic-mode/index.html +++ b/0.6.5/usage/basic-mode/index.html @@ -1,980 +1,1051 @@ - - - - - - - - - - - - - - - - - - - - - Basic Mode - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        -
        + +
        -
      112. - - Support - -
        113. - - - - - - - - - - -
      113. - - Usage - -
        114. - - - - - + - - - -
        -
        - - - -
        -
        -
        - - - +
      114. + + Home + +
        115. -
        + - - - - - - - - - -
      115. - - - - - - - - - - - Basic Mode - - - - - -
        116. - - - - - - - - - - - +
        +
        - - - - -
      116. - - - - - - - - - - -
        117. - + -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - - - -

        Basic Mode

        -

        Basic mode is a special layout that removes all of the graphs and provides an interface that resembles (a very stripped-down version of) htop.

        -
        - A picture of bottom's basic mode. -
        + bottom + -

        Basic mode can be enabled either through a command line flag:

        -
        btm -b
+                
        
+
+                  
+                    
        
+
+                      
+                        
+                      
+                    
        
+                    
        
+                      ClementTsang/bottom
+                    
        
+                          
+                
        
+
+                
+              
+
        +
        +
        + + + +
        +
        +
        + + +
        +
        +
        + + +
        +
        + + + + + + + + + +

        Basic Mode

        +

        Basic mode is a special layout that removes all of the graphs and provides an interface that resembles (a + very stripped-down version of) htop.

        +
        + A picture of bottom's basic mode. +
        + +

        Basic mode can be enabled either through a command line flag:

        +
        + 
        btm -b
 
 # or
 
 btm --basic
-
        -

        or through the config:

        -
        [flags]
+
        +
        +

        or through the config:

        +
        + 
        [flags]
 basic = true
-
        -

        Notes

        -

        In this mode, widgets that use tables (temperatures, processes, disks, and batteries) are only shown one at a time. -One can switch between these widgets either by clicking the arrow buttons or by using the general widget selection shortcuts (for example, Ctrl+Left or H) -to switch which widget is shown.

        -

        Also note that in this mode, widget expansion and custom layouts are disabled.

        -

        Key bindings

        -

        Basic mode follows the same key bindings as normal, barring widget expansion being disabled, and that the % key while selecting the memory widget toggles between total usage and percentage.

        - - - - +         +
        +

        Notes

        +

        In this mode, widgets that use tables (temperatures, processes, disks, and batteries) are only shown one + at a time. + One can switch between these widgets either by clicking the arrow buttons or by using the general widget + selection shortcuts (for example, Ctrl+Left or H) + to switch which widget is shown.

        +

        Also note that in this mode, widget expansion and custom layouts are disabled.

        +

        Key bindings

        +

        Basic mode follows the same key bindings as normal, barring widget expansion being disabled, and that the + % key while selecting the memory widget toggles between total usage + and percentage.

        - - -
        + + + + + + - - - - Back to top - - - - - - + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/usage/general-usage/index.html b/0.6.5/usage/general-usage/index.html index 39cb99a9..1e3d13ae 100644 --- a/0.6.5/usage/general-usage/index.html +++ b/0.6.5/usage/general-usage/index.html @@ -1,1122 +1,1221 @@ - - - - - - - - - - - - - - - - - - - - - General Usage - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        -
        - - - - - - - -
      117. - - Memory Widget - -
        118. - +
        - - - - - - - -
      118. - - Network Widget - -
        119. - - - - - - - - -
      119. - - Process Widget - -
        120. - - - - - - - - -
      120. - - Disk Widget - -
        121. - - - - - - - - -
      121. - - Temperature Widget - -
        122. - - - - - - - - -
      122. - - Battery Widget - -
        123. - + - - - - - - - - - - -
      123. - - Basic Mode - -
        124. - - - - - - - - - - - - - - - - - - -
      124. - - - - - - - - - - -
        125. - - - - - - - - - - - -
      125. - - - - - - - - - - -
        126. - - - - - - - - - - -
      126. - - Troubleshooting - -
        127. - - - - - -
        - - - - - -
        -
        -
        - -
        - - - -
      127. - - Key bindings - - -
        128. - -
      128. - - Mouse bindings - - -
        129. - - - - -
        -
        - - - -
        -
        - - - - + + + +
        +
        + + + +
        +
        +
        + + + + + + +
        +
        +
        + + + +
        +
        +
        + + +
        +
        +
        + + +
        +
        + + + + + + + + + +

        General Usage

        +

        You can run bottom with:

        +
        + 
        btm
+
        +
        +

        For help regarding the command-line flags, use:

        +
        + 
        # For a simple overview of flags
 btm -h
 
 # For more details
 btm --help
-
        -

        Features

        -

        Expansion

        -

        By default, bottom is somewhat like a dashboard - a bunch of different widgets, all showing different things, and they all cram together to fit into one terminal.

        -

        If you instead just want to see one widget - maybe you want to look at a graph in more detail, for example - you can "expand" the currently selected -widget using the e key, which will hide all other widgets and make that widget take up all available terminal space.

        -

        You can leave this state by either pressing e again or pressing Esc.

        -

        Widget selection

        -

        To allow for widget-specific keybindings and expansion, there is the idea of widget selection in bottom, where you can focus on a specific widget to work with it. -This can be done with the mouse (just click on the widget of interest) or keyboard (ex: Ctrl+Direction, see Key bindings for alternatives).

        -

        Key bindings

        -

        These are global or common keyboard shortcuts for the application, which you can see in-app through the ? shortcut. -Note that key bindings are generally case-sensitive.

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        BindingAction
        q , Ctrl+cQuit
        EscClose dialog windows, search, widgets, or exit expanded mode
        Ctrl+rReset display and any collected data
        fFreeze/unfreeze updating with new data
        ?Open help menu
        eToggle expanding the currently selected widget
        Ctrl+Up
        Shift+Up
        K
        W        		Select the widget above
        Ctrl+Down
        Shift+Down
        J
        S        		Select the widget below
        Ctrl+Left
        Shift+Left
        H
        A        		Select the widget on the left
        Ctrl+Right
        Shift+Right
        L
        D        		Select the widget on the right
        Up , kMove up within a widget
        Down , jMove down within a widget
        Left
        h
        Alt+h        		Move left within a widget
        Right
        l
        Alt+l        		Move right within a widget
        g+g , HomeJump to the first entry
        G , EndJump to the last entry
        -

        Mouse bindings

        - - - - - - - - - - - - - -
        BindingAction
        Left ButtonSelects the widget
        - - - - +         +
        +

        Features

        +

        Expansion

        +

        By default, bottom is somewhat like a dashboard - a bunch of different widgets, all showing different + things, and they all cram together to fit into one terminal.

        +

        If you instead just want to see one widget - maybe you want to look at a graph in more detail, + for example - you can "expand" the currently selected + widget using the e key, which will hide all other + widgets and make that widget take up all available terminal space.

        +

        You can leave this state by either pressing e again or + pressing Esc.

        +

        Widget selection

        +

        To allow for widget-specific keybindings and expansion, there is the idea of widget selection in + bottom, where you can focus on a specific widget to work with it. + This can be done with the mouse (just click on the widget of interest) or keyboard (ex: Ctrl+Direction, see Key bindings for alternatives).

        +

        Key bindings

        +

        These are global or common keyboard shortcuts for the application, which you can see in-app through the + ? shortcut. + Note that key bindings are generally case-sensitive.

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        BindingAction
        q , Ctrl+cQuit
        EscClose dialog windows, search, widgets, or exit expanded mode
        Ctrl+rReset display and any collected data
        fFreeze/unfreeze updating with new data
        ?Open help menu
        eToggle expanding the currently selected widget
        Ctrl+Up
        Shift+Up
        + K
        W        		Select the widget above
        Ctrl+Down
        Shift+Down
        + J
        S        		Select the widget below
        Ctrl+Left
        Shift+Left
        + H
        A        		Select the widget on the left
        Ctrl+Right
        Shift+Right +
        L
        D        		Select the widget on the right
        Up , kMove up within a widget
        Down , jMove down within a widget
        Left
        h
        Alt+h        		Move left within a widget
        Right
        l
        Alt+l        		Move right within a widget
        g+g , + HomeJump to the first entry
        G , EndJump to the last entry
        +

        Mouse bindings

        + + + + + + + + + + + + + +
        BindingAction
        Left ButtonSelects the widget
        - -
        -
        + + + + + + - - - - Back to top - - - - - - + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/usage/widgets/battery/index.html b/0.6.5/usage/widgets/battery/index.html index f9c7e15e..9c73e063 100644 --- a/0.6.5/usage/widgets/battery/index.html +++ b/0.6.5/usage/widgets/battery/index.html @@ -1,1027 +1,1095 @@ - - - - - - - - - - - - - - - - - - - - - Battery Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - + + + +
        -
      129. - - Home - -
        130. - - - - - -
      130. - - Support - -
        131. - - - - - - + - - - -
        -
        - - - -
        -
        -
        - - - -
        + - - - - - - - -
      131. - - Basic Mode - -
        132. - - - - - - - - - - - +
        +
        - - - - -
      132. - - - - - - - - - - -
        133. - + -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - - - -

        Battery Widget

        -
        -

        Warning

        -

        The battery features are unavailable if the binary is compiled with the battery feature disabled!

        -
        -

        The battery widget provides information about batteries on the system.

        -
        - A picture of an expanded battery widget. -
        + bottom + -

        The battery widget can be enabled through either the --battery flag, the battery = true option in a config file, or specifying the widget in a custom layout.

        -

        Features

        -

        The following data is displayed for batteries:

        -
          -
        • Charge percent
          • -
        • Consumption
          • -
        • Time to empty/charge, based on the current state
          • -
        • Battery health percent
          • -
        -

        The battery widget also supports devices with multiple batteries, and you can switch between them using the keyboard or the mouse.

        -

        Key bindings

        -

        Note that key bindings are generally case-sensitive.

        - - - - - - - - - - - - - - - - - -
        BindingAction
        Left
        h
        Alt+h        		Moves to the battery entry to the left of the current one
        Right
        l
        Alt+l        		Moves to the battery entry to the right of the current one
        -

        Mouse bindings

        - - - - - - - - - - - - - -
        BindingAction
        Left ButtonSelects a battery entry
        - - - - +
        + + +
        + + + + +
        +
        + ClementTsang/bottom +
        +         +
        + +
          - -
        + + + + + + +
      133. + + Home + +
        134. + + + + + + + + + + +
      134. + + Support + +
        135. + + + + + + + + + + + + + +
      135. + + + + + + + + + + +
        136. + + + + + + + + + + + +
      136. + + + + + + + + + + +
        137. + + + + + + + + + + + +
      137. + + + + + + + + + + +
        138. + + + + + + + + + + +
      138. + + Troubleshooting + +
        139. + + + + + +
        - - - - Back to top - - - - - -
        - -
        + + + + + + Back to top + + + + + + + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/usage/widgets/cpu/index.html b/0.6.5/usage/widgets/cpu/index.html index 7fe958c6..3d6cc750 100644 --- a/0.6.5/usage/widgets/cpu/index.html +++ b/0.6.5/usage/widgets/cpu/index.html @@ -1,1154 +1,1224 @@ - - - - - - - - - - - - - - - - - - - - - CPU Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - - - - -
        -
        - - - -
        -
        -
        - - - - - - -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - - - -

        CPU Widget

        -

        The CPU widget displays a visual representation of CPU usage over a time range.

        -
        - A picture of an expanded CPU widget showing average CPU usage. -
        + bottom + -

        Features

        -

        The CPU widget is composed of two parts: the graph and the legend:

        -
          -
        • The graph displays the usage data for the currently selected entry as a percentage
          • -
        • The legend displays all available entries that can be displayed on the graph along with their last recorded use percentage (except for the "All" option)
          • -
        -

        Users can scroll through the legend using either the keyboard or mouse to select which entry to display on the graph. The "All" option shows every entry -at the same time, though this may get a bit hard to follow if you have a large number of cores/threads.

        -

        One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

        -

        Key bindings

        -

        Note that key bindings are generally case-sensitive.

        -

        Graph

        - - - - - - - - - - - - - - - - - - - - - -
        BindingAction
        +Zoom in on chart (decrease time range)
        -Zoom out on chart (increase time range)
        =Reset zoom
        -

        Legend

        - - - - - - - - - - - - - - - - - - - - - - - - - -
        BindingAction
        Up , kMove up within a widget
        Down , jMove down within a widget
        g+g , HomeJump to the first entry in the legend
        G , EndJump to the last entry in the legend
        -

        Mouse bindings

        -

        Graph

        - - - - - - - - - - - - - -
        BindingAction
        ScrollScrolling up or down zooms in or out of the graph respectively
        -

        Legend

        - - - - - - - - - - - - - - - - - -
        BindingAction
        ScrollScroll through options to display in the graph
        Left ButtonSelects a CPU thread/average to show in the graph
        - - - - +
        + + +
        + + + + +
        +
        + ClementTsang/bottom +
        +         +
        + +
          - -
        + + + + + + +
      139. + + Home + +
        140. + + + + + + + + + + +
      140. + + Support + +
        141. + + + + + + + + + + + + + +
      141. + + + + + + + + + + +
        142. + + + + + + + + + + + +
      142. + + + + + + + + + + +
        143. + + + + + + + + + + + +
      143. + + + + + + + + + + +
        144. + + + + + + + + + + +
      144. + + Troubleshooting + +
        145. + + + + + +
        - - - - Back to top - - - - - - + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/usage/widgets/disk/index.html b/0.6.5/usage/widgets/disk/index.html index 932f0709..6dc0341f 100644 --- a/0.6.5/usage/widgets/disk/index.html +++ b/0.6.5/usage/widgets/disk/index.html @@ -1,1032 +1,1098 @@ - - - - - - - - - - - - - - - - - - - - - Disk Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - + + + +
        -
      145. - - Home - -
        146. - - - - - -
      146. - - Support - -
        147. - - - - - - + - - - -
        -
        - - - -
        -
        -
        - - - -
        + - - - - - - - -
      147. - - Basic Mode - -
        148. - - - - - - - - - - - +
        +
        - - - - -
      148. - - - - - - - - - - -
        149. - + -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - - - -

        Disk Widget

        -

        The disk widget provides a table of useful disk and partition information, like I/O per second and total usage.

        -
        - A picture of an expanded disk widget. -
        + bottom + -

        Features

        -

        The disk widget provides the following information:

        -
          -
        • Disk name
          • -
        • Disk mount location
          • -
        • Percentage of space used
          • -
        • Amount of space left
          • -
        • Total amount of space
          • -
        • Read per second
          • -
        • Write per second
          • -
        -

        Key bindings

        -

        Note that key bindings are generally case-sensitive.

        - - - - - - - - - - - - - - - - - - - - - - - - - -
        BindingAction
        Up , kMove up within a widget
        Down , jMove down within a widget
        g+g , HomeJump to the first entry in the table
        G , EndJump to the last entry in the table
        -

        Mouse bindings

        - - - - - - - - - - - - - -
        BindingAction
        Left ButtonSelects an entry in the table
        - - - - +
        + + +
        + + + + +
        +
        + ClementTsang/bottom +
        +         +
        + +
          - -
        + + + + + + +
      149. + + Home + +
        150. + + + + + + + + + + +
      150. + + Support + +
        151. + + + + + + + + + + + + + +
      151. + + + + + + + + + + +
        152. + + + + + + + + + + + +
      152. + + + + + + + + + + +
        153. + + + + + + + + + + + +
      153. + + + + + + + + + + +
        154. + + + + + + + + + + +
      154. + + Troubleshooting + +
        155. + + + + + +
        - - - - Back to top - - - - - -
        - -
        + + + + + + Back to top + + + + + + + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/usage/widgets/memory/index.html b/0.6.5/usage/widgets/memory/index.html index 0f83fb9d..85ead0d5 100644 --- a/0.6.5/usage/widgets/memory/index.html +++ b/0.6.5/usage/widgets/memory/index.html @@ -1,1040 +1,1109 @@ - - - - - - - - - - - - - - - - - - - - - Memory Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - + + + +
        -
      155. - - Home - -
        156. - - - - - -
      156. - - Support - -
        157. - - - - - - + - - - -
        -
        - - - -
        -
        -
        - - - -
        + - - - - - - - -
      157. - - Basic Mode - -
        158. - - - - - - - - - - - +
        +
        - - - - -
      158. - - - - - - - - - - -
        159. - + -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - - - -

        Memory Widget

        -

        The memory widget provides a visual representation of RAM and swap usage over time.

        -
        - A picture of an expanded memory widget. -
        + bottom + -

        Features

        -

        The legend displays the current usage in terms of percentage and actual usage in binary units (KiB, MiB, GiB, etc.). -If the total RAM or swap available is 0, then it is automatically hidden from the legend and graph.

        -

        One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

        -

        Key bindings

        -

        Note that key bindings are generally case-sensitive.

        - - - - - - - - - - - - - - - - - - - - - -
        BindingAction
        +Zoom in on chart (decrease time range)
        -Zoom out on chart (increase time range)
        =Reset zoom
        -

        Mouse bindings

        - - - - - - - - - - - - - -
        BindingAction
        ScrollScrolling up or down zooms in or out of the graph respectively
        -

        Calculations

        -

        Memory usage is calculated using the following formula based on values from /proc/meminfo (based on htop's implementation):

        -
        MemTotal - MemFree - Buffers - (Cached + SReclaimable - Shmem)
-
        -

        You can find more info on /proc/meminfo and its fields here.

        - - - - +
        + + +
        + + + + +
        +
        + ClementTsang/bottom +
        +         +
        + +
          - -
        + + + + + + +
      159. + + Home + +
        160. + + + + + + + + + + +
      160. + + Support + +
        161. + + + + + + + + + + + + + +
      161. + + + + + + + + + + +
        162. + + + + + + + + + + + +
      162. + + + + + + + + + + +
        163. + + + + + + + + + + + +
      163. + + + + + + + + + + +
        164. + + + + + + + + + + +
      164. + + Troubleshooting + +
        165. + + + + + +
        - - - - Back to top - - - - - -
        - -
        + + + + + + Back to top + + + + + + + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/usage/widgets/network/index.html b/0.6.5/usage/widgets/network/index.html index 560b2d8e..f23f75b8 100644 --- a/0.6.5/usage/widgets/network/index.html +++ b/0.6.5/usage/widgets/network/index.html @@ -1,1024 +1,1091 @@ - - - - - - - - - - - - - - - - - - - - - Network Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - + + + +
        -
      165. - - Home - -
        166. - - - - - -
      166. - - Support - -
        167. - - - - - - + - - - -
        -
        - - - -
        -
        -
        - - - -
        + - - - - - - - -
      167. - - Basic Mode - -
        168. - - - - - - - - - - - +
        +
        - - - - -
      168. - - - - - - - - - - -
        169. - + -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - - - -

        Network Widget

        -

        The network widget provides a visual representation of network input and output per second, as well as noting the total amount -received and transmitted.

        -
        - A picture of an expanded network widget. -
        + bottom + -

        Features

        -

        The legend displays the current reads and writes per second in bits, as well as the total amount read/written.

        -

        The y-axis automatically scales based on shown read/write values, and by default, is a linear scale based on base-10 units (e.x. kilobit, gigabit, etc.). -Through configuration, the read/write per second unit can be changed to bytes, while the y-axis can be changed to a -log scale and/or use base-2 units (e.x. kibibit, gibibit, etc.).

        -

        One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

        -

        Key bindings

        -

        Note that key bindings are generally case-sensitive.

        - - - - - - - - - - - - - - - - - - - - - -
        BindingAction
        +Zoom in on chart (decrease time range)
        -Zoom out on chart (increase time range)
        =Reset zoom
        -

        Mouse bindings

        - - - - - - - - - - - - - -
        BindingAction
        ScrollScrolling up or down zooms in or out of the graph respectively
        - - - - +
        + + +
        + + + + +
        +
        + ClementTsang/bottom +
        +         +
        + +
          - -
        + + + + + + +
      169. + + Home + +
        170. + + + + + + + + + + +
      170. + + Support + +
        171. + + + + + + + + + + + + + +
      171. + + + + + + + + + + +
        172. + + + + + + + + + + + +
      172. + + + + + + + + + + +
        173. + + + + + + + + + + + +
      173. + + + + + + + + + + +
        174. + + + + + + + + + + +
      174. + + Troubleshooting + +
        175. + + + + + +
        - - - - Back to top - - - - - -
        - -
        + + + + + + Back to top + + + + + + + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/usage/widgets/process/index.html b/0.6.5/usage/widgets/process/index.html index 03a2c95e..40d9ec72 100644 --- a/0.6.5/usage/widgets/process/index.html +++ b/0.6.5/usage/widgets/process/index.html @@ -1,1684 +1,1804 @@ - - - - - - - - - - - - - - - - - - - - - Process Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - - - - -
        -
        - - - -
        -
        -
        - - - - - -
        -
        -
        - - - -
        -
        -
        - -
        - - - - - - - - -
      175. - - Key bindings - - - - -
        176. - -
      176. - - Mouse bindings - - - - -
        177. - - - - -
        -
        -
        - - -
        -
        - - - - + + + +
        +
        + + + +
        +
        +
        + + + + + +
        + + + + + + +
      177. + + Home + +
        178. + + + + + + + + + + +
      178. + + Support + +
        179. + + + + + + + + + + + + + +
      179. + + + + + + + + + + +
        180. + + + + + + + + + + + +
      180. + + + + + + + + + + +
        181. + + + + + + + + + + + +
      181. + + + + + + + + + + +
        182. + + + + + + + + + + +
      182. + + Troubleshooting + +
        183. + + + + + +
        - - - - Back to top - - - - - -
        - - + +
        +
        +
        + + + Made with + + Material for MkDocs + + + +
        + +
        - - +
        + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.5/usage/widgets/temperature/index.html b/0.6.5/usage/widgets/temperature/index.html index 7836ee76..a139291d 100644 --- a/0.6.5/usage/widgets/temperature/index.html +++ b/0.6.5/usage/widgets/temperature/index.html @@ -1,1023 +1,1088 @@ - - - - - - - - - - - - - - - - - - - - - Temperature Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - -
        - -
        - - -
        - - -
        - -
        - - - - - - + + + +
        -
      183. - - Home - -
        184. - - - - - -
      184. - - Support - -
        185. - - - - - - + - - - -
        -
        - - - -
        -
        -
        - - - -
        + - - - - - - - -
      185. - - Basic Mode - -
        186. - - - - - - - - - - - +
        +
        - - - - -
      186. - - - - - - - - - - -
        187. - + -
        -
        -
        - - - -
        -
        -
        - - -
        -
        -
        - - -
        -
        - - - - - - -

        Temperature Widget

        -

        The temperature widget provides a table of temperature sensors and their current temperature.

        -
        - A picture of an expanded temperature widget. -
        + bottom + -

        Features

        -

        The temperature widget provides the sensor name as well as its current temperature.

        -

        Key bindings

        -

        Note that key bindings are generally case-sensitive.

        - - - - - - - - - - - - - - - - - - - - - - - - - -
        BindingAction
        Up , kMove up within a widget
        Down , jMove down within a widget
        g+g , HomeJump to the first entry in the table
        G , EndJump to the last entry in the table
        -

        Mouse bindings

        - - - - - - - - - - - - - -
        BindingAction
        Left ButtonSelects an entry in the table
        - - - - +
        + + +
        + + + + +
        +
        + ClementTsang/bottom +
        +         +
        + +
          - -
        + + + + + + +
      187. + + Home + +
        188. + + + + + + + + + + +
      188. + + Support + +
        189. + + + + + + + + + + + + + +
      189. + + + + + + + + + + +
        190. + + + + + + + + + + + +
      190. + + + + + + + + + + +
        191. + + + + + + + + + + + +
      191. + + + + + + + + + + +
        192. + + + + + + + + + + +
      192. + + Troubleshooting + +
        193. + + + + + +
        - - - - Back to top - - - - - -
        - -
        + + + + + + Back to top + + + + + + + - - - -
        -
        -
        - - - - - - - - \ No newline at end of file +
        +
        +
        + + + + + + + + + diff --git a/0.6.6/404.html b/0.6.6/404.html index 257b6abd..c4a47a8d 100644 --- a/0.6.6/404.html +++ b/0.6.6/404.html @@ -1,866 +1,923 @@ - - - - - - - - - - - - - - - - - - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + - - - - - - - - - - - - - - - - - - - - - -
        - -
        -
        - -
        - - - - - -
        - - -
        - -
        - - - - - - - - - -
        -
        - - - -
        -
        -
        - - - - - - -
        + +
        +
        +
        +
        + Initializing search
        +
          - - - -
          -
          - -

          404 - Not found

          - -
          +
          - - - - Back to top - - -
          - - - -
          -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/configuration/command-line-flags/index.html b/0.6.6/configuration/command-line-flags/index.html index d0a05a4a..68630c00 100644 --- a/0.6.6/configuration/command-line-flags/index.html +++ b/0.6.6/configuration/command-line-flags/index.html @@ -1,1048 +1,1110 @@ - - - - - - - - - - - - - - - - - - - - Command-line Flags - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - + + + +
          -
        1. - - Home - -
          2. - - - - - -
        2. - - Support - -
          3. - - - - + - - - -
          -
          - - - -
          -
          -
          - - - -
          + - - - - - - - -
        3. - - Basic Mode - -
          4. - - - - - - - - - - - +
          +
          - - - - - - -
        4. - - - - - - - - - - -
          5. - + -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - +
            -

            Command-line Flags

            -
            -

            Warning

            -

            This section is in progress, and is just copied from the old documentation.

            -
            -

            The following flags can be provided to bottom in the command line to change the behaviour of the program (run btm --help for more information on each flag):

            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            FlagBehaviour
            --autohide_timeTemporarily shows the time scale in graphs.
            -b, --basicHides graphs and uses a more basic look.
            --batteryShows the battery widget.
            -S, --case_sensitiveEnables case sensitivity by default.
            -c, --celsiusSets the temperature type to Celsius.
            --color <COLOR SCHEME>Use a color scheme, use --help for supported values.
            -C, --config <CONFIG PATH>Sets the location of the config file.
            -u, --current_usageSets process CPU% to be based on current CPU%.
            -t, --default_time_value <MS>Default time value for graphs in ms.
            --default_widget_count <INT>Sets the n'th selected widget type as the default.
            --default_widget_type <WIDGET TYPE>Sets the default widget type, use --help for more info.
            --disable_advanced_killHides advanced options to stop a process on Unix-like systems.
            --disable_clickDisables mouse clicks.
            -m, --dot_markerUses a dot marker for graphs.
            -f, --fahrenheitSets the temperature type to Fahrenheit.
            -g, --groupGroups processes with the same name by default.
            -h, --helpPrints help information. Use --help for more info.
            -a, --hide_avg_cpuHides the average CPU usage.
            --hide_table_gapHides the spacing between table headers and entries.
            --hide_timeHides the time scale.
            -k, --kelvinSets the temperature type to Kelvin.
            -l, --left_legendPuts the CPU chart legend to the left side.
            --mem_as_valueDefaults to showing process memory usage by value.
            --network_use_binary_prefixDisplays the network widget with binary prefixes.
            --network_use_bytesDisplays the network widget using bytes.
            --network_use_logDisplays the network widget with a log scale.
            --process_commandShow processes as their commands by default.
            -r, --rate <MS>Sets a refresh rate in ms.
            -R, --regexEnables regex by default.
            --show_table_scroll_positionShows the scroll position tracker in table widgets.
            -d, --time_delta <MS>The amount in ms changed upon zooming.
            -T, --treeDefaults to showing the process widget in tree mode.
            --use_old_network_legendDEPRECATED - uses the older network legend.
            -V, --versionPrints version information.
            -W, --whole_wordEnables whole-word matching by default.
            - -
          + + + + + +
        5. + + Home + +
          6. + + + + + + + + + + +
        6. + + Support + +
          7. + + + + + + + + + + + +
        7. + + + + + + + + + + +
          8. + + + + + + + + + + + + + +
        8. + + + + + + + + + + +
          9. + + + + + + + + + + + +
        9. + + + + + + + + + + +
          10. + + + + + + + + + + +
        10. + + Troubleshooting + +
          11. + + + + + +
          - - - - Back to top - - - - -
          - - + +
          +
          +
          + + + Made with + + Material for MkDocs + + +
          + +
          +
          +
          + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/configuration/config-file/data-filtering/index.html b/0.6.6/configuration/config-file/data-filtering/index.html index be1020a8..e5a65bf4 100644 --- a/0.6.6/configuration/config-file/data-filtering/index.html +++ b/0.6.6/configuration/config-file/data-filtering/index.html @@ -1,892 +1,962 @@ - - - - - - - - - - - - - - - - - - - - Data Filtering - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - + + + +
          -
        11. - - Home - -
          12. - - - - - -
        12. - - Support - -
          13. - - - - + - - - -
          -
          - - - -
          -
          -
          - - - -
          + - - - - - - - -
        13. - - Basic Mode - -
          14. - - - - - - - - - - - +
          +
          - - - - - - -
        14. - - - - - - - - - - -
          15. - + -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          +
          + + +
          +
          + + + + + + + + + +

          Data Filtering

          +
          +

          Warning

          +

          This section is in progress, and is just copied from the old documentation.

          +
          +

          You can hide specific disks, temperature sensors, and networks by name in the config file via + disk_filter and mount_filter, temp_filter, and + net_filter respectively. Regex (regex = true), case-sensitivity + (case_sensitive = true), and matching only if the entire word matches + (whole_word = true) are supported, but are off by default. Filters default to denying entries + that match and can be toggled by setting is_list_ignored to false in the config + file.

          +

          For example, here's the disk widget with no filter:

          +

          Disk 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 widget with just disk name filter

          -

          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]
+
          +
          +

          Disk widget with just disk name filter

          +

          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
@@ -899,30 +969,36 @@
 regex = true
 case_sensitive = false
 whole_word = true
-
          -

          This gives us:

          -

          Disk widget with disk name and mount filter

          +           +
          +

          This gives us:

          +

          Disk widget with disk name and mount filter

          - - - + + - - - - Back to top - - - - - + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/configuration/config-file/default-config/index.html b/0.6.6/configuration/config-file/default-config/index.html index 69e9fa49..b766a329 100644 --- a/0.6.6/configuration/config-file/default-config/index.html +++ b/0.6.6/configuration/config-file/default-config/index.html @@ -1,919 +1,985 @@ - - - - - - - - - - - - - - - - - - - - Default Config - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - + + + +
          -
        15. - - Home - -
          16. - - - - - -
        16. - - Support - -
          17. - - - - + - - - -
          -
          - - - -
          -
          -
          - - - -
          + - - - - - - - -
        17. - - Basic Mode - -
          18. - - - - - - - - - - - +
          +
          - - - - - - -
        18. - - - - - - - - - - -
          19. - + -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - +
            -

            Default Config

            -

            A default config file is automatically generated at the following locations that bottom checks by default:

            - - - - - - - - - - - - - - - - - - - - - -
            OSDefault Config Location
            macOS$HOME/Library/Application Support/bottom/bottom.toml
            ~/.config/bottom/bottom.toml
            $XDG_CONFIG_HOME/bottom/bottom.toml
            Linux~/.config/bottom/bottom.toml
            $XDG_CONFIG_HOME/bottom/bottom.toml
            WindowsC:\Users\<USER>\AppData\Roaming\bottom\bottom.toml
            -

            Furthermore, if a custom config path that does not exist is given (using -C or --config), bottom will attempt to create a default config file at that location.

            - -
          + + + + + +
        19. + + Home + +
          20. + + + + + + + + + + +
        20. + + Support + +
          21. + + + + + + + + + + + +
        21. + + + + + + + + + + +
          22. + + + + + + + + + + + + + +
        22. + + + + + + + + + + +
          23. + + + + + + + + + + + +
        23. + + + + + + + + + + +
          24. + + + + + + + + + + +
        24. + + Troubleshooting + +
          25. + + + + + +
          - - - - Back to top - - - - - + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/configuration/config-file/flags/index.html b/0.6.6/configuration/config-file/flags/index.html index 6973f481..bb8b35fe 100644 --- a/0.6.6/configuration/config-file/flags/index.html +++ b/0.6.6/configuration/config-file/flags/index.html @@ -1,1051 +1,1114 @@ - - - - - - - - - - - - - - - - - - - - Flags - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - + + + +
          -
        25. - - Home - -
          26. - - - - - -
        26. - - Support - -
          27. - - - - + - - - -
          -
          - - - -
          -
          -
          - - - -
          + - - - - - - - -
        27. - - Basic Mode - -
          28. - - - - - - - - - - - +
          +
          - - - - - - -
        28. - - - - - - - - - - -
          29. - + -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - +
            -

            Flags

            -
            -

            Warning

            -

            This section is in progress, and is just copied from the old documentation.

            -
            -

            Most of the command line flags have config file equivalents to avoid having to type them out each time:

            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            FieldTypeFunctionality
            hide_avg_cpuBooleanHides the average CPU usage.
            dot_markerBooleanUses a dot marker for graphs.
            left_legendBooleanPuts the CPU chart legend to the left side.
            current_usageBooleanSets process CPU% to be based on current CPU%.
            group_processesBooleanGroups processes with the same name by default.
            case_sensitiveBooleanEnables case sensitivity by default.
            whole_wordBooleanEnables whole-word matching by default.
            regexBooleanEnables regex by default.
            basicBooleanHides graphs and uses a more basic look.
            use_old_network_legendBooleanDEPRECATED - uses the older network legend.
            batteryBooleanShows the battery widget.
            rateUnsigned Int (represents milliseconds)Sets a refresh rate in ms.
            default_time_valueUnsigned Int (represents milliseconds)Default time value for graphs in ms.
            time_deltaUnsigned Int (represents milliseconds)The amount in ms changed upon zooming.
            hide_timeBooleanHides the time scale.
            temperature_typeString (one of ["k", "f", "c", "kelvin", "fahrenheit", "celsius"])Sets the temperature unit type.
            default_widget_typeString (one of ["cpu", "proc", "net", "temp", "mem", "disk"], same as layout options)Sets the default widget type, use --help for more info.
            default_widget_countUnsigned Int (represents which default_widget_type)Sets the n'th selected widget type as the default.
            disable_clickBooleanDisables mouse clicks.
            colorString (one of ["default", "default-light", "gruvbox", "gruvbox-light", "nord", "nord-light"])Use a color scheme, use --help for supported values.
            mem_as_valueBooleanDefaults to showing process memory usage by value.
            treeBooleanDefaults to showing the process widget in tree mode.
            show_table_scroll_positionBooleanShows the scroll position tracker in table widgets.
            process_commandBooleanShow processes as their commands by default.
            disable_advanced_killBooleanHides advanced options to stop a process on Unix-like systems.
            network_use_binary_prefixBooleanDisplays the network widget with binary prefixes.
            network_use_bytesBooleanDisplays the network widget using bytes.
            network_use_logBooleanDisplays the network widget with a log scale.
            - -
          + + + + + +
        29. + + Home + +
          30. + + + + + + + + + + +
        30. + + Support + +
          31. + + + + + + + + + + + +
        31. + + + + + + + + + + +
          32. + + + + + + + + + + + + + +
        32. + + + + + + + + + + +
          33. + + + + + + + + + + + +
        33. + + + + + + + + + + +
          34. + + + + + + + + + + +
        34. + + Troubleshooting + +
          35. + + + + + +
          - - - - Back to top - - - - -
          - - + +
          +
          +
          + + + Made with + + Material for MkDocs + + +
          + +
          +
          +
          + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/configuration/config-file/layout/index.html b/0.6.6/configuration/config-file/layout/index.html index 1ee5c060..43097059 100644 --- a/0.6.6/configuration/config-file/layout/index.html +++ b/0.6.6/configuration/config-file/layout/index.html @@ -1,881 +1,939 @@ - - - - - - - - - - - - - - - - - - - - Layout - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - + + + +
          -
        35. - - Home - -
          36. - - - - - -
        36. - - Support - -
          37. - - - - + - - - -
          -
          - - - -
          -
          -
          - - - -
          + - - - - - - - -
        37. - - Basic Mode - -
          38. - - - - - - - - - - - +
          +
          - - - - - - -
        38. - - - - - - - - - - -
          39. - + -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          +
          + + +
          +
          + + + + + + + + + +

          Layout

          +
          +

          Warning

          +

          This section is in progress, and is just copied from the old documentation.

          +
          +

          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]]
@@ -889,82 +947,94 @@
         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. -The second column is split into two rows with a 1:1 ratio. The first is the temperature widget, the second is the disk widget.

          -

          This is what the layout would look like when run:

          -

          Sample layout

          -

          Each [[row]] represents a row in the layout. A row can have any number of child values. Each [[row.child]] -represents either a column or a widget. A column can have any number of child values as well. Each [[row.child.child]] -represents a widget. A widget is represented by having a type field set to a string.

          -

          The following type values are supported:

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          "cpu"CPU chart and legend
          "mem", "memory"Memory chart
          "net", "network"Network chart and legend
          "proc", "process", "processes"Process table and search
          "temp", "temperature"Temperature table
          "disk"Disk table
          "empty"An empty space
          "batt", "battery"Battery statistics
          -

          Each component of the layout accepts a ratio value. If this is not set, it defaults to 1.

          -

          Furthermore, you can have duplicate widgets.

          -

          For an example, look at the default config, which contains the default layout.

          +           +
          +

          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. + The second column is split into two rows with a 1:1 ratio. The first is the temperature widget, the second + is the disk widget.

          +

          This is what the layout would look like when run:

          +

          Sample layout

          +

          Each [[row]] represents a row in the layout. A row can have any number of + child values. Each [[row.child]] + represents either a column or a widget. A column can have any number of child values + as well. Each [[row.child.child]] + represents a widget. A widget is represented by having a type field set to a string. +

          +

          The following type values are supported:

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          "cpu"CPU chart and legend
          "mem", "memory"Memory chart
          "net", "network"Network chart and legend
          "proc", "process", "processes"Process table and search
          "temp", "temperature"Temperature table
          "disk"Disk table
          "empty"An empty space
          "batt", "battery"Battery statistics
          +

          Each component of the layout accepts a ratio value. If this is not set, it defaults to 1. +

          +

          Furthermore, you can have duplicate widgets.

          +

          For an example, look at the default + config, which contains the default layout.

          - - - + + - - - - Back to top - - - - - + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/configuration/config-file/theming/index.html b/0.6.6/configuration/config-file/theming/index.html index 44cd3add..79a927a9 100644 --- a/0.6.6/configuration/config-file/theming/index.html +++ b/0.6.6/configuration/config-file/theming/index.html @@ -1,1007 +1,1071 @@ - - - - - - - - - - - - - - - - - - - - Theming - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - + + + +
          -
        39. - - Home - -
          40. - - - - - -
        40. - - Support - -
          41. - - - - + - - - -
          -
          - - - -
          -
          -
          - - - -
          + - - - - - - - -
        41. - - Basic Mode - -
          42. - - - - - - - - - - - +
          +
          - - - - - - -
        42. - - - - - - - - - - -
          43. - + -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - +
            -

            Theming

            -
            -

            Warning

            -

            This section is in progress, and is just copied from the old documentation.

            -
            -

            The config file can be used to set custom colours for parts of the application under the [colors] object. The following labels are customizable with strings that are hex colours, RGB colours, or specific named colours.

            -

            Supported named colours are one of the following strings: Reset, Black, Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed, LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White.

            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            LabelsDetailsExample
            Table header coloursColour of table headerstable_header_color="255, 255, 255"
            CPU colour per coreColour of each core. Read in order.cpu_core_colors=["#ffffff", "white", "255, 255, 255"]
            Average CPU colourThe average CPU coloravg_cpu_color="White"
            All CPUs colourThe colour for the "All" CPU labelall_cpu_color="White"
            RAMThe colour RAM will useram_color="#ffffff"
            SWAPThe colour SWAP will useswap_color="#ffffff"
            RXThe colour rx will userx_color="#ffffff"
            TXThe colour tx will usetx_color="#ffffff"
            Widget title colourThe colour of the label each widget haswidget_title_color="#ffffff"
            Border colourThe colour of the border of unselected widgetsborder_color="#ffffff"
            Selected border colourThe colour of the border of selected widgetshighlighted_border_color="#ffffff"
            Text colourThe colour of most texttext_color="#ffffff"
            Graph colourThe colour of the lines and text of the graphgraph_color="#ffffff"
            Cursor colourThe cursor's colourcursor_color="#ffffff"
            Selected text colourThe colour of text that is selectedscroll_entry_text_color="#ffffff"
            Selected text background colourThe background colour of text that is selectedscroll_entry_bg_color="#ffffff"
            High battery level colourThe colour used for a high battery level (100% to 50%)high_battery_color="green"
            Medium battery level colourThe colour used for a medium battery level (50% to 10%)medium_battery_color="yellow"
            Low battery level colourThe colour used for a low battery level (10% to 0%)low_battery_color="red"
            - -
          + + + + + +
        43. + + Home + +
          44. + + + + + + + + + + +
        44. + + Support + +
          45. + + + + + + + + + + + +
        45. + + + + + + + + + + +
          46. + + + + + + + + + + + + + +
        46. + + + + + + + + + + +
          47. + + + + + + + + + + + +
        47. + + + + + + + + + + +
          48. + + + + + + + + + + +
        48. + + Troubleshooting + +
          49. + + + + + +
          - - - - Back to top - - - - -
          - - + +
          +
          +
          + + + Made with + + Material for MkDocs + + +
          + +
          +
          +
          + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/contribution/development/index.html b/0.6.6/contribution/development/index.html index 2bec2cd6..da15bfc4 100644 --- a/0.6.6/contribution/development/index.html +++ b/0.6.6/contribution/development/index.html @@ -1,974 +1,1035 @@ - - - - - - - - - - - - - - - - - - - - Development - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - + + + +
          -
        49. - - Home - -
          50. - - - - - -
        50. - - Support - -
          51. - - - - + - - - -
          -
          - - - -
          -
          -
          - - - -
          + - - - - - - - -
        51. - - Basic Mode - -
          52. - - - - - - - - - - - +
          +
          - - - - -
        52. - - - - - - - - - - -
          53. - + -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          - + + + + + +
        53. + + Home + +
          54. + + + + + + + + + + +
        54. + + Support + +
          55. + + + + + + + + + + + +
        55. + + + + + + + + + + +
          56. + + + + + + + + + + + +
        56. + + + + + + + + + + +
          57. + + + + + + + + + + + + + +
        57. + + + + + + + + + + +
          58. + + + + + + + + + + +
        58. + + Troubleshooting + +
          59. + + + + + +
          - - - - Back to top - - - - - + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/contribution/documentation/index.html b/0.6.6/contribution/documentation/index.html index a0e2ffa9..8aef0929 100644 --- a/0.6.6/contribution/documentation/index.html +++ b/0.6.6/contribution/documentation/index.html @@ -1,1004 +1,1087 @@ - - - - - - - - - - - - - - - - - - - - Documentation - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - + + + +
          -
        59. - - Home - -
          60. - - - - - -
        60. - - Support - -
          61. - - - - + - - - -
          -
          - - - -
          -
          -
          - - - -
          + - - - - - - - -
        61. - - Basic Mode - -
          62. - - - - - - - - - - - +
          +
          - - - - -
        62. - - - - - - - - - - -
          63. - + -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - +
            -

            Documentation

            -

            When should documentation changes be done?

            -
              -
            • Whenever a new feature is added, a bug is fixed, or a breaking change is made, it should be documented where appropriate (ex: README.md, changelog, etc.)
              • -
            • New methods of installation are always appreciated and should be documented
              • -
            -

            What pages need documentation?

            -

            There are a few areas where documentation changes are often needed:

            - -

            How should I add documentation?

            -
              -
            1. -

              Fork the repository first and make changes there.

              -
              2. -
            2. -

              Where you're adding documentation will probably affect what you need to do:

              - -
                -
              • For changes to the help menu, try to refer to the existing code within src/constants.rs on how the help menu is generated.
                • -
              -
                -
              • -

                For changes to the extended documentation, you'll want MkDocs, Material for MkDocs, and mdx_truly_sane_lists installed to provide live reloading and preview for your changes. You can do so through pip or your system's package managers. While you don't need these, it'll probably help in making and validating changes.

                -

                You may also want Mike, but it isn't really needed.

                -
                • -
              -
              3. -
            3. -

              Once you have your documentation changes done, submit it as a pull request. For more information regarding that, refer to Issues and Pull Requests.

              -
              4. -
            - -
          + + + + + +
        63. + + Home + +
          64. + + + + + + + + + + +
        64. + + Support + +
          65. + + + + + + + + + + + +
        65. + + + + + + + + + + +
          66. + + + + + + + + + + + +
        66. + + + + + + + + + + +
          67. + + + + + + + + + + + + + +
        67. + + + + + + + + + + +
          68. + + + + + + + + + + +
        68. + + Troubleshooting + +
          69. + + + + + +
          - - - - Back to top - - - - - + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/contribution/issues-and-pull-requests/index.html b/0.6.6/contribution/issues-and-pull-requests/index.html index f17b4573..fa54d231 100644 --- a/0.6.6/contribution/issues-and-pull-requests/index.html +++ b/0.6.6/contribution/issues-and-pull-requests/index.html @@ -1,1010 +1,1085 @@ - - - - - - - - - - - - - - - - - - - - Issues and Pull Requests - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - - - - -
          -
          - - - -
          -
          -
          - - - - - -
          -
          -
          - - - -
          -
          -
          - - -
          - - - -
        69. - - Pull requests - - -
          70. - - - - -
          + + + +
          +
          + + + +
          +
          +
          + + + + + +
          - - -
          -
          - - - - - + +
            -

            Issues and Pull Requests

            -

            Contribution in any way is appreciated, whether it is reporting problems, fixing bugs, implementing features, improving the documentation, etc.

            -

            Opening an issue

            -

            Bug reports

            -

            When filing a bug report, please use the bug report template and fill in as much as you can. It is incredibly difficult for a maintainer to fix -a bug when it cannot be reproduced, and giving as much detail as possible generally helps to make it easier to reproduce the problem!

            -

            Feature requests

            -

            Please use the feature request template and fill it out. Remember to give details about what the feature is along with why you think this suggestion will be useful.

            -

            Pull requests

            -

            The expected workflow for a pull request is:

            -
              -
            1. Fork the project.
              2. -
            2. Make your changes.
              3. -
            3. Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See here for tips on documentation.
              4. -
            4. Commit and create a pull request to merge into the master branch. Please follow the pull request template.
              5. -
            5. Wait for the tests to pass. These consist of clippy lints, rustfmt checks, and basic tests. If you are a first time contributor, you may need to skip this step for now, as GitHub Actions requires approval to run.
              6. -
            6. Ask a maintainer to review your pull request. If changes are suggested or any comments are made, they should probably be addressed. Once it looks good, it'll be merged!
              7. -
            - -
          + + + + + +
        70. + + Home + +
          71. + + + + + + + + + + +
        71. + + Support + +
          72. + + + + + + + + + + + +
        72. + + + + + + + + + + +
          73. + + + + + + + + + + + +
        73. + + + + + + + + + + +
          74. + + + + + + + + + + + + + +
        74. + + + + + + + + + + +
          75. + + + + + + + + + + +
        75. + + Troubleshooting + +
          76. + + + + + +
          - - - - Back to top - - -
          - -
          - -
          + + + + + + Back to top + + +
          + + +
          - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/contribution/packaging-and-distribution/index.html b/0.6.6/contribution/packaging-and-distribution/index.html index b0bbeaf2..10d89a92 100644 --- a/0.6.6/contribution/packaging-and-distribution/index.html +++ b/0.6.6/contribution/packaging-and-distribution/index.html @@ -1,989 +1,1073 @@ - - - - - - - - - - - - - - - - - - - - Packaging and Distribution - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - + + + +
          -
        76. - - Home - -
          77. - - - - - -
        77. - - Support - -
          78. - - - - + - - - -
          -
          - - - -
          -
          -
          - - - -
          + - - - - - - - -
        78. - - Basic Mode - -
          79. - - - - - - - - - - - +
          +
          - - - - -
        79. - - - - - - - - - - -
          80. - + -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - +
            -

            Packaging and Distribution

            -

            Package maintainers are always welcome and appreciated! Here's some info on how one can help with package distribution and bottom.

            -

            Pre-built binaries

            -

            The latest stable release can be found here, where you can find pre-built binaries in either a tar.gz or zip format. -Binaries here also include automatically generated shell completion files for zsh, bash, fish, and Powershell, which you may want to also install during the packaging -process.

            -

            You can also find a nightly build in the releases page, built every day at 00:00 UTC off of the master branch.

            -

            Building manually

            -

            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
-
            -

            You'll then want to build with:

            -
            cargo build --release --locked
-
            -

            Completion files are automatically generated during this process, and are located in the directory target/release/build/bottom-<gibberish>/out. Note there may be multiple folders that look like target/release/build/bottom-<gibberish>. To programmatically determine which is the right folder, you might want to use something like:

            -
            $(ls target/release/build/bottom-*/out/btm.bash | head -n1 | xargs dirname)
-
            -

            You may find the Arch package install script template useful as a reference.

            -

            Adding an installation source

            -

            Once you've finished your installation source, if you want to mention it in the main bottom repo, fork the repo and add the installation method and any details to -the README.md file under the Installation section. -Once that's done, open a pull request - these will usually be approved of very quickly.

            -

            You can find more info on the contribution process here.

            - -
          + + + + + +
        80. + + Home + +
          81. + + + + + + + + + + +
        81. + + Support + +
          82. + + + + + + + + + + + +
        82. + + + + + + + + + + +
          83. + + + + + + + + + + + +
        83. + + + + + + + + + + +
          84. + + + + + + + + + + + + + +
        84. + + + + + + + + + + +
          85. + + + + + + + + + + +
        85. + + Troubleshooting + +
          86. + + + + + +
          - - - - Back to top - - - - - + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/index.html b/0.6.6/index.html index 1a7a3aa5..ad02806b 100644 --- a/0.6.6/index.html +++ b/0.6.6/index.html @@ -1,968 +1,1032 @@ - - - - - - - - - - - - - - - - - - - - Home - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - + + + +
          -
        86. - - Home - -
          87. - - - - - -
        87. - - Support - -
          88. - - - - + - - - -
          -
          - - - -
          -
          -
          - - - +
        88. + + Home + +
          89. -
          + - - - - - - - -
        89. - - Basic Mode - -
          90. - - - - - - - - - - - +
          +
          - - - - -
        90. - - - - - - - - - - -
          91. - + -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - +
            -

            bottom

            -

            This site serves as extended documentation for bottom alongside the README.md.

            -
            -

            Warning

            -

            Some areas of this documentation are still in progress and may be missing details. Feel free to suggest/contribute changes!

            -
            -

            Installation

            -
            -

            Tip

            -

            It is a good idea to first check out the Support page to see if your system is officially supported!

            -
            -
            -

            Tip

            -

            If you're facing some issues during/after installation, check out the Troubleshooting page for some common problems and solutions.

            -
            -

            To install bottom, refer to the installation section of the README.md, -which contains a list of all the installation methods.

            -

            Contribution

            -

            New contributors are always welcome! See the contribution section for how to contribute to -bottom, whether it be filing issues, writing documentation, creating pull requests, etc.

            - -
          + + + + + + + +
        91. + + + + + + + + + + + Home + + + + + + +
          92. + + + + + + + + + + +
        92. + + Support + +
          93. + + + + + + + + + + + +
        93. + + + + + + + + + + +
          94. + + + + + + + + + + + +
        94. + + + + + + + + + + +
          95. + + + + + + + + + + + +
        95. + + + + + + + + + + +
          96. + + + + + + + + + + +
        96. + + Troubleshooting + +
          97. + + + + + +
          - - - - Back to top - - - - - + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/support/index.html b/0.6.6/support/index.html index 96c233af..4a657a39 100644 --- a/0.6.6/support/index.html +++ b/0.6.6/support/index.html @@ -1,1080 +1,1151 @@ - - - - - - - - - - - - - - - - - - - - Support - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - - - - -
          -
          - - - -
          -
          -
          - - - - - - -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - +
            -

            Support

            -

            Official support

            -

            bottom officially supports the following operating systems and corresponding architectures:

            -
              -
            • macOS (x86_64)
              • -
            • Linux (x86_64, i686, aarch64)
              • -
            • Windows (x86_64, i686)
              • -
            -

            These platforms are tested to work (with caveats, see below) and issues on these platforms will be fixed if possible.

            -

            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.

            -

            Known problems

            -

            Windows

            -
              -
            • The temperature widget seems to require elevated access in some cases to get data.
              • -
            • The battery widget seems to have issues with dual battery systems, like some Thinkpads.
              • -
            • If you run on WSL/WSL2, you may have issues with getting memory data.
              • -
            • WSL and WSL2 (as far as I know) cannot correctly report temperature sensors.
              • -
            • WSL2 will not match Windows' own Task Manager in terms of data.
              • -
            -

            macOS

            -
              -
            • The process widget may require elevated access (ex: sudo btm) to gather all data in some cases. Please note that you should be certain that you trust any software you grant root privileges.
              • -
            -

            Unofficial support

            -

            Systems and architectures that aren't officially supported may still work, but there are no guarantees on how much will work. For example, it might only compile, or it might run with bugs/broken features. -Furthermore, while it will depend on the problem at the end of the day, issues on unsupported platforms are likely to go unfixed.

            -

            Unofficially supported platforms known to compile/work:

            -
              -
            • Linux on ARMv7 and ARMv6 (tested to compile in CI)
              • -
            • macOS on AArch64 (tested to compile in CI)
              • -
            • Linux on PowerPC 64 LE (tested to compile in CI)
              • -
            • Linux on an RISC-V (tested to compile in CI, tested to run on an Allwinner D1 Nezha)
              • -
            -

            Known problems

            -
              -
            • M1-based macOS devices may have issues with temperature sensors not returning anything.
              • -
            - -
          + + + + + +
        97. + + Home + +
          98. + + + + + + + + + + + + +
        98. + + + + + + + + + + + Support + + + + + + +
          99. + + + + + + + + + + + +
        99. + + + + + + + + + + +
          100. + + + + + + + + + + + +
        100. + + + + + + + + + + +
          101. + + + + + + + + + + + +
        101. + + + + + + + + + + +
          102. + + + + + + + + + + +
        102. + + Troubleshooting + +
          103. + + + + + +
          - - - - Back to top - - - - -
          - - + +
          +
          +
          + + + Made with + + Material for MkDocs + + +
          + +
          +
          +
          + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/troubleshooting/index.html b/0.6.6/troubleshooting/index.html index a5395b01..085cd54c 100644 --- a/0.6.6/troubleshooting/index.html +++ b/0.6.6/troubleshooting/index.html @@ -1,1090 +1,1187 @@ - - - - - - - - - - - - - - - - - - - - Troubleshooting - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - - - - -
          -
          - - - -
          -
          -
          - - - - - - -
          -
          -
          - - - -
          -
          -
          - + - -
          + + + +
          +
          + + + +
          +
          +
          + + + + + +
          - - -
          -
          - - - - - + +
            -

            Troubleshooting

            -

            The graph points look broken/strange

            -

            It's possible that your graphs won't look great out of the box due to the reliance on braille fonts.

            -

            One example of this is seeing a bunch of missing font characters, caused when the terminal isn't configured properly to render braille fonts.

            -
            - Example of a terminal with no braille font. -
            Powershell shown missing braille fonts
            -
            -

            Another example is when braille is rendered as a block of dots, with the non-coloured dots also appearing. This may look strange for some users, and it is also caused by misconfiguration or missing fonts.

            -
            - Example of a terminal with the wrong braille font. -
            Braille fonts rendering as a block of dots
            -
            -

            In either case, you may need to install a specific font and configure your terminal to use it. For example, installing UBraille -and ensuring your terminal uses it should work.

            -

            Another alternative is to use the --dot_marker option to render graph charts using dots instead of the braille characters, which generally seems better supported out of the box, -at the expense of looking less intricate:

            -
            - Example of running bottom with the dot marker flag -
            Example using btm --dot_marker
            -
            -

            Why can't I see all my processes/process usage on macOS?

            -

            You may have to run the program with elevated privileges - for example:

            -
            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, but there may still be some limitations.

            -

            My configuration file isn't working

            -

            If your configuration files aren't working, here are a few things to try:

            -

            Check the formatting

            -

            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"
-
            -

            Meanwhile, if you want to set a custom color scheme, it would be under the [colors] table:

            -
            [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:

            - - - - - - - - - - - - - - - - - - - - - -
            OSDefault Config Location
            macOS$HOME/Library/Application Support/bottom/bottom.toml
            ~/.config/bottom/bottom.toml
            $XDG_CONFIG_HOME/bottom/bottom.toml
            Linux~/.config/bottom/bottom.toml
            $XDG_CONFIG_HOME/bottom/bottom.toml
            WindowsC:\Users\<USER>\AppData\Roaming\bottom\bottom.toml
            -

            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
-
            -

            My installation through snap has some widgets that are blank/show no data

            -

            Make sure bottom is given the correct permissions. Snapcraft explains how to do so.

            - -
          + + +
        103. + + Home + +
          104. + + + + + + + + + + +
        104. + + Support + +
          105. + + + + + + + + + + + +
        105. + + + + + + + + + + +
          106. + + + + + + + + + + + +
        106. + + + + + + + + + + +
          107. + + + + + + + + + + + +
        107. + + + + + + + + + + +
          108. + + + + + + + + + + + + +
        108. + + + + + + + + + + + Troubleshooting + + + + + + +
          109. + + + + + +
          - - - - Back to top - - -
          - -
          + + + + + + Back to top + + +
          + + +
          - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/usage/basic-mode/index.html b/0.6.6/usage/basic-mode/index.html index 7464510f..03883f5f 100644 --- a/0.6.6/usage/basic-mode/index.html +++ b/0.6.6/usage/basic-mode/index.html @@ -1,976 +1,1047 @@ - - - - - - - - - - - - - - - - - - - - Basic Mode - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - + + + +
          -
        109. - - Home - -
          110. - - - - - -
        110. - - Support - -
          111. - - - - - - + - - - -
          -
          - - - -
          -
          -
          - - - -
          + - - - - - - - - - -
        111. - - - - - - - - - - - Basic Mode - - - - - -
          112. - - - - - - - +
          +
          - - - - - - - - -
        112. - - - - - - - - - -
        113. -
          114. - - - - - - - - - - -
        114. - - Troubleshooting - -
          115. - - - - - -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          +
          + + +
          +
          + + + + + + + + + +

          Basic Mode

          +

          Basic mode is a special layout that removes all of the graphs and provides an interface that resembles (a + very stripped-down version of) htop.

          +
          + A picture of bottom's basic mode. +
          + +

          Basic mode can be enabled either through a command line flag:

          +
          + 
          btm -b
 
 # or
 
 btm --basic
-
          -

          or through the config:

          -
          [flags]
+
          +
          +

          or through the config:

          +
          + 
          [flags]
 basic = true
-
          -

          Notes

          -

          In this mode, widgets that use tables (temperatures, processes, disks, and batteries) are only shown one at a time. -One can switch between these widgets either by clicking the arrow buttons or by using the general widget selection shortcuts (for example, Ctrl+Left or H) -to switch which widget is shown.

          -

          Also note that in this mode, widget expansion and custom layouts are disabled.

          -

          Key bindings

          -

          Basic mode follows the same key bindings as normal, barring widget expansion being disabled, and that the % key while selecting the memory widget toggles between total usage and percentage.

          +           +
          +

          Notes

          +

          In this mode, widgets that use tables (temperatures, processes, disks, and batteries) are only shown one + at a time. + One can switch between these widgets either by clicking the arrow buttons or by using the general widget + selection shortcuts (for example, Ctrl+Left or H) + to switch which widget is shown.

          +

          Also note that in this mode, widget expansion and custom layouts are disabled.

          +

          Key bindings

          +

          Basic mode follows the same key bindings as normal, barring widget expansion being disabled, and that the + % key while selecting the memory widget toggles between total usage + and percentage.

          - - - + + - - - - Back to top - - - - - + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/usage/general-usage/index.html b/0.6.6/usage/general-usage/index.html index d494ae19..75b62faa 100644 --- a/0.6.6/usage/general-usage/index.html +++ b/0.6.6/usage/general-usage/index.html @@ -1,1118 +1,1217 @@ - - - - - - - - - - - - - - - - - - - - General Usage - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - - - - -
          -
          - - - -
          -
          -
          - - - - - -
          -
          -
          - - - -
          -
          -
          - - -
          - - - -
        115. - - Key bindings - - -
          116. - -
        116. - - Mouse bindings - - -
          117. - - - - -
          + + + +
          +
          + + + +
          +
          +
          + + + + + +
          - - -
          -
          - - - - - + + + +
          +
          +
          + + + +
          +
          +
          + + + +
          +
          +
          + + +
          +
          + + + + + + + + + +

          General Usage

          +

          You can run bottom with:

          +
          + 
          btm
+
          +
          +

          For help regarding the command-line flags, use:

          +
          + 
          # For a simple overview of flags
 btm -h
 
 # For more details
 btm --help
-
          -

          Features

          -

          Expansion

          -

          By default, bottom is somewhat like a dashboard - a bunch of different widgets, all showing different things, and they all cram together to fit into one terminal.

          -

          If you instead just want to see one widget - maybe you want to look at a graph in more detail, for example - you can "expand" the currently selected -widget using the e key, which will hide all other widgets and make that widget take up all available terminal space.

          -

          You can leave this state by either pressing e again or pressing Esc.

          -

          Widget selection

          -

          To allow for widget-specific keybindings and expansion, there is the idea of widget selection in bottom, where you can focus on a specific widget to work with it. -This can be done with the mouse (just click on the widget of interest) or keyboard (ex: Ctrl+Direction, see Key bindings for alternatives).

          -

          Key bindings

          -

          These are global or common keyboard shortcuts for the application, which you can see in-app through the ? shortcut. -Note that key bindings are generally case-sensitive.

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          BindingAction
          q , Ctrl+cQuit
          EscClose dialog windows, search, widgets, or exit expanded mode
          Ctrl+rReset display and any collected data
          fFreeze/unfreeze updating with new data
          ?Open help menu
          eToggle expanding the currently selected widget
          Ctrl+Up
          Shift+Up
          K
          W          		Select the widget above
          Ctrl+Down
          Shift+Down
          J
          S          		Select the widget below
          Ctrl+Left
          Shift+Left
          H
          A          		Select the widget on the left
          Ctrl+Right
          Shift+Right
          L
          D          		Select the widget on the right
          Up , kMove up within a widget
          Down , jMove down within a widget
          Left
          h
          Alt+h          		Move left within a widget
          Right
          l
          Alt+l          		Move right within a widget
          g+g , HomeJump to the first entry
          G , EndJump to the last entry
          -

          Mouse bindings

          - - - - - - - - - - - - - -
          BindingAction
          Left ButtonSelects the widget
          +           +
          +

          Features

          +

          Expansion

          +

          By default, bottom is somewhat like a dashboard - a bunch of different widgets, all showing different + things, and they all cram together to fit into one terminal.

          +

          If you instead just want to see one widget - maybe you want to look at a graph in more detail, + for example - you can "expand" the currently selected + widget using the e key, which will hide all other + widgets and make that widget take up all available terminal space.

          +

          You can leave this state by either pressing e again or + pressing Esc.

          +

          Widget selection

          +

          To allow for widget-specific keybindings and expansion, there is the idea of widget selection in + bottom, where you can focus on a specific widget to work with it. + This can be done with the mouse (just click on the widget of interest) or keyboard (ex: Ctrl+Direction, see Key bindings for alternatives).

          +

          Key bindings

          +

          These are global or common keyboard shortcuts for the application, which you can see in-app through the + ? shortcut. + Note that key bindings are generally case-sensitive.

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          BindingAction
          q , Ctrl+cQuit
          EscClose dialog windows, search, widgets, or exit expanded mode
          Ctrl+rReset display and any collected data
          fFreeze/unfreeze updating with new data
          ?Open help menu
          eToggle expanding the currently selected widget
          Ctrl+Up
          Shift+Up
          + K
          W          		Select the widget above
          Ctrl+Down
          Shift+Down
          + J
          S          		Select the widget below
          Ctrl+Left
          Shift+Left
          + H
          A          		Select the widget on the left
          Ctrl+Right
          Shift+Right +
          L
          D          		Select the widget on the right
          Up , kMove up within a widget
          Down , jMove down within a widget
          Left
          h
          Alt+h          		Move left within a widget
          Right
          l
          Alt+l          		Move right within a widget
          g+g , + HomeJump to the first entry
          G , EndJump to the last entry
          +

          Mouse bindings

          + + + + + + + + + + + + + +
          BindingAction
          Left ButtonSelects the widget
          - - -
          + +
          - - - - Back to top - - -
          - -
          + + + + Back to top + + + + + + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/usage/widgets/battery/index.html b/0.6.6/usage/widgets/battery/index.html index 51ab462a..8fe72c11 100644 --- a/0.6.6/usage/widgets/battery/index.html +++ b/0.6.6/usage/widgets/battery/index.html @@ -1,1023 +1,1091 @@ - - - - - - - - - - - - - - - - - - - - Battery Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - + + + +
          -
        117. - - Home - -
          118. - - - - - -
        118. - - Support - -
          119. - - - - - - + - - - -
          -
          - - - -
          -
          -
          - - - -
          + - - - - - - - -
        119. - - Basic Mode - -
          120. - - - - - - - - - - - +
          +
          - - - - -
        120. - - - - - - - - - - -
          121. - + -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - +
            -

            Battery Widget

            -
            -

            Warning

            -

            The battery features are unavailable if the binary is compiled with the battery feature disabled!

            -
            -

            The battery widget provides information about batteries on the system.

            -
            - A picture of an expanded battery widget. -
            -

            The battery widget can be enabled through either the --battery flag, the battery = true option in a config file, or specifying the widget in a custom layout.

            -

            Features

            -

            The following data is displayed for batteries:

            -
              -
            • Charge percent
              • -
            • Consumption
              • -
            • Time to empty/charge, based on the current state
              • -
            • Battery health percent
              • -
            -

            The battery widget also supports devices with multiple batteries, and you can switch between them using the keyboard or the mouse.

            -

            Key bindings

            -

            Note that key bindings are generally case-sensitive.

            - - - - - - - - - - - - - - - - - -
            BindingAction
            Left
            h
            Alt+h            		Moves to the battery entry to the left of the current one
            Right
            l
            Alt+l            		Moves to the battery entry to the right of the current one
            -

            Mouse bindings

            - - - - - - - - - - - - - -
            BindingAction
            Left ButtonSelects a battery entry
            - -
          + + + + +
        121. + + Home + +
          122. + + + + + + + + + + +
        122. + + Support + +
          123. + + + + + + + + + + + + + +
        123. + + + + + + + + + + +
          124. + + + + + + + + + + + +
        124. + + + + + + + + + + +
          125. + + + + + + + + + + + +
        125. + + + + + + + + + + +
          126. + + + + + + + + + + +
        126. + + Troubleshooting + +
          127. + + + + + +
          - - - - Back to top - - - - - + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/usage/widgets/cpu/index.html b/0.6.6/usage/widgets/cpu/index.html index 1b80d524..00e3efe0 100644 --- a/0.6.6/usage/widgets/cpu/index.html +++ b/0.6.6/usage/widgets/cpu/index.html @@ -1,1150 +1,1220 @@ - - - - - - - - - - - - - - - - - - - - CPU Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - - - - -
          -
          - - - -
          -
          -
          - - - - - - -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - +
            -

            CPU Widget

            -

            The CPU widget displays a visual representation of CPU usage over a time range.

            -
            - A picture of an expanded CPU widget showing average CPU usage. -
            -

            Features

            -

            The CPU widget is composed of two parts: the graph and the legend:

            -
              -
            • The graph displays the usage data for the currently selected entry as a percentage
              • -
            • The legend displays all available entries that can be displayed on the graph along with their last recorded use percentage (except for the "All" option)
              • -
            -

            Users can scroll through the legend using either the keyboard or mouse to select which entry to display on the graph. The "All" option shows every entry -at the same time, though this may get a bit hard to follow if you have a large number of cores/threads.

            -

            One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

            -

            Key bindings

            -

            Note that key bindings are generally case-sensitive.

            -

            Graph

            - - - - - - - - - - - - - - - - - - - - - -
            BindingAction
            +Zoom in on chart (decrease time range)
            -Zoom out on chart (increase time range)
            =Reset zoom
            -

            Legend

            - - - - - - - - - - - - - - - - - - - - - - - - - -
            BindingAction
            Up , kMove up within a widget
            Down , jMove down within a widget
            g+g , HomeJump to the first entry in the legend
            G , EndJump to the last entry in the legend
            -

            Mouse bindings

            -

            Graph

            - - - - - - - - - - - - - -
            BindingAction
            ScrollScrolling up or down zooms in or out of the graph respectively
            -

            Legend

            - - - - - - - - - - - - - - - - - -
            BindingAction
            ScrollScroll through options to display in the graph
            Left ButtonSelects a CPU thread/average to show in the graph
            - -
          + + + + +
        127. + + Home + +
          128. + + + + + + + + + + +
        128. + + Support + +
          129. + + + + + + + + + + + + + +
        129. + + + + + + + + + + +
          130. + + + + + + + + + + + +
        130. + + + + + + + + + + +
          131. + + + + + + + + + + + +
        131. + + + + + + + + + + +
          132. + + + + + + + + + + +
        132. + + Troubleshooting + +
          133. + + + + + +
          - - - - Back to top - - - - - + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/usage/widgets/disk/index.html b/0.6.6/usage/widgets/disk/index.html index 5b2abe5e..8b8b825f 100644 --- a/0.6.6/usage/widgets/disk/index.html +++ b/0.6.6/usage/widgets/disk/index.html @@ -1,1028 +1,1094 @@ - - - - - - - - - - - - - - - - - - - - Disk Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - + + + +
          -
        133. - - Home - -
          134. - - - - - -
        134. - - Support - -
          135. - - - - - - + - - - -
          -
          - - - -
          -
          -
          - - - -
          + - - - - - - - -
        135. - - Basic Mode - -
          136. - - - - - - - - - - - +
          +
          - - - - -
        136. - - - - - - - - - - -
          137. - + -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - +
            -

            Disk Widget

            -

            The disk widget provides a table of useful disk and partition information, like I/O per second and total usage.

            -
            - A picture of an expanded disk widget. -
            -

            Features

            -

            The disk widget provides the following information:

            -
              -
            • Disk name
              • -
            • Disk mount location
              • -
            • Percentage of space used
              • -
            • Amount of space left
              • -
            • Total amount of space
              • -
            • Read per second
              • -
            • Write per second
              • -
            -

            Key bindings

            -

            Note that key bindings are generally case-sensitive.

            - - - - - - - - - - - - - - - - - - - - - - - - - -
            BindingAction
            Up , kMove up within a widget
            Down , jMove down within a widget
            g+g , HomeJump to the first entry in the table
            G , EndJump to the last entry in the table
            -

            Mouse bindings

            - - - - - - - - - - - - - -
            BindingAction
            Left ButtonSelects an entry in the table
            - -
          + + + + +
        137. + + Home + +
          138. + + + + + + + + + + +
        138. + + Support + +
          139. + + + + + + + + + + + + + +
        139. + + + + + + + + + + +
          140. + + + + + + + + + + + +
        140. + + + + + + + + + + +
          141. + + + + + + + + + + + +
        141. + + + + + + + + + + +
          142. + + + + + + + + + + +
        142. + + Troubleshooting + +
          143. + + + + + +
          - - - - Back to top - - - - - + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/usage/widgets/memory/index.html b/0.6.6/usage/widgets/memory/index.html index f7abfb1d..7586dc29 100644 --- a/0.6.6/usage/widgets/memory/index.html +++ b/0.6.6/usage/widgets/memory/index.html @@ -1,1036 +1,1105 @@ - - - - - - - - - - - - - - - - - - - - Memory Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - + + + +
          -
        143. - - Home - -
          144. - - - - - -
        144. - - Support - -
          145. - - - - - - + - - - -
          -
          - - - -
          -
          -
          - - - -
          + - - - - - - - -
        145. - - Basic Mode - -
          146. - - - - - - - - - - - +
          +
          - - - - -
        146. - - - - - - - - - - -
          147. - + -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - +
            -

            Memory Widget

            -

            The memory widget provides a visual representation of RAM and swap usage over time.

            -
            - A picture of an expanded memory widget. -
            -

            Features

            -

            The legend displays the current usage in terms of percentage and actual usage in binary units (KiB, MiB, GiB, etc.). -If the total RAM or swap available is 0, then it is automatically hidden from the legend and graph.

            -

            One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

            -

            Key bindings

            -

            Note that key bindings are generally case-sensitive.

            - - - - - - - - - - - - - - - - - - - - - -
            BindingAction
            +Zoom in on chart (decrease time range)
            -Zoom out on chart (increase time range)
            =Reset zoom
            -

            Mouse bindings

            - - - - - - - - - - - - - -
            BindingAction
            ScrollScrolling up or down zooms in or out of the graph respectively
            -

            Calculations

            -

            Memory usage is calculated using the following formula based on values from /proc/meminfo (based on htop's implementation):

            -
            MemTotal - MemFree - Buffers - (Cached + SReclaimable - Shmem)
-
            -

            You can find more info on /proc/meminfo and its fields here.

            - -
          + + + + +
        147. + + Home + +
          148. + + + + + + + + + + +
        148. + + Support + +
          149. + + + + + + + + + + + + + +
        149. + + + + + + + + + + +
          150. + + + + + + + + + + + +
        150. + + + + + + + + + + +
          151. + + + + + + + + + + + +
        151. + + + + + + + + + + +
          152. + + + + + + + + + + +
        152. + + Troubleshooting + +
          153. + + + + + +
          - - - - Back to top - - - - - + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/usage/widgets/network/index.html b/0.6.6/usage/widgets/network/index.html index 4583eaf9..a2481eea 100644 --- a/0.6.6/usage/widgets/network/index.html +++ b/0.6.6/usage/widgets/network/index.html @@ -1,1020 +1,1087 @@ - - - - - - - - - - - - - - - - - - - - Network Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - + + + +
          -
        153. - - Home - -
          154. - - - - - -
        154. - - Support - -
          155. - - - - - - + - - - -
          -
          - - - -
          -
          -
          - - - -
          + - - - - - - - -
        155. - - Basic Mode - -
          156. - - - - - - - - - - - +
          +
          - - - - -
        156. - - - - - - - - - - -
          157. - + -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - +
            -

            Network Widget

            -

            The network widget provides a visual representation of network input and output per second, as well as noting the total amount -received and transmitted.

            -
            - A picture of an expanded network widget. -
            -

            Features

            -

            The legend displays the current reads and writes per second in bits, as well as the total amount read/written.

            -

            The y-axis automatically scales based on shown read/write values, and by default, is a linear scale based on base-10 units (e.x. kilobit, gigabit, etc.). -Through configuration, the read/write per second unit can be changed to bytes, while the y-axis can be changed to a -log scale and/or use base-2 units (e.x. kibibit, gibibit, etc.).

            -

            One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.

            -

            Key bindings

            -

            Note that key bindings are generally case-sensitive.

            - - - - - - - - - - - - - - - - - - - - - -
            BindingAction
            +Zoom in on chart (decrease time range)
            -Zoom out on chart (increase time range)
            =Reset zoom
            -

            Mouse bindings

            - - - - - - - - - - - - - -
            BindingAction
            ScrollScrolling up or down zooms in or out of the graph respectively
            - -
          + + + + +
        157. + + Home + +
          158. + + + + + + + + + + +
        158. + + Support + +
          159. + + + + + + + + + + + + + +
        159. + + + + + + + + + + +
          160. + + + + + + + + + + + +
        160. + + + + + + + + + + +
          161. + + + + + + + + + + + +
        161. + + + + + + + + + + +
          162. + + + + + + + + + + +
        162. + + Troubleshooting + +
          163. + + + + + +
          - - - - Back to top - - - - - + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/usage/widgets/process/index.html b/0.6.6/usage/widgets/process/index.html index d1f1a9c5..dff3d135 100644 --- a/0.6.6/usage/widgets/process/index.html +++ b/0.6.6/usage/widgets/process/index.html @@ -1,1680 +1,1800 @@ - - - - - - - - - - - - - - - - - - - - Process Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - - - - -
          -
          - - - -
          -
          -
          - - - - - - -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - +
            -

            Process Widget

            -

            The process widget displays a table containing information regarding a running process, along with sorting, -searching, and process control features.

            -
            - A picture of an expanded process widget by default. -
            -

            Features

            -

            The process widget has three main components:

            -
              -
            • The main process table
              • -
            • The search sub-widget (opened with Ctrl+f or /)
              • -
            • The sort menu sub-widget (opened with s or F6)
              • -
            -

            By default, the main process table displays the following information for each process:

            -
              -
            • PID
              • -
            • Name of the process
              • -
            • CPU use percentage (note this is averaged out per available thread)
              • -
            • Memory use percentage
              • -
            • Reads per second
              • -
            • Writes per second
              • -
            • Total amount read
              • -
            • Total amount written
              • -
            • User
              • -
            • State
              • -
            -

            Sorting

            -

            The table can be sorted by clicking on the table headers, which will either sort the table by that column, or if already -sorting by that column, reverse the sorting order.

            -

            Alternatively, one can sort using the sort menu sub-widget, which is brought up using s or F6, and can be controlled by arrow keys or the mouse.

            -
            - A picture of an expanded process widget with the sort menu open. -
            -

            Grouping

            -

            Pressing Tab in the table will group entries with the same name together. The PID column will be replaced with the number of entries in each group, and usage -is added together when displayed.

            -
            - A picture of grouped mode in a process widget. -
            -

            Note that the process state and user columns are disabled in this mode.

            -

            Tree mode

            -

            Pressing t or F5 in the table toggles tree mode in the process widget, displaying processes in regards to their parent-child process relationships.

            -
            - A picture of tree mode in a process widget. -
            -

            A process in tree mode can also be "collapsed", hiding its children and any descendants, using either the - or + keys, or double clicking on an entry.

            -

            Lastly, note that in tree mode, processes cannot be grouped together due to the behaviour of the two modes somewhat clashing.

            -

            Full command

            -

            You can show the full command instead of just the process name by pressing P.

            -
            - A picture of a process widget using full commands. -
            - -

            Pressing / or Ctrl+f will open up the search sub-widget. By default, just typing in something will search by the process name.

            -
            - A picture of searching for a process with a simple search. -
            -

            This search can be further enhanced by matching by case, matching the entire word, or by regex.

            -
            - A picture of searching for a process with a search condition that uses regex. -
            +
          • + + Home + +
            • -

            We are able to also search for multiple things/conditions.

            -
            - A picture of searching for a process with a search condition that uses the or operator. -
            -

            And if our search uses a keyword, we need to use quotation marks around the term to properly search it.

            -
            - A picture of searching for a process with a search condition that needs quotation marks. -
            -

            Lastly, we can refine our search even further based on the other columns, like PID, CPU usage, etc., as well as grouping together conditions.

            -
            - A picture of searching for a process with a search condition that uses the CPU keyword. -
            -

            Keywords

            -

            Note all keywords are case-insensitive. To search for a process/command that collides with a keyword, surround the term with quotes (e.x. "cpu").

            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            KeywordsExampleDescription
            btmMatches by process or command name; supports regex
            pidpid=1044Matches by PID; supports regex
            cpu
            cpu%            		cpu > 0.5Matches the CPU column; supports comparison operators
            membmemb > 1000 bMatches the memory column in terms of bytes; supports comparison operators
            mem
            mem%            		mem < 0.5Matches the memory column in terms of percent; supports comparison operators
            read
            r/s            		read = 1 mbMatches the read/s column in terms of bytes; supports comparison operators
            write
            w/s            		write >= 1 kbMatches the write/s column in terms of bytes; supports comparison operators
            tread
            t.read            		tread <= 1024 gbMatches he total read column in terms of bytes; supports comparison operators
            twrite
            t.write            		twrite > 1024 tbMatches the total write column in terms of bytes; supports comparison operators
            useruser=rootMatches by user; supports regex
            statestate=runningMatches by state; supports regex
            ()(<COND 1> AND <COND 2>) OR <COND 3>Group together a condition
            -

            Comparison operators

            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            KeywordsDescription
            =Checks if the values are equal
            >Checks if the left value is strictly greater than the right
            <Checks if the left value is strictly less than the right
            >=Checks if the left value is greater than or equal to the right
            <=Checks if the left value is less than or equal to the right
            -

            Logical operators

            -

            Note all operators are case-insensitive, and the and operator takes precedence over the or operator.

            - - - - - - - - - - - - - - - - - - - - -
            KeywordsUsageDescription
            and
            &&
            <Space>            		<COND 1> and <COND 2>
            <COND 1> && <COND 2>
            <COND 1> <COND 2>            		Requires both conditions to be true to match
            or
            ||            		<COND 1> or <COND 2>
            <COND 1> &#124;&#124; <COND 2>            		Requires at least one condition to be true to match
            -

            Units

            -

            All units are case-insensitive.

            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            KeywordsDescription
            BBytes
            KBKilobytes
            MBMegabytes
            GBGigabytes
            TBTerabytes
            KiBKibibytes
            MiBMebibytes
            GiBGibibytes
            TiBTebibytes
            -

            Key bindings

            -

            Note that key bindings are generally case-sensitive.

            -

            Process table

            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            BindingAction
            Up , kMove up within a widget
            Down , jMove down within a widget
            g+g , HomeJump to the first entry in the table
            G , EndJump to the last entry in the table
            d+d , F9Send a kill signal to the selected process
            cSort by CPU usage, press again to reverse sorting order
            mSort by memory usage, press again to reverse sorting order
            pSort by PID name, press again to reverse sorting order
            nSort by process name, press again to reverse sorting order
            TabToggle grouping processes with the same name
            PToggle between showing the full command or just the process name
            Ctrl+f , /Toggle showing the search sub-widget
            s , F6Toggle showing the sort sub-widget
            IInvert the current sort
            %Toggle between values and percentages for memory usage
            t , F5Toggle tree mode
            -

            Sort sub-widget

            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            BindingAction
            Up , kMove up within a widget
            Down , jMove down within a widget
            g+g , HomeJump to the first entry in the table
            G , EndJump to the last entry in the table
            EscClose the sort sub-widget
            EnterSorts the corresponding process table
            -

            Search sub-widget

            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            BindingAction
            Left
            h
            Alt+h            		Moves the cursor left
            Right
            l
            Alt+l            		Moves the cursor right
            EscClose the search widget (retains the filter)
            Ctrl+aSkip to the start of the search query
            Ctrl+eSkip to the end of the search query
            Ctrl+uClear the current search query
            Ctrl+wDelete a word behind the cursor
            Ctrl+hDelete the character behind the cursor
            BackspaceDelete the character behind the cursor
            DelDelete the character at the cursor
            Alt+c , F1Toggle matching case
            Alt+w , F2Toggle matching the entire word
            Alt+r , F3Toggle using regex
            -

            Mouse bindings

            -

            Process table

            - - - - - - - - - - - - - - - - - -
            BindingAction
            ScrollSelects a CPU thread/average to show in the graph
            Left ButtonTable header: Sorts/reverse sorts the table by the column
            Table entry: Selects an entry in the table, if in tree mode, collapses/expands the entry's children
            -

            Sort sub-widget

            - - - - - - - - - - - - - -
            BindingAction
            Left ButtonSelects an entry in the table
            - -
          + + + + + +
        163. + + Support + +
          164. + + + + + + + + + + + + + +
        164. + + + + + + + + + + +
          165. + + + + + + + + + + + +
        165. + + + + + + + + + + +
          166. + + + + + + + + + + + +
        166. + + + + + + + + + + +
          167. + + + + + + + + + + +
        167. + + Troubleshooting + +
          168. + + + + + +
          - - - - Back to top - - - - -
          - - + +
          +
          +
          + + + Made with + + Material for MkDocs + + +
          + +
          +
          +
          + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + + diff --git a/0.6.6/usage/widgets/temperature/index.html b/0.6.6/usage/widgets/temperature/index.html index 2728283d..03d1c78c 100644 --- a/0.6.6/usage/widgets/temperature/index.html +++ b/0.6.6/usage/widgets/temperature/index.html @@ -1,1019 +1,1084 @@ - - - - - - - - - - - - - - - - - - - - Temperature Widget - bottom - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - + - - + + + + - - - - - - - - - - - - - - - - - - - - - - -
          - -
          - - - - - -
          - - -
          - -
          - - - - - - + + + +
          -
        168. - - Home - -
          169. - - - - - -
        169. - - Support - -
          170. - - - - - - + - - - -
          -
          - - - -
          -
          -
          - - - -
          + - - - - - - - -
        170. - - Basic Mode - -
          171. - - - - - - - - - - - +
          +
          - - - - -
        171. - - - - - - - - - - -
          172. - + -
          + + + +
          +
          + ClementTsang/bottom +
          +
          -
          - - - -
          -
          -
          - - -
          -
          -
          - - -
          -
          - - - - - +
            -

            Temperature Widget

            -

            The temperature widget provides a table of temperature sensors and their current temperature.

            -
            - A picture of an expanded temperature widget. -
            -

            Features

            -

            The temperature widget provides the sensor name as well as its current temperature.

            -

            Key bindings

            -

            Note that key bindings are generally case-sensitive.

            - - - - - - - - - - - - - - - - - - - - - - - - - -
            BindingAction
            Up , kMove up within a widget
            Down , jMove down within a widget
            g+g , HomeJump to the first entry in the table
            G , EndJump to the last entry in the table
            -

            Mouse bindings

            - - - - - - - - - - - - - -
            BindingAction
            Left ButtonSelects an entry in the table
            - -
          + + + + +
        172. + + Home + +
          173. + + + + + + + + + + +
        173. + + Support + +
          174. + + + + + + + + + + + + + +
        174. + + + + + + + + + + +
          175. + + + + + + + + + + + +
        175. + + + + + + + + + + +
          176. + + + + + + + + + + + +
        176. + + + + + + + + + + +
          177. + + + + + + + + + + +
        177. + + Troubleshooting + +
          178. + + + + + +
          - - - - Back to top - - - - - + - - - -
          -
          -
          - - - - - - - - \ No newline at end of file +
          +
          +
          + + + + + + + + +