[Doc] Add a manpage with all the bindings.

This commit is contained in:
Dave Davenport 2021-12-15 21:31:44 +01:00
parent 8f5d9b425e
commit 7b1008b38f
7 changed files with 1081 additions and 2 deletions

View File

@ -177,6 +177,7 @@ dist_man1_MANS=\
dist_man5_MANS=\
doc/rofi-theme.5\
doc/rofi-keys.5\
doc/rofi-script.5
EXTRA_DIST += \
@ -249,6 +250,7 @@ update-manpage: $(top_srcdir)/doc/rofi-theme-selector.1.markdown $(top_srcdir)/d
go-md2man -in $(top_srcdir)/doc/rofi.1.markdown -out $(top_srcdir)/doc/rofi.1
go-md2man -in $(top_srcdir)/doc/rofi-theme-selector.1.markdown -out $(top_srcdir)/doc/rofi-theme-selector.1
go-md2man -in $(top_srcdir)/doc/rofi-theme.5.markdown -out $(top_srcdir)/doc/rofi-theme.5
go-md2man -in $(top_srcdir)/doc/rofi-keys.5.markdown -out $(top_srcdir)/doc/rofi-keys.5
go-md2man -in $(top_srcdir)/doc/rofi-script.5.markdown -out $(top_srcdir)/doc/rofi-script.5
go-md2man -in $(top_srcdir)/doc/rofi-sensible-terminal.1.markdown -out $(top_srcdir)/doc/rofi-sensible-terminal.1

View File

@ -5,6 +5,7 @@ if gomd2man.found()
'rofi.1.markdown',
'rofi-theme-selector.1.markdown',
'rofi-theme.5.markdown',
'rofi-keys.5.markdown',
'rofi-script.5.markdown',
'rofi-sensible-terminal.1.markdown'
)]

625
doc/rofi-keys.5 Normal file
View File

