Mirrors/rofi
2
0
Fork 0
mirror of https://github.com/lbonn/rofi synced 2024-11-23 04:13:03 +00:00
Code Issues Projects Releases Packages Wiki Activity

[Doc] Highlight to use -dump-config as starting point in manpage.

Browse source 
issue: #1609
This commit is contained in:
Dave Davenport 2022-03-31 17:24:50 +02:00
parent d9490fddbe
commit a97fa4a199
8 changed files with 776 additions and 679 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

119
doc/rofi-dmenu.5
View file

@ -1,8 +1,7 @@
.nh
.TH ROFI-DMENU 5 rofi-dmenu
.TH ROFI\-DMENU 5 rofi\-dmenu
.SH NAME
.PP
\fBrofi dmenu mode\fP - Rofi dmenu emulation
\fBrofi dmenu mode\fP \- Rofi dmenu emulation
.SH DESCRIPTION
.PP
@ -15,8 +14,8 @@ 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.
Besides, \fBrofi\fP offers some extended features (like multi-select, highlighting, message bar, extra key bindings).
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
.PP
@ -29,27 +28,27 @@ By default separation of rows is done on new lines, making it easy to pipe the o
.SH USAGE
.PP
By launching \fBrofi\fP with the \fB\fC-dmenu\fR flag it will go into dmenu emulation mode.
By launching \fBrofi\fP with the \fB\fC\-dmenu\fR flag it will go into dmenu emulation mode.
.PP
.RS
.nf
ls | rofi -dmenu
ls | rofi \-dmenu
.fi
.RE
.SS DMENU DROP-IN REPLACEMENT
.SS DMENU DROP\-IN REPLACEMENT
.PP
If \fB\fCargv[0]\fR (calling command) is dmenu, \fBrofi\fP will start in dmenu mode.
This way, it can be used as a drop-in replacement for dmenu. Just copy or symlink \fBrofi\fP to dmenu in \fB\fC$PATH\fR\&.
This way, it can be used as a drop\-in replacement for dmenu. Just copy or symlink \fBrofi\fP to dmenu in \fB\fC$PATH\fR\&.
.PP
.RS
.nf
ln -s /usr/bin/rofi /usr/bin/dmenu
ln \-s /usr/bin/rofi /usr/bin/dmenu
.fi
.RE
@ -57,15 +56,15 @@ ln -s /usr/bin/rofi /usr/bin/dmenu
.SS DMENU VS SCRIPT MODE
.PP
Script mode is used to extend \fBrofi\fP, dmenu mode is used to extend a script.
The two do share much of the same input format. Please see the \fBrofi-script(5)\fP manpage for more information.
The two do share much of the same input format. Please see the \fBrofi\-script(5)\fP manpage for more information.
.SS DMENU SPECIFIC COMMANDLINE FLAGS
.PP
A lot of these options can also be modified by the script using special input. See the \fBrofi-script(5)\fP manpage
A lot of these options can also be modified by the script using special input. See the \fBrofi\-script(5)\fP manpage
for more information about this syntax.
.PP
\fB\fC-sep\fR \fIseparator\fP
\fB\fC\-sep\fR \fIseparator\fP
.PP
Separator for \fB\fCdmenu\fR\&. Example: To show a list of 'a' to 'e' with '|' as a separator:
@ -74,13 +73,13 @@ Separator for \fB\fCdmenu\fR\&. Example: To show a list of 'a' to 'e' with '|' a
.RS
.nf
echo "a|b|c|d|e" | rofi -sep '|' -dmenu
echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu
.fi
.RE
.PP
\fB\fC-p\fR \fIprompt\fP
\fB\fC\-p\fR \fIprompt\fP
.PP
Specify the prompt to show in \fB\fCdmenu\fR mode. For example, select 'monkey', a,b,c,d, or e.
@ -89,7 +88,7 @@ Specify the prompt to show in \fB\fCdmenu\fR mode. For example, select 'monkey',
.RS
.nf
echo "a|b|c|d|e" | rofi -sep '|' -dmenu -p "monkey"
echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu \-p "monkey"
.fi
.RE
@ -98,7 +97,7 @@ echo "a|b|c|d|e" | rofi -sep '|' -dmenu -p "monkey"
Default: \fIdmenu\fP
.PP
\fB\fC-l\fR \fInumber of lines to show\fP
\fB\fC\-l\fR \fInumber of lines to show\fP
.PP
Maximum number of lines the menu may show before scrolling.
@ -107,7 +106,7 @@ Maximum number of lines the menu may show before scrolling.
.RS
.nf
rofi -dmenu -l 25
rofi \-dmenu \-l 25
.fi
.RE
@ -116,39 +115,39 @@ rofi -dmenu -l 25
Default: \fI15\fP
.PP
\fB\fC-i\fR
\fB\fC\-i\fR
.PP
Makes \fB\fCdmenu\fR searches case-insensitive
Makes \fB\fCdmenu\fR searches case\-insensitive
.PP
\fB\fC-a\fR \fIX\fP
\fB\fC\-a\fR \fIX\fP
.PP
Active row, mark \fIX\fP as active. Where \fIX\fP is a comma-separated list of python(1)-style indices and ranges, e.g. indices start at 0, -1 refers to the last row with -2 preceding it, ranges are left-open and right-close, and so on. You can specify:
Active row, mark \fIX\fP as active. Where \fIX\fP is a comma\-separated list of python(1)\-style indices and ranges, e.g. indices start at 0, \-1 refers to the last row with \-2 preceding it, ranges are left\-open and right\-close, and so on. You can specify:
.RS
.IP \(bu 2
A single row: '5'
.IP \(bu 2
A range of (last 3) rows: '-3:'
A range of (last 3) rows: '\-3:'
.IP \(bu 2
4 rows starting from row 7: '7:11' (or in legacy notation: '7-10')
4 rows starting from row 7: '7:11' (or in legacy notation: '7\-10')
.IP \(bu 2
A set of rows: '2,0,-9'
A set of rows: '2,0,\-9'
.IP \(bu 2
Or any combination: '5,-3:,7:11,2,0,-9'
Or any combination: '5,\-3:,7:11,2,0,\-9'
.RE
.PP
\fB\fC-u\fR \fIX\fP
\fB\fC\-u\fR \fIX\fP
.PP
Urgent row, mark \fIX\fP as urgent. See \fB\fC-a\fR option for details.
Urgent row, mark \fIX\fP as urgent. See \fB\fC\-a\fR option for details.
.PP
\fB\fC-only-match\fR
\fB\fC\-only\-match\fR
.PP
Only return a selected item, do not allow custom entry.
@ -156,14 +155,14 @@ This mode always returns an entry. It will not return if no matching entry is
selected.
.PP
\fB\fC-no-custom\fR
\fB\fC\-no\-custom\fR
.PP
Only return a selected item, do not allow custom entry.
This mode returns directly when no entries given.
.PP
\fB\fC-format\fR \fIformat\fP
\fB\fC\-format\fR \fIformat\fP
.PP
Allows the output of dmenu to be customized (N is the total number of input entries):
@ -172,9 +171,9 @@ Allows the output of dmenu to be customized (N is the total number of input entr
.IP \(bu 2
\&'s' selected string
.IP \(bu 2
\&'i' index (0 - (N-1))
\&'i' index (0 \-\& (N\-\&1))
.IP \(bu 2
\&'d' index (1 - N)
\&'d' index (1 \-\& N)
.IP \(bu 2
\&'q' quote string
.IP \(bu 2
@ -190,13 +189,13 @@ Allows the output of dmenu to be customized (N is the total number of input entr
Default: 's'
.PP
\fB\fC-select\fR \fIstring\fP
\fB\fC\-select\fR \fIstring\fP
.PP
Select first line that matches the given string
.PP
\fB\fC-mesg\fR \fIstring\fP
\fB\fC\-mesg\fR \fIstring\fP
.PP
Add a message line below the filter entry box. Supports Pango markup.
@ -204,27 +203,27 @@ For more information on supported markup, see here
\[la]https://docs.gtk.org/Pango/pango_markup.html\[ra]
.PP
\fB\fC-dump\fR
\fB\fC\-dump\fR
.PP
Dump the filtered list to stdout and quit.
This can be used to get the list as \fBrofi\fP would filter it.
Use together with \fB\fC-filter\fR command.
Use together with \fB\fC\-filter\fR command.
.PP
\fB\fC-input\fR \fIfile\fP
\fB\fC\-input\fR \fIfile\fP
.PP
Reads from \fIfile\fP instead of stdin.
.PP
\fB\fC-password\fR
\fB\fC\-password\fR
.PP
Hide the input text. This should not be considered secure!
.PP
\fB\fC-markup-rows\fR
\fB\fC\-markup\-rows\fR
.PP
Tell \fBrofi\fP that DMenu input is Pango markup encoded, and should be rendered.
@ -232,23 +231,23 @@ See here
\[la]https://developer.gnome.org/pygtk/stable/pango-markup-language.html\[ra] for details about Pango markup.
.PP
\fB\fC-multi-select\fR
\fB\fC\-multi\-select\fR
.PP
Allow multiple lines to be selected. Adds a small selection indicator to the left of each entry.
.PP
\fB\fC-sync\fR
\fB\fC\-sync\fR
.PP
Force \fBrofi\fP mode to first read all data from stdin before showing the selection window. This is original dmenu behavior.
.PP
Note: the default asynchronous mode will also be automatically disabled if used with conflicting options,
such as \fB\fC-dump\fR, \fB\fC-only-match\fR or \fB\fC-auto-select\fR\&.
such as \fB\fC\-dump\fR, \fB\fC\-only\-match\fR or \fB\fC\-auto\-select\fR\&.
.PP
\fB\fC-async-pre-read\fR \fInumber\fP
\fB\fC\-async\-pre\-read\fR \fInumber\fP
.PP
Reads the first \fInumber\fP entries blocking, then switches to async mode.
@ -258,31 +257,31 @@ This makes it feel more 'snappy'.
\fIdefault\fP: 25
.PP
\fB\fC-window-title\fR \fItitle\fP
\fB\fC\-window\-title\fR \fItitle\fP
.PP
Set name used for the window title. Will be shown as Rofi - \fItitle\fP
Set name used for the window title. Will be shown as Rofi \- \fItitle\fP
.PP
\fB\fC-w\fR \fIwindowid\fP
\fB\fC\-w\fR \fIwindowid\fP
.PP
Position \fBrofi\fP over the window with the given X11 window ID.
.PP
\fB\fC-keep-right\fR
\fB\fC\-keep\-right\fR
.PP
Set ellipsize mode to start. So, the end of the string is visible.
.PP
\fB\fC-display-columns\fR
\fB\fC\-display\-columns\fR
.PP
A comma seperated list of columns to show.
.PP
\fB\fC-display-column-separator\fR
\fB\fC\-display\-column\-separator\fR
.PP
The column separator. This is a regex.
@ -297,30 +296,30 @@ The column separator. This is a regex.
.IP \(bu 2
\fB1\fP: User cancelled the selection.
.IP \(bu 2
\fB10-28\fP: Row accepted by custom keybinding.
\fB10\-28\fP: Row accepted by custom keybinding.
.RE
.SH SEE ALSO
.PP
rofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-script(5), rofi-theme-selector(1)
rofi(1), rofi\-sensible\-terminal(1), dmenu(1), rofi\-theme(5), rofi\-script(5), rofi\-theme\-selector(1)
.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
Morgane Glidic sardemff7+rofi@sardemff7.net
\[la]mailto:sardemff7+rofi@sardemff7.net\[ra]
Morgane 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.

339
doc/rofi-keys.5
View file

@ -1,8 +1,7 @@
.nh
.TH ROFI-KEYS 5 rofi-keys
.TH ROFI\-KEYS 5 rofi\-keys
.SH NAME
.PP
\fBrofi keys\fP - Rofi Key and Mouse bindings
\fBrofi keys\fP \- Rofi Key and Mouse bindings
.SH DESCRIPTION
.PP
@ -10,13 +9,13 @@
.SH Setting binding
.PP
Bindings can be done on the commandline (-{bindingname}):
Bindings can be done on the commandline (\-{bindingname}):
.PP
.RS
.nf
rofi -show run -kb-accept-entry 'Control+Shift+space'
rofi \-show run \-kb\-accept\-entry 'Control+Shift+space'
.fi
.RE
@ -29,7 +28,7 @@ or via the configuration file:
.nf
configuration {
kb-accept-entry: "Control+Shift+space";
kb\-accept\-entry: "Control+Shift+space";
}
.fi
@ -43,7 +42,7 @@ The key can be set by its name (see above) or its keycode:
.nf
configuration {
kb-accept-entry: "Control+Shift+[65]";
kb\-accept\-entry: "Control+Shift+[65]";
}
.fi
@ -60,7 +59,7 @@ Multiple keys can be specified for an action as a comma separated list:
.nf
configuration {
kb-accept-entry: "Control+Shift+space,Return";
kb\-accept\-entry: "Control+Shift+space,Return";
}
.fi
@ -75,566 +74,566 @@ prepend the binding with \fB\fC!\fR:
.nf
configuration {
kb-accept-entry: "!Control+Shift+space,Return";
kb\-accept\-entry: "!Control+Shift+space,Return";
}
.fi
.RE
.SH Keyboard Bindings
.SS \fBkb-primary-paste\fP:
.SS \fBkb\-primary\-paste\fP:
.PP
Paste primary selection
.PP
\fBDefault\fP: Control+V,Shift+Insert
\fBDefault\fP: Control+V,Shift+Insert
.SS \fBkb-secondary-paste\fP
.SS \fBkb\-secondary\-paste\fP
.PP
Paste clipboard
.PP
\fBDefault\fP: Control+v,Insert
\fBDefault\fP: Control+v,Insert
.SS \fBkb-clear-line\fP
.SS \fBkb\-clear\-line\fP
.PP
Clear input line
.PP
\fBDefault\fP: Control+w
\fBDefault\fP: Control+w
.SS \fBkb-move-front\fP
.SS \fBkb\-move\-front\fP
.PP
Beginning of line
.PP
\fBDefault\fP: Control+a
\fBDefault\fP: Control+a
.SS \fBkb-move-end\fP
.SS \fBkb\-move\-end\fP
.PP
End of line
.PP
\fBDefault\fP: Control+e
\fBDefault\fP: Control+e
.SS \fBkb-move-word-back\fP
.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
.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
.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
.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
.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
.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
.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
.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
.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
.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
.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
.SS \fBkb\-accept\-custom\fP
.PP
Use entered text as command (in ssh/run modes)
.PP
\fBDefault\fP: Control+Return
\fBDefault\fP: Control+Return
.SS \fBkb-accept-custom-alt\fP
.SS \fBkb\-accept\-custom\-alt\fP
.PP
Use entered text as command (in ssh/run modes)
.PP
\fBDefault\fP: Control+Shift+Return
\fBDefault\fP: Control+Shift+Return
.SS \fBkb-accept-alt\fP
.SS \fBkb\-accept\-alt\fP
.PP
Use alternate accept command.
.PP
\fBDefault\fP: Shift+Return
\fBDefault\fP: Shift+Return
.SS \fBkb-delete-entry\fP
.SS \fBkb\-delete\-entry\fP
.PP
Delete entry from history
.PP
\fBDefault\fP: Shift+Delete
\fBDefault\fP: Shift+Delete
.SS \fBkb-mode-next\fP
.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
.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
.SS \fBkb\-mode\-complete\fP
.PP
Start completion for mode.
.PP
\fBDefault\fP: Control+l
\fBDefault\fP: Control+l
.SS \fBkb-row-left\fP
.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
.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
.SS \fBkb\-row\-up\fP
.PP
Select previous entry
.PP
\fBDefault\fP: Up,Control+p
\fBDefault\fP: Up,Control+p
.SS \fBkb-row-down\fP
.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
.SS \fBkb\-row\-tab\fP
.PP
Go to next row, if one left, accept it, if no left next mode.
.PP
\fBDefault\fP:
\fBDefault\fP:
.SS \fBkb-element-next\fP
.SS \fBkb\-element\-next\fP
.PP
Go to next row.
.PP
\fBDefault\fP: Tab
\fBDefault\fP: Tab
.SS \fBkb-element-prev\fP
.SS \fBkb\-element\-prev\fP
.PP
Go to previous row.
.PP
\fBDefault\fP: ISO_Left_Tab
\fBDefault\fP: ISO\_Left\_Tab
.SS \fBkb-page-prev\fP
.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
.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
.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
.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
.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
.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
.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
.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
.SS \fBkb\-toggle\-sort\fP
.PP
Toggle sort
.PP
\fBDefault\fP: Alt+grave
\fBDefault\fP: Alt+grave
.SS \fBkb-cancel\fP
.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
.SS \fBkb\-custom\-1\fP
.PP
Custom keybinding 1
.PP
\fBDefault\fP: Alt+1
\fBDefault\fP: Alt+1
.SS \fBkb-custom-2\fP
.SS \fBkb\-custom\-2\fP
.PP
Custom keybinding 2
.PP
\fBDefault\fP: Alt+2
\fBDefault\fP: Alt+2
.SS \fBkb-custom-3\fP
.SS \fBkb\-custom\-3\fP
.PP
Custom keybinding 3
.PP
\fBDefault\fP: Alt+3
\fBDefault\fP: Alt+3
.SS \fBkb-custom-4\fP
.SS \fBkb\-custom\-4\fP
.PP
Custom keybinding 4
.PP
\fBDefault\fP: Alt+4
\fBDefault\fP: Alt+4
.SS \fBkb-custom-5\fP
.SS \fBkb\-custom\-5\fP
.PP
Custom Keybinding 5
.PP
\fBDefault\fP: Alt+5
\fBDefault\fP: Alt+5
.SS \fBkb-custom-6\fP
.SS \fBkb\-custom\-6\fP
.PP
Custom keybinding 6
.PP
\fBDefault\fP: Alt+6
\fBDefault\fP: Alt+6
.SS \fBkb-custom-7\fP
.SS \fBkb\-custom\-7\fP
.PP
Custom Keybinding 7
.PP
\fBDefault\fP: Alt+7
\fBDefault\fP: Alt+7
.SS \fBkb-custom-8\fP
.SS \fBkb\-custom\-8\fP
.PP
Custom keybinding 8
.PP
\fBDefault\fP: Alt+8
\fBDefault\fP: Alt+8
.SS \fBkb-custom-9\fP
.SS \fBkb\-custom\-9\fP
.PP
Custom keybinding 9
.PP
\fBDefault\fP: Alt+9
\fBDefault\fP: Alt+9
.SS \fBkb-custom-10\fP
.SS \fBkb\-custom\-10\fP
.PP
Custom keybinding 10
.PP
\fBDefault\fP: Alt+0
\fBDefault\fP: Alt+0
.SS \fBkb-custom-11\fP
.SS \fBkb\-custom\-11\fP
.PP
Custom keybinding 11
.PP
\fBDefault\fP: Alt+exclam
\fBDefault\fP: Alt+exclam
.SS \fBkb-custom-12\fP
.SS \fBkb\-custom\-12\fP
.PP
Custom keybinding 12
.PP
\fBDefault\fP: Alt+at
\fBDefault\fP: Alt+at
.SS \fBkb-custom-13\fP
.SS \fBkb\-custom\-13\fP
.PP
Custom keybinding 13
.PP
\fBDefault\fP: Alt+numbersign
\fBDefault\fP: Alt+numbersign
.SS \fBkb-custom-14\fP
.SS \fBkb\-custom\-14\fP
.PP
Custom keybinding 14
.PP
\fBDefault\fP: Alt+dollar
\fBDefault\fP: Alt+dollar
.SS \fBkb-custom-15\fP
.SS \fBkb\-custom\-15\fP
.PP
Custom keybinding 15
.PP
\fBDefault\fP: Alt+percent
\fBDefault\fP: Alt+percent
.SS \fBkb-custom-16\fP
.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
.SS \fBkb\-custom\-17\fP
.PP
Custom keybinding 17
.PP
\fBDefault\fP: Alt+ampersand
\fBDefault\fP: Alt+ampersand
.SS \fBkb-custom-18\fP
.SS \fBkb\-custom\-18\fP
.PP
Custom keybinding 18
.PP
\fBDefault\fP: Alt+asterisk
\fBDefault\fP: Alt+asterisk
.SS \fBkb-custom-19\fP
.SS \fBkb\-custom\-19\fP
.PP
Custom Keybinding 19
.PP
\fBDefault\fP: Alt+parenleft
\fBDefault\fP: Alt+parenleft
.SS \fBkb-select-1\fP
.SS \fBkb\-select\-1\fP
.PP
Select row 1
.PP
\fBDefault\fP: Super+1
\fBDefault\fP: Super+1
.SS \fBkb-select-2\fP
.SS \fBkb\-select\-2\fP
.PP
Select row 2
.PP
\fBDefault\fP: Super+2
\fBDefault\fP: Super+2
.SS \fBkb-select-3\fP
.SS \fBkb\-select\-3\fP
.PP
Select row 3
.PP
\fBDefault\fP: Super+3
\fBDefault\fP: Super+3
.SS \fBkb-select-4\fP
.SS \fBkb\-select\-4\fP
.PP
Select row 4
.PP
\fBDefault\fP: Super+4
\fBDefault\fP: Super+4
.SS \fBkb-select-5\fP
.SS \fBkb\-select\-5\fP
.PP
Select row 5
.PP
\fBDefault\fP: Super+5
\fBDefault\fP: Super+5
.SS \fBkb-select-6\fP
.SS \fBkb\-select\-6\fP
.PP
Select row 6
.PP
\fBDefault\fP: Super+6
\fBDefault\fP: Super+6
.SS \fBkb-select-7\fP
.SS \fBkb\-select\-7\fP
.PP
Select row 7
.PP
\fBDefault\fP: Super+7
\fBDefault\fP: Super+7
.SS \fBkb-select-8\fP
.SS \fBkb\-select\-8\fP
.PP
Select row 8
.PP
\fBDefault\fP: Super+8
\fBDefault\fP: Super+8
.SS \fBkb-select-9\fP
.SS \fBkb\-select\-9\fP
.PP
Select row 9
.PP
\fBDefault\fP: Super+9
\fBDefault\fP: Super+9
.SS \fBkb-select-10\fP
.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
.SS \fBml\-row\-left\fP
.PP
Go to the previous column
.PP
\fBDefault\fP: ScrollLeft
\fBDefault\fP: ScrollLeft
.SS \fBml-row-right\fP
.SS \fBml\-row\-right\fP
.PP
Go to the next column
.PP
\fBDefault\fP: ScrollRight
\fBDefault\fP: ScrollRight
.SS \fBml-row-up\fP
.SS \fBml\-row\-up\fP
.PP
Select previous entry
.PP
\fBDefault\fP: ScrollUp
\fBDefault\fP: ScrollUp
.SS \fBml-row-down\fP
.SS \fBml\-row\-down\fP
.PP
Select next entry
.PP
\fBDefault\fP: ScrollDown
\fBDefault\fP: ScrollDown
.SS \fBme-select-entry\fP
.SS \fBme\-select\-entry\fP
.PP
Select hovered row
.PP
\fBDefault\fP: MousePrimary
\fBDefault\fP: MousePrimary
.SS \fBme-accept-entry\fP
.SS \fBme\-accept\-entry\fP
.PP
Accept hovered row
.PP
\fBDefault\fP: MouseDPrimary
\fBDefault\fP: MouseDPrimary
.SS \fBme-accept-custom\fP
.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
rofi(1), rofi-sensible-terminal(1), rofi-theme(5), rofi-script(5)
rofi(1), rofi\-sensible\-terminal(1), rofi\-theme(5), rofi\-script(5)
.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
Morgane Glidic sardemff7+rofi@sardemff7.net
\[la]mailto:sardemff7+rofi@sardemff7.net\[ra]
Morgane 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.

51
doc/rofi-script.5
View file

@ -1,8 +1,7 @@
.nh
.TH ROFI-SCRIPT 5 rofi-script
.TH ROFI\-SCRIPT 5 rofi\-script
.SH NAME
.PP
\fBrofi script mode\fP - Rofi format for scriptable mode.
\fBrofi script mode\fP \- Rofi format for scriptable mode.
.SH DESCRIPTION
.PP
@ -20,7 +19,7 @@ For example:
.RS
.nf
rofi -show fb -modes "fb:file_browser.sh"
rofi \-show fb \-modes "fb:file\_browser.sh"
.fi
.RE
@ -62,7 +61,7 @@ This shows two entries, reload and quit. When the quit entry is selected, rofi c
.PP
Rofi sets the following environment variable when executing the script:
.SS \fB\fCROFI_RETV\fR
.SS \fB\fCROFI\_RETV\fR
.PP
An integer number with the current state:
@ -74,15 +73,15 @@ An integer number with the current state:
.IP \(bu 2
\fB2\fP: Selected a custom entry.
.IP \(bu 2
\fB10-28\fP: Custom keybinding 1-19 ( need to be explicitly enabled by script ).
\fB10\-28\fP: Custom keybinding 1\-19 ( need to be explicitly enabled by script ).
.RE
.SS \fB\fCROFI_INFO\fR
.SS \fB\fCROFI\_INFO\fR
.PP
Environment get set when selected entry get set with the property value of the 'info' row option, if set.
.SS \fB\fCROFI_DATA\fR
.SS \fB\fCROFI\_DATA\fR
.PP
Environment get set when script sets \fB\fCdata\fR option in header.
@ -98,7 +97,7 @@ For example to set the prompt:
.RS
.nf
echo -en "\\0prompt\\x1fChange prompt\\n"
echo \-en "\\0prompt\\x1fChange prompt\\n"
.fi
.RE
@ -112,7 +111,7 @@ The following extra options exists:
.IP \(bu 2
\fBmessage\fP: Update the message text.
.IP \(bu 2
\fBmarkup-rows\fP: If 'true' renders markup in the row.
\fBmarkup\-rows\fP: If 'true' renders markup in the row.
.IP \(bu 2
\fBurgent\fP: Mark rows as urgent. (for syntax see the urgent option in dmenu mode)
.IP \(bu 2
@ -120,11 +119,11 @@ The following extra options exists:
.IP \(bu 2
\fBdelim\fP: Set the delimiter for for next rows. Default is '\\n' and this option should finish with this. Only call this on first call of script, it is remembered for consecutive calls.
.IP \(bu 2
\fBno-custom\fP: If set to 'true'; only accept listed entries, ignore custom input.
\fBno\-custom\fP: If set to 'true'; only accept listed entries, ignore custom input.
.IP \(bu 2
\fBuse-hot-keys\fP: If set to true, it enabled the Custom keybindings for script. Warning this breaks the normal rofi flow.
\fBuse\-hot\-keys\fP: If set to true, it enabled the Custom keybindings for script. Warning this breaks the normal rofi flow.
.IP \(bu 2
\fBdata\fP: Passed data to the next execution of the script via \fBROFI_DATA\fP\&.
\fBdata\fP: Passed data to the next execution of the script via \fBROFI\_DATA\fP\&.
.RE
@ -140,7 +139,7 @@ For example:
.RS
.nf
echo -en "aap\\0icon\\x1ffolder\\n"
echo \-en "aap\\0icon\\x1ffolder\\n"
.fi
.RE
@ -156,7 +155,7 @@ The following options are supported:
.IP \(bu 2
\fBnonselectable\fP: If true the row cannot activated.
.IP \(bu 2
\fBinfo\fP: Info that, on selection, gets placed in the \fB\fCROFI_INFO\fR environment variable. This entry does not get searched.
\fBinfo\fP: Info that, on selection, gets placed in the \fB\fCROFI\_INFO\fR environment variable. This entry does not get searched.
.RE
@ -167,7 +166,7 @@ multiple entries can be passed using the \fB\fC\\x1f\fR separator.
.RS
.nf
echo -en "aap\\0icon\\x1ffolder\\x1finfo\\x1ftest\\n"
echo \-en "aap\\0icon\\x1ffolder\\x1finfo\\x1ftest\\n"
.fi
.RE
@ -184,7 +183,7 @@ In bash the best way to do this is using \fB\fCcoproc\fR\&.
.RS
.nf
coproc ( myApp > /dev/null 2>&1 )
coproc ( myApp > /dev/null 2>\&1 )
.fi
.RE
@ -196,24 +195,24 @@ See issue #1201 on github.
.SH SEE ALSO
.PP
rofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-theme-selector(1)
rofi(1), rofi\-sensible\-terminal(1), dmenu(1), rofi\-theme(5), rofi\-theme\-selector(1)
.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
Morgane Glidic sardemff7+rofi@sardemff7.net
\[la]mailto:sardemff7+rofi@sardemff7.net\[ra]
Morgane 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.

21
doc/rofi-sensible-terminal.1
View file

@ -1,18 +1,17 @@
.nh
.TH rofi-sensible-terminal 1 rofi-sensible-terminal
.TH rofi\-sensible\-terminal 1 rofi\-sensible\-terminal
.SH NAME
.PP
\fBrofi-sensible-terminal\fP - launches $TERMINAL with fallbacks
\fBrofi\-sensible\-terminal\fP \- launches $TERMINAL with fallbacks
.SH SYNOPSIS
.PP
rofi-sensible-terminal [arguments]
rofi\-sensible\-terminal [arguments]
.SH DESCRIPTION
.PP
rofi-sensible-terminal is invoked in the rofi default config to start a terminal. This
wrapper script is necessary since there is no distribution-independent terminal launcher
(but for example Debian has x-terminal-emulator). Distribution packagers are responsible for
rofi\-sensible\-terminal is invoked in the rofi default config to start a terminal. This
wrapper script is necessary since there is no distribution\-independent terminal launcher
(but for example Debian has x\-terminal\-emulator). Distribution packagers are responsible for
shipping this script in a way which is appropriate for the distribution.
.PP
@ -20,9 +19,9 @@ It tries to start one of the following (in that order):
.RS
.IP \(bu 2
\fB\fC$TERMINAL\fR (this is a non-standard variable)
\fB\fC$TERMINAL\fR (this is a non\-standard variable)
.IP \(bu 2
x-terminal-emulator
x\-terminal\-emulator
.IP \(bu 2
urxvt
.IP \(bu 2
@ -44,9 +43,9 @@ xterm
.IP \(bu 2
roxterm
.IP \(bu 2
xfce4-terminal.wrapper
xfce4\-terminal.wrapper
.IP \(bu 2
mate-terminal
mate\-terminal
.IP \(bu 2
lxterminal
.IP \(bu 2

25
doc/rofi-theme-selector.1
View file

@ -1,39 +1,38 @@
.nh
.TH rofi-theme-selector 1 rofi-theme-selector
.TH rofi\-theme\-selector 1 rofi\-theme\-selector
.SH NAME
.PP
\fBrofi-theme-selector\fP - Preview and apply themes for \fBrofi\fP
\fBrofi\-theme\-selector\fP \- Preview and apply themes for \fBrofi\fP
.SH DESCRIPTION
.PP
\fBrofi-theme-selector\fP is a bash/rofi script to preview and apply themes for \fBrofi\fP\&.
\fBrofi\-theme\-selector\fP is a bash/rofi script to preview and apply themes for \fBrofi\fP\&.
It's part of any installation of \fBrofi\fP\&.
.SH USAGE
.SS Running rofi-theme-selector
.SS Running rofi\-theme\-selector
.PP
\fBrofi-theme-selector\fP shows a list of all available themes in a \fBrofi\fP window.
\fBrofi\-theme\-selector\fP shows a list of all available themes in a \fBrofi\fP window.
It lets you preview each theme with the Enter key and apply the theme to your
\fBrofi\fP configuration file with Alt+a.
.SH Theme directories
.PP
\fBrofi-theme-selector\fP searches the following directories for themes:
\fBrofi\-theme\-selector\fP searches the following directories for themes:
.RS
.IP \(bu 2
${PREFIX}/share/rofi/themes
.IP \(bu 2
$XDG_CONFIG_HOME/rofi/themes
$XDG\_CONFIG\_HOME/rofi/themes
.IP \(bu 2
$XDG_DATA_HOME/share/rofi/themes
$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".
$XDG_DATA_HOME is normally unset. Default path is "$HOME/.local/share".
${PREFIX} reflects the install location of rofi. In most cases this will be "/usr".<br>
$XDG\_CONFIG\_HOME is normally unset. Default path is "$HOME/.config".<br>
$XDG\_DATA\_HOME is normally unset. Default path is "$HOME/.local/share".
.SH SEE ALSO
.PP
@ -41,5 +40,5 @@ rofi(1)
.SH AUTHORS
.PP
Qball Cow qball@gmpclient.org
Qball Cow qball@gmpclient.org<br>
Rasmus Steinke rasi@xssn.at

404
doc/rofi-theme.5
View file

File diff suppressed because it is too large Load diff

473
doc/rofi.1
View file

File diff suppressed because it is too large Load diff

23
doc/rofi.1.markdown
View file

@ -60,6 +60,29 @@ To get a template config file, run: `rofi -dump-config > config.rasi`
This will contain (commented) all current configuration options, modified options are uncommented.
To get a template config file that sets the icon-theme run: `rofi -icon-theme hicolor -dump-config`.
It is **strongly** recommended to use this as a starting point for your configuration.
An empty configuration section in the config file looks like:
```css
configuration {
// set config options here
}
```
Most of the configuration options mentioned below (beside options like `-show`,
`-dump-config` that apply to a single run) can be set here.
For example to set the dpi value to 72:
```css
configuration {
dpi: 72;
}
```
The configuration system supports the following types:
* string