Updated net (markdown)

[etc/awesome.git] / net.md

diff --git a/net.md b/net.md
index 58b27e3cb9814072db05c96405d393db0534a7bd..a1b6d35f4b6ac637ebbc56dd7a13cefa5b217778 100644 (file)
--- a/net.md
+++ b/net.md
@@ -1,30 +1,22 @@
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
+
 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"
-
-**Note**: `spr` can be a markup text.
+`settings` | User settings | function | empty function
 
-Possible value for `units` are stored in table `lain.widgets.net.units`, which contains:
+Possible other values for `units` are 1 (byte) or multiple of 1024: 1024^2 (mb), 1024^3 (gb), and so on.
 
-   {
-       ["b"] = 1,
-       ["kb"] = 1024,
-       ["mb"] = 1024^2,
-       ["gb"] = 1024^3
-   }
+`settings` can use the following `iface` strings: `carrier` ("0", "1"), `state` ("up", "down"), `sent`, `received` (numbers).
 
+### output
 
+A textbox.
\ No newline at end of file