rofi/doc/rofi.1

895 lines
20 KiB
Groff
Raw Normal View History

2014-05-22 08:03:36 +00:00
.TH ROFI 1 rofi
2012-06-29 17:29:23 +00:00
.SH NAME
2014-05-22 08:37:25 +00:00
.PP
2015-04-22 19:03:02 +00:00
rofi \- A window switcher, run launcher, ssh dialog and dmenu replacement
2012-06-29 17:29:23 +00:00
.SH SYNOPSIS
2014-05-22 08:37:25 +00:00
.PP
\fBrofi\fP
[ \-width \fIpct_scr\fP ]
[ \-lines \fIlines\fP ]
[ \-columns \fIcolumns\fP ]
[ \-font \fIpangofont\fP ]
[ \-fg \fIcolor\fP ]
2015-04-04 14:46:30 +00:00
[ \-fg\-urgent \fIcolor\fP ]
[ \-fg\-active \fIcolor\fP ]
2015-04-06 13:23:58 +00:00
[ \-bg\-urgent \fIcolor\fP ]
[ \-bg\-active \fIcolor\fP ]
[ \-bg \fIcolor\fP ]
[ \-bgalt \fIcolor\fP ]
[ \-hlfg \fIcolor\fP ]
[ \-hlbg \fIcolor\fP ]
[ \-key\-\fBmode\fP \fIcombo\fP ]
[ \-terminal \fIterminal\fP ]
[ \-location \fIposition\fP ]
[ \-fixed\-num\-lines ]
[ \-padding \fIpadding\fP ]
[ \-opacity \fIopacity%\fP ]
[ \-display \fIdisplay\fP ]
[ \-bc \fIcolor\fP ]
[ \-bw \fIwidth\fP ]
[ \-dmenu [ \-p \fIprompt\fP ] [ \-sep \fIseparator\fP ] [ \-l \fIselected line\fP ] ]
[ \-ssh\-client \fIclient\fP ]
[ \-ssh\-command \fIcommand\fP ]
[ \-disable\-history ]
[ \-levenshtein\-sort ]
[ \-case\-sensitive ]
[ \-show \fImode\fP ]
[ \-modi \fImode1,mode2\fP ]
[ \-eh \fIelement height\fP ]
[ \-lazy\-filter\-limit \fIlimit\fP ]
[ \-e \fImessage\fP]
2015-04-04 14:46:30 +00:00
[ \-a \fIrow\fP ]
[ \-u \fIrow\fP ]
[ \-pid \fIpath\fP ]
[ \-now ]
[ \-rnow ]
[ \-snow ]
[ \-version ]
[ \-help]
[ \-dump\-xresources ]
2015-02-24 16:34:25 +00:00
[ \-auto\-select ]
2015-03-29 10:27:00 +00:00
[ \-parse\-hosts ]
2015-04-01 12:49:27 +00:00
[ \-combi\-modi \fImode1,mode2\fP ]
[ \-quiet ]
2012-06-29 17:29:23 +00:00
.SH DESCRIPTION
2014-05-22 08:37:25 +00:00
.PP
2015-04-22 19:03:02 +00:00
\fBrofi\fP is an X11 popup window switcher, run dialog, dmenu replacement and more. It focuses on
being fast to use and have minimal distraction. It supports keyboard and mouse navigation, type to
filter, tokenized search and more.
2012-06-29 17:29:23 +00:00
.SH USAGE
2014-05-22 08:37:25 +00:00
.PP
2015-04-05 20:00:27 +00:00
\fBrofi\fP can be used in three ways, single\-shot; executes once and directly exits when done, as a
daemon listening to specific key\-combination or emulating dmenu.
2015-04-05 19:49:55 +00:00
.SS Single\-shot mode
.PP
To launch \fBrofi\fP directly in a certain mode, specifying \fB\fCrofi \-show <mode>\fR\&.
To show the run dialog:
.PP
.RS
.nf
rofi \-show run
.fi
.RE
2015-04-05 20:00:27 +00:00
.SS Daemon mode
2015-04-05 19:49:55 +00:00
.PP
To launch \fBrofi\fP in daemon mode don't specify a mode to show (\fB\fC\-show <mode>\fR), instead you can
bind keys to launch a certain mode. To have run mode open when pressing \fB\fCF2\fR start \fBrofi\fP like:
.PP
.RS
.nf
rofi \-key\-run F2
.fi
.RE
.PP
Keybindings can also be specified in the \fB\fCXresources\fR file.
2015-04-05 20:00:27 +00:00
.SS Emulating dmenu
.PP
\fBrofi\fP can emulate \fB\fCdmenu\fR (a dynamic menu for X) when launched with the \fB\fC\-dmenu\fR flag.
.PP
The official website for \fB\fCdmenu\fR can be found:
\[la]http://tools.suckless.org/dmenu/\[ra]
2012-06-29 17:29:23 +00:00
.SH OPTIONS
2014-05-22 08:37:25 +00:00
.PP
There are currently three methods of setting configuration options:
.RS
.IP \(bu 2
Compile time: edit config.c. This method is strongly discouraged.
.IP \(bu 2
Xresources: A method of storing key values in the Xserver. See
here
\[la]https://en.wikipedia.org/wiki/X_resources\[ra] for more information.
.IP \(bu 2
Commandline options: Arguments passed to \fBrofi\fP\&.
.RE
.PP
The Xresources options and the commandline options are aliased. So to set option X you would set:
.IP
rofi.X: value
.PP
In the Xresources file, and to (override) this via the commandline you would pass the same key
prefixed with a '\-':
.PP
.RS
.nf
rofi \-X value
.fi
.RE
.PP
To get a list of available options, formatted as Xresources entries run:
.PP
.RS
.nf
rofi \-dump\-xresources
.fi
.RE
.PP
The configuration system supports the following types:
.RS
.IP \(bu 2
String
.IP \(bu 2
Integer (signed and unsigned)
.IP \(bu 2
Char
.IP \(bu 2
Boolean
.RE
.PP
The boolean option has a non\-default commandline syntax, to enable option X you do:
.PP
\-X
.PP
to disable it:
.PP
\-no\-X
.PP
Below is a list of the most important options:
.SS General
.PP
\fB\fC\-key\-{mode}\fR \fBKEY\fP
2014-08-01 21:29:01 +00:00
.IP
Set the key combination to display a {mode} in daemon mode.
2014-05-22 08:37:25 +00:00
.PP
.RS
.nf
rofi \-key\-run F12
rofi \-key\-ssh control+shift+s
rofi \-key\-window mod1+Tab
2014-05-22 08:37:25 +00:00
.fi
.RE
.PP
2014-10-20 18:29:26 +00:00
\fB\fC\-dmenu\fR
.IP
Run rofi in dmenu mode. Allowing it to be used for user interaction in scripts.
.IP
2015-04-08 01:50:57 +00:00
In \fB\fCdmenu\fR mode, \fBrofi\fP will read input from STDIN, and will output to STDOUT by default.
.IP
Example to let the user choose between three pre\-defined options:
.PP
.RS
.nf
echo \-e "Option #1\\nOption #2\\nOption #3" | rofi \-dmenu
.fi
.RE
.IP
Or get the options from a script:
.PP
.RS
.nf
~/my_script.sh | rofi \-dmenu
.fi
.RE
.IP
2014-10-20 18:29:26 +00:00
Pressing \fB\fCshift\-enter\fR will open the selected entries and move to the next entry.
.PP
\fB\fC\-show\fR \fImode\fP
.IP
Open rofi in a certain mode.
.IP
For example to show the run\-dialog:
.PP
.RS
.nf
rofi \-show run
.fi
.RE
.IP
This function deprecates \-rnow,\-snow and \-now
.PP
\fB\fC\-switchers\fR \fImode1,mode1\fP
\fB\fC\-modi\fR \fImode1,mode1\fP
2014-10-20 18:29:26 +00:00
.IP
Give a comma separated list of modes to enable, in what order.
.IP
For example to only show the run and ssh launcher (in that order):
2014-10-20 18:29:26 +00:00
.PP
.RS
.nf
rofi \-modi "run,ssh" \-show run
2014-10-20 18:29:26 +00:00
.fi
.RE
.IP
Custom modes can be added using the internal 'script' mode. Each mode has two parameters:
.PP
.RS
.nf
<name>:<script>
.fi
.RE
.IP
So to have a mode 'Workspaces' using the \fB\fCi3_switch_workspace.sh\fR script type:
.PP
.RS
.nf
rofi \-modi "window,run,ssh,Workspaces:i3_switch_workspaces.sh" \-show Workspaces
2014-10-20 18:29:26 +00:00
.fi
.RE
2015-01-12 13:13:46 +00:00
.PP
\fB\fC\-case\-sensitive\fR
.IP
Start in case sensitive mode.
.PP
\fB\fC\-quiet\fR
.IP
Do not print any message when starting in daemon mode.
2014-10-20 18:29:26 +00:00
.SS Theming
.PP
2014-05-22 08:37:25 +00:00
\fB\fC\-bg\fR
2015-04-06 13:23:58 +00:00
.PP
\fB\fC\-bg\-active\fR
.PP
\fB\fC\-bg\-urgent\fR
2014-08-01 21:29:01 +00:00
.IP
Set the background text color (X11 named color or hex #rrggbb) for the menu.
2014-05-22 08:37:25 +00:00
.PP
2012-06-29 17:29:23 +00:00
.RS
2014-05-22 08:37:25 +00:00
.nf
rofi \-bg "#222222"
.fi
.RE
.IP
Default: \fI#f2f1f0\fP
.PP
\fB\fC\-bgalt\fR
.IP
Set the background text color for alternating rows (X11 named color or hex #rrggbb) for the menu.
.PP
.RS
.nf
rofi \-bgalt "#222222"
2014-05-22 08:37:25 +00:00
.fi
2012-06-29 17:29:23 +00:00
.RE
.IP
Default: \fI#f2f1f0\fP
2014-05-22 08:37:25 +00:00
.PP
\fB\fC\-bc\fR
2014-08-01 21:29:01 +00:00
.IP
Set the border color (X11 named color or hex #rrggbb) for the menu.
2014-05-22 08:37:25 +00:00
.PP
2012-07-18 12:14:13 +00:00
.RS
2014-05-22 08:37:25 +00:00
.nf
2014-08-01 21:29:01 +00:00
rofi \-bc black
2014-05-22 08:37:25 +00:00
.fi
2012-07-18 12:14:13 +00:00
.RE
.IP
Default: \fIblack\fP
2014-05-22 08:37:25 +00:00
.PP
\fB\fC\-bw\fR
2014-08-01 21:29:01 +00:00
.IP
Set the border width in pixels.
2014-05-22 08:37:25 +00:00
.PP
2012-07-18 12:14:13 +00:00
.RS
2014-05-22 08:37:25 +00:00
.nf
2014-08-01 21:29:01 +00:00
rofi \-bw 1
2014-05-22 08:37:25 +00:00
.fi
2012-07-18 12:14:13 +00:00
.RE
.IP
Default: \fI1\fP
2014-05-22 08:37:25 +00:00
.PP
\fB\fC\-fg\fR
.PP
2015-04-04 14:46:30 +00:00
\fB\fC\-fg\-urgent\fR
.PP
\fB\fC\-fg\-active\fR
.IP
Set the foreground text color (X11 named color or hex #rrggbb) for the menu.
.PP
.RS
.nf
2015-04-06 13:23:58 +00:00
rofi \-fg "#cccccc"
2015-04-04 14:46:30 +00:00
.fi
.RE
.IP
2015-04-06 13:23:58 +00:00
Default: \fI#222222\fP
2015-04-04 14:46:30 +00:00
.PP
2014-05-22 08:37:25 +00:00
\fB\fC\-hlbg\fR
2015-04-06 13:23:58 +00:00
.PP
\fB\fC\-hlbg\-active\fR
.PP
\fB\fC\-hlbg\-urgent\fR
2014-08-01 21:29:01 +00:00
.IP
Set the background text color (X11 named color or hex #rrggbb) for the highlighted item in the
menu.
2014-05-22 08:37:25 +00:00
.PP
2012-06-29 17:29:23 +00:00
.RS
2014-05-22 08:37:25 +00:00
.nf
rofi \-hlbg "#005577"
2014-05-22 08:37:25 +00:00
.fi
2012-06-29 17:29:23 +00:00
.RE
.IP
Default: \fI#005577\fP
2014-05-22 08:37:25 +00:00
.PP
\fB\fC\-hlfg\fR
2015-04-06 13:23:58 +00:00
.PP
\fB\fC\-hlfg\-active\fR
.PP
\fB\fC\-hlfg\-urgent\fR
2014-08-01 21:29:01 +00:00
.IP
Set the foreground text color (X11 named color or hex #rrggbb) for the highlighted item in the
menu.
2014-05-22 08:37:25 +00:00
.PP
2012-06-29 17:29:23 +00:00
.RS
2014-05-22 08:37:25 +00:00
.nf
rofi \-hlfg "#ffffff"
2014-05-22 08:37:25 +00:00
.fi
2012-06-29 17:29:23 +00:00
.RE
.IP
Default: \fI#FFFFFF\fP
.PP
\fB\fC\-font\fR
.IP
Pango font name for use by the menu.
.PP
.RS
.nf
rofi \-font monospace\\ 14
.fi
.RE
.IP
Default: \fImono 12\fP
2014-05-22 08:37:25 +00:00
.PP
\fB\fC\-opacity\fR
2014-08-01 21:29:01 +00:00
.IP
Set the window opacity (0\-100).
2014-05-22 08:37:25 +00:00
.PP
.RS
2014-05-22 08:37:25 +00:00
.nf
2014-08-01 21:29:01 +00:00
rofi \-opacity "75"
2014-05-22 08:37:25 +00:00
.fi
.RE
.IP
Default: \fI100\fP
.PP
\fB\fC\-eh\fR \fIelement height\fP
.IP
The height of a field in lines. e.g.
.PP
.RS
.nf
echo \-e "a\\n3|b\\n4|c\\n5" | rofi \-sep '|' \-eh 2 \-dmenu
.fi
.RE
.IP
Default: \fI1\fP
2015-04-12 07:31:59 +00:00
.PP
The following options are further explained in the theming section:
.PP
\fB\fC\-color\-enabled\fR
.PP
.RS
.nf
Enable the exteneded coloring options.
.fi
.RE
.PP
\fB\fC\-color\-window\fR \fIbackground\fP \fIborder color\fP
.PP
.RS
.nf
Set window background and border color.
.fi
.RE
.PP
\fB\fC\-color\-normal\fR \fIbackground,foreground,background alt, highlight background, highlight foreground\fP
\fB\fC\-color\-urgent\fR \fIbackground,foreground,background alt, highlight background, highlight foreground\fP
\fB\fC\-color\-active\fR \fIbackground,foreground,background alt, highlight background, highlight foreground\fP
.PP
.RS
.nf
Specify the colors used in a row per state (normal, active, urgent).
.fi
.RE
2014-10-20 18:29:26 +00:00
.SS Layout
2014-05-22 08:37:25 +00:00
.PP
\fB\fC\-lines\fR
2014-08-01 21:29:01 +00:00
.IP
Maximum number of lines the menu may show before scrolling.
2014-05-22 08:37:25 +00:00
.PP
2012-06-29 17:29:23 +00:00
.RS
2014-05-22 08:37:25 +00:00
.nf
2014-08-01 21:29:01 +00:00
rofi \-lines 25
2014-05-22 08:37:25 +00:00
.fi
2012-06-29 17:29:23 +00:00
.RE
.IP
Default: \fI15\fP
2014-05-22 08:37:25 +00:00
.PP
\fB\fC\-columns\fR
2014-08-01 21:29:01 +00:00
.IP
The number of columns the menu may show before scrolling.
2014-05-22 08:37:25 +00:00
.PP
.RS
2014-05-22 08:37:25 +00:00
.nf
2014-08-01 21:29:01 +00:00
rofi \-columns 2
2014-05-22 08:37:25 +00:00
.fi
.RE
.IP
Default: \fI1\fP
2014-05-22 08:37:25 +00:00
.PP
2014-08-14 19:16:42 +00:00
\fB\fC\-width\fR [value]
2014-08-01 21:29:01 +00:00
.IP
Set the width of the menu as a percentage of the screen width.
2014-05-22 08:37:25 +00:00
.PP
2012-06-29 17:29:23 +00:00
.RS
2014-05-22 08:37:25 +00:00
.nf
2014-08-01 21:29:01 +00:00
rofi \-width 60
2014-05-22 08:37:25 +00:00
.fi
2012-06-29 17:29:23 +00:00
.RE
2014-08-14 19:16:42 +00:00
.IP
If value is larger then 100, the size is set in pixels. e.g. to span a full hd monitor:
.PP
.RS
.nf
rofi \-width 1920
2014-08-14 19:16:42 +00:00
.fi
.RE
.IP
If the value is negative, it tries to estimates a character width. To show 30 characters on a row:
.PP
.RS
.nf
2014-10-20 18:29:26 +00:00
rofi \-width \-30
2014-08-14 19:16:42 +00:00
.fi
.RE
2014-08-01 21:29:01 +00:00
.IP
2014-10-20 18:29:26 +00:00
Character width is a rough estimation, and might not be correct, but should work for most monospaced fonts.
.IP
Default: \fI50\fP
2014-05-22 08:37:25 +00:00
.PP
\fB\fC\-location\fR
2014-08-01 21:29:01 +00:00
.IP
Specify where the window should be located. The numbers map to the following location on the
monitor:
2014-05-22 08:37:25 +00:00
.PP
.RS
.nf
2014-08-01 21:29:01 +00:00
1 2 3
8 0 4
7 6 5
2014-05-22 08:37:25 +00:00
.fi
.RE
.IP
Default: \fI0\fP
2014-05-22 08:37:25 +00:00
.PP
\fB\fC\-fixed\-num\-lines\fR
2014-08-01 21:29:01 +00:00
.IP
Keep a fixed number of visible lines (See the \fB\fC\-lines\fR option.)
2014-05-22 08:37:25 +00:00
.PP
\fB\fC\-padding\fR
2014-08-01 21:29:01 +00:00
.IP
Define the inner margin of the window.
2014-08-01 21:29:01 +00:00
.IP
Default: \fI5\fP
2014-11-09 12:10:24 +00:00
.PP
\fB\fC\-sidebar\-mode\fR
.PP
.RS
.nf
Go into side\-bar mode, it will show list of modi at the bottom.
To show sidebar use:
2015-03-30 19:05:13 +00:00
rofi \-show run \-sidebar\-mode \-lines 0
2014-11-09 12:10:24 +00:00
.fi
.RE
.PP
\fB\fC\-lazy\-filter\-limit\fR \fIlimit\fP
.PP
The number of entries required for Rofi to go into lazy filter mode.
In lazy filter mode, it won't refilter the list on each keypress, but only after rofi been idle
for 250ms. Experiments shows that the default (5000 lines) works well, set to 0 to always enable.
.PP
Default: \fI5000\fP
2015-02-24 16:34:25 +00:00
.PP
\fB\fC\-auto\-select\fR
.PP
.RS
.nf
When one entry is left, automatically select this.
.fi
.RE
.SS PATTERN setting
2014-05-22 08:37:25 +00:00
.PP
2014-10-20 18:29:26 +00:00
\fB\fC\-terminal\fR
2014-08-01 21:29:01 +00:00
.IP
Specify what terminal to start.
2014-05-22 08:37:25 +00:00
.PP
2014-10-20 18:29:26 +00:00
.RS
.nf
rofi \-terminal xterm
.fi
.RE
2014-05-22 19:56:57 +00:00
.IP
Pattern: \fI{terminal}\fP
Default: \fIx\-terminal\-emulator\fP
2014-05-22 19:56:57 +00:00
.PP
\fB\fC\-ssh\-client\fR \fIclient\fP
2014-05-22 08:37:25 +00:00
.IP
Override the used ssh client.
.IP
Pattern: \fI{ssh\-client}\fP
Default: \fIssh\fP
.SS SSH settings
.PP
\fB\fC\-ssh\-command\fR \fIcmd\fP
.IP
Set the command to execute when starting a ssh session.
The pattern \fI{host}\fP is replaced by the selected ssh entry.
.IP
Default: \fI{terminal} \-e {ssh\-client} {host}\fP
2015-03-29 10:27:00 +00:00
.PP
\fB\fC\-parse\-hosts\fR
.PP
.RS
.nf
Parse the `/etc/hosts` files for entries.
.fi
.RE
2014-10-20 18:29:26 +00:00
.SS Run settings
.PP
\fB\fC\-run\-command\fR \fIcmd\fP
.IP
Set the command (\fI{cmd}\fP) to execute when running an application.
See \fIPATTERN\fP\&.
.IP
Default: \fI{cmd}\fP
.PP
\fB\fC\-run\-shell\-command\fR \fIcmd\fP
.IP
Set the command to execute when running an application in a shell.
See \fIPATTERN\fP\&.
.IP
Default: \fI{terminal} \-e {cmd}\fP
2015-01-05 20:53:50 +00:00
.PP
\fB\fC\-run\-list\-command\fR \fIcmd\fP
.IP
If set, use an external tool to generate list of executable commands. Uses 'run\-command'
.IP
Default: \fI""\fP
2015-04-01 12:49:27 +00:00
.SS Combi settings
.PP
\fB\fC\-combi\-modi\fR \fImode1,mode2\fP
.PP
.RS
.nf
The modi to combine in the combi mode.
For syntax to see `\-modi`.
To get one merge view, of window,run,ssh:
rofi \-show combi \-combi\-mode "window,run,ssh"
.fi
.RE
2014-10-20 18:29:26 +00:00
.SS History and Sorting
2014-06-05 19:55:47 +00:00
.PP
\fB\fC\-disable\-history\fR
2015-04-19 11:19:20 +00:00
\fB\fC\-no\-disable\-history\fR (re\-enable history)
2014-06-05 19:55:47 +00:00
.IP
Disable history
2014-07-16 18:06:48 +00:00
.PP
2015-04-19 11:19:20 +00:00
\fB\fC\-levenshtein\-sort\fR to enable
\fB\fC\-no\-levenshtein\-sort\fR to disable
2014-07-16 18:06:48 +00:00
.IP
When searching sort the result based on levenshtein distance.
2014-10-20 18:29:26 +00:00
.SS Dmenu specific
.PP
2014-10-20 18:29:26 +00:00
\fB\fC\-sep\fR \fIseparator\fP
.PP
.RS
.nf
2014-10-20 18:29:26 +00:00
Separator for dmenu. For example to show list a to e with '|' as separator:
echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu
.fi
.RE
.PP
2014-10-20 18:29:26 +00:00
\fB\fC\-p\fR \fIprompt\fP
.PP
.RS
.nf
2014-10-20 18:29:26 +00:00
Specify the prompt to show in dmenu mode. E.g. select monkey a,b,c,d or e.
echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu \-p "monkey:"
Default: *dmenu*
2014-11-02 11:58:57 +00:00
.fi
.RE
.PP
\fB\fC\-l\fR \fIselected line\fP
.PP
.RS
.nf
Select a certain line.
Default: *0*
.fi
.RE
.PP
\fB\fC\-i\fR
.PP
.RS
.nf
Number mode, return the index of the selected row. (starting at 0)
.fi
.RE
2015-04-04 14:46:30 +00:00
.PP
\fB\fC\-a\fR \fIX\fP
.PP
.RS
.nf
Active row, mark row X as active. (starting at 0)
You can specify single element: \-a 3
A range: \-a 3\-8
or a set of rows: \-a 0,2
Or any combination: \-a 0,2\-3,9
2015-04-04 14:46:30 +00:00
.fi
.RE
.PP
\fB\fC\-u\fR \fIX\fP
.PP
.RS
.nf
Urgent row, mark row X as urgent. (starting at 0)
You can specify single element: \-u 3
A range: \-u 3\-8
or a set of rows: \-u 0,2
Or any combination: \-u 0,2\-3,9
2015-04-04 14:46:30 +00:00
.fi
.RE
2014-10-20 18:29:26 +00:00
.SS Message dialog
2014-08-27 17:48:54 +00:00
.PP
\fB\fC\-e\fR \fImessage\fP
.PP
.RS
.nf
Popup a message dialog (used internally for showing errors) with *message*.
2014-10-20 18:29:26 +00:00
Message can be multi\-line.
2014-08-27 17:48:54 +00:00
.fi
.RE
.SS Other
.PP
\&'\-pid' \fIpath\fP
.PP
.RS
.nf
Make **rofi** create a pid file and check this on startup. Avoiding multiple copies running
simultaneous. This is useful when running rofi from a keybinding daemon.
.fi
.RE
2014-10-20 18:31:15 +00:00
.SS Debug
2014-10-19 17:42:02 +00:00
.PP
2014-10-20 18:29:26 +00:00
\fB\fC\-dump\-xresources\fR
.IP
Dump the current active configuration in xresources format to the command\-line.
.SH PATTERN
.PP
To launch commands (e.g. when using the ssh launcher) the user can enter the used commandline,
the following keys can be used that will be replaced at runtime:
.RS
.IP \(bu 2
\fB\fC{host}\fR: The host to connect to.
.IP \(bu 2
\fB\fC{terminal}\fR: The configured terminal (See \-terminal\-emulator)
.IP \(bu 2
\fB\fC{ssh\-client}\fR: The configured ssh client (See \-ssh\-client)
.IP \(bu 2
\fB\fC{cmd}\fR: The command to execute.
.RE
2015-04-22 19:03:02 +00:00
.SH DMENU REPLACEMNT
.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\&.
.PP
.RS
.nf
ln \-s /usr/bin/dmenu /usr/bin/rofi
.fi
.RE
2015-04-22 19:03:02 +00:00
.SH SIGNALS
.PP
\fB\fCHUP\fR
.PP
.RS
.nf
If in daemon mode, reload the configuration from Xresources. (commandline arguments still
.fi
.RE
.PP
override xresources).
2015-04-22 19:03:02 +00:00
.SH THEMING
2015-04-06 20:17:05 +00:00
.PP
With \fBrofi\fP 0.15.4 we have a new way of specifying colors, the old settings still apply (for now).
To enable the new setup, set \fB\fCrofi.color\-enabled\fR to true. The new setup allows you to specify
colors per state, similar to \fBi3\fP
2015-04-06 20:17:05 +00:00
Currently 3 states exists:
.RS
.IP \(bu 2
\fBnormal\fP Normal row.
.IP \(bu 2
\fBurgent\fP Highlighted row (urgent)
.br
.IP \(bu 2
\fBactive\fP Highlighted row (active)
.RE
.PP
For each state the following 5 colors must be set:
.RS
.IP \(bu 2
\fBbg\fP Background color row
.IP \(bu 2
\fBfg\fP Text color
.IP \(bu 2
\fBbgalt\fP Background color alternating row
.IP \(bu 2
\fBhlfg\fP Foreground color selected row
.IP \(bu 2
\fBhlbg\fP Background color selected row
.RE
.PP
The window background and border color should be specified separate. The key \fB\fCcolor\-window\fR contains
a pair \fB\fCbackground,border\fR\&.
An example for \fB\fCXresources\fR file:
.PP
.RS
.nf
! State: 'bg', 'fg', 'bgalt', 'hlbg', 'hlfg'
2015-04-06 20:17:05 +00:00
rofi.color\-normal: #fdf6e3, #002b36, #eee8d5, #586e75, #eee8d5
rofi.color\-urgent: #fdf6e3, #dc322f, #eee8d5, #dc322f, #fdf6e3
rofi.color\-active: #fdf6e3, #268bd2, #eee8d5, #268bd2, #fdf6e3
! 'background', 'border'
rofi.color\-window: #fdf6e3, #002b36
.fi
.RE
.PP
Same settings can also be specified on command\-line:
.PP
.RS
.nf
rofi \-color\-normal "#fdf6e3,#002b36,#eee8d5,#586e75,#eee8d5"
.fi
.RE
2015-04-22 19:03:02 +00:00
.SH COLORS
2015-01-22 14:25:40 +00:00
.PP
Rofi has an experimental mode for a 'nicer' transparency. The idea is that you can make the
2015-01-27 09:02:12 +00:00
background of the window transparent but the text not. This way, in contrast to the \fB\fC\-opacity\fR
2015-01-22 14:25:40 +00:00
option, the text is still fully visible and readable.
To use this there are 2 requirements: 1. Your Xserver supports TrueColor, 2. You are running a
composite manager. If this is satisfied you can use the following format for colors:
.PP
argb:FF444444
.PP
The first two fields specify the alpha level. This determines how much the background shines through
the color (00 everything, FF nothing). E.g. 'argb:00FF0000' gives you a bright red color with the
background shining through. If you want a dark greenish transparent color use: 'argb:dd2c3311'. This
2015-01-27 09:02:12 +00:00
can be done for any color; it is therefore possible to have solid borders, the selected row solid,
2015-01-22 14:25:40 +00:00
and the others slightly transparent.
2015-04-22 19:03:02 +00:00
.SH KEYBINDINGS
2014-05-22 08:37:25 +00:00
.PP
\fBrofi\fP has the following key\-bindings:
2014-08-03 19:51:31 +00:00
.RS
.IP \(bu 2
\fB\fCCtrl\-v, Insert\fR: Paste clipboard
.IP \(bu 2
\fB\fCCtrl\-Shift\-v, Shift\-Insert\fR: Paste primary selection
.IP \(bu 2
\fB\fCCtrl\-u\fR: Clear the line
.IP \(bu 2
\fB\fCCtrl\-a\fR: Beginning of line
.IP \(bu 2
\fB\fCCtrl\-e\fR: End of line
.IP \(bu 2
\fB\fCCtrl\-f, Right\fR: Forward one character
.IP \(bu 2
\fB\fCAlt\-f\fR: Forward one word
.IP \(bu 2
2014-08-03 19:51:31 +00:00
\fB\fCCtrl\-b, Left\fR: Back one character
.IP \(bu 2
\fB\fCAlt\-b\fR: Back one word
.IP \(bu 2
2014-08-03 19:51:31 +00:00
\fB\fCCtrl\-d, Delete\fR: Delete character
.IP \(bu 2
`Ctrl\-Alt\-d': Delete word
.IP \(bu 2
2014-08-03 19:51:31 +00:00
\fB\fCCtrl\-h, Backspace\fR: Backspace (delete previous character)
.IP \(bu 2
\fB\fCCtrl\-Alt\-h\fR: Delete previous word
.IP \(bu 2
2014-08-03 19:51:31 +00:00
\fB\fCCtrl\-j,Ctrl\-m,Enter\fR: Accept entry
.IP \(bu 2
\fB\fCCtrl\-n,Down\fR: Select next entry
.IP \(bu 2
\fB\fCCtrl\-p,Up\fR: Select previous entry
.IP \(bu 2
\fB\fCPage Up\fR: Go to the previous page
.IP \(bu 2
\fB\fCPage Down\fR: Go to the next page
.IP \(bu 2
\fB\fCCtrl\-Page Up\fR: Go to the previous column
.IP \(bu 2
\fB\fCCtrl\-Page Down\fR: Go to the next column
2014-08-05 18:09:39 +00:00
.IP \(bu 2
\fB\fCCtrl\-Enter\fR: Use entered text as command (in ssh/run modi)
.IP \(bu 2
\fB\fCShift\-Enter\fR: Launch the application in a terminal (in run mode)
2015-01-23 19:07:56 +00:00
.IP \(bu 2
\fB\fCShift\-Enter\fR: Return the selected entry and move to the next item while keeping Rofi open. (in dmenu)
.IP \(bu 2
\fB\fCShift\-Right\fR: Switch to the next modi. The list can be customized with the \fB\fC\-switchers\fR argument.
.IP \(bu 2
\fB\fCShift\-Left\fR: Switch to the previous modi. The list can be customized with the \fB\fC\-switchers\fR argument.
2014-11-11 20:50:16 +00:00
.IP \(bu 2
\fB\fCCtrl\-Tab\fR: Switch to the next modi. The list can be customized with the \fB\fC\-switchers\fR argument.
.IP \(bu 2
\fB\fCCtrl\-Shift\-Tab\fR: Switch to the previous modi. The list can be customized with the \fB\fC\-switchers\fR argument.
.IP \(bu 2
\fB\fCCtrl\-space\fR: Set selected item as input text.
2014-12-24 15:16:24 +00:00
.IP \(bu 2
\fB\fCShift\-Del\fR: Delete entry from history.
2015-01-12 13:13:46 +00:00
.IP \(bu 2
2015-04-23 20:14:31 +00:00
\fB\fCCtrl\-grave\fR: Toggle case sensitivity.
2014-08-03 19:51:31 +00:00
.RE
2014-11-08 12:51:41 +00:00
.SH FAQ
.PP
\fB\fCText in window switcher is not nicely lined out\fR
.PP
.RS
.nf
Try using a mono\-space font.
.fi
.RE
2014-12-07 15:04:22 +00:00
.PP
\fB\fCRofi is completely black.\fR
.PP
.RS
.nf
Check quotes used on the commandline: e.g. used “ instead of ".
.fi
.RE
2015-04-22 19:03:02 +00:00
.SH LICENSE
.PP
MIT/X11
.PP
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
.PP
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
.PP
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2014-08-05 18:09:39 +00:00
.SH WEBSITE
.PP
\fBrofi\fP website can be found at here
\[la]https://davedavenport.github.io/rofi/\[ra]
.PP
\fBrofi\fP bugtracker can be found here
\[la]https://github.com/DaveDavenport/rofi/issues\[ra]
2012-06-29 17:29:23 +00:00
.SH AUTHOR
2014-05-22 08:37:25 +00:00
.PP
Qball Cow
\[la]qball@gmpclient.org\[ra]
2014-05-22 08:37:25 +00:00
.PP
Original code based on work by: Sean Pringle
\[la]sean.pringle@gmail.com\[ra]