X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/e25277ef15b7bcbdcbd2033e6f1488f042111610..9f9b4c959dfbcb6ae82d56cf1cedb7eb04f791e8:/fs.md?ds=sidebyside diff --git a/fs.md b/fs.md index 0659682..7ee1f5c 100644 --- a/fs.md +++ b/fs.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + Shows disk space usage for a set partition. Displays a notification when the partition is full or has low space. @@ -13,19 +15,19 @@ Variable | Meaning | Type | Default `header` | Text to show before value | string | " Hdd " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" -`footer` | Text to show after value | string | "%" +`footer` | Text to show after value | string | " " `shadow` | Hide the widget if `partition` < 90 | boolean | false -**Note**: `footer` color is `color`. +**Note**: `footer` can be markup text. `lain.widgets.fs` outputs the following table: -Variable | Type ---- | --- -`widget` | `wibox.widget.textbox` -`show` | function +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`show` | The notification | function -You can display a notification of current disk space usage with a key binding like this: +You can display the notification with a key binding like this: awful.key({ altkey }, "h", function () mypartition.show(7) end),