Using the TUI¶
rettui starts the terminal UI: ten tabs (Messages, Games, Channels, Network,
Browser, Node, Status, Reticulum, Hub, Repos, Tools) with keyboard and mouse control. Terminals
narrower than 110 columns get a sidebar of icons and narrower side lists, so
80×24 works well. Below 40×10 there's no room for the tabs, and the screen
asks for a bigger terminal instead.
Colours, times and dates are settings (Status): Terminal colours is dark (for a dark terminal, the default), light (for a light one) or basic (16 colours, for a terminal without full colour); Clock is 24-hour or 12-hour, and Dates month-day (Oct 07), day-month (07 Oct) or year-month-day (2025-10-07). Clock and Dates go for the web UI too, and for exported conversations. The light theme darkens pale colours (from Micron pages and nicks, say) so they read on white, and basic uses only the 16 colours every terminal has, pictures and game boards too.
Keys¶
The footer shows the most used keys of what's on screen (with nothing in a
list yet, only how to add something), as many as fit,
and ? keys at its right edge: ? lists them all, with those that work in
every tab. While typing, ? is typed, so it says F1 keys instead, and F1
lists them. Any key, or a click, closes the list. On a short terminal it
uses more columns, and says so if some keys still don't fit.
| Tab | Keys |
|---|---|
| All tabs | 1–9, 0 and - switch tab (0 is Repos, - Tools), < / > the tab's list narrower or wider (= back to its usual width), A announce, S sync with the propagation node (again, to stop one), ? list the keys of what's on screen (F1 while typing), Ctrl-L redraw the screen, q / Ctrl-C quit |
| Messages | ↑↓ pick a conversation, Enter write, / search messages (Tab this conversation or all, Enter open the one picked), r reply to their newest message, m pick a message, c contact card, X delete the conversation, n new conversation by address, y copy the peer's address (an lxma:// link with their key once heard), a attach a file, v record a voice message (v again stops it, Esc throws it away), o open the newest attachment (asks first), d cycle delivery mode, p read a paper message, P show the newest paper message written, N turn the conversation's notifications off or on, V play its voice messages as they come, H read its archived messages, L share a location (live 1h shares it live; L again stops that), K send a Sideband command (ping, echo <text>, signal or location), M the map of locations shared, g your games with them (in the Games tab), * pin it to the top (or unpin it), R mark every conversation read, E export the conversation as text, PgUp/PgDn scroll a page, Home/End the oldest or newest |
A picked message (m) |
↑↓ pick another, r / Enter reply, e react, y copy its text, f forward it, o open its file or location, t send it again if it failed, c cancel sending it, x delete it, Esc done |
| Games | ↑↓ pick a game, Enter (or a click on the board) go onto its board, n new game (who with, then which), f filter the list (all, active, pending, completed), c open the conversation, x forget the game, Home/End the first or last |
| On a game's board | arrows and Enter (or a click) play, 1–9 a cell or column (1–3 a throw in Rock Paper Scissors), p pass in Go, a/d accept or decline, D offer a draw, y/n answer one, t type a move, R resign, r send a move that failed again, x forget it, Esc back to the list; see Games |
The map (M) |
↑↓ pick a place, +/- or the wheel zoom in on it and out, 0 all of them, Enter open the conversation (an interface: its place in the interfaces found), w ask the one picked where they are now, i interfaces others made known off or on, o open the place on OpenStreetMap, x delete their locations (their place and trail), Esc close |
Contact card (c) |
r your name for them, e notes, t trust (or stop), l leave an unknown sender as is, b block (or unblock), y copy their address, p ping (how long a Link to them takes), P find their path, T probe them, D forget their path, I whose address it is, w ask where they are, f track them (ask every few minutes, or stop), k send a Sideband command, X delete the conversation, Esc close |
| Writing a message | Enter send, Esc stop writing (or first stop replying), Ctrl-R reply (again: to the one before), ↑↓ while replying another message, Ctrl-E emoji, :name an emoji by name, Ctrl-V paste, Ctrl-O attach, Ctrl-X clear attachments (and a voice message recorded), Alt-R start or stop recording a voice message, Ctrl-P cycle delivery mode |
Emoji picker (Ctrl-E while writing a message or in a channel, e on a picked message) |
type to search, arrows choose, Tab/Shift-Tab next or previous group, Enter put it in (or react with it), Esc close; click one to put it in |
An emoji name typed after : |
↑↓ choose, Tab/Enter put it in, Esc close the list |
| A paper message's QR code | y copy the link, s save the code as an SVG image, p print it, any other key (or a click) closes it |
| Channels | ↑↓ pick a hub, room or whisper conversation, Enter write (text or /commands), / search what was said, n add a hub, c connect or disconnect, a toggle auto-connect, J show or hide joins and leaves, D dates with the times or the times alone, N next notification choice for the hub, room or whisper conversation, x leave a room, close a whisper conversation, or remove a hub, y copy an rrc:// link, m message a user in the room, PgUp/PgDn scroll a page, Home/End the oldest or newest |
User menu (click a name, or m) |
w open your whisper conversation, l LXMF message, Enter pick (also copy their LXMF address or identity), Esc close |
| Network | ↑↓ select, y copy the selected address, Enter message a peer, browse a node, or pick a propagation node; p use the selected propagation node; b block or unblock an LXMF peer; P find a path to the selected address (or one typed), D forget its path, T probe it, F send it a file with rncp, O get a file from an rncp -l -F listener, I whose it is, and your own addresses (y copy a row, e look up another, Esc close); v a speed test with someone (Enter send, ←→ size, e their address, y copy yours, Esc close); e interfaces found by interface discovery or sent in telemetry (Enter add to the Reticulum config, m on the map, y copy where to reach it, Esc close); f filter (all, LXMF peers, NomadNet nodes, propagation nodes, blocked); s sort (last heard, name, nearest); i keep to one interface (through each in turn, then any); / search by name or address (Enter done, Esc clear); a announces as they're heard (again, or Esc, for the list); t Reticulum's path table and announce rates (f the other table, / search, R read again, P T D y as in the list, t or Esc for the list) |
| Browser (both panes) | ←/→ move between the node pane and the page, t switch Saved/Nodes, / search both lists (Enter done, Esc clear), g go to an address, y copy the current address, s save the current page, b back, r refresh from the network, R clear the whole cache, I identify to this node (toggle), H home, u view the page's Micron source (toggle), Esc cancel loading, T open the selected link in a new tab (else the page shown; in the list, the selected saved page or node in the tab shown, as Enter opens it in a new one, or the other way round with Open pages in new tabs off), W close the tab, [/] previous/next tab, Alt+1–Alt+9 that tab (or click one in the address bar's border; its × closes it, and + after them opens a new one) |
| Browser, node pane | ↑↓ select, Enter open beside the list, s save the selected node's home page (Nodes), x remove a saved page (Saved), Esc clear the search |
| Browser, page | Tab/Shift-Tab move between links and fields, Enter follow a link or edit a field, f (or Ctrl-F) find in the page (Enter/↓ next, ↑ previous, Esc done), L copy the selected link, a keep every repository linked on the page in the Repos tab, Y copy the whole page (the raw source when viewing source), Ctrl-V paste into the selected field, Esc clear the selection or leave the source view, ↑↓ / PgUp/PgDn scroll |
| Node | Enter edit the selected page, n new page (in the folder picked), u upload a file to the node without putting it in a page, r rename, m move to another folder (links to it follow), x delete, w who may see it (Space tick, Enter save, Esc cancel), R reset its statistics, h start or stop hosting, a announce the node, b open it in the Browser, y copy its address, p switch view (editor and preview, editor only, preview only) |
| Editing a page | Ctrl-S save (live on the node), Esc back to the pages, Alt + the underlined letter formats (see the ribbon), Alt+P adds a picture or file to the node and puts it in the page, Shift+arrows select, Ctrl-A select all, Ctrl-Z / Ctrl-Y undo and redo, Ctrl-P switch view, Ctrl-V paste; with the preview alone, ↑↓ / PgUp / PgDn scroll it |
| Status | ↑↓ select a setting, Enter edit it (or toggle), Tab / ←→ the settings' groups (Profile, Messages, Location, Browsing, Hosting, Display, Notifications, System), e edit display name, y copy your LXMF address (as an lxma:// link with your key), c show it as a QR code, g the getting-started guide, b back up your identity, B back up everything (sealed with a passphrase if you type one), i use another identity (from the next start), I your identities (Enter switch, n new, i from a file, r rename, c QR code, y copy, x delete, Esc close), x hide the first steps, u check for a newer release now, U install one found, Ctrl-R restart Reticulum |
| Reticulum | Tab sections / options, ↑↓ select, Enter edit (toggles flip, choices open a list), d back to the default, a add an interface, E make this node an entry point others connect to, Space enable or disable it, r rename, x delete, t edit the file as text, H earlier versions, P interface profiles (Enter switch to one, x delete), R reload the file, Ctrl-R restart Reticulum |
| Reticulum as text | Ctrl-S save (refused while the file can't load), Esc close, Ctrl-Z / Ctrl-Y undo and redo, Ctrl-V paste |
| Hub | The RRC hub hosted here: e start or stop hosting, y copy its rrc:// link, Tab / ←→ People, Rooms, Bans, ↑↓ select, a announce, : run a hub command (/stats, /kline list...), n new registered room; People: K kick from a room, b ban from a room, o make operator of a room (or not), v voice (or not), B ban from the whole hub, d disconnect; Rooms: t topic, m modes, r register or unregister, R rename, D delete; Bans: x lift the ban |
| Repos | rngit repositories: in the list, ↑↓ pick one, Enter / → open it (a node heard opens its pages in the Browser), b choose which node has a node's pages, n add one by its rns:// URL, D remove it, y copy its URL, H the repositories hosted here (m mirror, f fork, n new, s sync, r rename, X delete, Enter / a click / w who may use it, g who may use its group, y copy its URL, b open its pages in the Browser (with nothing picked, the list of them all), R list again, Esc / H back; in the table of who may use it, ←→↑↓ pick, Space / a click tick, a add someone by LXMF address or identity hash, Enter save, Esc cancel); Tab into the repository, then ←→ / Tab Branches and tags, Releases, Work, Permissions, ↑↓ / PgUp/PgDn move, r ask the node again, Enter on a branch or tag look inside the copy (Enter open, L log, Esc up), m make a copy on this computer or update it, u send the copy to another repository, M delete the copy, y copy the URL, Esc back to the list. Releases: Enter open one, P publish a release of a tag; in a release, Enter / g download the picked file (checked against its signature), X delete the release. Work: Enter open a document, s the next list (all, active, proposed, completed), w write a new one, p propose one; in a document, c comment, e edit, x mark it done (or active again), X delete it; in a proposal, a accept it, X decline it |
| Tools | Network tests: ↑↓ pick a tool, Enter run it, P find a path, T probe, D forget a path, I whose an address is, v speed test, F send and O fetch a file with rncp, c check the interfaces and whether each entry point can be reached, y copy the address tried last |
Resizing the lists¶
Each tab with a list beside its main pane (Messages, Games, Channels,
Browser, Node, Reticulum, Hub) lets you choose how wide the list is: drag
the border between the two with the mouse, or press < and > (two
columns at a time). =, or a double click on the border, puts it back to
its usual width. Each tab keeps its own width, saved in settings.json
(pane_widths), and the pane beside the list always keeps at least 20
columns.
A file asked for in a prompt (an attachment, a picture of a paper
message, an identity file, where to save a backup) can be dragged onto the
terminal: the quotes, \ escapes or file:// address the terminal adds
are understood. A path that names a file as typed is always taken as it is.
The footer confirms what keys did: ✓ (green) when something is done, ! (yellow) when it can't be done right now, and ✗ (red) when it failed. Problems stay up a little longer.
Mouse¶
- Click a section in the left sidebar to switch to it.
- Click a conversation to open it, the compose box to start writing, and an attachment to open it with your desktop's default app (it asks first). Click the name line of a message to pick it, then its buttons to reply, react, copy, retry or delete it. Click a reply's quote to see what it answers, and a location to see it on a map.
- In Channels, click a hub or room to open it, the input box to write, a public room in a hub's view to join it, and a name to message that user.
- In a conversation or a room, click a link written in it
(a NomadNet page, an LXMF address, an RRC hub) to open it, and drag across
the chat to select text: it's copied when you release the button (rettui
takes the mouse, so your terminal's own selection doesn't work there;
most terminals still select as usual with
Shiftheld). - In the Network tab, click a row to select it and double-click to open it. Click the search bar to start searching.
- In the browser, click a saved page or node on the left to open it beside the list. Click the Saved and Nodes headers to switch lists.
- Click a tab in the address bar's border to show it,
its
×(or a middle-click on it) to close it, and+after the tabs for a new one. A middle-click or Ctrl+click on a link, saved page or node opens it in a new tab (on a saved page or node, the other way from a click). - On a page, click links and form fields, click the address bar to go to an address, and right-click to go back.
- Click view source in the page's title bar to see its Micron source, and back to page to return.
- Drag across page text to select it. It's copied when you release the button, and dragging past the top or bottom edge scrolls the page.
- In the Status and Reticulum tabs, click a row to select it and double-click to edit it. In the editors, click to place the cursor and drag to select; click a ribbon button to format.
- The scroll wheel scrolls whatever is under the pointer.
- Click the version beside the name (top left) to open rettui's project page in your browser. In the web UI it opens in a new tab.
Copy and paste¶
- Copied text goes to the system clipboard (X11 or Wayland). It's also sent
through the terminal's OSC 52 clipboard escape, so copying works over SSH
in terminals that support it. Set
RETTUI_CLIPBOARD=osc52to use only OSC 52. - Your terminal's paste shortcut (for example
Ctrl-Shift-V) andCtrl-Vboth paste into whatever is being edited: a message, a prompt, the selected form field on a page, or an editor. Line breaks become spaces in the single-line inputs, and are kept in the editors. - rettui captures the mouse, so the terminal's own selection usually needs a
modifier. Most terminals use
Shift+drag.