@ -0,0 +1,625 @@
.TH ROFI\-KEYS 5 rofi\-keys
.SH NAME
.PP
\fBrofi keys\fP \- Rofi Key and Mouse bindings
.SH DESCRIPTION
.PP
\fBrofi\fP supports overriding of any of it key and mouse binding.
.SH Setting binding
.PP
Bindings can be done on the commandline (\-{bindingname}):
.PP
.RS
.nf
rofi \-show run \-kb\-accept\-entry 'Control+Shift+space'
.fi
.RE
.PP
or via the configuration file:
.PP
.RS
.nf
configuration {
kb\-accept\-entry: "Control+Shift+space";
}
.fi
.RE
.PP
The key can be set by its name (see above) or its keycode:
.PP
.RS
.nf
configuration {
kb\-accept\-entry: "Control+Shift+[65]";
}
.fi
.RE
.PP
An easy way to look up keycode is xev(1).
.PP
Multiple keys can be specified for an action as a comma separated list:
.PP
.RS
.nf
configuration {
kb\-accept\-entry: "Control+Shift+space,Return";
}
.fi
.RE
.PP
By Default \fBrofi\fP reacts on pressing, to act on the release of all keys
prepend the binding with \fB\fC!\fR:
.PP
.RS
.nf
configuration {
kb\-accept\-entry: "!Control+Shift+space,Return";
}
.fi
.RE
.SH Keyboard Bindings
.SS \fBkb\-primary\-paste\fP:
.PP
Paste primary selection
.PP
\fBDefault\fP: Control+V,Shift+Insert
.SS \fBkb\-secondary\-paste\fP
.PP
Paste clipboard
.PP
\fBDefault\fP: Control+v,Insert
.SS \fBkb\-clear\-line\fP
.PP
Clear input line
.PP
\fBDefault\fP: Control+w
.SS \fBkb\-move\-front\fP
.PP
Beginning of line
.PP
\fBDefault\fP: Control+a
.SS \fBkb\-move\-end\fP
.PP
End of line
.PP
\fBDefault\fP: Control+e
.SS \fBkb\-move\-word\-back\fP
.PP
Move back one word
.PP
\fBDefault\fP: Alt+b,Control+Left
.SS \fBkb\-move\-word\-forward\fP
.PP
Move forward one word
.PP
\fBDefault\fP: Alt+f,Control+Right
.SS \fBkb\-move\-char\-back\fP
.PP
Move back one char
.PP
\fBDefault\fP: Left,Control+b
.SS \fBkb\-move\-char\-forward\fP
.PP
Move forward one char
.PP
\fBDefault\fP: Right,Control+f
.SS \fBkb\-remove\-word\-back\fP
.PP
Delete previous word
.PP
\fBDefault\fP: Control+Alt+h,Control+BackSpace
.SS \fBkb\-remove\-word\-forward\fP
.PP
Delete next word
.PP
\fBDefault\fP: Control+Alt+d
.SS \fBkb\-remove\-char\-forward\fP
.PP
Delete next char
.PP
\fBDefault\fP: Delete,Control+d
.SS \fBkb\-remove\-char\-back\fP
.PP
Delete previous char
.PP
\fBDefault\fP: BackSpace,Shift+BackSpace,Control+h
.SS \fBkb\-remove\-to\-eol\fP
.PP
Delete till the end of line
.PP
\fBDefault\fP: Control+k
.SS \fBkb\-remove\-to\-sol\fP
.PP
Delete till the start of line
.PP
\fBDefault\fP: Control+u
.SS \fBkb\-accept\-entry\fP
.PP
Accept entry
.PP
\fBDefault\fP: Control+j,Control+m,Return,KP\_Enter
.SS \fBkb\-accept\-custom\fP
.PP
Use entered text as command (in ssh/run modi)
.PP
\fBDefault\fP: Control+Return
.SS \fBkb\-accept\-custom\-alt\fP
.PP
Use entered text as command (in ssh/run modi)
.PP
\fBDefault\fP: Control+Shift+Return
.SS \fBkb\-accept\-alt\fP
.PP
Use alternate accept command.
.PP
\fBDefault\fP: Shift+Return
.SS \fBkb\-delete\-entry\fP
.PP
Delete entry from history
.PP
\fBDefault\fP: Shift+Delete
.SS \fBkb\-mode\-next\fP
.PP
Switch to the next mode.
.PP
\fBDefault\fP: Shift+Right,Control+Tab
.SS \fBkb\-mode\-previous\fP
.PP
Switch to the previous mode.
.PP
\fBDefault\fP: Shift+Left,Control+ISO\_Left\_Tab
.SS \fBkb\-mode\-complete\fP
.PP
Start completion for mode.
.PP
\fBDefault\fP: Control+l
.SS \fBkb\-row\-left\fP
.PP
Go to the previous column
.PP
\fBDefault\fP: Control+Page\_Up
.SS \fBkb\-row\-right\fP
.PP
Go to the next column
.PP
\fBDefault\fP: Control+Page\_Down
.SS \fBkb\-row\-up\fP
.PP
Select previous entry
.PP
\fBDefault\fP: Up,Control+p,ISO\_Left\_Tab
.SS \fBkb\-row\-down\fP
.PP
Select next entry
.PP
\fBDefault\fP: Down,Control+n
.SS \fBkb\-row\-tab\fP
.PP
Go to next row, if one left, accept it, if no left next mode.
.PP
\fBDefault\fP: Tab
.SS \fBkb\-page\-prev\fP
.PP
Go to the previous page
.PP
\fBDefault\fP: Page\_Up
.SS \fBkb\-page\-next\fP
.PP
Go to the next page
.PP
\fBDefault\fP: Page\_Down
.SS \fBkb\-row\-first\fP
.PP
Go to the first entry
.PP
\fBDefault\fP: Home,KP\_Home
.SS \fBkb\-row\-last\fP
.PP
Go to the last entry
.PP
\fBDefault\fP: End,KP\_End
.SS \fBkb\-row\-select\fP
.PP
Set selected item as input text
.PP
\fBDefault\fP: Control+space
.SS \fBkb\-screenshot\fP
.PP
Take a screenshot of the rofi window
.PP
\fBDefault\fP: Alt+S
.SS \fBkb\-ellipsize\fP
.PP
Toggle between ellipsize modes for displayed data
.PP
\fBDefault\fP: Alt+period
.SS \fBkb\-toggle\-case\-sensitivity\fP
.PP
Toggle case sensitivity
.PP
\fBDefault\fP: grave,dead\_grave
.SS \fBkb\-toggle\-sort\fP
.PP
Toggle sort
.PP
\fBDefault\fP: Alt+grave
.SS \fBkb\-cancel\fP
.PP
Quit rofi
.PP
\fBDefault\fP: Escape,Control+g,Control+bracketleft
.SS \fBkb\-custom\-1\fP
.PP
Custom keybinding 1
.PP
\fBDefault\fP: Alt+1
.SS \fBkb\-custom\-2\fP
.PP
Custom keybinding 2
.PP
\fBDefault\fP: Alt+2
.SS \fBkb\-custom\-3\fP
.PP
Custom keybinding 3
.PP
\fBDefault\fP: Alt+3
.SS \fBkb\-custom\-4\fP
.PP
Custom keybinding 4
.PP
\fBDefault\fP: Alt+4
.SS \fBkb\-custom\-5\fP
.PP
Custom Keybinding 5
.PP
\fBDefault\fP: Alt+5
.SS \fBkb\-custom\-6\fP
.PP
Custom keybinding 6
.PP
\fBDefault\fP: Alt+6
.SS \fBkb\-custom\-7\fP
.PP
Custom Keybinding 7
.PP
\fBDefault\fP: Alt+7
.SS \fBkb\-custom\-8\fP
.PP
Custom keybinding 8
.PP
\fBDefault\fP: Alt+8
.SS \fBkb\-custom\-9\fP
.PP
Custom keybinding 9
.PP
\fBDefault\fP: Alt+9
.SS \fBkb\-custom\-10\fP
.PP
Custom keybinding 10
.PP
\fBDefault\fP: Alt+0
.SS \fBkb\-custom\-11\fP
.PP
Custom keybinding 11
.PP
\fBDefault\fP: Alt+exclam
.SS \fBkb\-custom\-12\fP
.PP
Custom keybinding 12
.PP
\fBDefault\fP: Alt+at
.SS \fBkb\-custom\-13\fP
.PP
Custom keybinding 13
.PP
\fBDefault\fP: Alt+numbersign
.SS \fBkb\-custom\-14\fP
.PP
Custom keybinding 14
.PP
\fBDefault\fP: Alt+dollar
.SS \fBkb\-custom\-15\fP
.PP
Custom keybinding 15
.PP
\fBDefault\fP: Alt+percent
.SS \fBkb\-custom\-16\fP
.PP
Custom keybinding 16
.PP
\fBDefault\fP: Alt+dead\_circumflex
.SS \fBkb\-custom\-17\fP
.PP
Custom keybinding 17
.PP
\fBDefault\fP: Alt+ampersand
.SS \fBkb\-custom\-18\fP
.PP
Custom keybinding 18
.PP
\fBDefault\fP: Alt+asterisk
.SS \fBkb\-custom\-19\fP
.PP
Custom Keybinding 19
.PP
\fBDefault\fP: Alt+parenleft
.SS \fBkb\-select\-1\fP
.PP
Select row 1
.PP
\fBDefault\fP: Super+1
.SS \fBkb\-select\-2\fP
.PP
Select row 2
.PP
\fBDefault\fP: Super+2
.SS \fBkb\-select\-3\fP
.PP
Select row 3
.PP
\fBDefault\fP: Super+3
.SS \fBkb\-select\-4\fP
.PP
Select row 4
.PP
\fBDefault\fP: Super+4
.SS \fBkb\-select\-5\fP
.PP
Select row 5
.PP
\fBDefault\fP: Super+5
.SS \fBkb\-select\-6\fP
.PP
Select row 6
.PP
\fBDefault\fP: Super+6
.SS \fBkb\-select\-7\fP
.PP
Select row 7
.PP
\fBDefault\fP: Super+7
.SS \fBkb\-select\-8\fP
.PP
Select row 8
.PP
\fBDefault\fP: Super+8
.SS \fBkb\-select\-9\fP
.PP
Select row 9
.PP
\fBDefault\fP: Super+9
.SS \fBkb\-select\-10\fP
.PP
Select row 10
.PP
\fBDefault\fP: Super+0
.SH Mouse Bindings
.SS \fBml\-row\-left\fP
.PP
Go to the previous column
.PP
\fBDefault\fP: ScrollLeft
.SS \fBml\-row\-right\fP
.PP
Go to the next column
.PP
\fBDefault\fP: ScrollRight
.SS \fBml\-row\-up\fP
.PP
Select previous entry
.PP
\fBDefault\fP: ScrollUp
.SS \fBml\-row\-down\fP
.PP
Select next entry
.PP
\fBDefault\fP: ScrollDown
.SS \fBme\-select\-entry\fP
.PP
Select hovered row
.PP
\fBDefault\fP: MousePrimary
.SS \fBme\-accept\-entry\fP
.PP
Accept hovered row
.PP
\fBDefault\fP: MouseDPrimary
.SS \fBme\-accept\-custom\fP
.PP
Accept hovered row with custom action
.PP
\fBDefault\fP: Control+MouseDPrimary
.SH SEE ALSO
.PP
rofi(1), rofi\-sensible\-terminal(1), rofi\-theme(5), rofi\-script(5)
.SH AUTHOR
.PP
Qball Cow
\[la]qball@gmpclient.org\[ra]
.PP
Rasmus Steinke
\[la]rasi@xssn.at\[ra]
.PP
Quentin Glidic
\[la]sardemff7+rofi@sardemff7.net\[ra]
.PP
Original code based on work by: Sean Pringle
\[la]sean.pringle@gmail.com\[ra]
.PP
For a full list of authors, check the AUTHORS file.

