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

Updates.

Browse source
This commit is contained in:
QC 2015-04-25 17:40:01 +02:00
parent a78355c7ef
commit 0b3b190159
2 changed files with 98 additions and 72 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

79
doc/rofi-manpage.markdown
View file

@ -48,7 +48,7 @@ rofi - A window switcher, run launcher, ssh dialog and dmenu replacement
[ -snow ] [ -snow ]
[ -version ] [ -version ]
[ -help] [ -help]
[ -dump-xresources ] [ -dump-Xresources ]
[ -auto-select ] [ -auto-select ]
[ -parse-hosts ] [ -parse-hosts ]
[ -combi-modi *mode1,mode2* ] [ -combi-modi *mode1,mode2* ]
@ -89,7 +89,7 @@ Keybindings can also be specified in the `Xresources` file.
**rofi** can emulate `dmenu` (a dynamic menu for X) when launched with the `-dmenu` flag. **rofi** can emulate `dmenu` (a dynamic menu for X) when launched with the `-dmenu` flag.
The official website for `dmenu` can be found: http://tools.suckless.org/dmenu/ The official website for `dmenu` can be found [here](http://tools.suckless.org/dmenu/).
## OPTIONS ## OPTIONS
@ -98,20 +98,20 @@ There are currently three methods of setting configuration options:
* Compile time: edit config.c. This method is strongly discouraged. * Compile time: edit config.c. This method is strongly discouraged.
* 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.
* Commandline options: Arguments passed to **rofi**. * Command-line options: Arguments passed to **rofi**.
The Xresources options and the commandline options are aliased. So to set option X you would set: The Xresources options and the command-line options are aliased. So to set option X you would set:
rofi.X: value rofi.X: value
In the Xresources file, and to (override) this via the commandline you would pass the same key In the Xresources file, and to (override) this via the command-line you would pass the same key
prefixed with a '-': prefixed with a '-':
rofi -X value rofi -X value
To get a list of available options, formatted as Xresources entries run: To get a list of available options, formatted as Xresources entries run:
rofi -dump-xresources rofi -dump-Xresources
The configuration system supports the following types: The configuration system supports the following types:
@ -120,13 +120,13 @@ The configuration system supports the following types:
* Char * Char
* Boolean * Boolean
The boolean option has a non-default commandline syntax, to enable option X you do: The boolean option has a non-default command-line syntax, to enable option X you do:
-X -X
to disable it: to disable it:
-no-X -no-X
Below is a list of the most important options: Below is a list of the most important options:
@ -143,7 +143,7 @@ Below is a list of the most important options:
`-dmenu` `-dmenu`
Run rofi in dmenu mode. Allowing it to be used for user interaction in scripts. Run **rofi** in dmenu mode. Allowing it to be used for user interaction in scripts.
In `dmenu` mode, **rofi** will read input from STDIN, and will output to STDOUT by default. In `dmenu` mode, **rofi** will read input from STDIN, and will output to STDOUT by default.
@ -159,7 +159,7 @@ Below is a list of the most important options:
`-show` *mode* `-show` *mode*
Open rofi in a certain mode. Open **rofi** in a certain mode.
For example to show the run-dialog: For example to show the run-dialog:
@ -377,9 +377,10 @@ The following options are further explained in the theming section:
`-lazy-filter-limit` *limit* `-lazy-filter-limit` *limit*
The number of entries required for Rofi to go into lazy filter mode. The number of entries required for **rofi** to go into lazy filter mode.
In lazy filter mode, it won't refilter the list on each keypress, but only after rofi been idle In lazy filter mode, it won't re-filter the list on each keypress, but only after **rofi** been
for 250ms. Experiments shows that the default (5000 lines) works well, set to 0 to always enable. idle for 250ms. Experiments shows that the default (5000 lines) works well, set to 0 to always
enable.
Default: *5000* Default: *5000*
@ -518,13 +519,13 @@ The following options are further explained in the theming section:
'-pid' *path* '-pid' *path*
Make **rofi** create a pid file and check this on startup. Avoiding multiple copies running Make **rofi** create a pid file and check this on startup. Avoiding multiple copies running
simultaneous. This is useful when running rofi from a keybinding daemon. simultaneous. This is useful when running **rofi** from a keybinding daemon.
### Debug ### Debug
`-dump-xresources` `-dump-Xresources`
Dump the current active configuration in xresources format to the command-line. Dump the current active configuration in Xresources format to the command-line.
## PATTERN ## PATTERN
@ -536,7 +537,7 @@ the following keys can be used that will be replaced at runtime:
* `{ssh-client}`: The configured ssh client (See -ssh-client) * `{ssh-client}`: The configured ssh client (See -ssh-client)
* `{cmd}`: The command to execute. * `{cmd}`: The command to execute.
## DMENU REPLACEMNT ## DMENU REPLACEMENT
If `argv[0]` (calling command) is dmenu, **rofi** will start in dmenu mode. If `argv[0]` (calling command) is dmenu, **rofi** will start in dmenu mode.
This way it can be used as a drop-in replacement for dmenu. just copy or symlink **rofi** to dmenu in `$PATH`. This way it can be used as a drop-in replacement for dmenu. just copy or symlink **rofi** to dmenu in `$PATH`.
@ -549,7 +550,7 @@ This way it can be used as a drop-in replacement for dmenu. just copy or symlink
`HUP` `HUP`
If in daemon mode, reload the configuration from Xresources. (commandline arguments still If in daemon mode, reload the configuration from Xresources. (commandline arguments still
override xresources). override Xresources).
## THEMING ## THEMING
@ -647,32 +648,32 @@ and the others slightly transparent.
Try using a mono-space font. Try using a mono-space font.
`Rofi is completely black.` `**rofi** is completely black.`
Check quotes used on the commandline: e.g. used “ instead of ". Check quotes used on the commandline: e.g. used “ instead of ".
## LICENSE ## LICENSE
MIT/X11 MIT/X11
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including "Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish, without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to permit persons to whom the Software is furnished to do so, subject to
the following conditions: the following conditions:
The above copyright notice and this permission notice shall be The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software. included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
## WEBSITE ## WEBSITE
@ -685,3 +686,5 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Qball Cow <qball@gmpclient.org> Qball Cow <qball@gmpclient.org>
Original code based on work by: Sean Pringle <sean.pringle@gmail.com> Original code based on work by: Sean Pringle <sean.pringle@gmail.com>
For a full list of authors, check the AUTHORS file.

