diff options
Diffstat (limited to 'doc/rofi.1')
| -rw-r--r-- | doc/rofi.1 | 78 |
1 files changed, 3 insertions, 75 deletions
@@ -68,8 +68,6 @@ Markup support can be enabled, see CONFIGURATION options. .SH CONFIGURATION .PP There are currently three methods of setting configuration options (evaluated in order below): - -.RS .IP \(bu 2 System configuration file (for example \fB\fC/etc/rofi.rasi\fR or old format \fB\fC/etc/rofi.conf\fR). It first checks XDG\_CONFIG\_DIRS and then SYSCONFDIR (that is passed at compile time). @@ -88,8 +86,6 @@ This is the recommended way of configuring \fBrofi\fP\&. .IP \(bu 2 Command\-line options: Arguments passed to \fBrofi\fP\&. -.RE - .PP \fBTIP\fP: To get a template config file run: \fB\fCrofi \-dump\-xresources > rofi\-example.config\fR\&. @@ -141,8 +137,6 @@ rofi \-dump\-xresources .PP The configuration system supports the following types: - -.RS .IP \(bu 2 string .IP \(bu 2 @@ -152,8 +146,6 @@ char .IP \(bu 2 Boolean -.RE - .PP Boolean options have a non\-default command\-line syntax. Example to enable option X: @@ -226,8 +218,6 @@ Try to parse the file and 0 when succesful. .PP Specify the number of threads \fBrofi\fP should use: - -.RS .IP \(bu 2 0: Autodetect the number of supported hardware threads. .IP \(bu 2 @@ -235,8 +225,6 @@ Specify the number of threads \fBrofi\fP should use: .IP \(bu 2 2..N: Specify the maximum number of threads to use in the thread pool. -.RE - .PP \fB\fC\-display\fR \fIdisplay\fP @@ -443,10 +431,10 @@ Use Pango markup to format output wherever possible. Make \fBrofi\fP react like a normal application window. Useful for scripts like Clerk that are basically an application. .PP -\fB\fC\-[no\-]restore\-focus\fR +\fB\fC\-[no\-]steal\-focus\fR .PP -Make rofi restore focus to window that held it when launched. +Make rofi steal focus on launch and restore close to window that held it when launched. .SS Matching .PP @@ -455,8 +443,6 @@ Make rofi restore focus to window that held it when launched. .PP Specify the matching algorithm used. Current the following methods are supported. - -.RS .IP \(bu 2 \fBnormal\fP: match the int string .IP \(bu 2 @@ -466,8 +452,6 @@ Current the following methods are supported. .IP \(bu 2 \fBfuzzy\fP: do a fuzzy match -.RE - .PP Default: \fInormal\fP @@ -492,8 +476,6 @@ Only show desktop files that are present in the listed categories. .PP When using \fB\fCdrun\fR, match only with the specified Desktop entry fields. The different fields are: - -.RS .IP \(bu 2 \fBname\fP: the application's name .IP \(bu 2 @@ -511,15 +493,11 @@ The different fields are: .PP Default: \fIname,generic,exec,categories,keywords\fP -.RE - .PP \fB\fC\-drun\-display\-format\fR .PP The format string for the \fB\fCdrun\fR dialog: - -.RS .IP \(bu 2 \fBname\fP: the application's name .IP \(bu 2 @@ -531,8 +509,6 @@ The format string for the \fB\fCdrun\fR dialog: .IP \(bu 2 \fBcomment\fP: the application comment -.RE - .PP Pango markup can be used to formatting the output. @@ -569,8 +545,6 @@ Default: false .PP When using window mode, match only with the specified fields. The different fields are: - -.RS .IP \(bu 2 \fBtitle\fP: window's title .IP \(bu 2 @@ -588,8 +562,6 @@ The different fields are: .PP Default: \fIall\fP -.RE - .PP \fB\fC\-matching\-negate\-char\fR \fIchar\fP @@ -779,8 +751,6 @@ When one entry is left, automatically select it. Select monitor to display \fBrofi\fP on. It accepts as input: \fIprimary\fP (if primary output is set), the \fIxrandr\fP output name, or integer number (in order of detection). Negative numbers are handled differently: - -.RS .IP \(bu 2 \fB\-1\fP: the currently focused monitor. .IP \(bu 2 @@ -797,8 +767,6 @@ behavior.) .PP Default: \fI\-5\fP -.RE - .PP See \fB\fCrofi \-h\fR output for the detected monitors, their position, and size. @@ -834,15 +802,11 @@ This option can be specified multiple times. .PP Override the default DPI setting. - -.RS .IP \(bu 2 If set to \fB\fC0\fR, it tries to auto\-detect based on X11 screen size (similar to i3 and GTK). .IP \(bu 2 If set to \fB\fC1\fR, it tries to auto\-detect based on the size of the monitor that \fBrofi\fP is displayed on (similar to latest Qt 5). -.RE - .PP \fB\fC\-selected\-row\fR \fIselected row\fP @@ -961,8 +925,6 @@ Format what is being displayed for windows. .PP \fIfield\fP: - -.RS .IP \(bu 2 \fBw\fP: desktop name .IP \(bu 2 @@ -974,8 +936,6 @@ Format what is being displayed for windows. .IP \(bu 2 \fBc\fP: class -.RE - .PP \fIlen\fP: maximum field length (0 for auto\-size). If length and window \fIwidth\fP are negative, field length is \fIwidth \- len\fP\&. if length is positive, the entry will be truncated or padded to fill that length. @@ -1042,15 +1002,11 @@ This setting can be changed at runtime (see \fB\fC\-kb\-toggle\-sort\fR). .PP There are 2 sorting method: - -.RS .IP \(bu 2 levenshtein (Default) .IP \(bu 2 fzf sorting. -.RE - .PP \fB\fC\-max\-history\-size\fR \fInumber\fP @@ -1120,8 +1076,6 @@ Makes \fB\fCdmenu\fR searches case\-insensitive .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: - -.RS .IP \(bu 2 A single row: '5' .IP \(bu 2 @@ -1133,8 +1087,6 @@ A set of rows: '2,0,\-9' .IP \(bu 2 Or any combination: '5,\-3:,7:11,2,0,\-9' -.RE - .PP \fB\fC\-u\fR \fIX\fP @@ -1161,8 +1113,6 @@ This mode returns directly when no entries given. .PP Allows the output of dmenu to be customized (N is the total number of input entries): - -.RS .IP \(bu 2 \&'s' selected string .IP \(bu 2 @@ -1178,8 +1128,6 @@ Allows the output of dmenu to be customized (N is the total number of input entr .IP \(bu 2 \&'F' quoted filter string (user input) -.RE - .PP Default: 's' @@ -1369,8 +1317,6 @@ For more information on debugging, see the wiki .SH PATTERN .PP To launch commands (for example, when using the ssh launcher), the user can enter the used command\-line. 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 @@ -1382,8 +1328,6 @@ To launch commands (for example, when using the ssh launcher), the user can ente .IP \(bu 2 \fB\fC{window}\fR: the window ID of the selected window (in \fB\fCwindow\-command\fR) -.RE - .SH DMENU REPLACEMENT .PP If \fB\fCargv[0]\fR (calling command) is dmenu, \fBrofi\fP will start in dmenu mode. @@ -1406,8 +1350,6 @@ manual. .PP The theme setup allows you to specify colors per state, similar to \fBi3\fP Currently 3 states exist: - -.RS .IP \(bu 2 \fBnormal\fP: normal row .IP \(bu 2 @@ -1415,12 +1357,8 @@ Currently 3 states exist: .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 @@ -1432,8 +1370,6 @@ For each state, the following 5 colors must be set: .IP \(bu 2 \fBhlbg\fP: background color selected row -.RE - .PP The window background and border color should be specified separately. The key \fB\fCcolor\-window\fR contains a tuple \fB\fCbackground,border,separator\fR\&. @@ -1519,8 +1455,6 @@ of the window will be visible through it. .SH KEY BINDINGS .PP \fBrofi\fP has the following key bindings: - -.RS .IP \(bu 2 \fB\fCCtrl\-v, Insert\fR: Paste from clipboard .IP \(bu 2 @@ -1586,8 +1520,6 @@ of the window will be visible through it. .IP \(bu 2 \fB\fCAlt\-Shift\-S\fR: Take a screenshot and store it in the Pictures directory. -.RE - .PP To get a full list of key bindings on the commandline, see \fB\fCrofi \-h\fR\&. The options starting with \fB\fC\-kb\fR are keybindings. @@ -1863,9 +1795,7 @@ first. .PP \fBrofi\-sensible\-terminal(1)\fP, \fBdmenu(1)\fP, \fBrofi\-theme(5)\fP, \fBrofi\-script(5)\fP, \fBrofi\-theme\-selector(1)\fP -.SH AUTHOR -.RS -.IP \(bu 2 +.SH AUTHOR.IP \(bu 2 Qball Cow \[la]qball@gmpclient.org\[ra] .IP \(bu 2 @@ -1875,8 +1805,6 @@ Rasmus Steinke Quentin Glidic \[la]sardemff7+rofi@sardemff7.net\[ra] -.RE - .PP Original code based on work by: Sean Pringle \[la]sean.pringle@gmail.com\[ra] |