summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDave Davenport <qball@gmpclient.org>2017-07-18 09:18:18 +0200
committerDave Davenport <qball@gmpclient.org>2017-07-18 09:18:18 +0200
commit138ffc168d68f43c74db0e658cb30261a07d9a8b (patch)
tree7234b3aaa0020f092725575bc476690fdfbb1ab7 /doc
parentfd146b05199b3de269f08030d1d2f5047fec00cb (diff)
Small manpage updates
Diffstat (limited to 'doc')
-rw-r--r--doc/rofi.19
-rw-r--r--doc/rofi.1.markdown10
2 files changed, 14 insertions, 5 deletions
diff --git a/doc/rofi.1 b/doc/rofi.1
index 6e335778..0bfe3c2c 100644
--- a/doc/rofi.1
+++ b/doc/rofi.1
@@ -37,6 +37,9 @@ rofi \-show run
.P
The "official" website for \fBdmenu\fR can be found here \fIhttp://tools\.suckless\.org/dmenu/\fR\.
.
+.P
+\fBrofi\fR does not aim to be 100% compatible with dmenu\. There are simply to many different flavours of dmenu\. The idea is the basic usage commandline flags are obeyed, theme related flags are not\. Besides this, \fBrofi\fR offers some extended features (like multi\-select, highlighting, message bar, extra key\-bindings)\.
+.
.SH "CONFIGURATION"
There are currently three methods of setting configuration options (evaluated in order below):
.
@@ -44,10 +47,10 @@ There are currently three methods of setting configuration options (evaluated in
System configuration file (f\.e\. /etc/rofi\.conf)\.
.
.IP "\(bu" 4
-Xresources: A method of storing key values in the Xserver\. See here \fIhttps://en\.wikipedia\.org/wiki/X_resources\fR for more information\. This is the recommended way of configuring \fBrofi\fR\.
+Xresources: A method of storing key values in the Xserver\. See here \fIhttps://en\.wikipedia\.org/wiki/X_resources\fR for more information\.
.
.IP "\(bu" 4
-Configuration File: This uses the same format as the Xresources file\. By default it looks in \fBXDG_USER_CONFIG_DIR\fR/rofi/config, but can be overriden on commandline\. By default XDG_USER_CONFIG_DIR defaults to \fB$HOME/\.config\fR\. (See \fBrofi \-h\fR for current location)\.
+Configuration File: This uses the same format as the Xresources file\. By default it looks in \fBXDG_USER_CONFIG_DIR\fR/rofi/config, but can be overridden on commandline\. By default XDG_USER_CONFIG_DIR defaults to \fB$HOME/\.config\fR\. (See \fBrofi \-h\fR for current location)\. This is the recommended way of configuring \fBrofi\fR\.
.
.IP "\(bu" 4
Command\-line options: Arguments passed to \fBrofi\fR\.
@@ -55,7 +58,7 @@ Command\-line options: Arguments passed to \fBrofi\fR\.
.IP "" 0
.
.P
-\fBTIP\fR: To get a template config file run: \fBrofi \-dump\-xresources > rofi\-example\.config\fR\.
+\fBTIP\fR: To get a template config file run: \fBrofi \-dump\-xresources > rofi\-example\.config\fR\. \fBNOTE\fR: In version 1\.4\.0 we support configuration in a new format, a config for this can be generated by: \fBrofi \-dump\-config\fR
.
.P
The Xresources file expects options starting with \fBrofi\.\fR followed by it\'s name\. An Example to set the number of lines:
diff --git a/doc/rofi.1.markdown b/doc/rofi.1.markdown
index 3a7c30eb..5194cab4 100644
--- a/doc/rofi.1.markdown
+++ b/doc/rofi.1.markdown
@@ -81,6 +81,10 @@ To show the run dialog:
The "official" website for `dmenu` can be found [here](http://tools.suckless.org/dmenu/).
+**rofi** does not aim to be 100% compatible with dmenu. There are simply to many different flavours of dmenu.
+The idea is the basic usage commandline flags are obeyed, theme related flags are not.
+Besides this, **rofi** offers some extended features (like multi-select, highlighting, message bar, extra key-bindings).
+
## CONFIGURATION
There are currently three methods of setting configuration options (evaluated in order below):
@@ -88,13 +92,15 @@ There are currently three methods of setting configuration options (evaluated in
* System configuration file (f.e. /etc/rofi.conf).
* Xresources: A method of storing key values in the Xserver. See
[here](https://en.wikipedia.org/wiki/X_resources) for more information.
- This is the recommended way of configuring **rofi**.
* 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 overriden on commandline.
+ By default it looks in `XDG_USER_CONFIG_DIR`/rofi/config, but can be overridden on commandline.
By default XDG_USER_CONFIG_DIR 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-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`
The Xresources file expects options starting with `rofi.` followed by it's name. An Example to set the number of lines: