1
0
Fork 0
mirror of https://github.com/davatorium/rofi.git synced 2025-07-31 21:59:25 -04:00

Fix XDG_USER_CONFIG_DIR to XDG_CONFIG_HOME.

This commit is contained in:
Dave Davenport 2020-05-23 15:27:15 +02:00
parent 3604b12fde
commit 135ff94a79
2 changed files with 27 additions and 88 deletions

View file

@ -1,4 +1,3 @@
.nh
.TH ROFI 1 rofi .TH ROFI 1 rofi
.SH NAME .SH NAME
.PP .PP
@ -47,7 +46,7 @@ The website for \fB\fCdmenu\fR can be found here
.PP .PP
\fBrofi\fP does not aim to be 100% compatible with \fB\fCdmenu\fR\&. There are simply too many different flavors of \fB\fCdmenu\fR\&. \fBrofi\fP does not aim to be 100% compatible with \fB\fCdmenu\fR\&. There are simply too many different flavors of \fB\fCdmenu\fR\&.
The idea is that the basic usage command\-\&line flags are obeyed, theme\-\&related flags are not. The idea is that the basic usage command\-line flags are obeyed, theme\-related flags are not.
Besides, \fBrofi\fP offers some extended features (like multi\-select, highlighting, message bar, extra key bindings). Besides, \fBrofi\fP offers some extended features (like multi\-select, highlighting, message bar, extra key bindings).
.SS Display Error message .SS Display Error message
@ -69,8 +68,6 @@ Markup support can be enabled, see CONFIGURATION options.
.SH CONFIGURATION .SH CONFIGURATION
.PP .PP
There are currently three methods of setting configuration options (evaluated in order below): There are currently three methods of setting configuration options (evaluated in order below):
.RS
.IP \(bu 2 .IP \(bu 2
System configuration file (for example \fB\fC/etc/rofi.rasi\fR or old format \fB\fC/etc/rofi.conf\fR). 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). It first checks XDG\_CONFIG\_DIRS and then SYSCONFDIR (that is passed at compile time).
@ -83,14 +80,12 @@ here
Rasi theme file: The new \fItheme\fP format can be used to set configuration values. Rasi theme file: The new \fItheme\fP format can be used to set configuration values.
.IP \(bu 2 .IP \(bu 2
Configuration File: This uses the same format as the Xresources file. Configuration File: This uses the same format as the Xresources file.
By default it looks in \fB\fCXDG\_USER\_CONFIG\_DIR\fR/rofi/config, but can be overridden on commandline. By default it looks in \fB\fCXDG\_CONFIG\_HOME\fR/rofi/config, but can be overridden on commandline.
By default \fB\fCXDG\_USER\_CONFIG\_DIR\fR defaults to \fB\fC$HOME/.config\fR\&. (See \fB\fCrofi \-h\fR for current location). By default \fB\fCXDG\_CONFIG\_HOME\fR defaults to \fB\fC$HOME/.config\fR\&. (See \fB\fCrofi \-h\fR for current location).
This is the recommended way of configuring \fBrofi\fP\&. This is the recommended way of configuring \fBrofi\fP\&.
.IP \(bu 2 .IP \(bu 2
Command\-line options: Arguments passed to \fBrofi\fP\&. Command\-line options: Arguments passed to \fBrofi\fP\&.
.RE
.PP .PP
\fBTIP\fP: To get a template config file run: \fB\fCrofi \-dump\-xresources > rofi\-example.config\fR\&. \fBTIP\fP: To get a template config file run: \fB\fCrofi \-dump\-xresources > rofi\-example.config\fR\&.
@ -142,8 +137,6 @@ rofi \-dump\-xresources
.PP .PP
The configuration system supports the following types: The configuration system supports the following types:
.RS
.IP \(bu 2 .IP \(bu 2
string string
.IP \(bu 2 .IP \(bu 2
@ -153,8 +146,6 @@ char
.IP \(bu 2 .IP \(bu 2
Boolean Boolean
.RE
.PP .PP
Boolean options have a non\-default command\-line syntax. Example to enable option X: Boolean options have a non\-default command\-line syntax. Example to enable option X:
@ -221,8 +212,6 @@ This does not validate all passed values (for example, colors).
.PP .PP
Specify the number of threads \fBrofi\fP should use: Specify the number of threads \fBrofi\fP should use:
.RS
.IP \(bu 2 .IP \(bu 2
0: Autodetect the number of supported hardware threads. 0: Autodetect the number of supported hardware threads.
.IP \(bu 2 .IP \(bu 2
@ -230,8 +219,6 @@ Specify the number of threads \fBrofi\fP should use:
.IP \(bu 2 .IP \(bu 2
2..N: Specify the maximum number of threads to use in the thread pool. 2..N: Specify the maximum number of threads to use in the thread pool.
.RE
.PP .PP
\fB\fC\-display\fR \fIdisplay\fP \fB\fC\-display\fR \fIdisplay\fP
@ -436,8 +423,6 @@ Make \fBrofi\fP react like a normal application window. Useful for scripts like
.PP .PP
Specify the matching algorithm used. Specify the matching algorithm used.
Current the following methods are supported. Current the following methods are supported.
.RS
.IP \(bu 2 .IP \(bu 2
\fBnormal\fP: match the int string \fBnormal\fP: match the int string
.IP \(bu 2 .IP \(bu 2
@ -447,8 +432,6 @@ Current the following methods are supported.
.IP \(bu 2 .IP \(bu 2
\fBfuzzy\fP: do a fuzzy match \fBfuzzy\fP: do a fuzzy match
.RE
.PP .PP
Default: \fInormal\fP Default: \fInormal\fP
@ -473,8 +456,6 @@ Only show desktop files that are present in the listed categories.
.PP .PP
When using \fB\fCdrun\fR, match only with the specified Desktop entry fields. When using \fB\fCdrun\fR, match only with the specified Desktop entry fields.
The different fields are: The different fields are:
.RS
.IP \(bu 2 .IP \(bu 2
\fBname\fP: the application's name \fBname\fP: the application's name
.IP \(bu 2 .IP \(bu 2
@ -486,17 +467,17 @@ The different fields are:
.IP \(bu 2 .IP \(bu 2
\fBcomment\fP: the application comment \fBcomment\fP: the application comment
.IP \(bu 2 .IP \(bu 2
\fBall\fP: all of the aboveDefault: \fIname,generic,exec,categories,keywords\fP
.RE .PP
\fBall\fP: all of the above
.PP
Default: \fIname,generic,exec,categories,keywords\fP
.PP .PP
\fB\fC\-drun\-display\-format\fR \fB\fC\-drun\-display\-format\fR
.PP .PP
The format string for the \fB\fCdrun\fR dialog: The format string for the \fB\fCdrun\fR dialog:
.RS
.IP \(bu 2 .IP \(bu 2
\fBname\fP: the application's name \fBname\fP: the application's name
.IP \(bu 2 .IP \(bu 2
@ -508,8 +489,6 @@ The format string for the \fB\fCdrun\fR dialog:
.IP \(bu 2 .IP \(bu 2
\fBcomment\fP: the application comment \fBcomment\fP: the application comment
.RE
.PP .PP
Pango markup can be used to formatting the output. Pango markup can be used to formatting the output.
@ -546,8 +525,6 @@ Default: false
.PP .PP
When using window mode, match only with the specified fields. When using window mode, match only with the specified fields.
The different fields are: The different fields are:
.RS
.IP \(bu 2 .IP \(bu 2
\fBtitle\fP: window's title \fBtitle\fP: window's title
.IP \(bu 2 .IP \(bu 2
@ -559,9 +536,11 @@ The different fields are:
.IP \(bu 2 .IP \(bu 2
\fBdesktop\fP: window's current desktop \fBdesktop\fP: window's current desktop
.IP \(bu 2 .IP \(bu 2
\fBall\fP: all of the aboveDefault: \fIall\fP
.RE .PP
\fBall\fP: all of the above
.PP
Default: \fIall\fP
.PP .PP
\fB\fC\-matching\-negate\-char\fR \fIchar\fP \fB\fC\-matching\-negate\-char\fR \fIchar\fP
@ -752,8 +731,6 @@ When one entry is left, automatically select it.
Select monitor to display \fBrofi\fP on. 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 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: detection). Negative numbers are handled differently:
.RS
.IP \(bu 2 .IP \(bu 2
\fB\-1\fP: the currently focused monitor. \fB\-1\fP: the currently focused monitor.
.IP \(bu 2 .IP \(bu 2
@ -764,9 +741,11 @@ behavior.)
.IP \(bu 2 .IP \(bu 2
\fB\-4\fP: the monitor with the focused window. \fB\-4\fP: the monitor with the focused window.
.IP \(bu 2 .IP \(bu 2
\fB\-5\fP: the monitor that shows the mouse pointer.Default: \fI\-5\fP
.RE .PP
\fB\-5\fP: the monitor that shows the mouse pointer.
.PP
Default: \fI\-5\fP
.PP .PP
See \fB\fCrofi \-h\fR output for the detected monitors, their position, and size. See \fB\fCrofi \-h\fR output for the detected monitors, their position, and size.
@ -803,15 +782,11 @@ This option can be specified multiple times.
.PP .PP
Override the default DPI setting. Override the default DPI setting.
.RS
.IP \(bu 2 .IP \(bu 2
If set to \fB\fC0\fR, it tries to auto\-detect based on X11 screen size (similar to i3 and GTK). If set to \fB\fC0\fR, it tries to auto\-detect based on X11 screen size (similar to i3 and GTK).
.IP \(bu 2 .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). 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 .PP
\fB\fC\-selected\-row\fR \fIselected row\fP \fB\fC\-selected\-row\fR \fIselected row\fP
@ -930,8 +905,6 @@ Format what is being displayed for windows.
.PP .PP
\fIfield\fP: \fIfield\fP:
.RS
.IP \(bu 2 .IP \(bu 2
\fBw\fP: desktop name \fBw\fP: desktop name
.IP \(bu 2 .IP \(bu 2
@ -943,8 +916,6 @@ Format what is being displayed for windows.
.IP \(bu 2 .IP \(bu 2
\fBc\fP: class \fBc\fP: class
.RE
.PP .PP
\fIlen\fP: maximum field length (0 for auto\-size). If length and window \fIwidth\fP are negative, field length is \fIwidth \- len\fP\&. \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. if length is positive, the entry will be truncated or padded to fill that length.
@ -1011,15 +982,11 @@ This setting can be changed at runtime (see \fB\fC\-kb\-toggle\-sort\fR).
.PP .PP
There are 2 sorting method: There are 2 sorting method:
.RS
.IP \(bu 2 .IP \(bu 2
levenshtein (Default) levenshtein (Default)
.IP \(bu 2 .IP \(bu 2
fzf sorting. fzf sorting.
.RE
.SS Dmenu specific .SS Dmenu specific
.PP .PP
\fB\fC\-sep\fR \fIseparator\fP \fB\fC\-sep\fR \fIseparator\fP
@ -1083,8 +1050,6 @@ Makes \fB\fCdmenu\fR searches case\-insensitive
.PP .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: 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 .IP \(bu 2
A single row: '5' A single row: '5'
.IP \(bu 2 .IP \(bu 2
@ -1096,8 +1061,6 @@ A set of rows: '2,0,\-9'
.IP \(bu 2 .IP \(bu 2
Or any combination: '5,\-3:,7:11,2,0,\-9' Or any combination: '5,\-3:,7:11,2,0,\-9'
.RE
.PP .PP
\fB\fC\-u\fR \fIX\fP \fB\fC\-u\fR \fIX\fP
@ -1124,8 +1087,6 @@ This mode returns directly when no entries given.
.PP .PP
Allows the output of dmenu to be customized (N is the total number of input entries): Allows the output of dmenu to be customized (N is the total number of input entries):
.RS
.IP \(bu 2 .IP \(bu 2
\&'s' selected string \&'s' selected string
.IP \(bu 2 .IP \(bu 2
@ -1141,8 +1102,6 @@ Allows the output of dmenu to be customized (N is the total number of input entr
.IP \(bu 2 .IP \(bu 2
\&'F' quoted filter string (user input) \&'F' quoted filter string (user input)
.RE
.PP .PP
Default: 's' Default: 's'
@ -1238,7 +1197,7 @@ Set ellipsize mode to start. So end of string is visible.
.PP .PP
Pops up a message dialog (used internally for showing errors) with \fImessage\fP\&. Pops up a message dialog (used internally for showing errors) with \fImessage\fP\&.
Message can be multi\-\&line. Message can be multi\-line.
.SS Other .SS Other
.PP .PP
@ -1332,8 +1291,6 @@ For more information on debugging, see the wiki
.SH PATTERN .SH PATTERN
.PP .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: 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 .IP \(bu 2
\fB\fC{host}\fR: the host to connect to \fB\fC{host}\fR: the host to connect to
.IP \(bu 2 .IP \(bu 2
@ -1345,8 +1302,6 @@ To launch commands (for example, when using the ssh launcher), the user can ente
.IP \(bu 2 .IP \(bu 2
\fB\fC{window}\fR: the window ID of the selected window (in \fB\fCwindow\-command\fR) \fB\fC{window}\fR: the window ID of the selected window (in \fB\fCwindow\-command\fR)
.RE
.SH DMENU REPLACEMENT .SH DMENU REPLACEMENT
.PP .PP
If \fB\fCargv[0]\fR (calling command) is dmenu, \fBrofi\fP will start in dmenu mode. If \fB\fCargv[0]\fR (calling command) is dmenu, \fBrofi\fP will start in dmenu mode.
@ -1369,8 +1324,6 @@ manual.
.PP .PP
The theme setup allows you to specify colors per state, similar to \fBi3\fP The theme setup allows you to specify colors per state, similar to \fBi3\fP
Currently 3 states exist: Currently 3 states exist:
.RS
.IP \(bu 2 .IP \(bu 2
\fBnormal\fP: normal row \fBnormal\fP: normal row
.IP \(bu 2 .IP \(bu 2
@ -1378,12 +1331,8 @@ Currently 3 states exist:
.IP \(bu 2 .IP \(bu 2
\fBactive\fP: highlighted row (active) \fBactive\fP: highlighted row (active)
.RE
.PP .PP
For each state, the following 5 colors must be set: For each state, the following 5 colors must be set:
.RS
.IP \(bu 2 .IP \(bu 2
\fBbg\fP: background color row \fBbg\fP: background color row
.IP \(bu 2 .IP \(bu 2
@ -1395,8 +1344,6 @@ For each state, the following 5 colors must be set:
.IP \(bu 2 .IP \(bu 2
\fBhlbg\fP: background color selected row \fBhlbg\fP: background color selected row
.RE
.PP .PP
The window background and border color should be specified separately. The key \fB\fCcolor\-window\fR contains The window background and border color should be specified separately. The key \fB\fCcolor\-window\fR contains
a tuple \fB\fCbackground,border,separator\fR\&. a tuple \fB\fCbackground,border,separator\fR\&.
@ -1482,8 +1429,6 @@ of the window will be visible through it.
.SH KEY BINDINGS .SH KEY BINDINGS
.PP .PP
\fBrofi\fP has the following key bindings: \fBrofi\fP has the following key bindings:
.RS
.IP \(bu 2 .IP \(bu 2
\fB\fCCtrl\-v, Insert\fR: Paste from clipboard \fB\fCCtrl\-v, Insert\fR: Paste from clipboard
.IP \(bu 2 .IP \(bu 2
@ -1549,8 +1494,6 @@ of the window will be visible through it.
.IP \(bu 2 .IP \(bu 2
\fB\fCAlt\-Shift\-S\fR: Take a screenshot and store it in the Pictures directory. \fB\fCAlt\-Shift\-S\fR: Take a screenshot and store it in the Pictures directory.
.RE
.PP .PP
To get a full list of key bindings on the commandline, see \fB\fCrofi \-h\fR\&. 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. The options starting with \fB\fC\-kb\fR are keybindings.
@ -1820,23 +1763,19 @@ first.
.PP .PP
\fBrofi\-sensible\-terminal(1)\fP, \fBdmenu(1)\fP, \fBrofi\-theme(5)\fP, \fBrofi\-script(5)\fP, \fBrofi\-theme\-selector(1)\fP \fBrofi\-sensible\-terminal(1)\fP, \fBdmenu(1)\fP, \fBrofi\-theme(5)\fP, \fBrofi\-script(5)\fP, \fBrofi\-theme\-selector(1)\fP
.SH AUTHOR .SH AUTHOR.IP \(bu 2
.RS Qball Cow
\[la]qball@gmpclient.org\[ra]
.IP \(bu 2 .IP \(bu 2
Qball Cow qball@gmpclient.org Rasmus Steinke
\[la]mailto:qball@gmpclient.org\[ra] \[la]rasi@xssn.at\[ra]
.IP \(bu 2 .IP \(bu 2
Rasmus Steinke rasi@xssn.at Quentin Glidic
\[la]mailto:rasi@xssn.at\[ra] \[la]sardemff7+rofi@sardemff7.net\[ra]
.IP \(bu 2
Quentin Glidic sardemff7+rofi@sardemff7.net
\[la]mailto:sardemff7+rofi@sardemff7.net\[ra]
.RE
.PP .PP
Original code based on work by: Sean Pringle sean.pringle@gmail.com Original code based on work by: Sean Pringle
\[la]mailto:sean.pringle@gmail.com\[ra] \[la]sean.pringle@gmail.com\[ra]
.PP .PP
For a full list of authors, check the \fB\fCAUTHORS\fR file. For a full list of authors, check the \fB\fCAUTHORS\fR file.

View file

@ -60,8 +60,8 @@ There are currently three methods of setting configuration options (evaluated in
[here](https://en.wikipedia.org/wiki/X_resources) for more information. [here](https://en.wikipedia.org/wiki/X_resources) for more information.
* Rasi theme file: The new *theme* format can be used to set configuration values. * Rasi theme file: The new *theme* format can be used to set configuration values.
* Configuration File: This uses the same format as the Xresources file. * Configuration File: This uses the same format as the Xresources file.
By default it looks in `XDG_USER_CONFIG_DIR`/rofi/config, but can be overridden on commandline. By default it looks in `XDG_CONFIG_HOME`/rofi/config, but can be overridden on commandline.
By default `XDG_USER_CONFIG_DIR` defaults to `$HOME/.config`. (See `rofi -h` for current location). By default `XDG_CONFIG_HOME` defaults to `$HOME/.config`. (See `rofi -h` for current location).
This is the recommended way of configuring **rofi**. This is the recommended way of configuring **rofi**.
* Command-line options: Arguments passed to **rofi**. * Command-line options: Arguments passed to **rofi**.