summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDave Davenport <qball@gmpclient.org>2017-01-07 10:38:47 +0100
committerDave Davenport <qball@gmpclient.org>2017-01-07 10:38:47 +0100
commit8124cfb0238e5929ca28e45d0bc119d3588fdad6 (patch)
tree10caa836b881e4b2afa70ec351c5f9a4e187e0b0 /doc
parent0d9804f108fa0610f774446fb8e69ab26dfeb374 (diff)
parentc98b67ed0d14c26bc0e022461f3a432c64c9cd80 (diff)
Merge remote-tracking branch 'origin/master' into themer
Diffstat (limited to 'doc')
-rw-r--r--doc/rofi-manpage.markdown18
-rw-r--r--doc/rofi.122
2 files changed, 38 insertions, 2 deletions
diff --git a/doc/rofi-manpage.markdown b/doc/rofi-manpage.markdown
index d159b87a..f0179355 100644
--- a/doc/rofi-manpage.markdown
+++ b/doc/rofi-manpage.markdown
@@ -48,6 +48,7 @@
[ -no-click-to-exit ]
[ -threads *num* ]
[ -config *filename* ]
+[ -no-show-match ]
## DESCRIPTION
@@ -204,6 +205,14 @@ Load alternative configuration file.
Select the scrolling method. 0: Per page, 1: continuous.
+`-no-show-match`
+
+Hide the indicator that shows what part of the string is matched.
+
+`-lazy-grab`
+
+When fail to grab keyboard, don't block but retry later in background.
+
### Theming
All colors are either hex #rrggbb, #aarrggbb or argb:aarrggbbvalues or X11 color names.
@@ -881,6 +890,15 @@ Use `qalc` to get a simple calculator in **rofi**:
rofi -show calc -modi "calc:qalc +u8 -nocurrencies"
+## I3
+
+In [I3](http://i3wm.org/) you want to bind rofi to be launched on key-release. Otherwise it cannot grab the keyboard.
+See also the I3 [manual](http://i3wm.org/docs/userguide.html):
+
+Some tools (such as import or xdotool) might be unable to run upon a KeyPress event, because the keyboard/pointer is
+still grabbed. For these situations, the --release flag can be used, which will execute the command after the keys have
+been released.
+
## LICENSE
MIT/X11
diff --git a/doc/rofi.1 b/doc/rofi.1
index fbd20911..dea91f1e 100644
--- a/doc/rofi.1
+++ b/doc/rofi.1
@@ -1,13 +1,13 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "ROFI\-MANPAGE" "" "2016-12-23" "" ""
+.TH "ROFI\-MANPAGE" "" "January 2017" "" ""
.
.SH "NAME"
\fBrofi\fR \- A window switcher, run launcher, ssh dialog and dmenu replacement
.
.SH "SYNOPSIS"
-\fBrofi\fR [ \-width \fIpct_scr\fR ] [ \-lines \fIlines\fR ] [ \-columns \fIcolumns\fR ] [ \-font \fIpangofont\fR ] [ \-terminal \fIterminal\fR ] [ \-location \fIposition\fR ] [ \-fixed\-num\-lines ] [ \-padding \fIpadding\fR ] [ \-display \fIdisplay\fR ] [ \-bw \fIwidth\fR ] [ \-dmenu [ \-p \fIprompt\fR ] [ \-sep \fIseparator\fR ] [ \-l \fIselected line\fR ] [ \-mesg ] [ \-select ] [ \-input \fIinput\fR ] ] [ \-filter \fIfilter\fR ] [ \-ssh\-client \fIclient\fR ] [ \-ssh\-command \fIcommand\fR ] [ \-window\-command \fIcommand\fR ] [ \-disable\-history ] [ \-levenshtein\-sort ] [ \-case\-sensitive ] [ \-cycle ] [ \-show \fImode\fR ] [ \-modi \fImode1,mode2\fR ] [ \-eh \fIelement height\fR ] [ \-e \fImessage\fR] [ \-a \fIrow\fR ] [ \-u \fIrow\fR ] [ \-pid \fIpath\fR ] [ \-version ] [ \-help ] [ \-dump\-xresources ] [ \-dump\-xresources\-theme ] [ \-auto\-select ] [ \-parse\-hosts ] [ \-no\-parse\-known\-hosts ] [ \-combi\-modi \fImode1,mode2\fR ] [ \-normal\-window ] [ \-fake\-transparency ] [ \-matching \fImethod\fR ] [ \-tokenize ] [ \-no\-click\-to\-exit ] [ \-threads \fInum\fR ] [ \-config \fIfilename\fR ]
+\fBrofi\fR [ \-width \fIpct_scr\fR ] [ \-lines \fIlines\fR ] [ \-columns \fIcolumns\fR ] [ \-font \fIpangofont\fR ] [ \-terminal \fIterminal\fR ] [ \-location \fIposition\fR ] [ \-fixed\-num\-lines ] [ \-padding \fIpadding\fR ] [ \-display \fIdisplay\fR ] [ \-bw \fIwidth\fR ] [ \-dmenu [ \-p \fIprompt\fR ] [ \-sep \fIseparator\fR ] [ \-l \fIselected line\fR ] [ \-mesg ] [ \-select ] [ \-input \fIinput\fR ] ] [ \-filter \fIfilter\fR ] [ \-ssh\-client \fIclient\fR ] [ \-ssh\-command \fIcommand\fR ] [ \-window\-command \fIcommand\fR ] [ \-disable\-history ] [ \-levenshtein\-sort ] [ \-case\-sensitive ] [ \-cycle ] [ \-show \fImode\fR ] [ \-modi \fImode1,mode2\fR ] [ \-eh \fIelement height\fR ] [ \-e \fImessage\fR] [ \-a \fIrow\fR ] [ \-u \fIrow\fR ] [ \-pid \fIpath\fR ] [ \-version ] [ \-help ] [ \-dump\-xresources ] [ \-dump\-xresources\-theme ] [ \-auto\-select ] [ \-parse\-hosts ] [ \-no\-parse\-known\-hosts ] [ \-combi\-modi \fImode1,mode2\fR ] [ \-normal\-window ] [ \-fake\-transparency ] [ \-matching \fImethod\fR ] [ \-tokenize ] [ \-no\-click\-to\-exit ] [ \-threads \fInum\fR ] [ \-config \fIfilename\fR ] [ \-no\-show\-match ]
.
.SH "DESCRIPTION"
\fBrofi\fR is an X11 popup window switcher, run dialog, dmenu replacement and more\. It focuses on being fast to use and have minimal distraction\. It supports keyboard and mouse navigation, type to filter, tokenized search and more\.
@@ -294,6 +294,18 @@ Load alternative configuration file\.
.P
Select the scrolling method\. 0: Per page, 1: continuous\.
.
+.P
+\fB\-no\-show\-match\fR
+.
+.P
+Hide the indicator that shows what part of the string is matched\.
+.
+.P
+\fB\-lazy\-grab\fR
+.
+.P
+When fail to grab keyboard, don\'t block but retry later in background\.
+.
.SS "Theming"
All colors are either hex #rrggbb, #aarrggbb or argb:aarrggbbvalues or X11 color names\.
.
@@ -1463,6 +1475,12 @@ Use \fBqalc\fR to get a simple calculator in \fBrofi\fR:
.
.IP "" 0
.
+.SH "I3"
+In I3 \fIhttp://i3wm\.org/\fR you want to bind rofi to be launched on key\-release\. Otherwise it cannot grab the keyboard\. See also the I3 manual \fIhttp://i3wm\.org/docs/userguide\.html\fR:
+.
+.P
+Some tools (such as import or xdotool) might be unable to run upon a KeyPress event, because the keyboard/pointer is still grabbed\. For these situations, the \-\-release flag can be used, which will execute the command after the keys have been released\.
+.
.SH "LICENSE"
.
.nf