From 0828bfa394c12520db723c23d7e1490d7775b068 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:55:52 -0700 Subject: [PATCH] Updated net (markdown) --- net.md | 21 +++++---------------- 1 file changed, 5 insertions(+), 16 deletions(-) diff --git a/net.md b/net.md index 82772d7..096b6a0 100644 --- a/net.md +++ b/net.md @@ -4,26 +4,15 @@ 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" +`settings` | User settings | function | empty function -**Note**: `spr` and `footer` can be a markup text. +Possible other values for `units` are 1 (byte) or multiple of 1024: 1024^2 (mb), 1024^3 (gb), ... . -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` can use the following `iface` strings: `carrier`, `state`, `sent`, `received`. \ No newline at end of file -- 2.39.2