v0.9.0
reference / settings

Settings

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.

generated README.md ↗
config.toml · 32 keys
KeyDefaultWhat it does
width 100 max width of the reading column (40–400); 0 = full width
center true center that column
spacing 1 blank lines between blocks: 0 compact, 1 normal, 2 airy
heading_rules true a rule under level 1 and 2 headings
code_frame true label and frame around code blocks
guess_code_lang true infer the language of unlabeled code when wr is sure (shown as (guessed))
render_js true render script-drawn pages with an installed Chromium/Chrome
update_check true look for a newer wr in the background (at most every 12 hours)
whats_new false a small window with the release notes when there is an update
links "footnotes" footnotes, inline or hidden (links stay clickable in all of them)
braille true braille 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)
scrollbar true scrollbar on the right
footer true the footer row
footer_rule true the thin rule above the footer
footer_hints true shortcut hints on the left
footer_progress "both" both, percent, bar or off
footer_chips true bookmark star, update available, search count
mouse true wheel, clicks and drag-to-copy
copy_on_select true copy when you release the mouse
wheel_lines 3 lines per wheel notch
animations true master switch for all animations
anim_scroll anim_reveal anim_panels anim_loading anim_notices true each 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
history true remember the pages you visit
history_limit 1000 how many visits to keep
cache true keep pages on disk
cache_days 30 days a page stays cached
background_refresh true refresh a cached page while you read it
[keys] — only the key bindings you changed

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

Where things live

README.md
PathWhat
~/.config/wr/config.toml settings and key bindings
~/.cache/wr/ the page cache
~/.local/state/wr/history.jsonl your history (one JSON line per visit)
~/.local/state/wr/bookmarks.json your bookmarks
~/.local/state/wr/update.json the 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.