summaryrefslogtreecommitdiff
path: root/volume-widget
diff options
context:
space:
mode:
authorzachir <zachir@librem.one>2023-10-19 08:23:38 -0500
committerzachir <zachir@librem.one>2023-10-19 08:23:38 -0500
commit3a984a9119cf431ec9eba7aafe5baf03376b379e (patch)
tree05c23648f9dcbef2cd603e63174099328c364032 /volume-widget
parent7090693bcf60efe23a0ce4531b02b6af93cafba8 (diff)
Update documentation
Diffstat (limited to 'volume-widget')
-rw-r--r--volume-widget/README.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/volume-widget/README.md b/volume-widget/README.md
index 4fc7f55..034a803 100644
--- a/volume-widget/README.md
+++ b/volume-widget/README.md
@@ -57,7 +57,7 @@ It is possible to customize the widget by providing a table with all or some of
| Name | Default | Description |
|---|---|---|
| `mixer_cmd` | `pavucontrol` | command to run on middle click (e.g. a mixer program) |
-| `step` | `5` | How much the volume is raised or lowered at once (in %) |
+| `step` | 5 | How much the volume is raised or lowered at once (in %) |
| `widget_type`| `icon_and_text`| Widget type, one of `horizontal_bar`, `vertical_bar`, `icon`, `icon_and_text`, `arc` |
| `device` | `pulse` | Select the device name to control |
@@ -98,11 +98,11 @@ _Note:_ if you are changing icons, the folder should contain following .svg imag
|---|---|---|
| `main_color` | `beautiful.fg_normal` | Color of the bar |
| `mute_color` | `beautiful.fg_urgent` | Color of the bar when mute |
-| `bg_color` | `'#ffffff11'` | Color of the bar's background |
-| `width` | `50` | The bar width |
-| `margins` | `10` | Top and bottom margins (if your wibar is 22 px high, bar will be 2 px = 22 - 2*10) |
-| `shape` | `'bar'` | [gears.shape](https://awesomewm.org/doc/api/libraries/gears.shape.html), could be `octogon`, `hexagon`, `powerline`, etc |
-| `with_icon` | `true` | Show volume icon|
+| `bg_color` | `#ffffff11` | Color of the bar's background |
+| `width` | 50 | The bar width |
+| `margins` | 10 | Top and bottom margins (if your wibar is 22 px high, bar will be 2 px = 22 - 2*10) |
+| `shape` | `bar` | [gears.shape](https://awesomewm.org/doc/api/libraries/gears.shape.html), could be `octogon`, `hexagon`, `powerline`, etc |
+| `with_icon` | true | Show volume icon|
_Note:_ I didn't figure out how does the `forced_height` property of progressbar widget work (maybe it doesn't work at all), thus there is a workaround with margins.
@@ -112,8 +112,8 @@ _Note:_ I didn't figure out how does the `forced_height` property of progressbar
|---|---|---|
| `main_color` | `beautiful.fg_normal` | Color of the bar |
| `mute_color` | `beautiful.fg_urgent` | Color of the bar when mute |
-| `bg_color` | `'#ffffff11'` | Color of the bar's background |
-| `width` | `10` | The bar width |
-| `margins` | `20` | Top and bottom margins (if your wibar is 22 px high, bar will be 2 px = 22 - 2*10) |
-| `shape` | `'bar'` | [gears.shape](https://awesomewm.org/doc/api/libraries/gears.shape.html), could be `octogon`, `hexagon`, `powerline`, etc |
-| `with_icon` | `true` | Show volume icon|
+| `bg_color` | `#ffffff11` | Color of the bar's background |
+| `width` | 10 | The bar width |
+| `margins` | 20 | Top and bottom margins (if your wibar is 22 px high, bar will be 2 px = 22 - 2*10) |
+| `shape` | `bar` | [gears.shape](https://awesomewm.org/doc/api/libraries/gears.shape.html), could be `octogon`, `hexagon`, `powerline`, etc |
+| `with_icon` | true | Show volume icon|