446
doc/rofi-keys.5.markdown Normal file
View File

@ -0,0 +1,446 @@
# ROFI-KEYS 5 rofi-keys
## NAME
**rofi keys** - Rofi Key and Mouse bindings
## DESCRIPTION
**rofi** supports overriding of any of it key and mouse binding.
## Setting binding
Bindings can be done on the commandline (-{bindingname}):
```bash
rofi -show run -kb-accept-entry 'Control+Shift+space'
```
or via the configuration file:
```css
configuration {
kb-accept-entry: "Control+Shift+space";
}
```
The key can be set by its name (see above) or its keycode:
```css
configuration {
kb-accept-entry: "Control+Shift+[65]";
}
```
An easy way to look up keycode is xev(1).
Multiple keys can be specified for an action as a comma separated list:
```css
configuration {
kb-accept-entry: "Control+Shift+space,Return";
}
```
By Default **rofi** reacts on pressing, to act on the release of all keys
prepend the binding with `!`:
```css
configuration {
kb-accept-entry: "!Control+Shift+space,Return";
}
```
## Keyboard Bindings
### **kb-primary-paste**:
Paste primary selection
**Default**: Control+V,Shift+Insert
### **kb-secondary-paste**
Paste clipboard
**Default**: Control+v,Insert
### **kb-clear-line**
Clear input line
**Default**: Control+w
### **kb-move-front**
Beginning of line
**Default**: Control+a
### **kb-move-end**
End of line
**Default**: Control+e
### **kb-move-word-back**
Move back one word
**Default**: Alt+b,Control+Left
### **kb-move-word-forward**
Move forward one word
**Default**: Alt+f,Control+Right
### **kb-move-char-back**
Move back one char
**Default**: Left,Control+b
### **kb-move-char-forward**
Move forward one char
**Default**: Right,Control+f
### **kb-remove-word-back**
Delete previous word
**Default**: Control+Alt+h,Control+BackSpace
### **kb-remove-word-forward**
Delete next word
**Default**: Control+Alt+d
### **kb-remove-char-forward**
Delete next char
**Default**: Delete,Control+d
### **kb-remove-char-back**
Delete previous char
**Default**: BackSpace,Shift+BackSpace,Control+h
### **kb-remove-to-eol**
Delete till the end of line
**Default**: Control+k
### **kb-remove-to-sol**
Delete till the start of line
**Default**: Control+u
### **kb-accept-entry**
Accept entry
**Default**: Control+j,Control+m,Return,KP_Enter
### **kb-accept-custom**
Use entered text as command (in ssh/run modi)
**Default**: Control+Return
### **kb-accept-custom-alt**
Use entered text as command (in ssh/run modi)
**Default**: Control+Shift+Return
### **kb-accept-alt**
Use alternate accept command.
**Default**: Shift+Return
### **kb-delete-entry**
Delete entry from history
**Default**: Shift+Delete
### **kb-mode-next**
Switch to the next mode.
**Default**: Shift+Right,Control+Tab
### **kb-mode-previous**
Switch to the previous mode.
**Default**: Shift+Left,Control+ISO_Left_Tab
### **kb-mode-complete**
Start completion for mode.
**Default**: Control+l
### **kb-row-left**
Go to the previous column
**Default**: Control+Page_Up
### **kb-row-right**
Go to the next column
**Default**: Control+Page_Down
### **kb-row-up**
Select previous entry
**Default**: Up,Control+p,ISO_Left_Tab
### **kb-row-down**
Select next entry
**Default**: Down,Control+n
### **kb-row-tab**
Go to next row, if one left, accept it, if no left next mode.
**Default**: Tab
### **kb-page-prev**
Go to the previous page
**Default**: Page_Up
### **kb-page-next**
Go to the next page
**Default**: Page_Down
### **kb-row-first**
Go to the first entry
**Default**: Home,KP_Home
### **kb-row-last**
Go to the last entry
**Default**: End,KP_End
### **kb-row-select**
Set selected item as input text
**Default**: Control+space
### **kb-screenshot**
Take a screenshot of the rofi window
**Default**: Alt+S
### **kb-ellipsize**
Toggle between ellipsize modes for displayed data
**Default**: Alt+period
### **kb-toggle-case-sensitivity**
Toggle case sensitivity
**Default**: grave,dead_grave
### **kb-toggle-sort**
Toggle sort
**Default**: Alt+grave
### **kb-cancel**
Quit rofi
**Default**: Escape,Control+g,Control+bracketleft
### **kb-custom-1**
Custom keybinding 1
**Default**: Alt+1
### **kb-custom-2**
Custom keybinding 2
**Default**: Alt+2
### **kb-custom-3**
Custom keybinding 3
**Default**: Alt+3
### **kb-custom-4**
Custom keybinding 4
**Default**: Alt+4
### **kb-custom-5**
Custom Keybinding 5
**Default**: Alt+5
### **kb-custom-6**
Custom keybinding 6
**Default**: Alt+6
### **kb-custom-7**
Custom Keybinding 7
**Default**: Alt+7
### **kb-custom-8**
Custom keybinding 8
**Default**: Alt+8
### **kb-custom-9**
Custom keybinding 9
**Default**: Alt+9
### **kb-custom-10**
Custom keybinding 10
**Default**: Alt+0
### **kb-custom-11**
Custom keybinding 11
**Default**: Alt+exclam
### **kb-custom-12**
Custom keybinding 12
**Default**: Alt+at
### **kb-custom-13**
Custom keybinding 13
**Default**: Alt+numbersign
### **kb-custom-14**
Custom keybinding 14
**Default**: Alt+dollar
### **kb-custom-15**
Custom keybinding 15
**Default**: Alt+percent
### **kb-custom-16**
Custom keybinding 16
**Default**: Alt+dead_circumflex
### **kb-custom-17**
Custom keybinding 17
**Default**: Alt+ampersand
### **kb-custom-18**
Custom keybinding 18
**Default**: Alt+asterisk
### **kb-custom-19**
Custom Keybinding 19
**Default**: Alt+parenleft
### **kb-select-1**
Select row 1
**Default**: Super+1
### **kb-select-2**
Select row 2
**Default**: Super+2
### **kb-select-3**
Select row 3
**Default**: Super+3
### **kb-select-4**
Select row 4
**Default**: Super+4
### **kb-select-5**
Select row 5
**Default**: Super+5
### **kb-select-6**
Select row 6
**Default**: Super+6
### **kb-select-7**
Select row 7
**Default**: Super+7
### **kb-select-8**
Select row 8
**Default**: Super+8
### **kb-select-9**
Select row 9
**Default**: Super+9
### **kb-select-10**
Select row 10
**Default**: Super+0
## Mouse Bindings
### **ml-row-left**
Go to the previous column
**Default**: ScrollLeft
### **ml-row-right**
Go to the next column
**Default**: ScrollRight
### **ml-row-up**
Select previous entry
**Default**: ScrollUp
### **ml-row-down**
Select next entry
**Default**: ScrollDown
### **me-select-entry**
Select hovered row
**Default**: MousePrimary
### **me-accept-entry**
Accept hovered row
**Default**: MouseDPrimary
### **me-accept-custom**
Accept hovered row with custom action
**Default**: Control+MouseDPrimary
## SEE ALSO
rofi(1), rofi-sensible-terminal(1), rofi-theme(5), rofi-script(5)
## AUTHOR
Qball Cow <qball@gmpclient.org>
Rasmus Steinke <rasi@xssn.at>
Quentin Glidic <sardemff7+rofi@sardemff7.net>
Original code based on work by: Sean Pringle <sean.pringle@gmail.com>
For a full list of authors, check the AUTHORS file.

