Rio
docs/index.mdRaw Markdown · GitHub ↗

The rio manual

How to use rio: what each part of the window does, how to do the everyday jobs, and where your settings are kept. No Tcl required.

Inside rio, press F1 or choose Help ▸ Contents… to read these pages.

Contents

Start here

  • Getting started — starting rio, the parts of the window, your first edit and save.
  • The editor — tabs, undo, the split view, wrap, line numbers, syntax highlighting, column editing, compare, unsaved changes.
  • Files & projects — the file tree, opening a folder, creating and renaming files, sessions.

Doing the work

  • Find & replace — the find bar, and the Search panel for a whole project.
  • Git — status, diffs, staging, committing, discarding.
  • The agent — providers and keys, and what the agent needs your approval for.

Making it yours

  • Preferences — every setting, and the file it is kept in.
  • Keyboard shortcuts — the defaults, and two ways to change them.
  • Panels & layout — moving panes, themes, fonts, zoom.
  • Editing modes — Windows, vi or emacs keys in the text area.
  • Extensions — repositories, and installing themes, highlighters, editing modes and agent providers.

Beyond one machine

Reading the manual inside rio

Help ▸ Contents… (F1) opens these pages in rio, formatted, from disk. No network connection is needed.

In the help windowWhat it does
The contents list on the leftClick a topic to open it.
A link in the textClick it to jump to that topic, or to that heading.
Alt+← / Alt+→Back and forward through the topics you have read.
The Find box, top leftType a word. The list becomes the sections that mention it; pick one to go there with the word highlighted.
Right-click the pageCopy. The pages are read-only, but you can select and copy from them.
EscClears the Find box; pressing it again closes the window.

Other documents

DocumentAnswers
INSTALL.mdHow do I install, deploy and run rio?
CAVEATS.mdKnown rough edges and platform differences
README.mdWhat is rio, and what works today?
WINDOWS.mdRunning rio on Windows 11
adr/The decisions — why rio works the way it does
CONTRIBUTING.mdHacking on rio itself
LICENSEMay I use, change and pass rio on?

Unfinished topics

Some topics are placeholders. Each one says so, lists what it will cover, and points at the document that has the facts today.