fs.md

   1 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
   2
   3 Shows disk space usage for a set partition.
   4
   5 Displays a notification when the partition is full or has low space.
   6
   7     mypartition = lain.widgets.fs()
   8
   9 The function takes a table as optional argument, which can contain:
  10
  11 Variable | Meaning | Type | Default
  12 --- | --- | --- | ---
  13 `partition` | Partition to monitor | string | "/"
  14 `refresh_timeout` | Refresh timeout seconds | int | 600
  15 `header` | Text to show before value | string | " Hdd "
  16 `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
  17 `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF"
  18 `footer` | Text to show after value | string | " "
  19 `shadow` | Hide the widget if `partition` < 90 | boolean | false
  20
  21 **Note**: `footer` color is `color`.
  22
  23 `lain.widgets.fs` outputs the following table:
  24
  25 Variable | Meaning | Type
  26 --- | --- | ---
  27 `widget` | The widget | `wibox.widget.textbox`
  28 `show` | The notification | function
  29
  30 You can display the notification with a key binding like this:
  31
  32     awful.key({ altkey }, "h", function () mypartition.show(7) end),
  33
  34 where ``altkey = "Mod1"`` and ``show`` argument is an optional integer, meaning timeout seconds.