From fb1eefb2988fcd617290e31a3087386cca9b796d Mon Sep 17 00:00:00 2001 From: Dave Davenport Date: Sun, 13 Feb 2022 12:22:25 +0100 Subject: [PATCH] Update manpage. --- doc/rofi-dmenu.5 | 19 ++-- doc/rofi-keys.5 | 165 ++++++++++++++++++----------------- 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 | 152 +++++--------------------------- doc/rofi.1.markdown | 60 ++----------- 8 files changed, 145 insertions(+), 326 deletions(-) diff --git a/doc/rofi-dmenu.5 b/doc/rofi-dmenu.5 index 49c12e55..d0973ee7 100644 --- a/doc/rofi-dmenu.5 +++ b/doc/rofi-dmenu.5 @@ -1,3 +1,4 @@ +.nh .TH ROFI\-DMENU 5 rofi\-dmenu .SH NAME .PP @@ -14,7 +15,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). .SH BASIC CONCEPT @@ -306,20 +307,20 @@ rofi(1), rofi\-sensible\-terminal(1), dmenu(1), rofi\-theme(5), rofi\-script(5), .SH AUTHOR .PP -Qball Cow -\[la]qball@gmpclient.org\[ra] +Qball Cow qball@gmpclient.org +\[la]mailto:qball@gmpclient.org\[ra] .PP -Rasmus Steinke -\[la]rasi@xssn.at\[ra] +Rasmus Steinke rasi@xssn.at +\[la]mailto:rasi@xssn.at\[ra] .PP -Quentin Glidic -\[la]sardemff7+rofi@sardemff7.net\[ra] +Quentin Glidic sardemff7+rofi@sardemff7.net +\[la]mailto:sardemff7+rofi@sardemff7.net\[ra] .PP -Original code based on work by: Sean Pringle -\[la]sean.pringle@gmail.com\[ra] +Original code based on work by: Sean Pringle sean.pringle@gmail.com +\[la]mailto:sean.pringle@gmail.com\[ra] .PP For a full list of authors, check the AUTHORS file. diff --git a/doc/rofi-keys.5 b/doc/rofi-keys.5 index f335e39e..c3052336 100644 --- a/doc/rofi-keys.5 +++ b/doc/rofi-keys.5 @@ -1,3 +1,4 @@ +.nh .TH ROFI\-KEYS 5 rofi\-keys .SH NAME .PP @@ -86,469 +87,469 @@ configuration { Paste primary selection .PP -\fBDefault\fP: Control+V,Shift+Insert +\fBDefault\fP: Control+V,Shift+Insert .SS \fBkb\-secondary\-paste\fP .PP Paste clipboard .PP -\fBDefault\fP: Control+v,Insert +\fBDefault\fP: Control+v,Insert .SS \fBkb\-clear\-line\fP .PP Clear input line .PP -\fBDefault\fP: Control+w +\fBDefault\fP: Control+w .SS \fBkb\-move\-front\fP .PP Beginning of line .PP -\fBDefault\fP: Control+a +\fBDefault\fP: Control+a .SS \fBkb\-move\-end\fP .PP End of line .PP -\fBDefault\fP: Control+e +\fBDefault\fP: Control+e .SS \fBkb\-move\-word\-back\fP .PP Move back one word .PP -\fBDefault\fP: Alt+b,Control+Left +\fBDefault\fP: Alt+b,Control+Left .SS \fBkb\-move\-word\-forward\fP .PP Move forward one word .PP -\fBDefault\fP: Alt+f,Control+Right +\fBDefault\fP: Alt+f,Control+Right .SS \fBkb\-move\-char\-back\fP .PP Move back one char .PP -\fBDefault\fP: Left,Control+b +\fBDefault\fP: Left,Control+b .SS \fBkb\-move\-char\-forward\fP .PP Move forward one char .PP -\fBDefault\fP: Right,Control+f +\fBDefault\fP: Right,Control+f .SS \fBkb\-remove\-word\-back\fP .PP Delete previous word .PP -\fBDefault\fP: Control+Alt+h,Control+BackSpace +\fBDefault\fP: Control+Alt+h,Control+BackSpace .SS \fBkb\-remove\-word\-forward\fP .PP Delete next word .PP -\fBDefault\fP: Control+Alt+d +\fBDefault\fP: Control+Alt+d .SS \fBkb\-remove\-char\-forward\fP .PP Delete next char .PP -\fBDefault\fP: Delete,Control+d +\fBDefault\fP: Delete,Control+d .SS \fBkb\-remove\-char\-back\fP .PP Delete previous char .PP -\fBDefault\fP: BackSpace,Shift+BackSpace,Control+h +\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 +\fBDefault\fP: Control+k .SS \fBkb\-remove\-to\-sol\fP .PP Delete till the start of line .PP -\fBDefault\fP: Control+u +\fBDefault\fP: Control+u .SS \fBkb\-accept\-entry\fP .PP Accept entry .PP -\fBDefault\fP: Control+j,Control+m,Return,KP\_Enter +\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 +\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 +\fBDefault\fP: Control+Shift+Return .SS \fBkb\-accept\-alt\fP .PP Use alternate accept command. .PP -\fBDefault\fP: Shift+Return +\fBDefault\fP: Shift+Return .SS \fBkb\-delete\-entry\fP .PP Delete entry from history .PP -\fBDefault\fP: Shift+Delete +\fBDefault\fP: Shift+Delete .SS \fBkb\-mode\-next\fP .PP Switch to the next mode. .PP -\fBDefault\fP: Shift+Right,Control+Tab +\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 +\fBDefault\fP: Shift+Left,Control+ISO\_Left\_Tab .SS \fBkb\-mode\-complete\fP .PP Start completion for mode. .PP -\fBDefault\fP: Control+l +\fBDefault\fP: Control+l .SS \fBkb\-row\-left\fP .PP Go to the previous column .PP -\fBDefault\fP: Control+Page\_Up +\fBDefault\fP: Control+Page\_Up .SS \fBkb\-row\-right\fP .PP Go to the next column .PP -\fBDefault\fP: Control+Page\_Down +\fBDefault\fP: Control+Page\_Down .SS \fBkb\-row\-up\fP .PP Select previous entry .PP -\fBDefault\fP: Up,Control+p,ISO\_Left\_Tab +\fBDefault\fP: Up,Control+p,ISO\_Left\_Tab .SS \fBkb\-row\-down\fP .PP Select next entry .PP -\fBDefault\fP: Down,Control+n +\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 +\fBDefault\fP: Tab .SS \fBkb\-page\-prev\fP .PP Go to the previous page .PP -\fBDefault\fP: Page\_Up +\fBDefault\fP: Page\_Up .SS \fBkb\-page\-next\fP .PP Go to the next page .PP -\fBDefault\fP: Page\_Down +\fBDefault\fP: Page\_Down .SS \fBkb\-row\-first\fP .PP Go to the first entry .PP -\fBDefault\fP: Home,KP\_Home +\fBDefault\fP: Home,KP\_Home .SS \fBkb\-row\-last\fP .PP Go to the last entry .PP -\fBDefault\fP: End,KP\_End +\fBDefault\fP: End,KP\_End .SS \fBkb\-row\-select\fP .PP Set selected item as input text .PP -\fBDefault\fP: Control+space +\fBDefault\fP: Control+space .SS \fBkb\-screenshot\fP .PP Take a screenshot of the rofi window .PP -\fBDefault\fP: Alt+S +\fBDefault\fP: Alt+S .SS \fBkb\-ellipsize\fP .PP Toggle between ellipsize modes for displayed data .PP -\fBDefault\fP: Alt+period +\fBDefault\fP: Alt+period .SS \fBkb\-toggle\-case\-sensitivity\fP .PP Toggle case sensitivity .PP -\fBDefault\fP: grave,dead\_grave +\fBDefault\fP: grave,dead\_grave .SS \fBkb\-toggle\-sort\fP .PP Toggle sort .PP -\fBDefault\fP: Alt+grave +\fBDefault\fP: Alt+grave .SS \fBkb\-cancel\fP .PP Quit rofi .PP -\fBDefault\fP: Escape,Control+g,Control+bracketleft +\fBDefault\fP: Escape,Control+g,Control+bracketleft .SS \fBkb\-custom\-1\fP .PP Custom keybinding 1 .PP -\fBDefault\fP: Alt+1 +\fBDefault\fP: Alt+1 .SS \fBkb\-custom\-2\fP .PP Custom keybinding 2 .PP -\fBDefault\fP: Alt+2 +\fBDefault\fP: Alt+2 .SS \fBkb\-custom\-3\fP .PP Custom keybinding 3 .PP -\fBDefault\fP: Alt+3 +\fBDefault\fP: Alt+3 .SS \fBkb\-custom\-4\fP .PP Custom keybinding 4 .PP -\fBDefault\fP: Alt+4 +\fBDefault\fP: Alt+4 .SS \fBkb\-custom\-5\fP .PP Custom Keybinding 5 .PP -\fBDefault\fP: Alt+5 +\fBDefault\fP: Alt+5 .SS \fBkb\-custom\-6\fP .PP Custom keybinding 6 .PP -\fBDefault\fP: Alt+6 +\fBDefault\fP: Alt+6 .SS \fBkb\-custom\-7\fP .PP Custom Keybinding 7 .PP -\fBDefault\fP: Alt+7 +\fBDefault\fP: Alt+7 .SS \fBkb\-custom\-8\fP .PP Custom keybinding 8 .PP -\fBDefault\fP: Alt+8 +\fBDefault\fP: Alt+8 .SS \fBkb\-custom\-9\fP .PP Custom keybinding 9 .PP -\fBDefault\fP: Alt+9 +\fBDefault\fP: Alt+9 .SS \fBkb\-custom\-10\fP .PP Custom keybinding 10 .PP -\fBDefault\fP: Alt+0 +\fBDefault\fP: Alt+0 .SS \fBkb\-custom\-11\fP .PP Custom keybinding 11 .PP -\fBDefault\fP: Alt+exclam +\fBDefault\fP: Alt+exclam .SS \fBkb\-custom\-12\fP .PP Custom keybinding 12 .PP -\fBDefault\fP: Alt+at +\fBDefault\fP: Alt+at .SS \fBkb\-custom\-13\fP .PP Custom keybinding 13 .PP -\fBDefault\fP: Alt+numbersign +\fBDefault\fP: Alt+numbersign .SS \fBkb\-custom\-14\fP .PP Custom keybinding 14 .PP -\fBDefault\fP: Alt+dollar +\fBDefault\fP: Alt+dollar .SS \fBkb\-custom\-15\fP .PP Custom keybinding 15 .PP -\fBDefault\fP: Alt+percent +\fBDefault\fP: Alt+percent .SS \fBkb\-custom\-16\fP .PP Custom keybinding 16 .PP -\fBDefault\fP: Alt+dead\_circumflex +\fBDefault\fP: Alt+dead\_circumflex .SS \fBkb\-custom\-17\fP .PP Custom keybinding 17 .PP -\fBDefault\fP: Alt+ampersand +\fBDefault\fP: Alt+ampersand .SS \fBkb\-custom\-18\fP .PP Custom keybinding 18 .PP -\fBDefault\fP: Alt+asterisk +\fBDefault\fP: Alt+asterisk .SS \fBkb\-custom\-19\fP .PP Custom Keybinding 19 .PP -\fBDefault\fP: Alt+parenleft +\fBDefault\fP: Alt+parenleft .SS \fBkb\-select\-1\fP .PP Select row 1 .PP -\fBDefault\fP: Super+1 +\fBDefault\fP: Super+1 .SS \fBkb\-select\-2\fP .PP Select row 2 .PP -\fBDefault\fP: Super+2 +\fBDefault\fP: Super+2 .SS \fBkb\-select\-3\fP .PP Select row 3 .PP -\fBDefault\fP: Super+3 +\fBDefault\fP: Super+3 .SS \fBkb\-select\-4\fP .PP Select row 4 .PP -\fBDefault\fP: Super+4 +\fBDefault\fP: Super+4 .SS \fBkb\-select\-5\fP .PP Select row 5 .PP -\fBDefault\fP: Super+5 +\fBDefault\fP: Super+5 .SS \fBkb\-select\-6\fP .PP Select row 6 .PP -\fBDefault\fP: Super+6 +\fBDefault\fP: Super+6 .SS \fBkb\-select\-7\fP .PP Select row 7 .PP -\fBDefault\fP: Super+7 +\fBDefault\fP: Super+7 .SS \fBkb\-select\-8\fP .PP Select row 8 .PP -\fBDefault\fP: Super+8 +\fBDefault\fP: Super+8 .SS \fBkb\-select\-9\fP .PP Select row 9 .PP -\fBDefault\fP: Super+9 +\fBDefault\fP: Super+9 .SS \fBkb\-select\-10\fP .PP Select row 10 .PP -\fBDefault\fP: Super+0 +\fBDefault\fP: Super+0 .SH Mouse Bindings .SS \fBml\-row\-left\fP @@ -556,49 +557,49 @@ Select row 10 Go to the previous column .PP -\fBDefault\fP: ScrollLeft +\fBDefault\fP: ScrollLeft .SS \fBml\-row\-right\fP .PP Go to the next column .PP -\fBDefault\fP: ScrollRight +\fBDefault\fP: ScrollRight .SS \fBml\-row\-up\fP .PP Select previous entry .PP -\fBDefault\fP: ScrollUp +\fBDefault\fP: ScrollUp .SS \fBml\-row\-down\fP .PP Select next entry .PP -\fBDefault\fP: ScrollDown +\fBDefault\fP: ScrollDown .SS \fBme\-select\-entry\fP .PP Select hovered row .PP -\fBDefault\fP: MousePrimary +\fBDefault\fP: MousePrimary .SS \fBme\-accept\-entry\fP .PP Accept hovered row .PP -\fBDefault\fP: MouseDPrimary +\fBDefault\fP: MouseDPrimary .SS \fBme\-accept\-custom\fP .PP Accept hovered row with custom action .PP -\fBDefault\fP: Control+MouseDPrimary +\fBDefault\fP: Control+MouseDPrimary .SH SEE ALSO .PP @@ -606,20 +607,20 @@ rofi(1), rofi\-sensible\-terminal(1), rofi\-theme(5), rofi\-script(5) .SH AUTHOR .PP -Qball Cow -\[la]qball@gmpclient.org\[ra] +Qball Cow qball@gmpclient.org +\[la]mailto:qball@gmpclient.org\[ra] .PP -Rasmus Steinke -\[la]rasi@xssn.at\[ra] +Rasmus Steinke rasi@xssn.at +\[la]mailto:rasi@xssn.at\[ra] .PP -Quentin Glidic -\[la]sardemff7+rofi@sardemff7.net\[ra] +Quentin Glidic sardemff7+rofi@sardemff7.net +\[la]mailto:sardemff7+rofi@sardemff7.net\[ra] .PP -Original code based on work by: Sean Pringle -\[la]sean.pringle@gmail.com\[ra] +Original code based on work by: Sean Pringle sean.pringle@gmail.com +\[la]mailto:sean.pringle@gmail.com\[ra] .PP For a full list of authors, check the AUTHORS file. diff --git a/doc/rofi-script.5 b/doc/rofi-script.5 index cc409edd..f414c1a2 100644 --- a/doc/rofi-script.5 +++ b/doc/rofi-script.5 @@ -1,3 +1,4 @@ +.nh .TH ROFI\-SCRIPT 5 rofi\-script .SH NAME .PP @@ -193,20 +194,20 @@ rofi(1), rofi\-sensible\-terminal(1), dmenu(1), rofi\-theme(5), rofi\-theme\-sel .SH AUTHOR .PP -Qball Cow -\[la]qball@gmpclient.org\[ra] +Qball Cow qball@gmpclient.org +\[la]mailto:qball@gmpclient.org\[ra] .PP -Rasmus Steinke -\[la]rasi@xssn.at\[ra] +Rasmus Steinke rasi@xssn.at +\[la]mailto:rasi@xssn.at\[ra] .PP -Quentin Glidic -\[la]sardemff7+rofi@sardemff7.net\[ra] +Quentin Glidic sardemff7+rofi@sardemff7.net +\[la]mailto:sardemff7+rofi@sardemff7.net\[ra] .PP -Original code based on work by: Sean Pringle -\[la]sean.pringle@gmail.com\[ra] +Original code based on work by: Sean Pringle sean.pringle@gmail.com +\[la]mailto: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 30d4a15d..653dee3f 100644 --- a/doc/rofi-sensible-terminal.1 +++ b/doc/rofi-sensible-terminal.1 @@ -1,3 +1,4 @@ +.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 de076ff4..e0f09c31 100644 --- a/doc/rofi-theme-selector.1 +++ b/doc/rofi-theme-selector.1 @@ -1,3 +1,4 @@ +.nh .TH rofi\-theme\-selector 1 rofi\-theme\-selector .SH NAME .PP @@ -30,8 +31,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 @@ -40,5 +41,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 07be4cd7..5c03f3da 100644 --- a/doc/rofi-theme.5 +++ b/doc/rofi-theme.5 @@ -1,3 +1,4 @@ +.nh .TH ROFI\-THEME 5 rofi\-theme .SH NAME .PP @@ -133,7 +134,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\-section names begin with a hash symbol \fB\fC#\fR\&. +Sub\-\§ion 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 @@ -492,11 +493,7 @@ The different values are: .IP \(bu 2 \fB\fC{PERCENTAGE}\fR can be between 0\-1.0, or 0%\-100% .IP \(bu 2 - -.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, +\fB\fC{named\-color}\fR is one of the following colors: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, @@ -734,6 +731,7 @@ style property. .PP When no unit is specified, pixels are assumed. + .RE .SH Position @@ -742,22 +740,14 @@ 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 -.PP -.RS - -.nf - +\fB\fC north west | north | north east \-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\- west | center | east \-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\- south west | south | south east - -.fi -.RE +\fR .RE @@ -992,7 +982,6 @@ The current widgets available in \fBrofi\fP: .RS .IP \(bu 2 \fB\fCwindow\fR - .RS .IP \(bu 2 \fB\fCoverlay\fR: the overlay widget. @@ -1000,7 +989,6 @@ 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 @@ -1016,15 +1004,14 @@ 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 @@ -1035,26 +1022,29 @@ 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 @@ -1162,13 +1152,9 @@ 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. @@ -1176,32 +1162,20 @@ 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 97612d09..8e125c7f 100644 --- a/doc/rofi.1 +++ b/doc/rofi.1 @@ -1,3 +1,4 @@ +.nh .TH ROFI 1 rofi .SH NAME .PP @@ -174,11 +175,7 @@ Specify the number of threads \fBrofi\fP should use: .IP \(bu 2 1: Disable threading .IP \(bu 2 - -.PP -2..n: Specify the maximum number of threads to use in the thread pool. -.PP -Default: Autodetect +2..n: Specify the maximum number of threads to use in the thread pool.Default: Autodetect .RE @@ -217,6 +214,9 @@ Or get the options from a script: .fi .RE +.PP +See the \fBrofi\-dmenu(5)\fP manpage for more information. + .PP \fB\fC\-show\fR \fImode\fP @@ -458,11 +458,7 @@ The different fields are: .IP \(bu 2 \fBcomment\fP: the application comment .IP \(bu 2 - -.PP -\fBall\fP: all the above -.PP -Default: \fIname,generic,exec,categories,keywords\fP +\fBall\fP: all the aboveDefault: \fIname,generic,exec,categories,keywords\fP .RE @@ -535,11 +531,7 @@ The different fields are: .IP \(bu 2 \fBdesktop\fP: window's current desktop .IP \(bu 2 - -.PP -\fBall\fP: all the above -.PP -Default: \fIall\fP +\fBall\fP: all the aboveDefault: \fIall\fP .RE @@ -672,11 +664,7 @@ behavior.) .IP \(bu 2 \fB\-4\fP: the monitor with the focused window. .IP \(bu 2 - -.PP -\fB\-5\fP: the monitor that shows the mouse pointer. -.PP -Default: \fI\-5\fP +\fB\-5\fP: the monitor that shows the mouse pointer.Default: \fI\-5\fP .RE @@ -991,7 +979,7 @@ Maximum number of entries to store in history. Defaults to 25. (WARNING: can cau .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 @@ -1108,96 +1096,11 @@ Please see \fBrofi\-theme(5)\fP manpage for more information on theming. .SH KEY BINDINGS .PP -\fBrofi\fP has the following key bindings: - -.RS -.IP \(bu 2 -\fB\fCControl\-v, Insert\fR: Paste from clipboard -.IP \(bu 2 -\fB\fCControl\-Shift\-v, Shift\-Insert\fR: Paste primary selection -.IP \(bu 2 -\fB\fCControl\-u\fR: Clear the line -.IP \(bu 2 -\fB\fCControl\-a\fR: Beginning of line -.IP \(bu 2 -\fB\fCControl\-e\fR: End of line -.IP \(bu 2 -\fB\fCControl\-f, Right\fR: Forward one character -.IP \(bu 2 -\fB\fCAlt\-f, Control\-Right\fR: Forward one word -.IP \(bu 2 -\fB\fCControl\-b, Left\fR: Back one character -.IP \(bu 2 -\fB\fCAlt\-b, Control\-Left\fR: Back one word -.IP \(bu 2 -\fB\fCControl\-d, Delete\fR: Delete character -.IP \(bu 2 -\fB\fCControl\-Alt\-d\fR: Delete word -.IP \(bu 2 -\fB\fCControl\-h, Backspace, Shift\-Backspace\fR: Backspace (delete previous character) -.IP \(bu 2 -\fB\fCControl\-Alt\-h\fR: Delete previous word -.IP \(bu 2 -\fB\fCControl\-j,Control\-m,Enter\fR: Accept entry -.IP \(bu 2 -\fB\fCControl\-n,Down\fR: Select next entry -.IP \(bu 2 -\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\fCControl\-Page Up\fR: Go to previous column -.IP \(bu 2 -\fB\fCControl\-Page Down\fR: Go to next column -.IP \(bu 2 -\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\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\-modi\fR argument. -.IP \(bu 2 -\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\fCControl\-Tab\fR: Switch to the next mode. The list can be customized with the \fB\fC\-modi\fR argument. -.IP \(bu 2 -\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\fCControl\-space\fR: Set selected item as input text. -.IP \(bu 2 -\fB\fCShift\-Del\fR: Delete entry from history. -.IP \(bu 2 -\fB\fCgrave\fR: Toggle case sensitivity. -.IP \(bu 2 -\fB\fCAlt\-grave\fR: Toggle sorting. -.IP \(bu 2 -\fB\fCAlt\-Shift\-S\fR: Take a screenshot and store it in the Pictures directory. -.IP \(bu 2 -\fB\fCControl\-l\fR: File complete for run dialog. - -.RE +Please see the \fBrofi\-keys(5)\fP manpage for the keybindings and how to set them up. .PP -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 -A key binding starting with \fB\fC!\fR will act when all keys have been released. - -.PP -You can bind certain events to key\-actions: +The keybinding can also be used for actions, when the action is executed the +mentioned keystroke is inserted: .SS Timeout .PP @@ -1236,9 +1139,6 @@ configuration { .fi .RE -.PP -For a full list of bindings, see the \fBrofi\-keys(5)\fP manpage. - .SH Available Modi .SS window .PP @@ -1464,18 +1364,6 @@ rofi \-show keys .fi .RE -.PP -Use \fB\fCqalc\fR to get a simple calculator in \fBrofi\fP: - -.PP -.RS - -.nf - rofi \-show calc \-modi "calc:qalc +u8 \-nocurrencies" - -.fi -.RE - .SH i3 .PP In i3 @@ -1620,21 +1508,21 @@ first. .SH AUTHOR .RS .IP \(bu 2 -Qball Cow -\[la]qball@blame.services\[ra] +Qball Cow qball@blame.services +\[la]mailto:qball@blame.services\[ra] .IP \(bu 2 -Rasmus Steinke -\[la]rasi@xssn.at\[ra] +Rasmus Steinke rasi@xssn.at +\[la]mailto:rasi@xssn.at\[ra] .IP \(bu 2 -Quentin Glidic -\[la]sardemff7+rofi@sardemff7.net\[ra] +Quentin Glidic sardemff7+rofi@sardemff7.net +\[la]mailto:sardemff7+rofi@sardemff7.net\[ra] .RE .PP Original code based on work by: Sean Pringle -\[la]https://github.com/seanpringle/simpleswitcher\[ra] -\[la]sean.pringle@gmail.com\[ra] +\[la]https://github.com/seanpringle/simpleswitcher\[ra] sean.pringle@gmail.com +\[la]mailto: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 bfb8c673..477f8ed7 100644 --- a/doc/rofi.1.markdown +++ b/doc/rofi.1.markdown @@ -131,6 +131,8 @@ Or get the options from a script: ~/my_script.sh | rofi -dmenu +See the **rofi-dmenu(5)** manpage for more information. + `-show` *mode* Open **rofi** in a certain mode. Available modes are `window`, `run`, `drun`, `ssh`, `combi`. @@ -674,54 +676,10 @@ Please see **rofi-theme(5)** manpage for more information on theming. ## KEY BINDINGS -**rofi** has the following key bindings: +Please see the **rofi-keys(5)** manpage for the keybindings and how to set them up. - * `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 - * `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) - * `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 `-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. - * `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 searchable list of key bindings, run `rofi -show keys`. - -A key binding starting with `!` will act when all keys have been released. - -You can bind certain events to key-actions: +The keybinding can also be used for actions, when the action is executed the +mentioned keystroke is inserted: ### Timeout @@ -750,8 +708,6 @@ configuration { } ``` -For a full list of bindings, see the **rofi-keys(5)** manpage. - ## Available Modi ### window @@ -899,10 +855,6 @@ Show all key bindings: rofi -show keys -Use `qalc` to get a simple calculator in **rofi**: - - rofi -show calc -modi "calc:qalc +u8 -nocurrencies" - ## i3 In [i3](http://i3wm.org/) you want to bind **rofi** to be launched on key release. Otherwise, it cannot grab the keyboard. @@ -960,7 +912,7 @@ If you run custom C plugins, you can disable them using: Disables the loading of plugins. To further debug the plugin, you can get a trace with (lots of) debug information. This debug output can be enabled for -multiple parts in rofi using the glib debug framework. Debug domains can be enabled by setting the G_MESSAGES_DEBUG +multiple parts in rofi using the glib debug framework. Debug domains can be enabled by setting the G\_MESSAGES\_DEBUG environment variable. At the time of creation of this page, the following debug domains exist: * all: Show debug information from all domains.