diff options
author | Dave Davenport <qball@gmpclient.org> | 2021-05-04 20:08:54 +0200 |
---|---|---|
committer | Dave Davenport <qball@gmpclient.org> | 2021-05-04 20:44:38 +0200 |
commit | 37044dc27e19c97510fdc7eb48f33d834439aba3 (patch) | |
tree | 3e4469ef4645c6278c0699977aaf1ef26807e007 /doc/rofi.1.markdown | |
parent | 2516173a3d336fe70d01d93c7bcd1a5315bca535 (diff) |
Remove -dump-xresources option update manpage.
Diffstat (limited to 'doc/rofi.1.markdown')
-rw-r--r-- | doc/rofi.1.markdown | 87 |
1 files changed, 6 insertions, 81 deletions
diff --git a/doc/rofi.1.markdown b/doc/rofi.1.markdown index 7c4c2f78..7feec701 100644 --- a/doc/rofi.1.markdown +++ b/doc/rofi.1.markdown @@ -56,8 +56,6 @@ There are currently three methods of setting configuration options (evaluated in * System configuration file (for example `/etc/rofi.rasi` or old format `/etc/rofi.conf`). It first checks XDG_CONFIG_DIRS and then SYSCONFDIR (that is passed at compile time). It loads the first config file it finds, it does not merge multiple system configuration files. - * Xresources: A method of storing key values in the Xserver. See - [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. * Configuration File: This uses the same format as the Xresources file. By default it looks in `XDG_CONFIG_HOME`/rofi/config, but can be overridden on commandline. @@ -65,26 +63,13 @@ There are currently three methods of setting configuration options (evaluated in This is the recommended way of configuring **rofi**. * Command-line options: Arguments passed to **rofi**. -**TIP**: To get a template config file run: `rofi -dump-xresources > rofi-example.config`. - -**NOTE**: In version 1.4.0 we support configuration in a new format, a config for this can be generated by: -`rofi -dump-config > config.rasi` - -**NOTE**: If you want to use the new configuration format, the config file should be named `config.rasi`. - -**NOTE**: You can upgrade to the new configuration file format using `rofi -upgrade-config` - -The Xresources file expects options starting with `rofi.` followed by its name. An example to set the number of lines: - - rofi.lines: 10 - -Command-line options override settings from the Xresources file. The same option set as argument — prefixed with a '-': - - rofi -lines 10 +**TIP**: To get a template config file run: `rofi -dump-config > config.rasi` To get a list of available options formatted as Xresources entries, run: - rofi -dump-xresources + rofi -dump-config + +This will contain (commented) all current configuration options. The configuration system supports the following types: @@ -92,6 +77,7 @@ The configuration system supports the following types: * integer (signed and unsigned) * char * Boolean + * lists Boolean options have a non-default command-line syntax. Example to enable option X: @@ -123,11 +109,6 @@ Information about the rasi format can be found in the **rofi-theme(5)** manpage. Dump the current active theme, in rasi format, to stdout and exit. -`-dump-xresources` - -Dump the current active configuration, in Xresources format, to stdout. -This does not validate all passed values (for example, colors). - `-rasi-validate` *filename* Try to parse the file and 0 when succesful. @@ -817,63 +798,7 @@ This way it can be used as a drop-in replacement for dmenu. Just copy or symlink ## THEMING -The theme format below describes the old (pre version 1.4) theme format. Please see rofi-theme(5) manpage for an updated -manual. - -The theme setup allows you to specify colors per state, similar to **i3** -Currently 3 states exist: - - * **normal**: normal row - * **urgent**: highlighted row (urgent) - * **active**: highlighted row (active) - -For each state, the following 5 colors must be set: - - * **bg**: background color row - * **fg**: text color - * **bgalt**: background color alternating row - * **hlfg**: foreground color selected row - * **hlbg**: background color selected row - -The window background and border color should be specified separately. The key `color-window` contains -a tuple `background,border,separator`. -An example `Xresources` file: - - ! State: 'bg', 'fg', 'bgalt', 'hlbg', 'hlfg' - rofi.color-normal: #fdf6e3, #002b36, #eee8d5, #586e75, #eee8d5 - rofi.color-urgent: #fdf6e3, #dc322f, #eee8d5, #dc322f, #fdf6e3 - rofi.color-active: #fdf6e3, #268bd2, #eee8d5, #268bd2, #fdf6e3 - - ! 'background', 'border', 'separator' - rofi.color-window: #fdf6e3, #002b36, #002b36 - -Same settings can also be specified on the command-line: - - rofi -color-normal "#fdf6e3,#002b36,#eee8d5,#586e75,#eee8d5" - -## COLORS - -RGB colors can be specified by either their X11 name or hexadecimal notation. -For example: - - white - -Or: - - #FFFFFF - -ARGB colors are also supported. These can be used to create a transparent window if (1) your Xserver supports TrueColor, and (2) you are running a composite manager. -For example: - argb:FF444444 - -Or: - - #FF444444 - -The first two fields specify the alpha level. This determines the amount of transparency (00 everything, FF nothing). The other fields represent the actual color, in hex. - -Transparency can be used within **rofi**, for example if the selected background color is 50% transparent, the background color -of the window will be visible through it. +Please see rofi-theme(5) manpage for more information on themeing. ## KEY BINDINGS |