View File

@ -1433,6 +1433,9 @@ configuration {
.fi
.RE
.PP
For a full list of bindings, see the \fBrofi\-keys(5)\fP manpage.
.SH Available Modi
.SS window
.PP
@ -1794,7 +1797,7 @@ first.
.SH SEE ALSO
.PP
\fBrofi\-sensible\-terminal(1)\fP, \fBdmenu(1)\fP, \fBrofi\-theme(5)\fP, \fBrofi\-script(5)\fP, \fBrofi\-theme\-selector(1)\fP
\fBrofi\-sensible\-terminal(1)\fP, \fBdmenu(1)\fP, \fBrofi\-theme(5)\fP, \fBrofi\-script(5)\fP, \fBrofi\-keys(5)\fP,\fBrofi\-theme\-selector(1)\fP
.SH AUTHOR
.RS

View File

@ -868,6 +868,7 @@ configuration {
}
```
For a full list of bindings, see the **rofi-keys(5)** manpage.
## Available Modi
@ -1104,7 +1105,7 @@ first.
## SEE ALSO
**rofi-sensible-terminal(1)**, **dmenu(1)**, **rofi-theme(5)**, **rofi-script(5)**, **rofi-theme-selector(1)**
**rofi-sensible-terminal(1)**, **dmenu(1)**, **rofi-theme(5)**, **rofi-script(5)**, **rofi-keys(5)**,**rofi-theme-selector(1)**
## AUTHOR

View File

@ -232,6 +232,7 @@ install_man(
'doc/rofi-sensible-terminal.1',
'doc/rofi-script.5',
'doc/rofi-theme.5',
'doc/rofi-keys.5',
)
install_data(