More docs changes
This commit is contained in:
parent
106afb674e
commit
8029b42870
112
docs/docs.md
112
docs/docs.md
|
@ -31,7 +31,11 @@ See a list below for a list.
|
||||||
|
|
||||||
## Arguments
|
## Arguments
|
||||||
|
|
||||||
You may use long, descriptive arguments or the shorter arguments.
|
You may use long, descriptive arguments or the shorter arguments. Note that none
|
||||||
|
need to be specified for a basic spmenu prompt. The most commonly used arguments
|
||||||
|
are `-l` or `--lines` and `-g` or `--columns`. All of the arguments can be defined
|
||||||
|
permanently in the configuration file. Arguments take priority over settings defined
|
||||||
|
in the config files.
|
||||||
|
|
||||||
`-mh, --line-height height`
|
`-mh, --line-height height`
|
||||||
: Set spmenu line height to height
|
: Set spmenu line height to height
|
||||||
|
@ -765,57 +769,6 @@ into multiple segments.
|
||||||
Note that spmenu also has a `binds.conf` configuration file, which isn't used
|
Note that spmenu also has a `binds.conf` configuration file, which isn't used
|
||||||
very much. This file is documented well [here](https://spmenu.speedie.site/binds.conf+documentation).
|
very much. This file is documented well [here](https://spmenu.speedie.site/binds.conf+documentation).
|
||||||
|
|
||||||
## Mouse
|
|
||||||
|
|
||||||
spmenu supports mouse clicks. The following parts can be clicked on:
|
|
||||||
|
|
||||||
- `ClickWindow`
|
|
||||||
- Clicking on the spmenu window
|
|
||||||
- `ClickPrompt`
|
|
||||||
- Clicking on the prompt
|
|
||||||
- `ClickInput`
|
|
||||||
- Clicking on the input
|
|
||||||
- `ClickLArrow`
|
|
||||||
- Clicking on the left arrow
|
|
||||||
- `ClickRArrow`
|
|
||||||
- Clicking on the right arrow
|
|
||||||
- `ClickItem`
|
|
||||||
- Clicking on the item area
|
|
||||||
- `ClickSelItem`
|
|
||||||
- Clicking on an item, function here doesn't matter, it will always be selected
|
|
||||||
- `ClickImage`
|
|
||||||
- Clicking on an image
|
|
||||||
- `ClickNumber`
|
|
||||||
- Clicking on the match count indicator
|
|
||||||
- `ClickCaps`
|
|
||||||
- Clicking on the caps lock indicator
|
|
||||||
- `ClickMode`
|
|
||||||
- Clicking on the mode indicator
|
|
||||||
- `None`
|
|
||||||
- Any click
|
|
||||||
|
|
||||||
You can set mouse binds through the config file. A default config file is available
|
|
||||||
after installing spmenu. This configuration file has identical keybinds to the
|
|
||||||
default hardcoded keybinds.
|
|
||||||
|
|
||||||
By default, the configuration file will ignore all hardcoded mouse binds to
|
|
||||||
prevent conflicts, but if you do not like this behavior you can
|
|
||||||
simply set `ignoreglobalmouse = 0`.
|
|
||||||
|
|
||||||
|
|
||||||
These are the default mouse binds. Mode does not apply for mouse binds.
|
|
||||||
|
|
||||||
| Click | Button | Function | Argument |
|
|
||||||
| :----------------- | :----------------- | :----------------- | :----------------- |
|
|
||||||
| ClickInput | Left Click | clear | 0 |
|
|
||||||
| ClickPrompt | Left Click | clear | 0 |
|
|
||||||
| ClickMode | Left Click | switchmode | 0 |
|
|
||||||
| ClickNumber | Left Click | viewhist | 0 |
|
|
||||||
| ClickSelItem | Left Click | Outputs the item | 0 |
|
|
||||||
| None | Scroll Up | moveprev | 0 |
|
|
||||||
| None | Scroll Down | movenext | 0 |
|
|
||||||
|
|
||||||
|
|
||||||
## Keybinds
|
## Keybinds
|
||||||
|
|
||||||
You can set keybinds through the config file. A default config file is available
|
You can set keybinds through the config file. A default config file is available
|
||||||
|
@ -826,6 +779,10 @@ By default, the configuration file will ignore all hardcoded keybinds to
|
||||||
prevent keybind conflicts, but if you do not like this behavior you can
|
prevent keybind conflicts, but if you do not like this behavior you can
|
||||||
simply set `ignoreglobalkeys = 0`.
|
simply set `ignoreglobalkeys = 0`.
|
||||||
|
|
||||||
|
Note that if you do unbind your exit or switchmode key by accident and find that
|
||||||
|
you cannot exit spmenu, press `Ctrl+Alt+Delete`. This is a hardcoded keybind
|
||||||
|
which cannot be disabled from the configuration file.
|
||||||
|
|
||||||
These are the default keybinds.
|
These are the default keybinds.
|
||||||
|
|
||||||
| Mode | Modifier | Key | Function | Argument |
|
| Mode | Modifier | Key | Function | Argument |
|
||||||
|
@ -877,6 +834,57 @@ These are the default keybinds.
|
||||||
| 1 | 0 | Escape | switchmode | 0 |
|
| 1 | 0 | Escape | switchmode | 0 |
|
||||||
| 1 | Ctrl | r | toggleregex | 0 |
|
| 1 | Ctrl | r | toggleregex | 0 |
|
||||||
|
|
||||||
|
## Mouse
|
||||||
|
|
||||||
|
spmenu supports mouse clicks. The following parts can be clicked on:
|
||||||
|
|
||||||
|
- `ClickWindow`
|
||||||
|
- Clicking on the spmenu window
|
||||||
|
- `ClickPrompt`
|
||||||
|
- Clicking on the prompt
|
||||||
|
- `ClickInput`
|
||||||
|
- Clicking on the input
|
||||||
|
- `ClickLArrow`
|
||||||
|
- Clicking on the left arrow
|
||||||
|
- `ClickRArrow`
|
||||||
|
- Clicking on the right arrow
|
||||||
|
- `ClickItem`
|
||||||
|
- Clicking on the item area
|
||||||
|
- `ClickSelItem`
|
||||||
|
- Clicking on an item, function here doesn't matter, it will always be selected
|
||||||
|
- `ClickImage`
|
||||||
|
- Clicking on an image
|
||||||
|
- `ClickNumber`
|
||||||
|
- Clicking on the match count indicator
|
||||||
|
- `ClickCaps`
|
||||||
|
- Clicking on the caps lock indicator
|
||||||
|
- `ClickMode`
|
||||||
|
- Clicking on the mode indicator
|
||||||
|
- `None`
|
||||||
|
- Any click
|
||||||
|
|
||||||
|
You can set mouse binds through the config file. A default config file is available
|
||||||
|
after installing spmenu. This configuration file has identical keybinds to the
|
||||||
|
default hardcoded keybinds.
|
||||||
|
|
||||||
|
By default, the configuration file will ignore all hardcoded mouse binds to
|
||||||
|
prevent conflicts, but if you do not like this behavior you can
|
||||||
|
simply set `ignoreglobalmouse = 0`.
|
||||||
|
|
||||||
|
|
||||||
|
These are the default mouse binds. Mode does not apply for mouse binds.
|
||||||
|
|
||||||
|
| Click | Button | Function | Argument |
|
||||||
|
| :----------------- | :----------------- | :----------------- | :----------------- |
|
||||||
|
| ClickInput | Left Click | clear | 0 |
|
||||||
|
| ClickPrompt | Left Click | clear | 0 |
|
||||||
|
| ClickMode | Left Click | switchmode | 0 |
|
||||||
|
| ClickNumber | Left Click | viewhist | 0 |
|
||||||
|
| ClickSelItem | Left Click | Outputs the item | 0 |
|
||||||
|
| None | Scroll Up | moveprev | 0 |
|
||||||
|
| None | Scroll Down | movenext | 0 |
|
||||||
|
|
||||||
|
|
||||||
## .Xresources
|
## .Xresources
|
||||||
|
|
||||||
**NOTE: Only applies for X11 users**
|
**NOTE: Only applies for X11 users**
|
||||||
|
|
345
spmenu.1
345
spmenu.1
|
@ -57,6 +57,12 @@ See a list below for a list.
|
||||||
.SS Arguments
|
.SS Arguments
|
||||||
.PP
|
.PP
|
||||||
You may use long, descriptive arguments or the shorter arguments.
|
You may use long, descriptive arguments or the shorter arguments.
|
||||||
|
Note that none need to be specified for a basic spmenu prompt.
|
||||||
|
The most commonly used arguments are \f[V]-l\f[R] or \f[V]--lines\f[R]
|
||||||
|
and \f[V]-g\f[R] or \f[V]--columns\f[R].
|
||||||
|
All of the arguments can be defined permanently in the configuration
|
||||||
|
file.
|
||||||
|
Arguments take priority over settings defined in the config files.
|
||||||
.TP
|
.TP
|
||||||
\f[V]-mh, --line-height height\f[R]
|
\f[V]-mh, --line-height height\f[R]
|
||||||
Set spmenu line height to height
|
Set spmenu line height to height
|
||||||
|
@ -823,173 +829,6 @@ Note that spmenu also has a \f[V]binds.conf\f[R] configuration file,
|
||||||
which isn\[cq]t used very much.
|
which isn\[cq]t used very much.
|
||||||
This file is documented well
|
This file is documented well
|
||||||
here (https://spmenu.speedie.site/binds.conf+documentation).
|
here (https://spmenu.speedie.site/binds.conf+documentation).
|
||||||
.SS Mouse
|
|
||||||
.PP
|
|
||||||
spmenu supports mouse clicks.
|
|
||||||
The following parts can be clicked on:
|
|
||||||
.IP \[bu] 2
|
|
||||||
\f[V]ClickWindow\f[R]
|
|
||||||
.RS 2
|
|
||||||
.IP \[bu] 2
|
|
||||||
Clicking on the spmenu window
|
|
||||||
.RE
|
|
||||||
.IP \[bu] 2
|
|
||||||
\f[V]ClickPrompt\f[R]
|
|
||||||
.RS 2
|
|
||||||
.IP \[bu] 2
|
|
||||||
Clicking on the prompt
|
|
||||||
.RE
|
|
||||||
.IP \[bu] 2
|
|
||||||
\f[V]ClickInput\f[R]
|
|
||||||
.RS 2
|
|
||||||
.IP \[bu] 2
|
|
||||||
Clicking on the input
|
|
||||||
.RE
|
|
||||||
.IP \[bu] 2
|
|
||||||
\f[V]ClickLArrow\f[R]
|
|
||||||
.RS 2
|
|
||||||
.IP \[bu] 2
|
|
||||||
Clicking on the left arrow
|
|
||||||
.RE
|
|
||||||
.IP \[bu] 2
|
|
||||||
\f[V]ClickRArrow\f[R]
|
|
||||||
.RS 2
|
|
||||||
.IP \[bu] 2
|
|
||||||
Clicking on the right arrow
|
|
||||||
.RE
|
|
||||||
.IP \[bu] 2
|
|
||||||
\f[V]ClickItem\f[R]
|
|
||||||
.RS 2
|
|
||||||
.IP \[bu] 2
|
|
||||||
Clicking on the item area
|
|
||||||
.RE
|
|
||||||
.IP \[bu] 2
|
|
||||||
\f[V]ClickSelItem\f[R]
|
|
||||||
.RS 2
|
|
||||||
.IP \[bu] 2
|
|
||||||
Clicking on an item, function here doesn\[cq]t matter, it will always be
|
|
||||||
selected
|
|
||||||
.RE
|
|
||||||
.IP \[bu] 2
|
|
||||||
\f[V]ClickImage\f[R]
|
|
||||||
.RS 2
|
|
||||||
.IP \[bu] 2
|
|
||||||
Clicking on an image
|
|
||||||
.RE
|
|
||||||
.IP \[bu] 2
|
|
||||||
\f[V]ClickNumber\f[R]
|
|
||||||
.RS 2
|
|
||||||
.IP \[bu] 2
|
|
||||||
Clicking on the match count indicator
|
|
||||||
.RE
|
|
||||||
.IP \[bu] 2
|
|
||||||
\f[V]ClickCaps\f[R]
|
|
||||||
.RS 2
|
|
||||||
.IP \[bu] 2
|
|
||||||
Clicking on the caps lock indicator
|
|
||||||
.RE
|
|
||||||
.IP \[bu] 2
|
|
||||||
\f[V]ClickMode\f[R]
|
|
||||||
.RS 2
|
|
||||||
.IP \[bu] 2
|
|
||||||
Clicking on the mode indicator
|
|
||||||
.RE
|
|
||||||
.IP \[bu] 2
|
|
||||||
\f[V]None\f[R]
|
|
||||||
.RS 2
|
|
||||||
.IP \[bu] 2
|
|
||||||
Any click
|
|
||||||
.RE
|
|
||||||
.PP
|
|
||||||
You can set mouse binds through the config file.
|
|
||||||
A default config file is available after installing spmenu.
|
|
||||||
This configuration file has identical keybinds to the default hardcoded
|
|
||||||
keybinds.
|
|
||||||
.PP
|
|
||||||
By default, the configuration file will ignore all hardcoded mouse binds
|
|
||||||
to prevent conflicts, but if you do not like this behavior you can
|
|
||||||
simply set \f[V]ignoreglobalmouse = 0\f[R].
|
|
||||||
.PP
|
|
||||||
These are the default mouse binds.
|
|
||||||
Mode does not apply for mouse binds.
|
|
||||||
.PP
|
|
||||||
.TS
|
|
||||||
tab(@);
|
|
||||||
lw(17.5n) lw(17.5n) lw(17.5n) lw(17.5n).
|
|
||||||
T{
|
|
||||||
Click
|
|
||||||
T}@T{
|
|
||||||
Button
|
|
||||||
T}@T{
|
|
||||||
Function
|
|
||||||
T}@T{
|
|
||||||
Argument
|
|
||||||
T}
|
|
||||||
_
|
|
||||||
T{
|
|
||||||
ClickInput
|
|
||||||
T}@T{
|
|
||||||
Left Click
|
|
||||||
T}@T{
|
|
||||||
clear
|
|
||||||
T}@T{
|
|
||||||
0
|
|
||||||
T}
|
|
||||||
T{
|
|
||||||
ClickPrompt
|
|
||||||
T}@T{
|
|
||||||
Left Click
|
|
||||||
T}@T{
|
|
||||||
clear
|
|
||||||
T}@T{
|
|
||||||
0
|
|
||||||
T}
|
|
||||||
T{
|
|
||||||
ClickMode
|
|
||||||
T}@T{
|
|
||||||
Left Click
|
|
||||||
T}@T{
|
|
||||||
switchmode
|
|
||||||
T}@T{
|
|
||||||
0
|
|
||||||
T}
|
|
||||||
T{
|
|
||||||
ClickNumber
|
|
||||||
T}@T{
|
|
||||||
Left Click
|
|
||||||
T}@T{
|
|
||||||
viewhist
|
|
||||||
T}@T{
|
|
||||||
0
|
|
||||||
T}
|
|
||||||
T{
|
|
||||||
ClickSelItem
|
|
||||||
T}@T{
|
|
||||||
Left Click
|
|
||||||
T}@T{
|
|
||||||
Outputs the item
|
|
||||||
T}@T{
|
|
||||||
0
|
|
||||||
T}
|
|
||||||
T{
|
|
||||||
None
|
|
||||||
T}@T{
|
|
||||||
Scroll Up
|
|
||||||
T}@T{
|
|
||||||
moveprev
|
|
||||||
T}@T{
|
|
||||||
0
|
|
||||||
T}
|
|
||||||
T{
|
|
||||||
None
|
|
||||||
T}@T{
|
|
||||||
Scroll Down
|
|
||||||
T}@T{
|
|
||||||
movenext
|
|
||||||
T}@T{
|
|
||||||
0
|
|
||||||
T}
|
|
||||||
.TE
|
|
||||||
.SS Keybinds
|
.SS Keybinds
|
||||||
.PP
|
.PP
|
||||||
You can set keybinds through the config file.
|
You can set keybinds through the config file.
|
||||||
|
@ -1001,6 +840,11 @@ By default, the configuration file will ignore all hardcoded keybinds to
|
||||||
prevent keybind conflicts, but if you do not like this behavior you can
|
prevent keybind conflicts, but if you do not like this behavior you can
|
||||||
simply set \f[V]ignoreglobalkeys = 0\f[R].
|
simply set \f[V]ignoreglobalkeys = 0\f[R].
|
||||||
.PP
|
.PP
|
||||||
|
Note that if you do unbind your exit or switchmode key by accident and
|
||||||
|
find that you cannot exit spmenu, press \f[V]Ctrl+Alt+Delete\f[R].
|
||||||
|
This is a hardcoded keybind which cannot be disabled from the
|
||||||
|
configuration file.
|
||||||
|
.PP
|
||||||
These are the default keybinds.
|
These are the default keybinds.
|
||||||
.PP
|
.PP
|
||||||
.TS
|
.TS
|
||||||
|
@ -1525,6 +1369,173 @@ T}@T{
|
||||||
0
|
0
|
||||||
T}
|
T}
|
||||||
.TE
|
.TE
|
||||||
|
.SS Mouse
|
||||||
|
.PP
|
||||||
|
spmenu supports mouse clicks.
|
||||||
|
The following parts can be clicked on:
|
||||||
|
.IP \[bu] 2
|
||||||
|
\f[V]ClickWindow\f[R]
|
||||||
|
.RS 2
|
||||||
|
.IP \[bu] 2
|
||||||
|
Clicking on the spmenu window
|
||||||
|
.RE
|
||||||
|
.IP \[bu] 2
|
||||||
|
\f[V]ClickPrompt\f[R]
|
||||||
|
.RS 2
|
||||||
|
.IP \[bu] 2
|
||||||
|
Clicking on the prompt
|
||||||
|
.RE
|
||||||
|
.IP \[bu] 2
|
||||||
|
\f[V]ClickInput\f[R]
|
||||||
|
.RS 2
|
||||||
|
.IP \[bu] 2
|
||||||
|
Clicking on the input
|
||||||
|
.RE
|
||||||
|
.IP \[bu] 2
|
||||||
|
\f[V]ClickLArrow\f[R]
|
||||||
|
.RS 2
|
||||||
|
.IP \[bu] 2
|
||||||
|
Clicking on the left arrow
|
||||||
|
.RE
|
||||||
|
.IP \[bu] 2
|
||||||
|
\f[V]ClickRArrow\f[R]
|
||||||
|
.RS 2
|
||||||
|
.IP \[bu] 2
|
||||||
|
Clicking on the right arrow
|
||||||
|
.RE
|
||||||
|
.IP \[bu] 2
|
||||||
|
\f[V]ClickItem\f[R]
|
||||||
|
.RS 2
|
||||||
|
.IP \[bu] 2
|
||||||
|
Clicking on the item area
|
||||||
|
.RE
|
||||||
|
.IP \[bu] 2
|
||||||
|
\f[V]ClickSelItem\f[R]
|
||||||
|
.RS 2
|
||||||
|
.IP \[bu] 2
|
||||||
|
Clicking on an item, function here doesn\[cq]t matter, it will always be
|
||||||
|
selected
|
||||||
|
.RE
|
||||||
|
.IP \[bu] 2
|
||||||
|
\f[V]ClickImage\f[R]
|
||||||
|
.RS 2
|
||||||
|
.IP \[bu] 2
|
||||||
|
Clicking on an image
|
||||||
|
.RE
|
||||||
|
.IP \[bu] 2
|
||||||
|
\f[V]ClickNumber\f[R]
|
||||||
|
.RS 2
|
||||||
|
.IP \[bu] 2
|
||||||
|
Clicking on the match count indicator
|
||||||
|
.RE
|
||||||
|
.IP \[bu] 2
|
||||||
|
\f[V]ClickCaps\f[R]
|
||||||
|
.RS 2
|
||||||
|
.IP \[bu] 2
|
||||||
|
Clicking on the caps lock indicator
|
||||||
|
.RE
|
||||||
|
.IP \[bu] 2
|
||||||
|
\f[V]ClickMode\f[R]
|
||||||
|
.RS 2
|
||||||
|
.IP \[bu] 2
|
||||||
|
Clicking on the mode indicator
|
||||||
|
.RE
|
||||||
|
.IP \[bu] 2
|
||||||
|
\f[V]None\f[R]
|
||||||
|
.RS 2
|
||||||
|
.IP \[bu] 2
|
||||||
|
Any click
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
You can set mouse binds through the config file.
|
||||||
|
A default config file is available after installing spmenu.
|
||||||
|
This configuration file has identical keybinds to the default hardcoded
|
||||||
|
keybinds.
|
||||||
|
.PP
|
||||||
|
By default, the configuration file will ignore all hardcoded mouse binds
|
||||||
|
to prevent conflicts, but if you do not like this behavior you can
|
||||||
|
simply set \f[V]ignoreglobalmouse = 0\f[R].
|
||||||
|
.PP
|
||||||
|
These are the default mouse binds.
|
||||||
|
Mode does not apply for mouse binds.
|
||||||
|
.PP
|
||||||
|
.TS
|
||||||
|
tab(@);
|
||||||
|
lw(17.5n) lw(17.5n) lw(17.5n) lw(17.5n).
|
||||||
|
T{
|
||||||
|
Click
|
||||||
|
T}@T{
|
||||||
|
Button
|
||||||
|
T}@T{
|
||||||
|
Function
|
||||||
|
T}@T{
|
||||||
|
Argument
|
||||||
|
T}
|
||||||
|
_
|
||||||
|
T{
|
||||||
|
ClickInput
|
||||||
|
T}@T{
|
||||||
|
Left Click
|
||||||
|
T}@T{
|
||||||
|
clear
|
||||||
|
T}@T{
|
||||||
|
0
|
||||||
|
T}
|
||||||
|
T{
|
||||||
|
ClickPrompt
|
||||||
|
T}@T{
|
||||||
|
Left Click
|
||||||
|
T}@T{
|
||||||
|
clear
|
||||||
|
T}@T{
|
||||||
|
0
|
||||||
|
T}
|
||||||
|
T{
|
||||||
|
ClickMode
|
||||||
|
T}@T{
|
||||||
|
Left Click
|
||||||
|
T}@T{
|
||||||
|
switchmode
|
||||||
|
T}@T{
|
||||||
|
0
|
||||||
|
T}
|
||||||
|
T{
|
||||||
|
ClickNumber
|
||||||
|
T}@T{
|
||||||
|
Left Click
|
||||||
|
T}@T{
|
||||||
|
viewhist
|
||||||
|
T}@T{
|
||||||
|
0
|
||||||
|
T}
|
||||||
|
T{
|
||||||
|
ClickSelItem
|
||||||
|
T}@T{
|
||||||
|
Left Click
|
||||||
|
T}@T{
|
||||||
|
Outputs the item
|
||||||
|
T}@T{
|
||||||
|
0
|
||||||
|
T}
|
||||||
|
T{
|
||||||
|
None
|
||||||
|
T}@T{
|
||||||
|
Scroll Up
|
||||||
|
T}@T{
|
||||||
|
moveprev
|
||||||
|
T}@T{
|
||||||
|
0
|
||||||
|
T}
|
||||||
|
T{
|
||||||
|
None
|
||||||
|
T}@T{
|
||||||
|
Scroll Down
|
||||||
|
T}@T{
|
||||||
|
movenext
|
||||||
|
T}@T{
|
||||||
|
0
|
||||||
|
T}
|
||||||
|
.TE
|
||||||
.SS .Xresources
|
.SS .Xresources
|
||||||
.PP
|
.PP
|
||||||
\f[B]NOTE: Only applies for X11 users\f[R]
|
\f[B]NOTE: Only applies for X11 users\f[R]
|
||||||
|
|
Loading…
Reference in a new issue