net.md

   1 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
   2
   3 Monitors network interfaces and shows current traffic in a textbox.
   4
   5     mynet = lain.widgets.net()
   6
   7 The function takes a table as optional argument, which can contain:
   8
   9 Variable | Meaning | Type | Default
  10 --- | --- | --- | ---
  11 `iface` | Network device | string | autodetected
  12 `refresh_timeout` | Refresh timeout seconds | int | 2
  13 `units` | Units | int | 1024 (kilobytes)
  14 `spr` | Separator text between download and upload values | string | " "
  15 `header` | Text to show before value | string | `iface`
  16 `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
  17 `footer` | Text to append after value | string | ""
  18 `color_up` | Upload value color | string | `beautiful.fg_focus` or "#FFFFFF"
  19 `color_down` | Download value color | string | `beautiful.fg_focus` or "#FFFFFF"
  20 `app` | Net program to spawn on click | string | "sudo wifi-menu"
  21
  22 **Note**: `spr` and `footer` can be a markup text.
  23
  24 Possible value for `units` are stored in table `lain.widgets.net.units`, which contains:
  25
  26          ["b"] = 1,
  27          ["kb"] = 1024,
  28          ["mb"] = 1024^2,
  29          ["gb"] = 1024^3