detached 0620efb

chore(doc): add gen-docs command to README usage section

commit
0620efbc39b58d449bbdf21bc8fd055d67ac0c93
author
bnema · · 2025-12-27 19:33 UTC
parent
4ddee70
signature
GPG Unverified2B82207D370127A0 The key is unknown
1 file · +4 -0
Unified
UnifiedSplit
M README.md +4 -0
@@ -279,6 +279,10 @@ sudo apt install va-driver-all
279279 - `dumber logs -n 200 <session>` # show last N lines
280280 - `dumber logs clear` # clean up old log files
281281 - `dumber logs clear --all` # remove all log files
282+- Generate documentation:
283+ - `dumber gen-docs` # install man pages to ~/.local/share/man/man1/
284+ - `dumber gen-docs --format markdown` # generate markdown docs to ./docs/
285+ - `dumber gen-docs --output ./man` # generate to custom directory
282286
283287 ### Dmenu mode invocation
284288 You can invoke dmenu mode in two ways:
@@ -279,6 +279,10 @@ sudo apt install va-driver-all
279 - `dumber logs -n 200 <session>` # show last N lines279 - `dumber logs -n 200 <session>` # show last N lines
280 - `dumber logs clear` # clean up old log files280 - `dumber logs clear` # clean up old log files
281 - `dumber logs clear --all` # remove all log files281 - `dumber logs clear --all` # remove all log files
282+- Generate documentation:
283+ - `dumber gen-docs` # install man pages to ~/.local/share/man/man1/
284+ - `dumber gen-docs --format markdown` # generate markdown docs to ./docs/
285+ - `dumber gen-docs --output ./man` # generate to custom directory
282 286
283 ### Dmenu mode invocation287 ### Dmenu mode invocation
284 You can invoke dmenu mode in two ways:288 You can invoke dmenu mode in two ways:

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 8

Tags 42

↑↓ moveenter openesc close