summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDave Davenport <qball@gmpclient.org>2016-08-25 08:43:40 +0200
committerDave Davenport <qball@gmpclient.org>2016-08-25 21:17:58 +0200
commit20e55e1e4e7a084e2e86c16e5b3f0497a14773a4 (patch)
treee3a45cbbbf93135bcafbdced2878bac0282d2fe6 /doc
parenta657f81145465df1d8a75bedb1b56a0e99d541e0 (diff)
Add fuzzy matching, make a -matching option.
* -matching *method* option instead of -regex, -glob, -fuzzy. * Re-add fuzzy matching pattern. * When there are substrings in regex, only highlight those matches. Fixes: #447
Diffstat (limited to 'doc')
-rw-r--r--doc/rofi-manpage.markdown18
-rw-r--r--doc/rofi.130
-rw-r--r--doc/test_xr.txt6
3 files changed, 35 insertions, 19 deletions
diff --git a/doc/rofi-manpage.markdown b/doc/rofi-manpage.markdown
index d668b25e..e203d43b 100644
--- a/doc/rofi-manpage.markdown
+++ b/doc/rofi-manpage.markdown
@@ -45,8 +45,7 @@
[ -combi-modi *mode1,mode2* ]
[ -normal-window ]
[ -fake-transparency ]
-[ -glob ]
-[ -regex ]
+[ -matching *method* ]
[ -tokenize ]
[ -threads *num* ]
[ -config *filename* ]
@@ -275,14 +274,19 @@ Hide the scrollbar.
Set the scrollbar width.
-`-glob`
+`-matching` *method*
-Use glob style matching
-*Warning this option might be slow on large lists*
+Specify the matching algorithm used.
+Current the following methods are supported.
-`-regex`
+* **normal**: Match the int string.
+* **regex**: Match a regex input.
+* **glob**: Match a glob pattern.
+* **fuzzy**: Do a fuzzy match.
-Use regex matching
+ Default: normal
+
+ Note:, glob matching might be slow for larger lists.
`-tokenize`
diff --git a/doc/rofi.1 b/doc/rofi.1
index 5c387a41..38ed7579 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-08-22" "" ""
+.TH "ROFI\-MANPAGE" "" "2016-08-25" "" ""
.
.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 ] [ \-opacity \fIopacity%\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 ] [ \-lazy\-filter\-limit \fIlimit\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 ] [ \-glob ] [ \-regex ] [ \-tokenize ] [ \-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 ] [ \-opacity \fIopacity%\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 ] [ \-lazy\-filter\-limit \fIlimit\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 ] [ \-threads \fInum\fR ] [ \-config \fIfilename\fR ]
.
.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\.
@@ -444,16 +444,30 @@ Hide the scrollbar\.
Set the scrollbar width\.
.
.P
-\fB\-glob\fR
+\fB\-matching\fR \fImethod\fR
.
.P
-Use glob style matching \fIWarning this option might be slow on large lists\fR
+Specify the matching algorithm used\. Current the following methods are supported\.
.
-.P
-\fB\-regex\fR
+.IP "\(bu" 4
+\fBnormal\fR: Match the int string\.
.
-.P
-Use regex matching
+.IP "\(bu" 4
+\fBregex\fR: Match a regex input\.
+.
+.IP "\(bu" 4
+\fBglob\fR: Match a glob pattern\.
+.
+.IP "\(bu" 4
+\fBfuzzy\fR: Do a fuzzy match\.
+.
+.IP
+Default: normal
+.
+.IP
+Note:, glob matching might be slow for larger lists\.
+.
+.IP "" 0
.
.P
\fB\-tokenize\fR
diff --git a/doc/test_xr.txt b/doc/test_xr.txt
index e1570290..2f5664e9 100644
--- a/doc/test_xr.txt
+++ b/doc/test_xr.txt
@@ -64,10 +64,8 @@ rofi.parse-hosts: false
rofi.parse-known-hosts: true
! "Set the modi to combine in combi mode" Set from: File
rofi.combi-modi: window,drun,run,ssh
-! "Use glob matching" Set from: File
-rofi.glob: false
-! "Use regex matching" Set from: File
-rofi.regex: false
+! "Set the matching algorithm. (normal, regex, glob, fuzzy)" Set from: Default
+! rofi.matching: normal
! "Tokenize input string" Set from: File
rofi.tokenize: true
! "Monitor id to show on" Set from: File