docs: add more troubleshooting documentation

This commit is contained in:
ClementTsang 2022-05-07 19:38:37 -04:00
parent 460869f281
commit 4d507d1793
6 changed files with 61 additions and 5 deletions

View File

@ -43,6 +43,7 @@
- [Auto-completion](#auto-completion) - [Auto-completion](#auto-completion)
- [Usage](#usage) - [Usage](#usage)
- [Configuration](#configuration) - [Configuration](#configuration)
- [Troubleshooting](#troubleshooting)
- [Contribution](#contribution) - [Contribution](#contribution)
- [Contributors](#contributors) - [Contributors](#contributors)
- [Thanks](#thanks) - [Thanks](#thanks)
@ -291,6 +292,11 @@ generate a configuration file on the first launch, which one can change as appro
More details on configuration can be found [in the documentation](https://clementtsang.github.io/bottom/nightly/configuration/config-file/default-config/). More details on configuration can be found [in the documentation](https://clementtsang.github.io/bottom/nightly/configuration/config-file/default-config/).
## Troubleshooting
If some things aren't working, give the [Troubleshooting page](https://clementtsang.github.io/bottom/nightly/troubleshooting) a look. If things still aren't
working, then consider asking a [question](https://github.com/ClementTsang/bottom/discussions) or filing a [bug report](https://github.com/ClementTsang/bottom/issues/new/choose).
## Contribution ## Contribution
Whether it's reporting bugs, suggesting features, maintaining packages, or submitting a PR, Whether it's reporting bugs, suggesting features, maintaining packages, or submitting a PR,

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

View File

@ -22,7 +22,7 @@ bottom from the repo/source, then please try that as well.
### Windows ### Windows
- The temperature widget seems to require elevated access in some cases to get data. - The temperature widget seems to require admin privileges in some cases to get data.
- The battery widget seems to have issues with dual battery systems, like some Thinkpads. - The battery widget seems to have issues with dual battery systems, like some Thinkpads.
- If you are using WSL or WSL2: - If you are using WSL or WSL2:
- You may have issues with getting memory data. - You may have issues with getting memory data.

View File

@ -18,10 +18,7 @@ Another example is when braille is rendered as a block of dots, with the non-col
<figcaption>Braille fonts rendering as a block of dots</figcaption> <figcaption>Braille fonts rendering as a block of dots</figcaption>
</figure> </figure>
In either case, you may need to install a specific font and configure your terminal to use it. For example, installing [UBraille](https://yudit.org/download/fonts/UBraille/) One 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,
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: at the expense of looking less intricate:
<figure> <figure>
@ -29,6 +26,59 @@ at the expense of looking less intricate:
<figcaption>Example using <code>btm --dot_marker</code></figcaption> <figcaption>Example using <code>btm --dot_marker</code></figcaption>
</figure> </figure>
Another (better) alternative is to install a font that supports braille fonts, and configure your terminal to use it. For example, installing
something like [UBraille](https://yudit.org/download/fonts/UBraille/) or [Iosevka](https://github.com/be5invis/Iosevka)
and ensuring your terminal uses it should work.
### Installing fonts for Windows Command Prompt/PowerShell
**Note: I would advise backing up your registry beforehand if you aren't sure what you are doing!**
Let's say you're installing [Iosevka](https://github.com/be5invis/Iosevka). The steps you can take are:
1. Install the font itself.
2. Open the registry editor, which you can do either by `Win+R` and opening `regedit`, or just opening it from the Start Menu.
3. In the registry editor, go to
```
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Console\TrueTypeFont
```
4. Here, add a new `String value`, and set the `Name` to a bunch of 0's (e.g. `000` - make sure the name isn't already used), then set the `Data` to the font name (e.g. `Iosevka`).
<figure>
<img src="../assets/screenshots/troubleshooting/regedit_fonts.webp" alt="Regedit menu showing how to add a new font for Command Prompt/PowerShell"/>
<figcaption>The last entry is the new entry for Iosevka</code></figcaption>
</figure>
5. Then, open the Command Prompt/PowerShell, and right click on the top bar, and open `Properties`:
<figure>
<img src="../assets/screenshots/troubleshooting/cmd_prompt_props.webp" alt="Opening the properties menu in Command Prompt/PowerShell"/>
</figure>
6. From here, go to `Font`, and set the font to your new font (e.g. `Iosevka`):
<figure>
<img src="../assets/screenshots/troubleshooting/cmd_prompt_font.webp" alt="Setting a new font in Command Prompt/PowerShell"/>
</figure>
## Why can't I see all my temperature sensors on Windows?
This is a known issue, and some sensors may require admin privileges to get sensor data.
## Why don't I see dual batteries on Windows reported separately? (e.g. Thinkpads)
This seems to be some issue with how batteries are being detected on Windows.
## Why can't I see all my temperature sensors on WSL?
Due to how WSL works, hosts may not expose their temperature sensors and therefore, temperature sensors might be missing.
## Why does WSL2 not match Task Manager?
Due to how WSL2 works, the two might not match up in terms of reported data.
## Why can't I see all my processes/process usage on macOS? ## Why can't I see all my processes/process usage on macOS?
You may have to run the program with elevated privileges - for example: You may have to run the program with elevated privileges - for example: