diff options
author | Dave Davenport <qball@gmpclient.org> | 2020-12-28 22:54:20 +0100 |
---|---|---|
committer | Dave Davenport <qball@gmpclient.org> | 2020-12-28 22:54:20 +0100 |
commit | 46031bbee10a1676c1fade86261fb56dce32e4ea (patch) | |
tree | 1a58a9ea62b125798c24d03273e8780a7fe0c8af /doc/rofi.1 | |
parent | 9313d7a8a0bc2bd2577afa7839987439062df93a (diff) |
[rofi-theme] Update manpage with textbox::markup option.
Diffstat (limited to 'doc/rofi.1')
-rw-r--r-- | doc/rofi.1 | 74 |
1 files changed, 73 insertions, 1 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\&. @@ -137,6 +141,8 @@ rofi \-dump\-xresources .PP The configuration system supports the following types: + +.RS .IP \(bu 2 string .IP \(bu 2 @@ -146,6 +152,8 @@ char .IP \(bu 2 Boolean +.RE + .PP Boolean options have a non\-default command\-line syntax. Example to enable option X: @@ -212,6 +220,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 @@ -219,6 +229,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\-display\fR \fIdisplay\fP @@ -431,6 +443,8 @@ Make \fBrofi\fP react like a normal application window. Useful for scripts like .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 @@ -440,6 +454,8 @@ Current the following methods are supported. .IP \(bu 2 \fBfuzzy\fP: do a fuzzy match +.RE + .PP Default: \fInormal\fP @@ -464,6 +480,8 @@ 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 @@ -481,11 +499,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 \fB\fCdrun\fR dialog: + +.RS .IP \(bu 2 \fBname\fP: the application's name .IP \(bu 2 @@ -497,6 +519,8 @@ 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. @@ -533,6 +557,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 @@ -550,6 +576,8 @@ The different fields are: .PP Default: \fIall\fP +.RE + .PP \fB\fC\-matching\-negate\-char\fR \fIchar\fP @@ -739,6 +767,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 @@ -755,6 +785,8 @@ behavior.) .PP Default: \fI\-5\fP +.RE + .PP See \fB\fCrofi \-h\fR output for the detected monitors, their position, and size. @@ -790,11 +822,15 @@ 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 @@ -913,6 +949,8 @@ Format what is being displayed for windows. .PP \fIfield\fP: + +.RS .IP \(bu 2 \fBw\fP: desktop name .IP \(bu 2 @@ -924,6 +962,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. @@ -990,11 +1030,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 @@ -1058,6 +1102,8 @@ 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 @@ -1069,6 +1115,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 @@ -1095,6 +1143,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 @@ -1110,6 +1160,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' @@ -1299,6 +1351,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 @@ -1310,6 +1364,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. @@ -1332,6 +1388,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 @@ -1339,8 +1397,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 @@ -1352,6 +1414,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\&. @@ -1437,6 +1501,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 @@ -1502,6 +1568,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. @@ -1777,7 +1845,9 @@ 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.IP \(bu 2 +.SH AUTHOR +.RS +.IP \(bu 2 Qball Cow \[la]qball@gmpclient.org\[ra] .IP \(bu 2 @@ -1787,6 +1857,8 @@ 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] |