fujin/rtorrent
1
0
Fork 0
mirror of https://github.com/rakshasa/rtorrent.git synced 2026-10-05 21:59:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add blurb about color support

kannibalox
2025-01-09 14:11:22 -05:00
parent 61ad845a0c
commit 2a969585a1
1 changed files with 43 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
User-Guide.md
+43 -2
@@ -25,7 +25,7 @@
* [The Tracker list screen](#the-tracker-list-screen)
* [The Chunks seen screen](#the-chunks-seen-screen)
* [Signal handlers](#signal-handlers)
* [Color Support](#color-support)
## Adding and removing torrents ##
| Shortcut | Description |
@@ -108,6 +108,7 @@ This message is caused by deleting/modifying the downloaded file after a torrent
| ------------- | ------------- |
| right | Switch to selected view |
| left | Switch to view selection or back to main view |
| page up/page down | Move up/down multiple items. |
| 1/2 | Adjust min uploads. |
| 3/4 | Adjust max uploads. |
| !/@ | Adjust min downloads. |
@@ -399,4 +400,44 @@ If the chunk is in **bold** it means you do not have that chunk yet, if it is <u
| ------------- | ------------- |
| SIGINT | Normal shutdown with 5 seconds to send the stopped request to trackers. |
| SIGTERM | Shut down immediately. |
| SIGWINCH | Resize and redraw. |
| SIGWINCH | Resize and redraw. |
## Color Support ##
In the `master` branch (TODO: Replace with next release version), several new color commands are available for the ncurses UI. Each color is defined as a string in the format of:
```
<foreground attributes> <foreground color> [on <background attributes> <background color>]
```
The available attributes are: `bold, standout, underline, reverse, blink, dim, bright`
The available colors are: `black, red, green, yellow, blue, magenta, cyan, white, grey (or gray)`
As an example: `bold green on bright blue` or `bold green` or even just `green`
256 terminal colors are required for the full range of color settings, however basic colors can still be used with 8 terminal colors. See your terminal's documentation if necessary for how to configure its color range.
Here is a fully commented example configuration:
```ini
# Sets the title color
ui.color.title.set = "bold black on bright blue"
# Sets the footer color
ui.color.footer.set = "bold black on blue"
# Sets the focus color. The other color settings take precedence over this, so normally it's just an attribute
ui.color.focus.set = "reverse"
# The default label color
ui.color.label.set = ""
# If the torrent is complete, active and not uploading data
ui.color.complete.set = "green"
# If the torrent is complete, active and uploading data
ui.color.seeding.set = "blue"
# If the torrent is complete and not active
ui.color.stopped.set = "red"
# If the torrent is incomplete, active and not downloading data
ui.color.queued.set = "cyan"
# If the torrent is incomplete, active and downloading data
ui.color.leeching.set = "yellow"
# If the torrent is incomplete and not active
ui.color.incomplete.set = "cyan"
# Colors the odd rows
ui.color.odd.set = "bold"
# Colors the even rows
ui.color.even.set = ""
```