Fix missing keybindings in MANUAL.rst

This commit is contained in:
CrystalSplitter 2024-01-15 12:45:43 -08:00 committed by Jordan R AW
parent d09a6d125b
commit 7976595617
3 changed files with 34 additions and 31 deletions

View File

@ -99,7 +99,7 @@ At any point in time, you can revert back to the Source Viewer panel with the
panel.
On top of each panel is a label where the navigation key combination is located.
For example, the key combination above the Modules panel displays `[M]`.
For example, the key combination above the Modules panel displays ``[M]``.
Pressing this key combination will move the focus to that panel.
-----------
@ -116,6 +116,7 @@ Source Viewer
- ``?``: Display help inside GHCiTUI.
- ``Ctrl+x``: Toggle between the Source Viewer and the Live Interpreter
panels.
- ``M``: Switch to the module panel.
- ``<Esc>``, ``q``: Quit.
- ``<Up>``, ``k``: Move the cursor up. (``j`` and ``k`` from Vim keybinds)
- ``<Down>``, ``j``: Move the cursor down. (``j`` and ``k`` from Vim keybinds).
@ -153,7 +154,7 @@ Modules
- ``?``: Display help inside GHCiTUI.
- ``Ctrl+x``: Switch to the Live Interpreter.
- ``<Esc>``: Switch to Source Viewer.
- ``<Esc>``, ``C``: Switch to Source Viewer.
- ``<Up>``, ``k``: Move the module selection up.
- ``<Down>``, ``j``: Move the module selection down.
- ``+``, ``-``: Increase/decrease the info panel size.

View File

@ -19,8 +19,8 @@ CLI SYNOPSIS
STARTING AND STOPPING
Starting
GHCiTUI runs a REPL in the current directory by default. By default, it
launches cabal repl.
GHCiTUI runs a REPL in the current directory by default. By default,
it launches cabal repl.
$ cd your/cabal/project/root/directory
$ ghcitui
@ -31,13 +31,13 @@ STARTING AND STOPPING
Stopping
To quit, press <ESC> or q while in the code viewport panel to quit.
While not in the code viewport panel, you may press <ESC> to get to the
viewport panel.
While not in the code viewport panel, you may press <ESC> to get to
the viewport panel.
LAYOUT
GHCiTUI is an in-terminal viewer for GHCi. The TUI is broken up into
three primary panels, with some additional auxiliary panels for special
use cases:
three primary panels, with some additional auxiliary panels for spe
cial use cases:
┌──────────────────┬──────┐
│ │ Info │
@ -67,10 +67,10 @@ NAVIGATION
with the <Esc> key, and you can always quit by hitting <Esc> in the
Source Viewer panel.
On top of each panel is a label where the navigation key combination is
located. For example, the key combination above the Modules panel dis
plays [M]. Pressing this key combination will move the focus to that
panel.
On top of each panel is a label where the navigation key combination
is located. For example, the key combination above the Modules panel
displays [M]. Pressing this key combination will move the focus to
that panel.
KEYBINDINGS
At this time, keybindings are hardcoded. This will hopefully change in
@ -82,6 +82,8 @@ KEYBINDINGS
• Ctrl+x: Toggle between the Source Viewer and the Live Interpreter
panels.
• M: Switch to the module panel.
• <Esc>, q: Quit.
• <Up>, k: Move the cursor up. (j and k from Vim keybinds)
@ -94,8 +96,8 @@ KEYBINDINGS
• +, -: Increase/decrease the left panel sizes.
• b: Toggle breakpoint at current line. Not every line in a source file
can have a breakpoint placed on it.
• b: Toggle breakpoint at current line. Not every line in a source
file can have a breakpoint placed on it.
• s: Advance execution by one step. Same as the :step in GHCi.
@ -132,7 +134,7 @@ KEYBINDINGS
• Ctrl+x: Switch to the Live Interpreter.
• <Esc>: Switch to Source Viewer.
• <Esc>, C: Switch to Source Viewer.
• <Up>, k: Move the module selection up.

View File

@ -4,4 +4,4 @@ GENDIR="gen"
mkdir -p "${GENDIR}"
TMPFILE="$(mktemp)"
rst2man MANUAL.rst > "${TMPFILE}"
man "${TMPFILE}" | sed -e '1,5d' > ${GENDIR}/MANUAL.txt
MANWIDTH=79 man "${TMPFILE}" | sed -e '1,5d' > ${GENDIR}/MANUAL.txt