path: root/doc/rofi.1

.TH ROFI 1 rofi
.SH NAME
.PP
\fBrofi\fP \- A window switcher, run launcher, ssh dialog and dmenu replacement
.SH SYNOPSIS
.PP
\fBrofi\fP
[ \-width \fIpct_scr\fP ]
[ \-lines \fIlines\fP ]
[ \-columns \fIcolumns\fP ]
[ \-font \fIpangofont\fP ]
[ \-fg \fIcolor\fP ]
[ \-fg\-urgent \fIcolor\fP ]
[ \-fg\-active \fIcolor\fP ]
[ \-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 ] [ \-mesg ] [ \-filter ] [ \-select ] ]
[ \-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]
[ \-a \fIrow\fP ]
[ \-u \fIrow\fP ]
[ \-pid \fIpath\fP ]
[ \-now ]
[ \-rnow ]
[ \-snow ]
[ \-version ]
[ \-help]
[ \-dump\-Xresources ]
[ \-auto\-select ]
[ \-parse\-hosts ]
[ \-combi\-modi \fImode1,mode2\fP ]
[ \-quiet ]
.SH DESCRIPTION
.PP
\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.
.SH USAGE
.PP
\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.
.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
.SS Daemon mode
.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.
.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 here
\[la]http://tools.suckless.org/dmenu/\[ra]\&.
.SH OPTIONS
.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.
This is the recommended way of configuring \fBrofi\fP\&.
.IP \(bu 2
Command\-line options: Arguments passed to \fBrofi\fP\&.
.RE
.PP
The Xresources options and the command\-line options are aliased. So to set option X you would set:
.PP
.RS
.nf
rofi.X: value
.fi
.RE
.PP
In the Xresources file, and to (override) this via the command\-line 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 command\-line syntax, to enable option X  you do:
.PP
.RS
.nf
\-X
.fi
.RE
.PP
to disable it:
.PP
.RS
.nf
\-no\-X
.fi
.RE
.PP
Below is a list of the most important options:
.SS General
.PP
\fB\fC\-key\-{mode}\fR \fBKEY\fP
.IP
Set the key combination to display a {mode} in daemon mode.
.PP
.RS
.nf
  rofi \-key\-run F12
  rofi \-key\-ssh control+shift+s
  rofi \-key\-window mod1+Tab
.fi
.RE
.PP
\fB\fC\-dmenu\fR
.IP
Run \fBrofi\fP in dmenu mode. Allowing it to be used for user interaction in scripts.
.IP
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
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 \fBrofi\fP 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
.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):
.PP
.RS
.nf
    rofi \-modi "run,ssh" \-show run
.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
.fi
.RE
.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.
.SS Theming
.PP
\fB\fC\-bg\fR
.PP
\fB\fC\-bg\-active\fR
.PP
\fB\fC\-bg\-urgent\fR
.IP
Set the background text color (X11 named color or hex #rrggbb) for the menu.
.PP
.RS
.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"
.fi
.RE
.IP
Default: \fI#f2f1f0\fP
.PP
\fB\fC\-bc\fR
.IP
Set the border color (X11 named color or hex #rrggbb) for the menu.
.PP
.RS
.nf
  rofi \-bc black
.fi
.RE
.IP
Default: \fIblack\fP
.PP
\fB\fC\-bw\fR
.IP
Set the border width in pixels.
.PP
.RS
.nf
  rofi \-bw 1
.fi
.RE
.IP
Default: \fI1\fP
.PP
\fB\fC\-fg\fR
.PP
\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
  rofi \-fg "#cccccc"
.fi
.RE
.IP
Default: \fI#222222\fP
.PP
\fB\fC\-hlbg\fR
.PP
\fB\fC\-hlbg\-active\fR
.PP
\fB\fC\-hlbg\-urgent\fR
.IP
Set the background text color (X11 named color or hex #rrggbb) for the highlighted item in the
menu.
.PP
.RS
.nf
  rofi \-hlbg "#005577"
.fi
.RE
.IP
Default: \fI#005577\fP
.PP
\fB\fC\-hlfg\fR
.PP
\fB\fC\-hlfg\-active\fR
.PP
\fB\fC\-hlfg\-urgent\fR
.IP
Set the foreground text color (X11 named color or hex #rrggbb) for the highlighted item in the
menu.
.PP
.RS
.nf
  rofi \-hlfg "#ffffff"
.fi
.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
.PP
\fB\fC\-opacity\fR
.IP
Set the window opacity (0\-100).
.PP
.RS
.nf
  rofi \-opacity "75"
.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
.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