From c0169b5da6c89a30ba1275f7226b4206addc7f1f Mon Sep 17 00:00:00 2001
From: speedie
Date: Fri, 19 May 2023 00:21:01 +0200
Subject: [PATCH] add default keybinds to man page
---
docs/docs.md | 71 +++++
spmenu.1 | 725 +++++++++++++++++++++++++++++++++++++++++++++++++++
spmenu.html | 479 ++++++++++++++++++++++++++++++++++
3 files changed, 1275 insertions(+)
diff --git a/docs/docs.md b/docs/docs.md
index d73f2f3..0c705a3 100644
--- a/docs/docs.md
+++ b/docs/docs.md
@@ -666,6 +666,77 @@ This configuration file is loaded on startup.
You can also include other configuration files in the configuration file using
`@include "path/to/config"`.
+## Default keybinds
+
+These are the default keybinds. You can generate these yourself from a
+`keybinds.h` using `scripts/make/generate-keybind-list.sh`.
+
+| Mode | Modifier | Key | Function | Argument |
+| :----------------- | :----------------- | :----------------- | :----------------- | :----------------- |
+| -1 | 0 | Return | selectitem | +1 |
+| -1 | Shift | Return | selectitem | 0 |
+| -1 | Ctrl | Return | markitem | 0 |
+| -1 | 0 | Tab | complete | 0 |
+| -1 | Ctrl | v | paste | 2 |
+| -1 | Ctrl+Shift | v | paste | 1 |
+| -1 | 0 | BackSpace | backspace | 0 |
+| -1 | Ctrl | BackSpace | deleteword | 0 |
+| -1 | Ctrl | Left | moveword | -1 |
+| -1 | Ctrl | Right | moveword | +1 |
+| -1 | 0 | Left | movecursor | -1 |
+| -1 | 0 | Right | movecursor | +1 |
+| -1 | Ctrl+Shift | p | setprofile | 0 |
+| 0 | 0 | i | switchmode | 0 |
+| 0 | 0 | slash | switchmode | 0 |
+| 0 | Ctrl | equal | setimgsize | +1 |
+| 0 | Ctrl | minus | setimgsize | -1 |
+| 0 | 0 | equal | setimgsize | +10 |
+| 0 | 0 | minus | setimgsize | -10 |
+| 0 | Shift | equal | setimgsize | +100 |
+| 0 | Shift | minus | setimgsize | -100 |
+| 0 | Shift | 0 | defaultimg | 0 |
+| 0 | 0 | r | rotateimg | 0 |
+| 0 | 0 | o | setimgpos | +1 |
+| 0 | Ctrl | 1 | setimggaps | -1 |
+| 0 | Ctrl | 2 | setimggaps | +1 |
+| 0 | 0 | 1 | setimggaps | -10 |
+| 0 | 0 | 2 | setimggaps | +10 |
+| 0 | Shift | 1 | setimggaps | -100 |
+| 0 | Shift | 2 | setimggaps | +100 |
+| 0 | 0 | t | toggleimg | 0 |
+| 0 | 0 | f | togglefullimg | 0 |
+| 0 | 0 | p | paste | 2 |
+| 0 | 0 | h | flipimg | 1 |
+| 0 | 0 | v | flipimg | 0 |
+| 0 | 0 | k | moveup | 0 |
+| 0 | 0 | j | movedown | 0 |
+| 0 | 0 | h | moveleft | 0 |
+| 0 | 0 | l | moveright | 0 |
+| 0 | Ctrl | u | moveup | 5 |
+| 0 | Ctrl | d | movedown | 5 |
+| 0 | Ctrl | k | setlines | +1 |
+| 0 | Ctrl | j | setlines | -1 |
+| 0 | Ctrl+Alt+Shift | k | setlines | +5 |
+| 0 | Ctrl+Alt+Shift | j | setlines | -5 |
+| 0 | Ctrl | h | setcolumns | +1 |
+| 0 | Ctrl | l | setcolumns | -1 |
+| 0 | Ctrl+Alt+Shift | h | setcolumns | +5 |
+| 0 | Ctrl+Alt+Shift | l | setcolumns | -5 |
+| 0 | 0 | u | togglehighlight | 0 |
+| 0 | Ctrl+Shift | h | viewhist | 0 |
+| 0 | 0 | d | clear | 0 |
+| 0 | Shift | d | clearins | 0 |
+| 0 | 0 | Escape | quit | 0 |
+| 0 | 0 | Home | movestart | 0 |
+| 0 | 0 | End | moveend | 0 |
+| 0 | 0 | g | movestart | 0 |
+| 0 | Shift | g | moveend | 0 |
+| 0 | 0 | Next | movenext | 0 |
+| 0 | 0 | Prior | moveprev | 0 |
+| 0 | Alt | p | navhistory | -1 |
+| 0 | Alt | n | navhistory | +1 |
+| 1 | 0 | Escape | switchmode | 0 |
+
## .Xresources
spmenu also has .Xresources (xrdb) support built in. It reads the xrdb
diff --git a/spmenu.1 b/spmenu.1
index 779ff96..b75e356 100644
--- a/spmenu.1
+++ b/spmenu.1
@@ -1,3 +1,4 @@
+'\" t
.\" Automatically generated by Pandoc 3.0.1
.\"
.\" Define V font for inline verbatim, using C font in formats
@@ -711,6 +712,730 @@ This configuration file is loaded on startup.
.PP
You can also include other configuration files in the configuration file
using \f[V]\[at]include \[dq]path/to/config\[dq]\f[R].
+.SS Default keybinds
+.PP
+These are the default keybinds.
+You can generate these yourself from a \f[V]keybinds.h\f[R] using
+\f[V]scripts/make/generate-keybind-list.sh\f[R].
+.TP
+Mode \f[V]-1\f[R]
+Any
+.TP
+Mode \f[V]0\f[R]
+Normal mode
+.TP
+Mode \f[V]1\f[R]
+Insert mode
+.PP
+.TS
+tab(@);
+lw(14.0n) lw(14.0n) lw(14.0n) lw(14.0n) lw(14.0n).
+T{
+Mode
+T}@T{
+Modifier
+T}@T{
+Key
+T}@T{
+Function
+T}@T{
+Argument
+T}
+_
+T{
+-1
+T}@T{
+0
+T}@T{
+Return
+T}@T{
+selectitem
+T}@T{
++1
+T}
+T{
+-1
+T}@T{
+Shift
+T}@T{
+Return
+T}@T{
+selectitem
+T}@T{
+0
+T}
+T{
+-1
+T}@T{
+Ctrl
+T}@T{
+Return
+T}@T{
+markitem
+T}@T{
+0
+T}
+T{
+-1
+T}@T{
+0
+T}@T{
+Tab
+T}@T{
+complete
+T}@T{
+0
+T}
+T{
+-1
+T}@T{
+Ctrl
+T}@T{
+v
+T}@T{
+paste
+T}@T{
+2
+T}
+T{
+-1
+T}@T{
+Ctrl+Shift
+T}@T{
+v
+T}@T{
+paste
+T}@T{
+1
+T}
+T{
+-1
+T}@T{
+0
+T}@T{
+BackSpace
+T}@T{
+backspace
+T}@T{
+0
+T}
+T{
+-1
+T}@T{
+Ctrl
+T}@T{
+BackSpace
+T}@T{
+deleteword
+T}@T{
+0
+T}
+T{
+-1
+T}@T{
+Ctrl
+T}@T{
+Left
+T}@T{
+moveword
+T}@T{
+-1
+T}
+T{
+-1
+T}@T{
+Ctrl
+T}@T{
+Right
+T}@T{
+moveword
+T}@T{
++1
+T}
+T{
+-1
+T}@T{
+0
+T}@T{
+Left
+T}@T{
+movecursor
+T}@T{
+-1
+T}
+T{
+-1
+T}@T{
+0
+T}@T{
+Right
+T}@T{
+movecursor
+T}@T{
++1
+T}
+T{
+-1
+T}@T{
+Ctrl+Shift
+T}@T{
+p
+T}@T{
+setprofile
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+i
+T}@T{
+switchmode
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+slash
+T}@T{
+switchmode
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+Ctrl
+T}@T{
+equal
+T}@T{
+setimgsize
+T}@T{
++1
+T}
+T{
+0
+T}@T{
+Ctrl
+T}@T{
+minus
+T}@T{
+setimgsize
+T}@T{
+-1
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+equal
+T}@T{
+setimgsize
+T}@T{
++10
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+minus
+T}@T{
+setimgsize
+T}@T{
+-10
+T}
+T{
+0
+T}@T{
+Shift
+T}@T{
+equal
+T}@T{
+setimgsize
+T}@T{
++100
+T}
+T{
+0
+T}@T{
+Shift
+T}@T{
+minus
+T}@T{
+setimgsize
+T}@T{
+-100
+T}
+T{
+0
+T}@T{
+Shift
+T}@T{
+0
+T}@T{
+defaultimg
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+r
+T}@T{
+rotateimg
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+o
+T}@T{
+setimgpos
+T}@T{
++1
+T}
+T{
+0
+T}@T{
+Ctrl
+T}@T{
+1
+T}@T{
+setimggaps
+T}@T{
+-1
+T}
+T{
+0
+T}@T{
+Ctrl
+T}@T{
+2
+T}@T{
+setimggaps
+T}@T{
++1
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+1
+T}@T{
+setimggaps
+T}@T{
+-10
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+2
+T}@T{
+setimggaps
+T}@T{
++10
+T}
+T{
+0
+T}@T{
+Shift
+T}@T{
+1
+T}@T{
+setimggaps
+T}@T{
+-100
+T}
+T{
+0
+T}@T{
+Shift
+T}@T{
+2
+T}@T{
+setimggaps
+T}@T{
++100
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+t
+T}@T{
+toggleimg
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+f
+T}@T{
+togglefullimg
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+p
+T}@T{
+paste
+T}@T{
+2
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+h
+T}@T{
+flipimg
+T}@T{
+1
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+v
+T}@T{
+flipimg
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+k
+T}@T{
+moveup
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+j
+T}@T{
+movedown
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+h
+T}@T{
+moveleft
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+l
+T}@T{
+moveright
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+Ctrl
+T}@T{
+u
+T}@T{
+moveup
+T}@T{
+5
+T}
+T{
+0
+T}@T{
+Ctrl
+T}@T{
+d
+T}@T{
+movedown
+T}@T{
+5
+T}
+T{
+0
+T}@T{
+Ctrl
+T}@T{
+k
+T}@T{
+setlines
+T}@T{
++1
+T}
+T{
+0
+T}@T{
+Ctrl
+T}@T{
+j
+T}@T{
+setlines
+T}@T{
+-1
+T}
+T{
+0
+T}@T{
+Ctrl+Alt+Shift
+T}@T{
+k
+T}@T{
+setlines
+T}@T{
++5
+T}
+T{
+0
+T}@T{
+Ctrl+Alt+Shift
+T}@T{
+j
+T}@T{
+setlines
+T}@T{
+-5
+T}
+T{
+0
+T}@T{
+Ctrl
+T}@T{
+h
+T}@T{
+setcolumns
+T}@T{
++1
+T}
+T{
+0
+T}@T{
+Ctrl
+T}@T{
+l
+T}@T{
+setcolumns
+T}@T{
+-1
+T}
+T{
+0
+T}@T{
+Ctrl+Alt+Shift
+T}@T{
+h
+T}@T{
+setcolumns
+T}@T{
++5
+T}
+T{
+0
+T}@T{
+Ctrl+Alt+Shift
+T}@T{
+l
+T}@T{
+setcolumns
+T}@T{
+-5
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+u
+T}@T{
+togglehighlight
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+Ctrl+Shift
+T}@T{
+h
+T}@T{
+viewhist
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+d
+T}@T{
+clear
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+Shift
+T}@T{
+d
+T}@T{
+clearins
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+Escape
+T}@T{
+quit
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+Home
+T}@T{
+movestart
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+End
+T}@T{
+moveend
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+g
+T}@T{
+movestart
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+Shift
+T}@T{
+g
+T}@T{
+moveend
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+Next
+T}@T{
+movenext
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+0
+T}@T{
+Prior
+T}@T{
+moveprev
+T}@T{
+0
+T}
+T{
+0
+T}@T{
+Alt
+T}@T{
+p
+T}@T{
+navhistory
+T}@T{
+-1
+T}
+T{
+0
+T}@T{
+Alt
+T}@T{
+n
+T}@T{
+navhistory
+T}@T{
++1
+T}
+T{
+1
+T}@T{
+0
+T}@T{
+Escape
+T}@T{
+switchmode
+T}@T{
+0
+T}
+.TE
.SS .Xresources
.PP
spmenu also has .Xresources (xrdb) support built in.
diff --git a/spmenu.html b/spmenu.html
index c58c7d0..cdfc792 100644
--- a/spmenu.html
+++ b/spmenu.html
@@ -981,6 +981,485 @@ override this by exporting $XDG_CONFIG_HOME
.
on startup.
You can also include other configuration files in the configuration
file using @include "path/to/config"
.
+Default keybinds
+These are the default keybinds. You can generate these yourself from
+a keybinds.h
using
+scripts/make/generate-keybind-list.sh
.
+
+- Mode
-1
+-
+Any
+
+- Mode
0
+-
+Normal mode
+
+- Mode
1
+-
+Insert mode
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-1 |
+0 |
+Return |
+selectitem |
++1 |
+
+
+-1 |
+Shift |
+Return |
+selectitem |
+0 |
+
+
+-1 |
+Ctrl |
+Return |
+markitem |
+0 |
+
+
+-1 |
+0 |
+Tab |
+complete |
+0 |
+
+
+-1 |
+Ctrl |
+v |
+paste |
+2 |
+
+
+-1 |
+Ctrl+Shift |
+v |
+paste |
+1 |
+
+
+-1 |
+0 |
+BackSpace |
+backspace |
+0 |
+
+
+-1 |
+Ctrl |
+BackSpace |
+deleteword |
+0 |
+
+
+-1 |
+Ctrl |
+Left |
+moveword |
+-1 |
+
+
+-1 |
+Ctrl |
+Right |
+moveword |
++1 |
+
+
+-1 |
+0 |
+Left |
+movecursor |
+-1 |
+
+
+-1 |
+0 |
+Right |
+movecursor |
++1 |
+
+
+-1 |
+Ctrl+Shift |
+p |
+setprofile |
+0 |
+
+
+0 |
+0 |
+i |
+switchmode |
+0 |
+
+
+0 |
+0 |
+slash |
+switchmode |
+0 |
+
+
+0 |
+Ctrl |
+equal |
+setimgsize |
++1 |
+
+
+0 |
+Ctrl |
+minus |
+setimgsize |
+-1 |
+
+
+0 |
+0 |
+equal |
+setimgsize |
++10 |
+
+
+0 |
+0 |
+minus |
+setimgsize |
+-10 |
+
+
+0 |
+Shift |
+equal |
+setimgsize |
++100 |
+
+
+0 |
+Shift |
+minus |
+setimgsize |
+-100 |
+
+
+0 |
+Shift |
+0 |
+defaultimg |
+0 |
+
+
+0 |
+0 |
+r |
+rotateimg |
+0 |
+
+
+0 |
+0 |
+o |
+setimgpos |
++1 |
+
+
+0 |
+Ctrl |
+1 |
+setimggaps |
+-1 |
+
+
+0 |
+Ctrl |
+2 |
+setimggaps |
++1 |
+
+
+0 |
+0 |
+1 |
+setimggaps |
+-10 |
+
+
+0 |
+0 |
+2 |
+setimggaps |
++10 |
+
+
+0 |
+Shift |
+1 |
+setimggaps |
+-100 |
+
+
+0 |
+Shift |
+2 |
+setimggaps |
++100 |
+
+
+0 |
+0 |
+t |
+toggleimg |
+0 |
+
+
+0 |
+0 |
+f |
+togglefullimg |
+0 |
+
+
+0 |
+0 |
+p |
+paste |
+2 |
+
+
+0 |
+0 |
+h |
+flipimg |
+1 |
+
+
+0 |
+0 |
+v |
+flipimg |
+0 |
+
+
+0 |
+0 |
+k |
+moveup |
+0 |
+
+
+0 |
+0 |
+j |
+movedown |
+0 |
+
+
+0 |
+0 |
+h |
+moveleft |
+0 |
+
+
+0 |
+0 |
+l |
+moveright |
+0 |
+
+
+0 |
+Ctrl |
+u |
+moveup |
+5 |
+
+
+0 |
+Ctrl |
+d |
+movedown |
+5 |
+
+
+0 |
+Ctrl |
+k |
+setlines |
++1 |
+
+
+0 |
+Ctrl |
+j |
+setlines |
+-1 |
+
+
+0 |
+Ctrl+Alt+Shift |
+k |
+setlines |
++5 |
+
+
+0 |
+Ctrl+Alt+Shift |
+j |
+setlines |
+-5 |
+
+
+0 |
+Ctrl |
+h |
+setcolumns |
++1 |
+
+
+0 |
+Ctrl |
+l |
+setcolumns |
+-1 |
+
+
+0 |
+Ctrl+Alt+Shift |
+h |
+setcolumns |
++5 |
+
+
+0 |
+Ctrl+Alt+Shift |
+l |
+setcolumns |
+-5 |
+
+
+0 |
+0 |
+u |
+togglehighlight |
+0 |
+
+
+0 |
+Ctrl+Shift |
+h |
+viewhist |
+0 |
+
+
+0 |
+0 |
+d |
+clear |
+0 |
+
+
+0 |
+Shift |
+d |
+clearins |
+0 |
+
+
+0 |
+0 |
+Escape |
+quit |
+0 |
+
+
+0 |
+0 |
+Home |
+movestart |
+0 |
+
+
+0 |
+0 |
+End |
+moveend |
+0 |
+
+
+0 |
+0 |
+g |
+movestart |
+0 |
+
+
+0 |
+Shift |
+g |
+moveend |
+0 |
+
+
+0 |
+0 |
+Next |
+movenext |
+0 |
+
+
+0 |
+0 |
+Prior |
+moveprev |
+0 |
+
+
+0 |
+Alt |
+p |
+navhistory |
+-1 |
+
+
+0 |
+Alt |
+n |
+navhistory |
++1 |
+
+
+1 |
+0 |
+Escape |
+switchmode |
+0 |
+
+
+
.Xresources
spmenu also has .Xresources (xrdb) support built in. It reads the
xrdb (.Xresources database) on runtime. You may disable it by passing