From 182c897ad5f97da087d8dd6f07a5aa3cfff4e695 Mon Sep 17 00:00:00 2001 From: Dave Davenport Date: Fri, 27 Aug 2021 15:33:35 +0200 Subject: [PATCH] [Doc] Update manpage on keybindings. --- doc/meson_build_manpages.sh | 3 +- doc/rofi-script.5 | 17 +++--- doc/rofi-sensible-terminal.1 | 1 - doc/rofi-theme-selector.1 | 7 +-- doc/rofi-theme.5 | 50 ++++++++++++---- doc/rofi.1 | 108 +++++++++++++++++++++-------------- doc/rofi.1.markdown | 61 ++++++++++---------- 7 files changed, 147 insertions(+), 100 deletions(-) diff --git a/doc/meson_build_manpages.sh b/doc/meson_build_manpages.sh index a30821ed..ef0adfb6 100755 --- a/doc/meson_build_manpages.sh +++ b/doc/meson_build_manpages.sh @@ -3,7 +3,8 @@ ## Did not get this working in meson directly. ## not via generator or custom_target. -pushd "${MESON_SOURCE_ROOT}" + +pushd "${MESON_BUILD_ROOT}" for a in $@ do diff --git a/doc/rofi-script.5 b/doc/rofi-script.5 index f414c1a2..cc409edd 100644 --- a/doc/rofi-script.5 +++ b/doc/rofi-script.5 @@ -1,4 +1,3 @@ -.nh .TH ROFI\-SCRIPT 5 rofi\-script .SH NAME .PP @@ -194,20 +193,20 @@ rofi(1), rofi\-sensible\-terminal(1), dmenu(1), rofi\-theme(5), rofi\-theme\-sel .SH AUTHOR .PP -Qball Cow qball@gmpclient.org -\[la]mailto:qball@gmpclient.org\[ra] +Qball Cow +\[la]qball@gmpclient.org\[ra] .PP -Rasmus Steinke rasi@xssn.at -\[la]mailto:rasi@xssn.at\[ra] +Rasmus Steinke +\[la]rasi@xssn.at\[ra] .PP -Quentin Glidic sardemff7+rofi@sardemff7.net -\[la]mailto:sardemff7+rofi@sardemff7.net\[ra] +Quentin Glidic +\[la]sardemff7+rofi@sardemff7.net\[ra] .PP -Original code based on work by: Sean Pringle sean.pringle@gmail.com -\[la]mailto:sean.pringle@gmail.com\[ra] +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. diff --git a/doc/rofi-sensible-terminal.1 b/doc/rofi-sensible-terminal.1 index 653dee3f..30d4a15d 100644 --- a/doc/rofi-sensible-terminal.1 +++ b/doc/rofi-sensible-terminal.1 @@ -1,4 +1,3 @@ -.nh .TH rofi\-sensible\-terminal 1 rofi\-sensible\-terminal .SH NAME .PP diff --git a/doc/rofi-theme-selector.1 b/doc/rofi-theme-selector.1 index e0f09c31..de076ff4 100644 --- a/doc/rofi-theme-selector.1 +++ b/doc/rofi-theme-selector.1 @@ -1,4 +1,3 @@ -.nh .TH rofi\-theme\-selector 1 rofi\-theme\-selector .SH NAME .PP @@ -31,8 +30,8 @@ $XDG\_DATA\_HOME/share/rofi/themes .RE .PP -${PREFIX} reflects the install location of rofi. In most cases this will be "/usr". -$XDG\_CONFIG\_HOME is normally unset. Default path is "$HOME/.config". +${PREFIX} reflects the install location of rofi. In most cases this will be "/usr".
+$XDG\_CONFIG\_HOME is normally unset. Default path is "$HOME/.config".
$XDG\_DATA\_HOME is normally unset. Default path is "$HOME/.local/share". .SH SEE ALSO @@ -41,5 +40,5 @@ rofi(1) .SH AUTHORS .PP -Qball Cow qball@gmpclient.org +Qball Cow qball@gmpclient.org
Rasmus Steinke rasi@xssn.at diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5 index 6ac4df1d..d9570334 100644 --- a/doc/rofi-theme.5 +++ b/doc/rofi-theme.5 @@ -1,4 +1,3 @@ -.nh .TH ROFI\-THEME 5 rofi\-theme .SH NAME .PP @@ -96,7 +95,7 @@ abbreviation for \fBr\fPofi \fBa\fPdvanced \fBs\fPtyle \fBi\fPnformation. .SH Basic Structure .PP Each element has a section with defined properties. Global properties can be defined in section \fB\fC* { }\fR\&. -Sub\-\§ion names begin with a hash symbol \fB\fC#\fR\&. +Sub\-section names begin with a hash symbol \fB\fC#\fR\&. .PP It is advised to define the \fIglobal properties section\fP on top of the file to @@ -453,7 +452,11 @@ The different values are: .IP \(bu 2 \fB\fC{PERCENTAGE}\fR can be between 0\-1.0, or 0%\-100% .IP \(bu 2 -\fB\fC{named\-color}\fR is one of the following colors:AliceBlue, AntiqueWhite, Aqua, Aquamarine, Azure, Beige, Bisque, Black, BlanchedAlmond, Blue, BlueViolet, Brown, + +.PP +\fB\fC{named\-color}\fR is one of the following colors: +.PP +AliceBlue, AntiqueWhite, Aqua, Aquamarine, Azure, Beige, Bisque, Black, BlanchedAlmond, Blue, BlueViolet, Brown, BurlyWood, CadetBlue, Chartreuse, Chocolate, Coral, CornflowerBlue, Cornsilk, Crimson, Cyan, DarkBlue, DarkCyan, DarkGoldenRod, DarkGray, DarkGrey, DarkGreen, DarkKhaki, DarkMagenta, DarkOliveGreen, DarkOrange, DarkOrchid, DarkRed, DarkSalmon, DarkSeaGreen, DarkSlateBlue, DarkSlateGray, DarkSlateGrey, DarkTurquoise, DarkViolet, DeepPink, DeepSkyBlue, @@ -685,7 +688,6 @@ style property. .PP When no unit is specified, pixels are assumed. - .RE .SH Position @@ -694,14 +696,22 @@ Indicate a place on the window/monitor. .RS .IP \(bu 2 + +.PP Format: \fB\fC(center|east|north|west|south|north east|north west|south west|south east)\fR -\fB\fC +.PP +.RS + +.nf + north west | north | north east \-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\- west | center | east \-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\- south west | south | south east -\fR + +.fi +.RE .RE @@ -873,6 +883,7 @@ The current widgets available in \fBrofi\fP: .RS .IP \(bu 2 \fB\fCwindow\fR + .RS .IP \(bu 2 \fB\fCoverlay\fR: the overlay widget. @@ -880,6 +891,7 @@ The current widgets available in \fBrofi\fP: \fB\fCmainbox\fR: The mainbox box. .IP \(bu 2 \fB\fCinputbar\fR: The input bar box. + .RS .IP \(bu 2 \fB\fCbox\fR: the horizontal @box packing the widgets @@ -895,14 +907,15 @@ The current widgets available in \fBrofi\fP: \fB\fCnum\-filtered\-rows\fR: Shows the total number of rows after filtering. .RE - .IP \(bu 2 \fB\fClistview\fR: The listview. + .RS .IP \(bu 2 \fB\fCscrollbar\fR: the listview scrollbar .IP \(bu 2 \fB\fCelement\fR: a box in the listview holding the entries + .RS .IP \(bu 2 \fB\fCelement\-icon\fR: the widget in the listview's entry showing the (optional) icon @@ -913,29 +926,26 @@ The current widgets available in \fBrofi\fP: .RE - .RE - .IP \(bu 2 \fB\fCmode\-switcher\fR: the main horizontal @box packing the buttons. + .RS .IP \(bu 2 \fB\fCbutton\fR: the buttons @textbox for each mode .RE - .IP \(bu 2 \fB\fCmessage\fR: The container holding the textbox. + .RS .IP \(bu 2 \fB\fCtextbox\fR: the message textbox .RE - .RE - .RE .PP @@ -1043,9 +1053,13 @@ Type of mouse cursor that is set when the mouse pointer is hovered over the widg .SS window: .RS .IP \(bu 2 + +.PP \fBfont\fP: string The font used in the window .IP \(bu 2 + +.PP \fBtransparency\fP: string Indicating if transparency should be used and what type: \fBreal\fP \- True transparency. Only works with a compositor. @@ -1053,20 +1067,32 @@ Indicating if transparency should be used and what type: \fBscreenshot\fP \- Take a screenshot of the screen and use that. \fBPath\fP to png file \- Use an image. .IP \(bu 2 + +.PP \fBlocation\fP: position The place of the anchor on the monitor .IP \(bu 2 + +.PP \fBanchor\fP: anchor The anchor position on the window .IP \(bu 2 + +.PP \fBfullscreen\fP: boolean Window is fullscreen. .IP \(bu 2 + +.PP \fBwidth\fP: distance The width of the window .IP \(bu 2 + +.PP \fBx\-offset\fP: distance .IP \(bu 2 + +.PP \fBy\-offset\fP: distance The offset of the window to the anchor point, allowing you to push the window left/right/up/down diff --git a/doc/rofi.1 b/doc/rofi.1 index 8977b0df..62f40e35 100644 --- a/doc/rofi.1 +++ b/doc/rofi.1 @@ -1,4 +1,3 @@ -.nh .TH ROFI 1 rofi .SH NAME .PP @@ -47,7 +46,7 @@ The website for \fB\fCdmenu\fR can be found here .PP \fBrofi\fP does not aim to be 100% compatible with \fB\fCdmenu\fR\&. There are simply too many flavors of \fB\fCdmenu\fR\&. -The idea is that the basic usage command\-\&line flags are obeyed, theme\-\&related flags are not. +The idea is that the basic usage command\-line flags are obeyed, theme\-related flags are not. Besides, \fBrofi\fP offers some extended features (like multi\-select, highlighting, message bar, extra key bindings). .SS Display Error message @@ -181,7 +180,11 @@ Specify the number of threads \fBrofi\fP should use: .IP \(bu 2 1: Disable threading .IP \(bu 2 -2..n: Specify the maximum number of threads to use in the thread pool.Default: Autodetect + +.PP +2..n: Specify the maximum number of threads to use in the thread pool. +.PP +Default: Autodetect .RE @@ -461,7 +464,11 @@ The different fields are: .IP \(bu 2 \fBcomment\fP: the application comment .IP \(bu 2 -\fBall\fP: all the aboveDefault: \fIname,generic,exec,categories,keywords\fP + +.PP +\fBall\fP: all the above +.PP +Default: \fIname,generic,exec,categories,keywords\fP .RE @@ -534,7 +541,11 @@ The different fields are: .IP \(bu 2 \fBdesktop\fP: window's current desktop .IP \(bu 2 -\fBall\fP: all the aboveDefault: \fIall\fP + +.PP +\fBall\fP: all the above +.PP +Default: \fIall\fP .RE @@ -667,7 +678,11 @@ behavior.) .IP \(bu 2 \fB\-4\fP: the monitor with the focused window. .IP \(bu 2 -\fB\-5\fP: the monitor that shows the mouse pointer.Default: \fI\-5\fP + +.PP +\fB\-5\fP: the monitor that shows the mouse pointer. +.PP +Default: \fI\-5\fP .RE @@ -1165,7 +1180,7 @@ Set ellipsize mode to start. So, the end of the string is visible. .PP Pops up a message dialog (used internally for showing errors) with \fImessage\fP\&. -Message can be multi\-\&line. +Message can be multi\-line. .SS File browser settings .PP @@ -1294,63 +1309,63 @@ Please see \fBrofi\-theme(5)\fP manpage for more information on theming. .RS .IP \(bu 2 -\fB\fCCtrl\-v, Insert\fR: Paste from clipboard +\fB\fCControl\-v, Insert\fR: Paste from clipboard .IP \(bu 2 -\fB\fCCtrl\-Shift\-v, Shift\-Insert\fR: Paste primary selection +\fB\fCControl\-Shift\-v, Shift\-Insert\fR: Paste primary selection .IP \(bu 2 -\fB\fCCtrl\-u\fR: Clear the line +\fB\fCControl\-u\fR: Clear the line .IP \(bu 2 -\fB\fCCtrl\-a\fR: Beginning of line +\fB\fCControl\-a\fR: Beginning of line .IP \(bu 2 -\fB\fCCtrl\-e\fR: End of line +\fB\fCControl\-e\fR: End of line .IP \(bu 2 -\fB\fCCtrl\-f, Right\fR: Forward one character +\fB\fCControl\-f, Right\fR: Forward one character .IP \(bu 2 -\fB\fCAlt\-f, Ctrl\-Right\fR: Forward one word +\fB\fCAlt\-f, Control\-Right\fR: Forward one word .IP \(bu 2 -\fB\fCCtrl\-b, Left\fR: Back one character +\fB\fCControl\-b, Left\fR: Back one character .IP \(bu 2 -\fB\fCAlt\-b, Ctrl\-Left\fR: Back one word +\fB\fCAlt\-b, Control\-Left\fR: Back one word .IP \(bu 2 -\fB\fCCtrl\-d, Delete\fR: Delete character +\fB\fCControl\-d, Delete\fR: Delete character .IP \(bu 2 -\fB\fCCtrl\-Alt\-d\fR: Delete word +\fB\fCControl\-Alt\-d\fR: Delete word .IP \(bu 2 -\fB\fCCtrl\-h, Backspace, Shift\-Backspace\fR: Backspace (delete previous character) +\fB\fCControl\-h, Backspace, Shift\-Backspace\fR: Backspace (delete previous character) .IP \(bu 2 -\fB\fCCtrl\-Alt\-h\fR: Delete previous word +\fB\fCControl\-Alt\-h\fR: Delete previous word .IP \(bu 2 -\fB\fCCtrl\-j,Ctrl\-m,Enter\fR: Accept entry +\fB\fCControl\-j,Control\-m,Enter\fR: Accept entry .IP \(bu 2 -\fB\fCCtrl\-n,Down\fR: Select next entry +\fB\fCControl\-n,Down\fR: Select next entry .IP \(bu 2 -\fB\fCCtrl\-p,Up\fR: Select previous entry +\fB\fCControl\-p,Up\fR: Select previous entry .IP \(bu 2 \fB\fCPage Up\fR: Go to previous page .IP \(bu 2 \fB\fCPage Down\fR: Go to next page .IP \(bu 2 -\fB\fCCtrl\-Page Up\fR: Go to previous column +\fB\fCControl\-Page Up\fR: Go to previous column .IP \(bu 2 -\fB\fCCtrl\-Page Down\fR: Go to next column +\fB\fCControl\-Page Down\fR: Go to next column .IP \(bu 2 -\fB\fCCtrl\-Enter\fR: Use entered text as a command (in \fB\fCssh/run modi\fR) +\fB\fCControl\-Enter\fR: Use entered text as a command (in \fB\fCssh/run modi\fR) .IP \(bu 2 \fB\fCShift\-Enter\fR: Launch the application in a terminal (in run mode) .IP \(bu 2 -\fB\fCCtrl\-Shift\-Enter\fR: As Ctrl\-Enter and run the command in terminal (in run mode) +\fB\fCControl\-Shift\-Enter\fR: As Control\-Enter and run the command in terminal (in run mode) .IP \(bu 2 \fB\fCShift\-Enter\fR: Return the selected entry and move to the next item while keeping \fBrofi\fP open. (in dmenu) .IP \(bu 2 -\fB\fCShift\-Right\fR: Switch to the next mode. The list can be customized with the \fB\fC\-switchers\fR argument. +\fB\fCShift\-Right\fR: Switch to the next mode. The list can be customized with the \fB\fC\-modi\fR argument. .IP \(bu 2 -\fB\fCShift\-Left\fR: Switch to the previous mode. The list can be customized with the \fB\fC\-switchers\fR argument. +\fB\fCShift\-Left\fR: Switch to the previous mode. The list can be customized with the \fB\fC\-modi\fR argument. .IP \(bu 2 -\fB\fCCtrl\-Tab\fR: Switch to the next mode. The list can be customized with the \fB\fC\-switchers\fR argument. +\fB\fCControl\-Tab\fR: Switch to the next mode. The list can be customized with the \fB\fC\-modi\fR argument. .IP \(bu 2 -\fB\fCCtrl\-Shift\-Tab\fR: Switch to the previous mode. The list can be customized with the \fB\fC\-switchers\fR argument. +\fB\fCControl\-Shift\-Tab\fR: Switch to the previous mode. The list can be customized with the \fB\fC\-modi\fR argument. .IP \(bu 2 -\fB\fCCtrl\-space\fR: Set selected item as input text. +\fB\fCControl\-space\fR: Set selected item as input text. .IP \(bu 2 \fB\fCShift\-Del\fR: Delete entry from history. .IP \(bu 2 @@ -1360,14 +1375,19 @@ Please see \fBrofi\-theme(5)\fP manpage for more information on theming. .IP \(bu 2 \fB\fCAlt\-Shift\-S\fR: Take a screenshot and store it in the Pictures directory. .IP \(bu 2 -\fB\fCCtrl\-l\fR: File complete for run dialog. +\fB\fCControl\-l\fR: File complete for run dialog. .RE .PP -To get a full list of key bindings on the command line, see \fB\fCrofi \-h\fR\&. -The options starting with \fB\fC\-kb\fR are keybindings. -Key bindings can be modified using the configuration systems. +This list might not be complete, to get a full list of all key bindings +supported in your rofi, see \fB\fCrofi \-h\fR\&. The options starting with \fB\fC\-kb\fR are keybindings. + +.PP +Key bindings can be modified using the configuration systems. Multiple keys can be bound +to one action by comma separating them. For example \fB\fC\-kb\-primary\-paste "Conctrol+v,Insert"\fR + +.PP To get a searchable list of key bindings, run \fB\fCrofi \-show keys\fR\&. .PP @@ -1739,21 +1759,21 @@ first. .SH AUTHOR .RS .IP \(bu 2 -Qball Cow qball@blame.services -\[la]mailto:qball@blame.services\[ra] +Qball Cow +\[la]qball@blame.services\[ra] .IP \(bu 2 -Rasmus Steinke rasi@xssn.at -\[la]mailto:rasi@xssn.at\[ra] +Rasmus Steinke +\[la]rasi@xssn.at\[ra] .IP \(bu 2 -Quentin Glidic sardemff7+rofi@sardemff7.net -\[la]mailto:sardemff7+rofi@sardemff7.net\[ra] +Quentin Glidic +\[la]sardemff7+rofi@sardemff7.net\[ra] .RE .PP Original code based on work by: Sean Pringle -\[la]https://github.com/seanpringle/simpleswitcher\[ra] sean.pringle@gmail.com -\[la]mailto:sean.pringle@gmail.com\[ra] +\[la]https://github.com/seanpringle/simpleswitcher\[ra] +\[la]sean.pringle@gmail.com\[ra] .PP For a full list of authors, check the \fB\fCAUTHORS\fR file. diff --git a/doc/rofi.1.markdown b/doc/rofi.1.markdown index 0157aad5..ab312b95 100644 --- a/doc/rofi.1.markdown +++ b/doc/rofi.1.markdown @@ -793,44 +793,47 @@ Please see **rofi-theme(5)** manpage for more information on theming. **rofi** has the following key bindings: - * `Ctrl-v, Insert`: Paste from clipboard - * `Ctrl-Shift-v, Shift-Insert`: Paste primary selection - * `Ctrl-u`: Clear the line - * `Ctrl-a`: Beginning of line - * `Ctrl-e`: End of line - * `Ctrl-f, Right`: Forward one character - * `Alt-f, Ctrl-Right`: Forward one word - * `Ctrl-b, Left`: Back one character - * `Alt-b, Ctrl-Left`: Back one word - * `Ctrl-d, Delete`: Delete character - * `Ctrl-Alt-d`: Delete word - * `Ctrl-h, Backspace, Shift-Backspace`: Backspace (delete previous character) - * `Ctrl-Alt-h`: Delete previous word - * `Ctrl-j,Ctrl-m,Enter`: Accept entry - * `Ctrl-n,Down`: Select next entry - * `Ctrl-p,Up`: Select previous entry + * `Control-v, Insert`: Paste from clipboard + * `Control-Shift-v, Shift-Insert`: Paste primary selection + * `Control-u`: Clear the line + * `Control-a`: Beginning of line + * `Control-e`: End of line + * `Control-f, Right`: Forward one character + * `Alt-f, Control-Right`: Forward one word + * `Control-b, Left`: Back one character + * `Alt-b, Control-Left`: Back one word + * `Control-d, Delete`: Delete character + * `Control-Alt-d`: Delete word + * `Control-h, Backspace, Shift-Backspace`: Backspace (delete previous character) + * `Control-Alt-h`: Delete previous word + * `Control-j,Control-m,Enter`: Accept entry + * `Control-n,Down`: Select next entry + * `Control-p,Up`: Select previous entry * `Page Up`: Go to previous page * `Page Down`: Go to next page - * `Ctrl-Page Up`: Go to previous column - * `Ctrl-Page Down`: Go to next column - * `Ctrl-Enter`: Use entered text as a command (in `ssh/run modi`) + * `Control-Page Up`: Go to previous column + * `Control-Page Down`: Go to next column + * `Control-Enter`: Use entered text as a command (in `ssh/run modi`) * `Shift-Enter`: Launch the application in a terminal (in run mode) - * `Ctrl-Shift-Enter`: As Ctrl-Enter and run the command in terminal (in run mode) + * `Control-Shift-Enter`: As Control-Enter and run the command in terminal (in run mode) * `Shift-Enter`: Return the selected entry and move to the next item while keeping **rofi** open. (in dmenu) - * `Shift-Right`: Switch to the next mode. The list can be customized with the `-switchers` argument. - * `Shift-Left`: Switch to the previous mode. The list can be customized with the `-switchers` argument. - * `Ctrl-Tab`: Switch to the next mode. The list can be customized with the `-switchers` argument. - * `Ctrl-Shift-Tab`: Switch to the previous mode. The list can be customized with the `-switchers` argument. - * `Ctrl-space`: Set selected item as input text. + * `Shift-Right`: Switch to the next mode. The list can be customized with the `-modi` argument. + * `Shift-Left`: Switch to the previous mode. The list can be customized with the `-modi` argument. + * `Control-Tab`: Switch to the next mode. The list can be customized with the `-modi` argument. + * `Control-Shift-Tab`: Switch to the previous mode. The list can be customized with the `-modi` argument. + * `Control-space`: Set selected item as input text. * `Shift-Del`: Delete entry from history. * `grave`: Toggle case sensitivity. * `Alt-grave`: Toggle sorting. * `Alt-Shift-S`: Take a screenshot and store it in the Pictures directory. - * `Ctrl-l`: File complete for run dialog. + * `Control-l`: File complete for run dialog. + +This list might not be complete, to get a full list of all key bindings +supported in your rofi, see `rofi -h`. The options starting with `-kb` are keybindings. + +Key bindings can be modified using the configuration systems. Multiple keys can be bound +to one action by comma separating them. For example `-kb-primary-paste "Conctrol+v,Insert"` -To get a full list of key bindings on the command line, see `rofi -h`. -The options starting with `-kb` are keybindings. -Key bindings can be modified using the configuration systems. To get a searchable list of key bindings, run `rofi -show keys`. A key binding starting with `!` will act when all keys have been released.