mirror of
https://github.com/davatorium/rofi.git
synced 2024-11-25 13:55:34 -05:00
Add explanation about options to manpage.
This commit is contained in:
parent
faae5abb33
commit
24aab4527e
2 changed files with 100 additions and 10 deletions
|
@ -96,6 +96,45 @@ The official website for `dmenu` can be found: http://tools.suckless.org/dmenu/
|
||||||
|
|
||||||
## OPTIONS
|
## OPTIONS
|
||||||
|
|
||||||
|
There are currently three methods of setting configuration options:
|
||||||
|
|
||||||
|
* Compile time: edit config.c. This method is strongly discouraged.
|
||||||
|
* Xresources: A method of storing key values in the Xserver. See
|
||||||
|
[here](https://en.wikipedia.org/wiki/X_resources) for more information.
|
||||||
|
* Commandline options: Arguments passed to **rofi**.
|
||||||
|
|
||||||
|
The Xresources options and the commandline options are aliased. So to set option X you would set:
|
||||||
|
|
||||||
|
rofi.X: value
|
||||||
|
|
||||||
|
In the Xresources file, and to (override) this via the commandline you would pass the same key
|
||||||
|
prefixed with a '-':
|
||||||
|
|
||||||
|
rofi -X value
|
||||||
|
|
||||||
|
To get a list of available options, formatted as Xresources entries run:
|
||||||
|
|
||||||
|
rofi -dump-xresources
|
||||||
|
|
||||||
|
The configuration system supports the following types:
|
||||||
|
|
||||||
|
* String
|
||||||
|
* Integer (signed and unsigned)
|
||||||
|
* Char
|
||||||
|
* Boolean
|
||||||
|
|
||||||
|
The boolean option has a non-default commandline syntax, to enable option X you do:
|
||||||
|
|
||||||
|
-X
|
||||||
|
|
||||||
|
to disable it:
|
||||||
|
|
||||||
|
-no-X
|
||||||
|
|
||||||
|
Below is a list of the most important options:
|
||||||
|
|
||||||
|
### General
|
||||||
|
|
||||||
`-key-{mode}` **KEY**
|
`-key-{mode}` **KEY**
|
||||||
|
|
||||||
Set the key combination to display a {mode} in daemon mode.
|
Set the key combination to display a {mode} in daemon mode.
|
||||||
|
|
71
doc/rofi.1
71
doc/rofi.1
|
@ -90,10 +90,65 @@ Keybindings can also be specified in the \fB\fCXresources\fR file.
|
||||||
\fBrofi\fP can emulate \fB\fCdmenu\fR (a dynamic menu for X) when launched with the \fB\fC\-dmenu\fR flag.
|
\fBrofi\fP can emulate \fB\fCdmenu\fR (a dynamic menu for X) when launched with the \fB\fC\-dmenu\fR flag.
|
||||||
.PP
|
.PP
|
||||||
The official website for \fB\fCdmenu\fR can be found:
|
The official website for \fB\fCdmenu\fR can be found:
|
||||||
.UR http://tools.suckless.org/dmenu/
|
\[la]http://tools.suckless.org/dmenu/\[ra]
|
||||||
.UE
|
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
.PP
|
.PP
|
||||||
|
There are currently three methods of setting configuration options:
|
||||||
|
.RS
|
||||||
|
.IP \(bu 2
|
||||||
|
Compile time: edit config.c. This method is strongly discouraged.
|
||||||
|
.IP \(bu 2
|
||||||
|
Xresources: A method of storing key values in the Xserver. See
|
||||||
|
here
|
||||||
|
\[la]https://en.wikipedia.org/wiki/X_resources\[ra] for more information.
|
||||||
|
.IP \(bu 2
|
||||||
|
Commandline options: Arguments passed to \fBrofi\fP\&.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
The Xresources options and the commandline options are aliased. So to set option X you would set:
|
||||||
|
.IP
|
||||||
|
rofi.X: value
|
||||||
|
.PP
|
||||||
|
In the Xresources file, and to (override) this via the commandline you would pass the same key
|
||||||
|
prefixed with a '\-':
|
||||||
|
.PP
|
||||||
|
.RS
|
||||||
|
.nf
|
||||||
|
rofi \-X value
|
||||||
|
.fi
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
To get a list of available options, formatted as Xresources entries run:
|
||||||
|
.PP
|
||||||
|
.RS
|
||||||
|
.nf
|
||||||
|
rofi \-dump\-xresources
|
||||||
|
.fi
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
The configuration system supports the following types:
|
||||||
|
.RS
|
||||||
|
.IP \(bu 2
|
||||||
|
String
|
||||||
|
.IP \(bu 2
|
||||||
|
Integer (signed and unsigned)
|
||||||
|
.IP \(bu 2
|
||||||
|
Char
|
||||||
|
.IP \(bu 2
|
||||||
|
Boolean
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
The boolean option has a non\-default commandline syntax, to enable option X you do:
|
||||||
|
.PP
|
||||||
|
\-X
|
||||||
|
.PP
|
||||||
|
to disable it:
|
||||||
|
.PP
|
||||||
|
\-no\-X
|
||||||
|
.PP
|
||||||
|
Below is a list of the most important options:
|
||||||
|
.SS General
|
||||||
|
.PP
|
||||||
\fB\fC\-key\-{mode}\fR \fBKEY\fP
|
\fB\fC\-key\-{mode}\fR \fBKEY\fP
|
||||||
.IP
|
.IP
|
||||||
Set the key combination to display a {mode} in daemon mode.
|
Set the key combination to display a {mode} in daemon mode.
|
||||||
|
@ -811,18 +866,14 @@ Check quotes used on the commandline: e.g. used “ instead of ".
|
||||||
.SH WEBSITE
|
.SH WEBSITE
|
||||||
.PP
|
.PP
|
||||||
\fBrofi\fP website can be found at here
|
\fBrofi\fP website can be found at here
|
||||||
.UR https://davedavenport.github.io/rofi/
|
\[la]https://davedavenport.github.io/rofi/\[ra]
|
||||||
.UE
|
|
||||||
.PP
|
.PP
|
||||||
\fBrofi\fP bugtracker can be found here
|
\fBrofi\fP bugtracker can be found here
|
||||||
.UR https://github.com/DaveDavenport/rofi/issues
|
\[la]https://github.com/DaveDavenport/rofi/issues\[ra]
|
||||||
.UE
|
|
||||||
.SH AUTHOR
|
.SH AUTHOR
|
||||||
.PP
|
.PP
|
||||||
Qball Cow
|
Qball Cow
|
||||||
.MT qball@gmpclient.org
|
\[la]qball@gmpclient.org\[ra]
|
||||||
.ME
|
|
||||||
.PP
|
.PP
|
||||||
Original code based on work by: Sean Pringle
|
Original code based on work by: Sean Pringle
|
||||||
.MT sean.pringle@gmail.com
|
\[la]sean.pringle@gmail.com\[ra]
|
||||||
.ME
|
|
||||||
|
|
Loading…
Reference in a new issue