aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorkolunmi <kolunmi@tutanota.com>2023-02-19 11:06:31 -0700
committerkolunmi <kolunmi@tutanota.com>2023-02-19 11:06:31 -0700
commit2710f3428d3ea25fbbbfa0df0ef6b227b7cf7601 (patch)
tree58af503cb19e8e79beb258a3bf6ccf3e9bb4470b /README.md
parentd25242c29949a209b5063e64f8ecd35b153fa260 (diff)
downloaddwlb-2710f3428d3ea25fbbbfa0df0ef6b227b7cf7601.tar.gz
minor fix and update README for status buttons
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8c356bf..0a04cfc 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,17 @@ dwl -s 'dwlb -font "monospace:size=16"'
Command options send instructions to existing instances of dwlb. All commands take at least one argument to specify a bar on which to operate. This may be zxdg_output_v1 name, "all" to affect all outputs, "selected" for the current output, or "first" for the first output in the internal list.
### Status Text
-The `-status` command is used to write status text. The text may contain in-line color commands in the following format: `^fg/bg(HEXCOLOR)`. For example, `^fg(ff0000)` would set the foreground red. Colors can be reset by omitting the hex value. `^^` represents a single `^` character. Color command functionality can be disabled with `-no-status-commands`.
+The `-status` command is used to write status text. The text may contain in-line commands in the following format: `^cmd(argument)`:
+
+| Command | Description |
+|---------------------|-----------------------------------------------------------------------------|
+| `^fg(HEXCOLOR)` | Sets foreground color to `HEXCOLOR`. |
+| `^bg(HEXCOLOR)` | Sets background color to `HEXCOLOR`. |
+| `^lm(SHELLCOMMAND)` | Begins or terminates left mouse button region with action `SHELLCOMMAND`. |
+| `^mm(SHELLCOMMAND)` | Begins or terminates middle mouse button region with action `SHELLCOMMAND`. |
+| `^rm(SHELLCOMMAND)` | Begins or terminates right mouse button region with action `SHELLCOMMAND`. |
+
+A color command with no argument reverts to the default value. `^^` represents a single `^` character. Status commands can be disabled with `-no-status-commands`.
## Other Options
Run `dwlb -h` for a full list of options.