X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/02e6f1361ee690954d69e046e8d0fb3fccf694a2..2882ef92c6b9454ca153f729003fa2374fb7ef55:/net.md?ds=sidebyside

diff --git a/net.md b/net.md
index b02c239..f857239 100644
--- a/net.md
+++ b/net.md
@@ -4,25 +4,23 @@ Monitors network interfaces and shows current traffic in a textbox.
 
     mynet = lain.widgets.net()
 
-The function takes a table as optional argument, which can contain:
+### input table
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
+`timeout` | Refresh timeout seconds | int | 2
 `iface` | Network device | string | autodetected
-`refresh_timeout` | Refresh timeout seconds | int | 2
 `units` | Units | int | 1024 (kilobytes) 
-`spr` | Separator text between download and upload values | string | " "
-`header` | Text to show before value | string | `iface`
-`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
-`color_up` | Upload value color | string | `beautiful.fg_focus` or "#FFFFFF"
-`color_down` | Download value color | string | `beautiful.fg_focus` or "#FFFFFF"
-`app` | Net program to spawn on click | string | "sudo wifi-menu"
+`settings` | User settings | function | empty function
 
-**Note**: `spr` can be a markup text.
+Possible other values for `units` are 1 (byte) or multiple of 1024: 1024^2 (mb), 1024^3 (gb), and so on.
 
-Possible value for `units` are stored in table `lain.widgets.net.units`, which contains:
+`settings` can use the following `iface` related strings:
 
-         ["b"] = 1,
-         ["kb"] = 1024,
-         ["mb"] = 1024^2,
-         ["gb"] = 1024^3
\ No newline at end of file
+- `net_now.carrier` ("0", "1");
+- `net_now.state` ("up", "down");
+- `net_now.sent` and `net_now.received` (numbers).
+
+### output
+
+A textbox.
\ No newline at end of file