rofi/doc/rofi.1

.TH ROFI 1 rofi
.SH NAME
.PP
rofi \- A window switcher, run 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 ] [ \-bg \fIcolor\fP ] [ \-bgalt \fIcolor\fP ] [ \-hlfg \fIcolor\fP ] [ \-hlbg \fIcolor\fP ] [ \-key \fIcombo\fP ] [
\-dkey \fIcomdo\fP ] [ \-rkey \fIcomdo\fP ] [ \-terminal \fIterminal\fP ] [ \-location \fIposition\fP ] [ \-hmode ] [
\-fixed\-num\-lines ] [ \-padding \fIpadding\fP ] [ \-opacity \fIopacity%\fP ] [ \-display \fIdisplay\fP ] [ \-bc
\fIcolor\fP ] [ \-bw \fIwidth\fP ] [ \-dmenu [ \-p \fIprompt\fP ] ] [ \-ssh\-client \fIclient\fP ] [ \-ssh\-command
\fIcommand\fP ] [ \-now ] [ \-rnow ] [ \-snow ] [ \-version ] [ \-help] [ \-dump\-xresources ] [
\-disable\-history ] [ \-levenshtein\-sort ] [ \-case\-sensitive ] [ \-show \fImode\fP ] [ \-switcher \fImode1,
mode2\fP ] [ \-e \fImessage\fP] [ \-sep \fIseparator\fP ] [ \-eh \fIelement height\fP ] [ \-l \fIselected line\fP ] [
\-run\-list\-command \fIcmd\fP ]
.SH DESCRIPTION
.PP
\fBrofi\fP is an X11 popup window switcher. A list is displayed center\-screen showing open window titles, WM_CLASS, and desktop number.
The user may filter the list by typing, navigate with Up/Down or Tab keys, and select a window with Return (Enter). Escape cancels.
.SH License
.PP
MIT/X11
.SH USAGE
.PP
\fBrofi\fP can be used in two ways, single\-shot; executes once and directly exits when done or as
daemon listening to specific key\-combinations.
.PP
The default key combinations are:
.RS
.IP \(bu 2
\fB\fCF12\fR
.RE
.PP
   Show all windows on all desktops.
.RS
.IP \(bu 2
\fB\fCmod1\-F2\fR
.RE
.PP
   Show run\-dialog.
.RS
.IP \(bu 2
\fB\fCmod1\-F3\fR
.RE
.PP
   Show run\-dialog.
.SH OPTIONS
.PP
\fB\fC\-key\fR
.IP
Change the key combination to display all windows (default: F12).
.PP
.RS
.nf
  rofi \-key F12
  rofi \-key control+shift+s
  rofi \-key mod1+Tab
.fi
.RE
.PP
\fB\fC\-rkey\fR
.IP
Change the key combination to display the run dialog (default: mod1\-F2).
.PP
.RS
.nf
  rofi \-rkey F11
  rofi \-rkey control+shift+d
  rofi \-rkey mod1+grave (grave=backtick)
.fi
.RE
.PP
\fB\fC\-skey\fR
.IP
Change the key combination to display the ssh dialog (default: Alt\-F3).
.PP
.RS
.nf
  rofi \-skey F10
  rofi \-skey control+shift+s
  rofi \-skey mod1+grave (grave=backtick)
.fi
.RE
.PP
\fB\fC\-now\fR
.IP
Run rofi in all\-windows mode once then exit. Does not bind any keys.
.PP
\fB\fC\-rnow\fR
.IP
Run rofi in run\-dialog mode once then exit. Does not bind any keys.
.PP
\fB\fC\-snow\fR
.IP
Run rofi in ssh mode once then exit. Does not bind any keys.
.PP
\fB\fC\-dmenu\fR
.IP
Run rofi in dmenu mode. Allowing it to be used for user interaction in scripts.
.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 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
.IP
Give a comma separated list of modes to enable, in what order.
.IP
For example to only show the run and ssh dialog (in that order):
.PP
.RS
.nf
    rofi \-switchers "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 \-switchers "window,run,ssh,Workspaces:i3_switch_workspaces.sh" \-show Workspaces
.fi
.RE
.PP
\fB\fC\-case\-sensitive\fR
.IP
Start in case sensitive mode.
.SS Theming
.PP
\fB\fC\-bg\fR
.IP
Set the background text color (X11 named color or hex #rrggbb) for the menu (default: #222222).
.PP
.RS
.nf
  rofi \-bg "#222222"
.fi
.RE
.PP
\fB\fC\-bg\fR
.IP
Set the background text color  for alternating rows (X11 named color or hex #rrggbb) for the menu
(default: #222222).
.PP
.RS
.nf
  rofi \-bgalt "#222222"
.fi
.RE
.PP
\fB\fC\-bc\fR
.IP
Set the border color (X11 named color or hex #rrggbb) for the menu (default: #000000).
.PP
.RS
.nf
  rofi \-bc black
.fi
.RE
.PP
\fB\fC\-bw\fR
.IP
Set the border width in pixels (default: 1).
.PP
.RS
.nf
  rofi \-bw 1
.fi
.RE
.PP
\fB\fC\-fg\fR
.IP
Set the foreground text color (X11 named color or hex #rrggbb) for the menu (default: #cccccc).
.PP
.RS
.nf
  rofi \-fg "#cccccc"
.fi
.RE
.PP
\fB\fC\-font\fR
.IP
Pango font name for use by the menu (default: mono 14).
.PP
.RS
.nf
  rofi \-font monospace\\ 14
.fi
.RE
.PP
\fB\fC\-hlbg\fR
.IP
Set the background text color (X11 named color or hex #rrggbb) for the highlighted item in the
menu (default: #005577).
.PP
.RS
.nf
  rofi \-fg "#005577"
.fi
.RE
.PP
\fB\fC\-hlfg\fR
.IP
Set the foreground text color (X11 named color or hex #rrggbb) for the highlighted item in the
menu (default: #ffffff).
.PP
.RS
.nf
  rofi \-fg "#ffffff"
.fi
.RE
.PP
\fB\fC\-opacity\fR
.IP
Set the window opacity (0\-100).
.PP
.RS
.nf
  rofi \-opacity "75"
.fi
.RE
.SS Layout
.PP
\fB\fC\-lines\fR
.IP
Maximum number of lines the menu may show before scrolling (default: 25).
.PP
.RS
.nf
  rofi \-lines 25
.fi
.RE
.PP
\fB\fC\-columns\fR
.IP
The number of columns the menu may show before scrolling (default: 25).
.PP
.RS
.nf
  rofi \-columns 2
.fi
.RE
.PP
\fB\fC\-width\fR [value]
.IP
Set the width of the menu as a percentage of the screen width (default: 60).
.PP
.RS
.nf
  rofi \-width 60
.fi
.RE
.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 1980
.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
  rofi \-width \-30
.fi
.RE
.IP
Character width is a rough estimation, and might not be correct, but should work for most monospaced fonts.
.PP
\fB\fC\-location\fR
.IP
Specify where the window should be located. The numbers map to the following location on the
monitor:
.PP
.RS
.nf
  1 2 3
  8 0 4
  7 6 5
.fi
.RE
.PP
\fB\fC\-hmode\fR
.IP
Switch to horizontal mode (ala dmenu). The number of elements is the number of \fB\fClines\fR times the
number of \fB\fCcolumns\fR\&.
.PP
\fB\fC\-fixed\-num\-lines\fR
.IP
Keep a fixed number of visible lines (See the \fB\fC\-lines\fR option.)
.PP
\fB\fC\-padding\fR
.IP
Define the inner margin of the window. Default is 5 pixels.
.IP
To make rofi look like dmenu:
.PP
.RS
.nf
  rofi \-hmode \-padding 0
.fi
.RE
.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:
    rofi \-rnow \-sidebar\-mode \-lines 0
.fi
.RE
.SS Pattern setting
.PP
\fB\fC\-terminal\fR
.IP
Specify what terminal to start (default x\-terminal\-emulator)
.PP
.RS
.nf
  rofi \-terminal xterm
.fi
.RE
.PP
\fB\fC\-ssh\-client\fR \fIclient\fP
.IP
Override the used ssh client. Default is \fB\fCssh\fR\&.
.SS SSH settings
.PP
\fB\fC\-ssh\-set\-title\fR \fItrue|false\fP
.IP
SSH dialogs tries to set 'ssh hostname' of the spawned terminal.
Not all terminals support this.
Default value is true.
.IP
\fIThis command has been deprecated for the ssh\-command string\fP
.PP
\fB\fC\-ssh\-command\fR \fIcmd\fP
.IP
Set the command to execute when starting a ssh session.
.SS Run settings
.PP
\fB\fC\-run\-command\fR \fIcmd\fP
.IP
Set the command to execute when running an application.
See \fIPATTERN\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\&.
.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'
.SS History and Sorting
.PP
\fB\fC\-disable\-history\fR
.IP
Disable history
.PP
\fB\fC\-levenshtein\-sort\fR
.IP
When searching sort the result based on levenshtein distance.
.IP
Note that levenshtein sort is disabled in dmenu mode.
.SS Dmenu specific
.PP
\fB\fC\-sep\fR \fIseparator\fP
.PP
.RS
.nf
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
\fB\fC\-p\fR \fIprompt\fP
.PP
.RS
.nf
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:"
.fi
.RE
.PP
\fB\fC\-eh\fR \fIelement height\fP
.PP
.RS
.nf
The height of a field in lines. e.g.
        echo \-e "a\\n3|b\\n4|c\\n5" | rofi \-sep '|' \-eh 2 \-dmenu
.fi
.RE
.PP
\fB\fC\-l\fR \fIselected line\fP
.PP
.RS
.nf
Select a certain line.
.fi
.RE
.SS Message dialog
.PP
\fB\fC\-e\fR \fImessage\fP
.PP
.RS
.nf
Popup a message dialog (used internally for showing errors) with *message*.
Message can be multi\-line.
.fi
.RE
.SS Debug
.PP
\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 dialog) 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
.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
.SH Signals
.PP
\fB\fCHUP\fR
.PP
.RS
.nf
If in daemon mode, reload the configuration from Xresources. (arguments still override).
.fi
.RE
.SH Keybindings
.PP
Rofi supports the following keybindings:
.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\fCCtrl\-b, Left\fR: Back one character
.IP \(bu 2
\fB\fCCtrl\-d, Delete\fR: Delete character
.IP \(bu 2
\fB\fCCtrl\-h, Backspace\fR: Backspace (delete previous character)
.IP \(bu 2
\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
.IP \(bu 2
\fB\fCCtrl\-Enter\fR: Use entered text as command (in ssh/run dialog)
.IP \(bu 2
\fB\fC?\fR: Switch to the next modi. The list can be customized with the \fB\fC\-switchers\fR argument.
.IP \(bu 2
\fB\fCctrl\-/\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.
.IP \(bu 2
\fB\fCShift\-Del\fR: Delete entry from history.
.IP \(bu 2
\fB\fCgrave\fR: Toggle case sensitivity.
.RE
.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
.PP
\fB\fCRofi is completely black.\fR
.PP
.RS
.nf
Check quotes used on the commandline: e.g. used “ instead of ".
.fi
.RE
.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]
.SH AUTHOR
.PP
Qball Cow 
\[la]qball@gmpclient.org\[ra]
.PP
Original code based on work by: Sean Pringle 
\[la]sean.pringle@gmail.com\[ra]