]> 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:

projects / etc / awesome.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Updated bat (markdown)
[etc/awesome.git] / net.md
diff --git a/net.md b/net.md
index 59390dca11c0d21d78c1387685f810ac042e0a13..f1cd09542845b0cd1ed16ba511f022b8b1f46e07 100644 (file)
--- a/net.md
+++ b/net.md
@@ -1,26 +1,26 @@
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
+
 Monitors network interfaces and shows current traffic in a textbox. 
 
     mynet = lain.widgets.net()
 
 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
 --- | --- | --- | ---
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
+`timeout` | Refresh timeout seconds | int | 2
 `iface` | Network device | string | autodetected
 `iface` | Network device | string | autodetected
-`refresh_timeout` | Refresh timeout seconds | int | 2
 `units` | Units | int | 1024 (kilobytes) 
 `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
+
+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` strings:
 
 
-**Note**: `spr` can be a markup text.
+- `carrier` ("0", "1");
+- `state` ("up", "down");
+- `sent` and `received` (numbers).
 
 
-Possible value for `units` are stored in table `lain.widgets.net.units`, which contains:
+### output
 
 
-         ["b"] = 1,
-         ["kb"] = 1024,
-         ["mb"] = 1024^2,
-         ["gb"] = 1024^3
\ No newline at end of file
+A textbox.
\ No newline at end of file
awesome window-manager configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.