]> git.madduck.net Git - etc/awesome.git/blobdiff - net.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Created task (markdown)
[etc/awesome.git] / net.md
diff --git a/net.md b/net.md
index 82772d747e528ed1a5bf716fa2a7e74d6b6d1f99..f857239b2ec8d1454c9351b7973064f1fdd494ae 100644 (file)
--- a/net.md
+++ b/net.md
@@ -4,26 +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"
-`footer` | Text to append after value | string | ""
-`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` and `footer` can be a markup text.
-
-Possible value for `units` are stored in table `lain.widgets.net.units`, which contains:
-
-         ["b"] = 1,
-         ["kb"] = 1024,
-         ["mb"] = 1024^2,
-         ["gb"] = 1024^3
\ No newline at end of file
+`settings` | User settings | function | empty function
+
+Possible other values for `units` are 1 (byte) or multiple of 1024: 1024^2 (mb), 1024^3 (gb), and so on.
+
+`settings` can use the following `iface` related strings:
+
+- `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