awesomewm-mirrors
/
lain
mirror of https://github.com/lcpz/lain.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Created fs (markdown)

This commit is contained in:
Luke Bonham 2013-09-07 03:27:10 -07:00
parent 11d7af8cf3
commit c1d7ccacb1
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
fs.md Normal file
View File

@ -0,0 +1,32 @@
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
`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 | "%"
`shadow` | Hide the widget if `partition` < 90 | boolean | false
**Note**: `footer` color is `color`.
`lain.widgets.fs` outputs the following table:
Variable | Type
--- | ---
`widget` | `wibox.widget.textbox`
`show` | function
You can display a notification of current disk space usage with the following key binding:
awful.key({ altkey }, "h", function () mypartition.show(7) end),
where ``altkey = "Mod1"`` and ``show`` argument is an optional integer, meaning timeout seconds.