PolytreeDE/rofi
1
0
Fork 0
mirror of https://github.com/davatorium/rofi.git synced 2024-11-18 13:54:36 -05:00
Code Releases Activity

Small manpage updates

Browse source
This commit is contained in:
Dave Davenport 2017-07-18 09:18:18 +02:00
parent fd146b0519
commit 138ffc168d
2 changed files with 14 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/rofi.1
View file

@ -37,6 +37,9 @@ rofi \-show run
.P .P
The "official" website for \fBdmenu\fR can be found here \fIhttp://tools\.suckless\.org/dmenu/\fR\. 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" .SH "CONFIGURATION"
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):
. .
@ -44,10 +47,10 @@ There are currently three methods of setting configuration options (evaluated in
System configuration file (f\.e\. /etc/rofi\.conf)\. System configuration file (f\.e\. /etc/rofi\.conf)\.
. .
.IP "\(bu" 4 .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 .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 .IP "\(bu" 4
Command\-line options: Arguments passed to \fBrofi\fR\. Command\-line options: Arguments passed to \fBrofi\fR\.
@ -55,7 +58,7 @@ Command\-line options: Arguments passed to \fBrofi\fR\.
.IP "" 0 .IP "" 0
. .
.P .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 .P
The Xresources file expects options starting with \fBrofi\.\fR followed by it\'s name\. An Example to set the number of lines: The Xresources file expects options starting with \fBrofi\.\fR followed by it\'s name\. An Example to set the number of lines:

10
doc/rofi.1.markdown
View file

@ -81,6 +81,10 @@ To show the run dialog:
The "official" website for `dmenu` can be found [here](http://tools.suckless.org/dmenu/). 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 ## CONFIGURATION
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):
@ -88,13 +92,15 @@ There are currently three methods of setting configuration options (evaluated in
* System configuration file (f.e. /etc/rofi.conf). * System configuration file (f.e. /etc/rofi.conf).
* Xresources: A method of storing key values in the Xserver. See * Xresources: A method of storing key values in the Xserver. See
[here](https://en.wikipedia.org/wiki/X_resources) for more information. [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. * 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). 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**. * Command-line options: Arguments passed to **rofi**.
**TIP**: To get a template config file run: `rofi -dump-xresources > rofi-example.config`. **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: The Xresources file expects options starting with `rofi.` followed by it's name. An Example to set the number of lines: