fs.md

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