awesomewm-mirrors
/
lain
mirror of https://github.com/lcpz/lain.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated net (markdown)

This commit is contained in:
Luke Bonham 2013-09-10 14:55:52 -07:00 committed by copycat-killer
parent de3e1da7cb
commit 0828bfa394
1 changed files with 5 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
net.md
View File

@ -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
`settings` can use the following `iface` strings: `carrier`, `state`, `sent`, `received`.