diff options
Diffstat (limited to 'doc/rofi.1')
| -rw-r--r-- | doc/rofi.1 | 64 |
1 files changed, 64 insertions, 0 deletions
@@ -68,6 +68,8 @@ 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). @@ -86,6 +88,8 @@ 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\&. \fBNOTE\fP: In version 1.4.0 we support configuration in a new format, a config for this can be generated by: \fB\fCrofi @@ -131,6 +135,8 @@ rofi \-dump\-xresources .PP The configuration system supports the following types: + +.RS .IP \(bu 2 string .IP \(bu 2 @@ -140,6 +146,8 @@ char .IP \(bu 2 Boolean +.RE + .PP Boolean options have a non\-default command\-line syntax. Example to enable option X: @@ -187,6 +195,8 @@ This does not validate all passed values (for example, colors). .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 @@ -194,6 +204,8 @@ 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\-dmenu\fR @@ -380,6 +392,8 @@ fallback themes. .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 @@ -389,6 +403,8 @@ Current the following methods are supported. .IP \(bu 2 \fBfuzzy\fP: do a fuzzy match +.RE + .PP Default: \fInormal\fP @@ -413,6 +429,8 @@ Only show desktop files that are present in the listed categories. .PP When using drun, 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 @@ -430,11 +448,15 @@ 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 drun dialog: + +.RS .IP \(bu 2 \fBname\fP: the application's name .IP \(bu 2 @@ -446,6 +468,8 @@ The format string for the drun dialog: .IP \(bu 2 \fBcomment\fP: the application comment +.RE + .PP Pango markup can be used to formatting the output. @@ -482,6 +506,8 @@ 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 @@ -499,6 +525,8 @@ The different fields are: .PP Default: \fIall\fP +.RE + .PP \fB\fC\-matching\-negate\-char\fR \fIchar\fP @@ -688,6 +716,8 @@ 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 @@ -704,6 +734,8 @@ behavior.) .PP Default: \fI\-5\fP +.RE + .PP See \fB\fCrofi \-h\fR output for the detected monitors, their position, and size. @@ -854,6 +886,8 @@ Format what is being displayed for windows. .PP \fIfield\fP: + +.RS .IP \(bu 2 \fBw\fP: desktop name .IP \(bu 2 @@ -865,6 +899,8 @@ 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. @@ -925,11 +961,15 @@ 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 + .SS Dmenu specific .PP \fB\fC\-sep\fR \fIseparator\fP @@ -993,6 +1033,8 @@ Makes dmenu 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 @@ -1004,6 +1046,8 @@ 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 @@ -1029,6 +1073,8 @@ 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 @@ -1044,6 +1090,8 @@ 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' @@ -1232,6 +1280,8 @@ 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 @@ -1243,6 +1293,8 @@ 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. @@ -1265,6 +1317,8 @@ 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 @@ -1272,8 +1326,12 @@ 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 @@ -1285,6 +1343,8 @@ 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\&. @@ -1370,6 +1430,8 @@ 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 @@ -1435,6 +1497,8 @@ 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. |