1
0
Fork 0
mirror of https://github.com/davatorium/rofi.git synced 2024-11-18 13:54:36 -05:00

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
This commit is contained in:
lbonn 2017-01-09 20:32:31 +01:00 committed by Dave Davenport
parent 854aa55453
commit b010da57d7
2 changed files with 80 additions and 86 deletions

View file

@ -162,7 +162,10 @@ Or get the options from a script:
`-show` *mode* `-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: To show the run-dialog:
rofi -show run 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. Set the spacing between the rows.
Default: *3* Default: *3*, Min: *3*, Max: *50*
Min: *3*
Max: *50*
`-separator-style` *style* `-separator-style` *style*
Set separator style. Possible options are "none", "solid" or "dash". Set separator style. Possible options are "none", "solid" or "dash".
Default: *dash* Default: *dash*
`-hide-scrollbar` `-hide-scrollbar`
@ -287,9 +288,9 @@ Current the following methods are supported.
* **glob**: Match a glob pattern. * **glob**: Match a glob pattern.
* **fuzzy**: Do a fuzzy match. * **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` `-tokenize`
@ -454,6 +455,28 @@ If set, use an external tool to generate list of executable commands. Uses 'run-
Default: *""* 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* `-window-command` *cmd*
Set command to execute on selected window for custom action. 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. Force rofi mode to first read all data from stdin before showing selection window. This is how original dmenu behaviour.
### Window Mode Note: the default asynchronous mode will also be automatically disabled if used with conflicting options
such as `-dump`, `-only-match` or `-auto-select`
`-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}
### Message dialog ### Message dialog

View file

@ -210,7 +210,10 @@ Or get the options from a script:
\fB\-show\fR \fImode\fR \fB\-show\fR \fImode\fR
. .
.P .P
Open \fBrofi\fR in a certain mode\. Available modes are \fBwindow\fR, \fBrun\fR,\fBdrun\fR, \fBssh\fR, \fBcombi\fR To show the run\-dialog: Open \fBrofi\fR in a certain mode\. Available modes are \fBwindow\fR, \fBrun\fR, \fBdrun\fR, \fBssh\fR, \fBcombi\fR\. The special argument \fBkeys\fR can be used to open a searchable list of supported keybindings (see \fIKEYBINDINGS\fR)
.
.P
To show the run\-dialog:
. .
.IP "" 4 .IP "" 4
. .
@ -393,17 +396,8 @@ Specify the colors used in a row per state (normal, active, urgent)\.
.P .P
Set the spacing between the rows\. Set the spacing between the rows\.
. .
.IP "" 4 .P
. Default: \fI3\fR, Min: \fI3\fR, Max: \fI50\fR
.nf
Default: *3*
Min: *3*
Max: *50*
.
.fi
.
.IP "" 0
. .
.P .P
\fB\-separator\-style\fR \fIstyle\fR \fB\-separator\-style\fR \fIstyle\fR
@ -411,15 +405,8 @@ Max: *50*
.P .P
Set separator style\. Possible options are "none", "solid" or "dash"\. Set separator style\. Possible options are "none", "solid" or "dash"\.
. .
.IP "" 4 .P
. Default: \fIdash\fR
.nf
Default: *dash*
.
.fi
.
.IP "" 0
. .
.P .P
\fB\-hide\-scrollbar\fR \fB\-hide\-scrollbar\fR
@ -452,14 +439,14 @@ Specify the matching algorithm used\. Current the following methods are supporte
\fBfuzzy\fR: Do a fuzzy match\. \fBfuzzy\fR: Do a fuzzy match\.
. .
.IP .IP
Default: normal Default: \fInormal\fR
.
.IP
Note:, glob matching might be slow for larger lists\.
. .
.IP "" 0 .IP "" 0
. .
.P .P
Note: glob matching might be slow for larger lists
.
.P
\fB\-tokenize\fR \fB\-tokenize\fR
. .
.P .P
@ -735,6 +722,41 @@ If set, use an external tool to generate list of executable commands\. Uses \'ru
.P .P
Default: \fI""\fR Default: \fI""\fR
. .
.SS "Window switcher settings"
\fB\-window\-format\fR \fIformat\fR
.
.P
Format what is being displayed for windows\.
.
.P
\fIformat\fR: {field[:len]}
.
.P
\fIfield\fR:
.
.IP "\(bu" 4
\fBw\fR: Desktop name
.
.IP "\(bu" 4
\fBt\fR: Title of window
.
.IP "\(bu" 4
\fBn\fR: Name
.
.IP "\(bu" 4
\fBr\fR: Role
.
.IP "\(bu" 4
\fBc\fR: Class
.
.IP "" 0
.
.P
\fIlen\fR: maximum field length (0 for auto\-size)\. If length negative and window \fIwidth\fR is negative field length is \fIwidth \- len\fR\. if length is positive, the entry will be truncated or padded to fill that length\.
.
.P
default: {w} {c} {t}
.
.P .P
\fB\-window\-command\fR \fIcmd\fR \fB\-window\-command\fR \fIcmd\fR
. .
@ -948,40 +970,8 @@ Allow multiple lines to be selected\. Adds a small selection indicator to the le
.P .P
Force rofi mode to first read all data from stdin before showing selection window\. This is how original dmenu behaviour\. Force rofi mode to first read all data from stdin before showing selection window\. This is how original dmenu behaviour\.
. .
.SS "Window Mode"
\fB\-window\-format\fR \fIformat\fR
.
.P .P
Format what is being displayed for windows\. Note: the default asynchronous mode will also be automatically disabled if used with conflicting options such as \fB\-dump\fR, \fB\-only\-match\fR or \fB\-auto\-select\fR
.
.P
\fIformat\fR: {field[:len]}
.
.P
\fIfield\fR:
.
.IP "\(bu" 4
\fBw\fR: Desktop name
.
.IP "\(bu" 4
\fBt\fR: Title of window
.
.IP "\(bu" 4
\fBn\fR: Name
.
.IP "\(bu" 4
\fBr\fR: Role
.
.IP "\(bu" 4
\fBc\fR: Class
.
.IP "" 0
.
.P
\fIlen\fR: maximum field length (0 for auto\-size)\. If length negative and window \fIwidth\fR is negative field length is \fIwidth \- len\fR\. if length is positive, the entry will be truncated or padded to fill that length\.
.
.P
default: {w} {c} {t}
. .
.SS "Message dialog" .SS "Message dialog"
\fB\-e\fR \fImessage\fR \fB\-e\fR \fImessage\fR