85
doc/rofi.1
View file

@ -46,7 +46,7 @@ rofi \- A window switcher, run launcher, ssh dialog and dmenu replacement
[ \-snow ] [ \-snow ]
[ \-version ] [ \-version ]
[ \-help] [ \-help]
[ \-dump\-xresources ] [ \-dump\-Xresources ]
[ \-auto\-select ] [ \-auto\-select ]
[ \-parse\-hosts ] [ \-parse\-hosts ]
[ \-combi\-modi \fImode1,mode2\fP ] [ \-combi\-modi \fImode1,mode2\fP ]
@ -86,8 +86,9 @@ Keybindings can also be specified in the \fB\fCXresources\fR file.
.PP .PP
\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 here
\[la]http://tools.suckless.org/dmenu/\[ra] .UR http://tools.suckless.org/dmenu/
.UE \&.
.SH OPTIONS .SH OPTIONS
.PP .PP
There are currently three methods of setting configuration options: There are currently three methods of setting configuration options:
@ -97,16 +98,22 @@ Compile time: edit config.c. This method is strongly discouraged.
.IP \(bu 2 .IP \(bu 2
Xresources: A method of storing key values in the Xserver. See Xresources: A method of storing key values in the Xserver. See
here here
\[la]https://en.wikipedia.org/wiki/X_resources\[ra] for more information. .UR https://en.wikipedia.org/wiki/X_resources
.UE
for more information.
.IP \(bu 2 .IP \(bu 2
Commandline options: Arguments passed to \fBrofi\fP\&. Command\-line options: Arguments passed to \fBrofi\fP\&.
.RE .RE
.PP .PP
The Xresources options and the commandline options are aliased. So to set option X you would set: The Xresources options and the command\-line options are aliased. So to set option X you would set:
.IP
rofi.X: value
.PP .PP
In the Xresources file, and to (override) this via the commandline you would pass the same key .RS
.nf
rofi.X: value
.fi
.RE
.PP
In the Xresources file, and to (override) this via the command\-line you would pass the same key
prefixed with a '\-': prefixed with a '\-':
.PP .PP
.RS .RS
@ -119,7 +126,7 @@ To get a list of available options, formatted as Xresources entries run:
.PP .PP
.RS .RS
.nf .nf
rofi \-dump\-xresources rofi \-dump\-Xresources
.fi .fi
.RE .RE
.PP .PP
@ -135,13 +142,21 @@ Char
Boolean Boolean
.RE .RE
.PP .PP
The boolean option has a non\-default commandline syntax, to enable option X you do: The boolean option has a non\-default command\-line syntax, to enable option X you do:
.PP .PP
\-X .RS
.nf
\-X
.fi
.RE
.PP .PP
to disable it: to disable it:
.PP .PP
\-no\-X .RS
.nf
\-no\-X
.fi
.RE
.PP .PP
Below is a list of the most important options: Below is a list of the most important options:
.SS General .SS General
@ -160,7 +175,7 @@ Set the key combination to display a {mode} in daemon mode.
.PP .PP
\fB\fC\-dmenu\fR \fB\fC\-dmenu\fR
.IP .IP
Run rofi in dmenu mode. Allowing it to be used for user interaction in scripts. Run \fBrofi\fP in dmenu mode. Allowing it to be used for user interaction in scripts.
.IP .IP
In \fB\fCdmenu\fR mode, \fBrofi\fP will read input from STDIN, and will output to STDOUT by default. In \fB\fCdmenu\fR mode, \fBrofi\fP will read input from STDIN, and will output to STDOUT by default.
.IP .IP
@ -184,7 +199,7 @@ Pressing \fB\fCshift\-enter\fR will open the selected entries and move to the ne
.PP .PP
\fB\fC\-show\fR \fImode\fP \fB\fC\-show\fR \fImode\fP
.IP .IP
Open rofi in a certain mode. Open \fBrofi\fP in a certain mode.
.IP .IP
For example to show the run\-dialog: For example to show the run\-dialog:
.PP .PP
@ -492,9 +507,10 @@ To show sidebar use:
.PP .PP
\fB\fC\-lazy\-filter\-limit\fR \fIlimit\fP \fB\fC\-lazy\-filter\-limit\fR \fIlimit\fP
.PP .PP
The number of entries required for Rofi to go into lazy filter mode. The number of entries required for \fBrofi\fP to go into lazy filter mode.
In lazy filter mode, it won't refilter the list on each keypress, but only after rofi been idle In lazy filter mode, it won't re\-filter the list on each keypress, but only after \fBrofi\fP been
for 250ms. Experiments shows that the default (5000 lines) works well, set to 0 to always enable. idle for 250ms. Experiments shows that the default (5000 lines) works well, set to 0 to always
enable.
.PP .PP
Default: \fI5000\fP Default: \fI5000\fP
.PP .PP
@ -664,14 +680,14 @@ Message can be multi\-line.
.RS .RS
.nf .nf
Make **rofi** create a pid file and check this on startup. Avoiding multiple copies running Make **rofi** create a pid file and check this on startup. Avoiding multiple copies running
simultaneous. This is useful when running rofi from a keybinding daemon. simultaneous. This is useful when running **rofi** from a keybinding daemon.
.fi .fi
.RE .RE
.SS Debug .SS Debug
.PP .PP
\fB\fC\-dump\-xresources\fR \fB\fC\-dump\-Xresources\fR
.IP .IP
Dump the current active configuration in xresources format to the command\-line. Dump the current active configuration in Xresources format to the command\-line.
.SH PATTERN .SH PATTERN
.PP .PP
To launch commands (e.g. when using the ssh launcher) the user can enter the used commandline, To launch commands (e.g. when using the ssh launcher) the user can enter the used commandline,
@ -686,7 +702,7 @@ the following keys can be used that will be replaced at runtime:
.IP \(bu 2 .IP \(bu 2
\fB\fC{cmd}\fR: The command to execute. \fB\fC{cmd}\fR: The command to execute.
.RE .RE
.SH DMENU REPLACEMNT .SH DMENU REPLACEMENT
.PP .PP
If \fB\fCargv[0]\fR (calling command) is dmenu, \fBrofi\fP will start in dmenu mode. If \fB\fCargv[0]\fR (calling command) is dmenu, \fBrofi\fP will start in dmenu mode.
This way it can be used as a drop\-in replacement for dmenu. just copy or symlink \fBrofi\fP to dmenu in \fB\fC$PATH\fR\&. This way it can be used as a drop\-in replacement for dmenu. just copy or symlink \fBrofi\fP to dmenu in \fB\fC$PATH\fR\&.
@ -706,7 +722,7 @@ If in daemon mode, reload the configuration from Xresources. (commandline argume
.fi .fi
.RE .RE
.PP .PP
override xresources). override Xresources).
.SH THEMING .SH THEMING
.PP .PP
With \fBrofi\fP 0.15.4 we have a new way of specifying colors, the old settings still apply (for now). With \fBrofi\fP 0.15.4 we have a new way of specifying colors, the old settings still apply (for now).
@ -849,7 +865,7 @@ Try using a mono\-space font.
.fi .fi
.RE .RE
.PP .PP
\fB\fCRofi is completely black.\fR \fB\fC**rofi** is completely black.\fR
.PP .PP
.RS .RS
.nf .nf
@ -858,8 +874,9 @@ Check quotes used on the commandline: e.g. used “ instead of ".
.RE .RE
.SH LICENSE .SH LICENSE
.PP .PP
.RS
.nf
MIT/X11 MIT/X11
.PP
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including "Software"), to deal in the Software without restriction, including
@ -867,10 +884,8 @@ without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to permit persons to whom the Software is furnished to do so, subject to
the following conditions: the following conditions:
.PP
The above copyright notice and this permission notice shall be The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software. included in all copies or substantial portions of the Software.
.PP
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
@ -878,17 +893,25 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.fi
.RE
.SH WEBSITE .SH WEBSITE
.PP .PP
\fBrofi\fP website can be found at here \fBrofi\fP website can be found at here
\[la]https://davedavenport.github.io/rofi/\[ra] .UR https://davedavenport.github.io/rofi/
.UE
.PP .PP
\fBrofi\fP bugtracker can be found here \fBrofi\fP bugtracker can be found here
\[la]https://github.com/DaveDavenport/rofi/issues\[ra] .UR https://github.com/DaveDavenport/rofi/issues
.UE
.SH AUTHOR .SH AUTHOR
.PP .PP
Qball Cow Qball Cow
\[la]qball@gmpclient.org\[ra] .MT qball@gmpclient.org
.ME
.PP .PP
Original code based on work by: Sean Pringle Original code based on work by: Sean Pringle
\[la]sean.pringle@gmail.com\[ra] .MT sean.pringle@gmail.com
.ME
.PP
For a full list of authors, check the AUTHORS file.