diff options
author | Dave Davenport <qball@blame.services> | 2024-01-09 11:46:25 +0100 |
---|---|---|
committer | Dave Davenport <qball@blame.services> | 2024-01-09 11:46:25 +0100 |
commit | e74c2dc25334fb099d4a19240a7a9d2b4839da60 (patch) | |
tree | b4a24654492460bae71e8759ae3939fee322e817 | |
parent | 1a5e9e9af61d10071db431444c77a0df7d8ea421 (diff) |
[DOC] Add explanation to PATTERN of brackets
Fixes: #1933
-rw-r--r-- | doc/rofi.1 | 9 | ||||
-rw-r--r-- | doc/rofi.1.markdown | 7 |
2 files changed, 16 insertions, 0 deletions
@@ -1340,6 +1340,15 @@ replaced at runtime: .RE +.PP +It processes the string as follows: \fB\fC{key}\fR +is replaced by its value, if \fB\fC{key}\fR is not set it is removed. If the \fB\fC{key}\fR +is in between \fB\fC[]\fR all the text between \fB\fC[]\fR is removed if \fB\fC{key}\fR is not set. +Otherwise key is replaced and the \fB\fC[]\fR are removed. + +.PP +For example: \fB\fC{ssh-client} [-p {port}] {host}\fR + .SH THEMING .PP Please see \fBrofi-theme(5)\fP manpage for more information on theming. diff --git a/doc/rofi.1.markdown b/doc/rofi.1.markdown index 0f9c3cb6..67e3e0e5 100644 --- a/doc/rofi.1.markdown +++ b/doc/rofi.1.markdown @@ -880,6 +880,13 @@ replaced at runtime: - `{cmd}`: the command to execute - `{window}`: the window ID of the selected window (in `window-command`) +It processes the string as follows: `{key}` +is replaced by its value, if `{key}` is not set it is removed. If the `{key}` +is in between `[]` all the text between `[]` is removed if `{key}` is not set. +Otherwise key is replaced and the `[]` are removed. + +For example: `{ssh-client} [-p {port}] {host}` + ## THEMING Please see **rofi-theme(5)** manpage for more information on theming. |