summaryrefslogtreecommitdiffstats
path: root/doc/rofi-manpage.markdown
diff options
context:
space:
mode:
authorlbonn <lbonn@users.noreply.github.com>2017-01-09 20:32:31 +0100
committerDave Davenport <DaveDavenport@users.noreply.github.com>2017-01-09 20:32:31 +0100
commitb010da57d74922ba35e94e254417a569fa3097d5 (patch)
treebea46e10edb0c449402d88740dafe160952fbc2b /doc/rofi-manpage.markdown
parent854aa554533fcb5f93559220b474043f28ce45d4 (diff)
Misc man page changes (#535)
* Manpage: review the window section * rename "Window Mode" to "Window switcher settings" for more consistency * put `-window-command` in the correct section * move the window switcher settings section up * Manpage: minor markup/syntax fix * Manpage: mention `-show keys` in `-show` section * Manpage: fix some markup problems Some parts were over-indented and interpreted as verbatim blocks * Manpage: note about dmenu async mode disabling Stay voluntarily vague about the exact list of confliction options to avoid keeping it in sync with the code
Diffstat (limited to 'doc/rofi-manpage.markdown')
-rw-r--r--doc/rofi-manpage.markdown60
1 files changed, 32 insertions, 28 deletions
diff --git a/doc/rofi-manpage.markdown b/doc/rofi-manpage.markdown
index f0179355..c7af4af4 100644
--- a/doc/rofi-manpage.markdown
+++ b/doc/rofi-manpage.markdown
@@ -162,7 +162,10 @@ Or get the options from a script:
`-show` *mode*
-Open **rofi** in a certain mode. Available modes are `window`, `run`,`drun`, `ssh`, `combi`
+Open **rofi** in a certain mode. Available modes are `window`, `run`, `drun`, `ssh`, `combi`.
+The special argument `keys` can be used to open a searchable list of supported keybindings
+(see *KEYBINDINGS*)
+
To show the run-dialog:
rofi -show run
@@ -259,15 +262,13 @@ Specify the colors used in a row per state (normal, active, urgent).
Set the spacing between the rows.
- Default: *3*
- Min: *3*
- Max: *50*
+Default: *3*, Min: *3*, Max: *50*
`-separator-style` *style*
Set separator style. Possible options are "none", "solid" or "dash".
- Default: *dash*
+Default: *dash*
`-hide-scrollbar`
@@ -287,9 +288,9 @@ Current the following methods are supported.
* **glob**: Match a glob pattern.
* **fuzzy**: Do a fuzzy match.
- Default: normal
+ Default: *normal*
- Note:, glob matching might be slow for larger lists.
+Note: glob matching might be slow for larger lists
`-tokenize`
@@ -454,6 +455,28 @@ If set, use an external tool to generate list of executable commands. Uses 'run-
Default: *""*
+### Window switcher settings
+
+`-window-format` *format*
+
+Format what is being displayed for windows.
+
+*format*: {field[:len]}
+
+*field*:
+
+ * **w**: Desktop name
+ * **t**: Title of window
+ * **n**: Name
+ * **r**: Role
+ * **c**: Class
+
+*len*: maximum field length (0 for auto-size). If length negative and window *width* is negative field length is *width - len*.
+if length is positive, the entry will be truncated or padded to fill that length.
+
+
+default: {w} {c} {t}
+
`-window-command` *cmd*
Set command to execute on selected window for custom action.
@@ -598,27 +621,8 @@ Allow multiple lines to be selected. Adds a small selection indicator to the lef
Force rofi mode to first read all data from stdin before showing selection window. This is how original dmenu behaviour.
-### Window Mode
-
-`-window-format` *format*
-
-Format what is being displayed for windows.
-
-*format*: {field[:len]}
-
-*field*:
-
- * **w**: Desktop name
- * **t**: Title of window
- * **n**: Name
- * **r**: Role
- * **c**: Class
-
-*len*: maximum field length (0 for auto-size). If length negative and window *width* is negative field length is *width - len*.
-if length is positive, the entry will be truncated or padded to fill that length.
-
-
-default: {w} {c} {t}
+Note: the default asynchronous mode will also be automatically disabled if used with conflicting options
+such as `-dump`, `-only-match` or `-auto-select`
### Message dialog