rofi/doc/rofi.1

.TH ROFI 1 rofi
.SH NAME
rofi \- a simple EWMH window switcher
.SH SYNOPSIS
.B rofi
.RB [ \-width
.IR pct_scr ]
.RB [ \-lines
.IR lines ]
.RB [ \-columns
.IR columns ]
.RB [ \-font
.IR xftfont ]
.RB [ \-fg
.IR color ]
.RB [ \-bg
.IR color ]
.RB [ \-hlfg
.IR color ]
.RB [ \-hlbg
.IR color ]
.RB [ \-key
.IR combo ]
.RB [ \-dkey
.IR comdo ]
.RB [ \-rkey
.IR comdo ]
.RB [ \-now ]
.RB [ \-rnow ]
.RB [ \-snow ]
.RB [ \-terminal
.IR terminal
]
.RB [ \-loc
.IR position ]
.RB [ \-hmode ]
.RB [ \-fixed\-num\-lines ]
.RB [ \-padding
.IR padding
]
.RB [ \-opacity
.IR opacity %
]
.RB [ \-version ]
.RB [ \-help]
.RB [ \-display
.IR display ]
.RB [ \-bc
.IR color ]
.RB [ \-bw
.IR width ]
.RB [ \-dmenu
.RB [ \-p
.IR prompt
]
.RB [ \-dump ]
.RB [ \-ssh\-set\-title
true|false
]

.SH DESCRIPTION
.I rofi
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.
.P
License: MIT/X11
.SH USAGE
See options below for custom key combinations. These are the defaults.
.TP
.B F12
Show all windows on all desktops.
.TP
.B mod1-F2
Show run-dialog.
.SH OPTIONS
.TP
.B -key
Change the key combination to display all windows (default: F12).
.P
.RS
rofi -key F12
.br
rofi -key control+shift+s
.br
rofi -key mod1+Tab
.RE
.TP
.B -rkey
Change the key combination to display the run dialog (default: mod1-F2).
.P
.RS
rofi -rkey F11
.br
rofi -rkey control+shift+d
.br
rofi -rkey mod1+grave (grave=backtick)
.RE
.TP
.B -skey
Change the key combination to display the ssh dialog (default: Alt-F3).
.P
.RS
rofi -skey F10
.br
rofi -skey control+shift+s
.br
rofi -skey mod1+grave (grave=backtick)
.RE
.TP
.B -now
Run rofi in all-windows mode once then exit. Does not bind any keys.
.TP
.B -rnow
Run rofi in run-dialog mode once then exit. Does not bind any keys.
.TP
.B -snow
Run rofi in ssh mode once then exit. Does not bind any keys.
.TP
.B -bg
Set the background text color (X11 named color or hex #rrggbb) for the menu (default: #222222).
.P
.RS
rofi -fg "#222222"
.RE
.TP
.B -bc
Set the border color (X11 named color or hex #rrggbb) for the menu (default: #000000).
.P
.RS
rofi -bc black
.RE
.TP
.B -bw
Set the border width in pixels (default: 1).
.P
.RS
rofi -bw 1
.RE
.TP
.B -fg
Set the foreground text color (X11 named color or hex #rrggbb) for the menu (default: #cccccc).
.P
.RS
rofi -fg "#cccccc"
.RE
.TP
.B -font
Xft font name for use by the menu (default: mono-14).
.P
.RS
rofi -font monospace-14:medium
.RE
.TP
.B -hlbg
Set the background text color (X11 named color or hex #rrggbb) for the highlighted item in the menu (default: #005577).
.P
.RS
rofi -fg "#005577"
.RE
.TP
.B -hlfg
Set the foreground text color (X11 named color or hex #rrggbb) for the highlighted item in the menu (default: #ffffff).
.P
.RS
rofi -fg "#ffffff"
.RE
.TP
.B -opacity
Set the window opacity (0-100).
.P
.RS
rofi -opacity "75"
.RE
.TP
.B -lines
Maximum number of lines the menu may show before scrolling (default: 25).
.P
.RS
rofi -lines 25
.RE
.TP
.B -columns
The number of columns the menu may show before scrolling (default: 25).
.P
.RS
rofi -columns 2
.RE
.TP
.B -width
Set the width of the menu as a percentage of the screen width (default: 60).
.P
.RS
rofi -width 60
.RE
.TP
.B -terminal
Specify what terminal to start (default x-terminal-emulator)
.P
.RS
rofi -terminal xterm
.RE
.TP
.B -loc
Specify where the window should be located. The numbers map to the following location on the
monitor:
.RS
.TP
1 2 3
.TP
8 0 4
.TP
7 6 5
.RE
.TP
.B -hmode
Switch to horizontal mode (ala dmenu). The number of elements is the number of
.IR lines
times the number of
.IR columns
.
.TP
.B -fixed-num-lines
Keep a fixed number of visible lines (See the
.IR -lines
option.)
.TP
.B -padding
Define the inner margin of the window. Default is 5 pixels.
.RS
To make rofi look like dmenu:
.TP
rofi -hmode -padding 0
.RE
.TP
.B -dmenu
Run rofi in dmenu mode. Allowing it to be used for user interaction in scripts.
.RE
.TP
.B -dump
Dump the current active configuration to the command-line.
.RE
.TP
.B -ssh-set-title true|false
SSH dialogs tries to set 'ssh <hostname>' of the spawned terminal.
Not all terminals support this.
Default value is true.
.RS
.SH Switch between modi
Type '?'<enter> to switch between window list, run and ssh mode.
.SH SEE ALSO
.BR rofi (1)
.SH AUTHOR
Qball Cow <qball@gmpclient.org>
.br
Original code based on work by: Sean Pringle <sean.pringle@gmail.com>
Make ssh set title public. 2014-05-22 08:03:36 +00:00			`.TH ROFI 1 rofi`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.SH NAME`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi \- a simple EWMH window switcher`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.SH SYNOPSIS`
Make ssh set title public. 2014-05-22 08:03:36 +00:00			`.B rofi`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.RB [ \-width`
			`.IR pct_scr ]`
			`.RB [ \-lines`
			`.IR lines ]`
Use true/false for hmode and fixed-num-lines * Also update man page to reflect this. 2014-05-21 22:38:14 +00:00			`.RB [ \-columns`
			`.IR columns ]`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.RB [ \-font`
			`.IR xftfont ]`
			`.RB [ \-fg`
			`.IR color ]`
			`.RB [ \-bg`
			`.IR color ]`
			`.RB [ \-hlfg`
			`.IR color ]`
			`.RB [ \-hlbg`
			`.IR color ]`
			`.RB [ \-key`
			`.IR combo ]`
			`.RB [ \-dkey`
			`.IR comdo ]`
Update man page. 2014-04-23 16:31:08 +00:00			`.RB [ \-rkey`
Add support for selecting marks 2014-01-26 14:39:50 +00:00			`.IR comdo ]`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.RB [ \-now ]`
Improve run-dialog options. 2014-01-14 05:36:12 +00:00			`.RB [ \-rnow ]`
Add keybinding. 2014-01-21 09:13:42 +00:00			`.RB [ \-snow ]`
Commandline options and Xresources now match in nameing. 2014-05-22 07:18:16 +00:00			`.RB [ \-terminal`
			`.IR terminal`
			`]`
Add support for horizontal mode. 2014-01-26 11:59:10 +00:00			`.RB [ \-loc`
Allow user to specify location of switcher 2014-01-25 23:27:57 +00:00			`.IR position ]`
Add support for horizontal mode. 2014-01-26 11:59:10 +00:00			`.RB [ \-hmode ]`
Use true/false for hmode and fixed-num-lines * Also update man page to reflect this. 2014-05-21 22:38:14 +00:00			`.RB [ \-fixed\-num\-lines ]`
Add support for horizontal mode. 2014-01-26 11:59:10 +00:00			`.RB [ \-padding`
Commandline options and Xresources now match in nameing. 2014-05-22 07:18:16 +00:00			`.IR padding`
			`]`
			`.RB [ \-opacity`
			`.IR opacity %`
			`]`
Update man page. 2014-04-23 16:31:08 +00:00			`.RB [ \-version ]`
			`.RB [ \-help]`
			`.RB [ \-display`
			`.IR display ]`
Make ssh set title public. 2014-05-22 08:03:36 +00:00			`.RB [ \-bc`
Update man page. 2014-04-23 16:31:08 +00:00			`.IR color ]`
Make ssh set title public. 2014-05-22 08:03:36 +00:00			`.RB [ \-bw`
Update man page. 2014-04-23 16:31:08 +00:00			`.IR width ]`
Make ssh set title public. 2014-05-22 08:03:36 +00:00			`.RB [ \-dmenu`
Update man page. 2014-04-23 16:31:08 +00:00			`.RB [ \-p`
Commandline options and Xresources now match in nameing. 2014-05-22 07:18:16 +00:00			`.IR prompt`
			`]`
Add -dump to man page. 2014-05-21 21:50:29 +00:00			`.RB [ \-dump ]`
Make ssh set title public. 2014-05-22 08:03:36 +00:00			`.RB [ \-ssh\-set\-title`
			`true\|false`
			`]`
docs, pkgbuild 2012-06-29 17:29:23 +00:00
			`.SH DESCRIPTION`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`.I rofi`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`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.`
			`.P`
			`License: MIT/X11`
			`.SH USAGE`
			`See options below for custom key combinations. These are the defaults.`
			`.TP`
			`.B F12`
			`Show all windows on all desktops.`
			`.TP`
Add support for horizontal mode. 2014-01-26 11:59:10 +00:00			`.B mod1-F2`
Improve run-dialog options. 2014-01-14 05:36:12 +00:00			`Show run-dialog.`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.SH OPTIONS`
			`.TP`
			`.B -key`
			`Change the key combination to display all windows (default: F12).`
			`.P`
			`.RS`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -key F12`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.br`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -key control+shift+s`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.br`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -key mod1+Tab`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.RE`
			`.TP`
Improve run-dialog options. 2014-01-14 05:36:12 +00:00			`.B -rkey`
			`Change the key combination to display the run dialog (default: mod1-F2).`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.P`
			`.RS`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -rkey F11`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.br`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -rkey control+shift+d`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.br`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -rkey mod1+grave (grave=backtick)`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.RE`
			`.TP`
Add keybinding. 2014-01-21 09:13:42 +00:00			`.B -skey`
Add support for selecting marks 2014-01-26 14:39:50 +00:00			`Change the key combination to display the ssh dialog (default: Alt-F3).`
Add keybinding. 2014-01-21 09:13:42 +00:00			`.P`
			`.RS`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -skey F10`
Add keybinding. 2014-01-21 09:13:42 +00:00			`.br`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -skey control+shift+s`
Add keybinding. 2014-01-21 09:13:42 +00:00			`.br`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -skey mod1+grave (grave=backtick)`
Add keybinding. 2014-01-21 09:13:42 +00:00			`.RE`
			`.TP`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.B -now`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`Run rofi in all-windows mode once then exit. Does not bind any keys.`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.TP`
Improve run-dialog options. 2014-01-14 05:36:12 +00:00			`.B -rnow`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`Run rofi in run-dialog mode once then exit. Does not bind any keys.`
Improve run-dialog options. 2014-01-14 05:36:12 +00:00			`.TP`
Add keybinding. 2014-01-21 09:13:42 +00:00			`.B -snow`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`Run rofi in ssh mode once then exit. Does not bind any keys.`
Add keybinding. 2014-01-21 09:13:42 +00:00			`.TP`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.B -bg`
			`Set the background text color (X11 named color or hex #rrggbb) for the menu (default: #222222).`
			`.P`
			`.RS`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -fg "#222222"`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.RE`
			`.TP`
port fixes from goomwwm switcher 2012-07-18 12:14:13 +00:00			`.B -bc`
			`Set the border color (X11 named color or hex #rrggbb) for the menu (default: #000000).`
			`.P`
			`.RS`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -bc black`
port fixes from goomwwm switcher 2012-07-18 12:14:13 +00:00			`.RE`
			`.TP`
			`.B -bw`
			`Set the border width in pixels (default: 1).`
			`.P`
			`.RS`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -bw 1`
port fixes from goomwwm switcher 2012-07-18 12:14:13 +00:00			`.RE`
			`.TP`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.B -fg`
			`Set the foreground text color (X11 named color or hex #rrggbb) for the menu (default: #cccccc).`
			`.P`
			`.RS`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -fg "#cccccc"`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.RE`
			`.TP`
			`.B -font`
			`Xft font name for use by the menu (default: mono-14).`
			`.P`
			`.RS`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -font monospace-14:medium`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.RE`
			`.TP`
			`.B -hlbg`
			`Set the background text color (X11 named color or hex #rrggbb) for the highlighted item in the menu (default: #005577).`
			`.P`
			`.RS`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -fg "#005577"`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.RE`
			`.TP`
			`.B -hlfg`
			`Set the foreground text color (X11 named color or hex #rrggbb) for the highlighted item in the menu (default: #ffffff).`
			`.P`
			`.RS`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -fg "#ffffff"`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.RE`
			`.TP`
Commandline options and Xresources now match in nameing. 2014-05-22 07:18:16 +00:00			`.B -opacity`
Add support for horizontal mode. 2014-01-26 11:59:10 +00:00			`Set the window opacity (0-100).`
Quick and dirty hack to set window opacity 2013-01-20 13:20:05 +00:00			`.P`
			`.RS`
Commandline options and Xresources now match in nameing. 2014-05-22 07:18:16 +00:00			`rofi -opacity "75"`
Quick and dirty hack to set window opacity 2013-01-20 13:20:05 +00:00			`.RE`
			`.TP`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.B -lines`
Use true/false for hmode and fixed-num-lines * Also update man page to reflect this. 2014-05-21 22:38:14 +00:00			`Maximum number of lines the menu may show before scrolling (default: 25).`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.P`
			`.RS`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -lines 25`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.RE`
			`.TP`
Use true/false for hmode and fixed-num-lines * Also update man page to reflect this. 2014-05-21 22:38:14 +00:00			`.B -columns`
			`The number of columns the menu may show before scrolling (default: 25).`
			`.P`
			`.RS`
			`rofi -columns 2`
			`.RE`
			`.TP`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.B -width`
			`Set the width of the menu as a percentage of the screen width (default: 60).`
			`.P`
			`.RS`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -width 60`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.RE`
Add option to specify terminal to launch 2014-01-20 20:17:19 +00:00			`.TP`
Commandline options and Xresources now match in nameing. 2014-05-22 07:18:16 +00:00			`.B -terminal`
Add option to specify terminal to launch 2014-01-20 20:17:19 +00:00			`Specify what terminal to start (default x-terminal-emulator)`
			`.P`
			`.RS`
Commandline options and Xresources now match in nameing. 2014-05-22 07:18:16 +00:00			`rofi -terminal xterm`
Add option to specify terminal to launch 2014-01-20 20:17:19 +00:00			`.RE`
Allow user to specify location of switcher 2014-01-25 23:27:57 +00:00			`.TP`
			`.B -loc`
Update documentation 2014-01-26 11:02:00 +00:00			`Specify where the window should be located. The numbers map to the following location on the`
			`monitor:`
			`.RS`
			`.TP`
			`1 2 3`
			`.TP`
			`8 0 4`
			`.TP`
			`7 6 5`
			`.RE`
Add support for horizontal mode. 2014-01-26 11:59:10 +00:00			`.TP`
			`.B -hmode`
Use true/false for hmode and fixed-num-lines * Also update man page to reflect this. 2014-05-21 22:38:14 +00:00			`Switch to horizontal mode (ala dmenu). The number of elements is the number of`
			`.IR lines`
Make ssh set title public. 2014-05-22 08:03:36 +00:00			`times the number of`
Use true/false for hmode and fixed-num-lines * Also update man page to reflect this. 2014-05-21 22:38:14 +00:00			`.IR columns`
			`.`
			`.TP`
			`.B -fixed-num-lines`
Make ssh set title public. 2014-05-22 08:03:36 +00:00			`Keep a fixed number of visible lines (See the`
Add support for horizontal mode. 2014-01-26 11:59:10 +00:00			`.IR -lines`
Use true/false for hmode and fixed-num-lines * Also update man page to reflect this. 2014-05-21 22:38:14 +00:00			`option.)`
Add support for horizontal mode. 2014-01-26 11:59:10 +00:00			`.TP`
			`.B -padding`
			`Define the inner margin of the window. Default is 5 pixels.`
			`.RS`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`To make rofi look like dmenu:`
Add support for horizontal mode. 2014-01-26 11:59:10 +00:00			`.TP`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`rofi -hmode -padding 0`
Add support for horizontal mode. 2014-01-26 11:59:10 +00:00			`.RE`
Update man page. 2014-04-23 16:31:08 +00:00			`.TP`
			`.B -dmenu`
			`Run rofi in dmenu mode. Allowing it to be used for user interaction in scripts.`
Add -dump to man page. 2014-05-21 21:50:29 +00:00			`.RE`
			`.TP`
			`.B -dump`
			`Dump the current active configuration to the command-line.`
Make ssh set title public. 2014-05-22 08:03:36 +00:00			`.RE`
			`.TP`
			`.B -ssh-set-title true\|false`
			`SSH dialogs tries to set 'ssh <hostname>' of the spawned terminal.`
			`Not all terminals support this.`
			`Default value is true.`
Update man page. 2014-04-23 16:31:08 +00:00			`.RS`
Allow switching between modi more easily 2014-01-16 08:21:48 +00:00			`.SH Switch between modi`
Update man page. 2014-04-23 16:31:08 +00:00			`Type '?'<enter> to switch between window list, run and ssh mode.`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.SH SEE ALSO`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`.BR rofi (1)`
docs, pkgbuild 2012-06-29 17:29:23 +00:00			`.SH AUTHOR`
Improve run-dialog options. 2014-01-14 05:36:12 +00:00			`Qball Cow <qball@gmpclient.org>`
Rename simpleswitcher to rofi. 2014-03-01 16:27:52 +00:00			`.br`
			`Original code based on work by: Sean Pringle <sean.pringle@gmail.com>`