detached 1753172

docs(readme): rewrite as a short guide to scripting modules

commit
1753172fd6ac77df4c79d0a438055575443d2038
author
brice · · 2026-10-05 15:03 UTC
parent
38d28a5
signature
GPG VerifiedCD88F9E564E0102646FB6077A1A07C7C7C3E349D · arch-gpg Verified for the committer email
1 file · +1 -1
M README.md +1 -1
@@ -86,7 +86,7 @@ Make it executable (`chmod +x clock.sh`) and put its path in `exec`. That's all.
8686 Rules:
8787
8888 1. Print one line, then print another line later. The new line replaces the old one.
89-2. A frame ends at a newline (`\n`) or a form feed (`\f`). Use `\f` if the frame itself should not end the line.
89+2. A frame ends at a newline (`\n`) or a form feed (`\f`). They mean the same thing. Text after the last one, with no ending yet, is not shown until its frame is finished.
9090 3. Keep the script running. A script that exits is restarted after a short delay, and the bar shows `[name!]` in the meantime.
9191 4. Print errors to stderr. They go to the bar's log and not to the screen.
9292 5. Frames are cut to 16 KiB, and text wider than the bar is clipped.
@@ -86,7 +86,7 @@ Make it executable (`chmod +x clock.sh`) and put its path in `exec`. That's all.
86 Rules:86 Rules:
87 87
88 1. Print one line, then print another line later. The new line replaces the old one.88 1. Print one line, then print another line later. The new line replaces the old one.
89-2. A frame ends at a newline (`\n`) or a form feed (`\f`). Use `\f` if the frame itself should not end the line.89+2. A frame ends at a newline (`\n`) or a form feed (`\f`). They mean the same thing. Text after the last one, with no ending yet, is not shown until its frame is finished.
90 3. Keep the script running. A script that exits is restarted after a short delay, and the bar shows `[name!]` in the meantime.90 3. Keep the script running. A script that exits is restarted after a short delay, and the bar shows `[name!]` in the meantime.
91 4. Print errors to stderr. They go to the bar's log and not to the screen.91 4. Print errors to stderr. They go to the bar's log and not to the screen.
92 5. Frames are cut to 16 KiB, and text wider than the bar is clipped.92 5. Frames are cut to 16 KiB, and text wider than the bar is clipped.

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 5

Tags 4

↑↓ moveenter openesc close