reference / settings

reference / settings

Settings

v0.12.0 · generated from README.md

Settings change from inside the program (press ,) and are saved for you; the file is the same thing, fully commented. A broken file never stops you from reading.

config.toml · 32 keys · press / to search this page.

KeyDefaultWhat it does
width100max width of the reading column (40–400); 0 = full width
centertruecenter that column
spacing1blank lines between blocks: 0 compact, 1 normal, 2 airy
heading_rulestruea rule under level 1 and 2 headings
code_frametruelabel and frame around code blocks
guess_code_langtrueinfer the language of unlabeled code when wr is sure (shown as (guessed))
render_jstruerender script-drawn pages with an installed Chromium/Chrome
update_checktruelook for a newer wr in the background (at most every 12 hours)
whats_newfalsea small window with the release notes when there is an update
links"footnotes"footnotes, inline or hidden (links stay clickable in all of them)
brailletruebraille decoration; false = plain glyphs
accent"blue"color of panels, keys, marks and bars, and the one the headings walk: blue, cyan, green, magenta, yellow, red, gray, white (your terminal's own colors) or orange, violet, teal, pink, lime, slate (fixed presets)
scrollbartruescrollbar on the right
footertruethe footer row
footer_ruletruethe thin rule above the footer
footer_hintstrueshortcut hints on the left
footer_progress"both"both, percent, bar or off
footer_chipstruebookmark star, update available, search count
mousetruewheel, clicks and drag-to-copy
copy_on_selecttruecopy when you release the mouse
wheel_lines3lines per wheel notch
animationstruemaster switch for all animations
anim_scroll anim_reveal anim_panels anim_loading anim_noticestrueeach animation on its own
scroll_speed"normal"slow, normal or fast
search_engine"duckduckgo"duckduckgo, wikipedia, github, or your own URL with %s
homepage""page to open when you run wr with no address; empty = the start page
historytrueremember the pages you visit
history_limit1000how many visits to keep
cachetruekeep pages on disk
cache_days30days a page stays cached
background_refreshtruerefresh a cached page while you read it
[keys]—only the key bindings you changed

Where things live

PathWhat
~/.config/wr/config.tomlsettings and key bindings
~/.cache/wr/the page cache
~/.local/state/wr/history.jsonlyour history (one JSON line per visit)
~/.local/state/wr/bookmarks.jsonyour bookmarks
~/.local/state/wr/update.jsonthe newest release seen and which version was announced

All directories are 0700 and files 0600. The cache and the history store the addresses and the content of what you read: turn them off in Settings, or clear them from the History panel and the menu.

Create the file with wr --config; it comes with everything commented. Key bindings live in the [keys] table — seeShortcuts.

README.md ↗report a problem ↗