diff options
author | Dave Davenport <qball@gmpclient.org> | 2021-06-01 10:32:58 +0200 |
---|---|---|
committer | Dave Davenport <qball@gmpclient.org> | 2021-06-01 10:32:58 +0200 |
commit | 3cd7170a8d2f97a8d044690795162ff3e6963b1c (patch) | |
tree | f27683267edbe2ce45ab3ccbb97fa368284dca12 /doc | |
parent | d85712225129853fffd83c472ff962f66dd21afe (diff) |
[Doc] Small tweaks to manpage.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/rofi.1 | 17 | ||||
-rw-r--r-- | doc/rofi.1.markdown | 17 |
2 files changed, 16 insertions, 18 deletions
@@ -38,7 +38,7 @@ rofi \-show run .SS Emulating dmenu .PP -\fBrofi\fP can emulate \fBdmenu(1)\fP (a dynamic menu for X) when launched with the \fB\fC\-dmenu\fR flag. +\fBrofi\fP can emulate \fBdmenu(1)\fP (a dynamic menu for X11) when launched with the \fB\fC\-dmenu\fR flag. .PP The website for \fB\fCdmenu\fR can be found here @@ -69,24 +69,19 @@ Markup support can be enabled, see CONFIGURATION options. .PP There are currently three methods of setting configuration options (evaluated in order below): .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). 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. .IP \(bu 2 Rasi theme file: The new \fItheme\fP format can be used to set configuration values. .IP \(bu 2 -Configuration File: This uses the same format as the Xresources file. -By default it looks in \fB\fCXDG\_CONFIG\_HOME\fR/rofi/config, but can be overridden on commandline. -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\&. -.IP \(bu 2 Command\-line options: Arguments passed to \fBrofi\fP\&. .PP \fBTIP\fP: To get a template config file run: \fB\fCrofi \-dump\-config > config.rasi\fR .PP -To get a list of available options formatted as Xresources entries, run: +To get a list of available options formatted in reasi format, run: .PP .RS @@ -114,7 +109,11 @@ Boolean lists .PP -Boolean options have a non\-default command\-line syntax. Example to enable option X: +For the syntax of these options see the \fBrofi\-theme(5)\fP manpage. + +.PP +For use on the commandline, Boolean options have a non\-default command\-line +syntax. Example to enable option X: .PP .RS diff --git a/doc/rofi.1.markdown b/doc/rofi.1.markdown index 56aabb04..96863421 100644 --- a/doc/rofi.1.markdown +++ b/doc/rofi.1.markdown @@ -33,7 +33,7 @@ To show the `run` dialog: ### Emulating dmenu -**rofi** can emulate **dmenu(1)** (a dynamic menu for X) when launched with the `-dmenu` flag. +**rofi** can emulate **dmenu(1)** (a dynamic menu for X11) when launched with the `-dmenu` flag. The website for `dmenu` can be found [here](http://tools.suckless.org/dmenu/). @@ -53,19 +53,15 @@ Markup support can be enabled, see CONFIGURATION options. There are currently three methods of setting configuration options (evaluated in order below): - * 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). + * System configuration file (for example `/etc/rofi.rasi`). + 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. * 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. - By default `XDG_CONFIG_HOME` defaults to `$HOME/.config`. (See `rofi -h` for current location). - 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-config > config.rasi` -To get a list of available options formatted as Xresources entries, run: +To get a list of available options formatted in reasi format, run: rofi -dump-config @@ -79,7 +75,10 @@ The configuration system supports the following types: * Boolean * lists -Boolean options have a non-default command-line syntax. Example to enable option X: +For the syntax of these options see the **rofi-theme(5)** manpage. + +For use on the commandline, Boolean options have a non-default command-line +syntax. Example to enable option X: -X |