2013-09-07 14:34:38 +02:00
|
|
|
[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
|
|
|
|
|
|
2013-09-07 12:27:10 +02:00
|
|
|
Shows disk space usage for a set partition.
|
|
|
|
|
|
|
|
|
|
Displays a notification when the partition is full or has low space.
|
|
|
|
|
|
|
|
|
|
mypartition = lain.widgets.fs()
|
|
|
|
|
|
|
|
|
|
The function takes a table as optional argument, which can contain:
|
|
|
|
|
|
|
|
|
|
Variable | Meaning | Type | Default
|
|
|
|
|
--- | --- | --- | ---
|
|
|
|
|
`partition` | Partition to monitor | string | "/"
|
|
|
|
|
`refresh_timeout` | Refresh timeout seconds | int | 600
|
2013-09-08 18:52:39 +02:00
|
|
|
`header` | Text to show before value | string | " Hdd "
|
2013-09-07 12:27:10 +02:00
|
|
|
`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
|
|
|
|
|
`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF"
|
2013-09-08 18:52:39 +02:00
|
|
|
`footer` | Text to show after value | string | " "
|
2013-09-07 12:27:10 +02:00
|
|
|
`shadow` | Hide the widget if `partition` < 90 | boolean | false
|
|
|
|
|
|
2013-09-09 14:00:23 +02:00
|
|
|
**Note**: `footer` can be markup text.
|
2013-09-07 12:27:10 +02:00
|
|
|
|
|
|
|
|
`lain.widgets.fs` outputs the following table:
|
|
|
|
|
|
2013-09-07 13:21:12 +02:00
|
|
|
Variable | Meaning | Type
|
|
|
|
|
--- | --- | ---
|
|
|
|
|
`widget` | The widget | `wibox.widget.textbox`
|
|
|
|
|
`show` | The notification | function
|
2013-09-07 12:27:10 +02:00
|
|
|
|
2013-09-07 13:21:34 +02:00
|
|
|
You can display the notification with a key binding like this:
|
2013-09-07 12:27:10 +02:00
|
|
|
|
|
|
|
|
awful.key({ altkey }, "h", function () mypartition.show(7) end),
|
|
|
|
|
|
|
|
|
|
where ``altkey = "Mod1"`` and ``show`` argument is an optional integer, meaning timeout seconds.
|
