From: Luke Bonham Date: Sat, 7 Sep 2013 10:27:10 +0000 (-0700) Subject: Created fs (markdown) X-Git-Url: https://git.madduck.net/etc/awesome.git/commitdiff_plain/d2900b69c87bbb4c6322fdf18bf3052998ee1430?ds=sidebyside;hp=47cfa9550bd383d7c0b08af262d589bc98d9d5d8 Created fs (markdown) --- diff --git a/fs.md b/fs.md new file mode 100644 index 0000000..98016fb --- /dev/null +++ b/fs.md @@ -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. \ No newline at end of file