From 3387b4caef938fc40d30dc0adb22386f9f3342ab Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:05:00 -0700 Subject: [PATCH 001/303] Initial Commit --- Home.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 Home.md diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..a520d81 --- /dev/null +++ b/Home.md @@ -0,0 +1 @@ +Welcome to the lain wiki! \ No newline at end of file From 7ec0f4f1534e576130b5283c753d30b1531bf92d Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:10:58 -0700 Subject: [PATCH 002/303] Created To start (markdown) --- To-start.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 To-start.md diff --git a/To-start.md b/To-start.md new file mode 100644 index 0000000..9135be2 --- /dev/null +++ b/To-start.md @@ -0,0 +1,26 @@ +All you have to do is to include the module: + + local lain = require("lain") + +Some widgets require a terminal, lain default is `xterm`, but can be changed: + + lain.widgets.terminal = "urxvtc" + +or + + lain.widgets.terminal = terminal + +providing you have something like this: + + terminal = "urxvtc" + +in your `rc.lua`. + +`terminal` may also be a lua function that accepts one parameter. +Something like this: + + function footerm(cmd) + -- elaborate cmd + end + + lain.widgets.terminal = footerm \ No newline at end of file From f026d1011a3b28c1f649b32afe85920175355b38 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:11:44 -0700 Subject: [PATCH 003/303] Created mem (markdown) --- mem.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 mem.md diff --git a/mem.md b/mem.md new file mode 100644 index 0000000..58ccf72 --- /dev/null +++ b/mem.md @@ -0,0 +1,19 @@ +Show used memory and total memory in MiB. + + mymem = lain.widgets.mem() + + +The function takes a table as an optional argument. That table may +contain: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`refresh_timeout` | Refresh timeout seconds | int | 10 +`show_swap` | Show amount of used swap space? | boolean | false +`show_total` | Show amout of total memory? | boolean | false +`header` | Text to show before value | string | " Vol " +`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" +`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" +`footer` | Text to show after value | string | "MB" + +**Note**: `footer` color is `color`. \ No newline at end of file From 095e7e28bfef98509b296ed3e0f0b34c69cf058c Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:12:36 -0700 Subject: [PATCH 004/303] Created maildir (markdown) --- maildir.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 maildir.md diff --git a/maildir.md b/maildir.md new file mode 100644 index 0000000..df5f6fe --- /dev/null +++ b/maildir.md @@ -0,0 +1,37 @@ +Checks your maildirs. + +Maildirs are structured as follows: + + ~/Mail + . + |-- arch + | |-- cur + | |-- new + | `-- tmp + |-- gmail + | |-- cur + | |-- new + | `-- tmp + . + . + . + +therefore the widget checks whether there are files in the `new` directories. +If there's new mail, the textbox will say something like "mail: bugs(3), system(1)", otherwise it says +"no mail". + + mymaildir= lain.widgets.maildir("/path/to/my/maildir") + +The function takes a table as optional argument, which can contain: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`mailpath` | Path to your maildir | string | "~/Mail" +`ignore_boxes` | A list of boxes to ignore | table | empty table +`refresh_timeout` | Refresh timeout seconds | int | 60 +`header` | Text to show before value | string | " Mail " +`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" +`color_newmail` | New mail value color | string | `beautiful.fg_focus` or "#FFFFFF" +`color_nomail` | No mail value color | string | `beautiful.fg_normal` or "#FFFFFF" +`app` | Mail program to spawn on click | string | "mutt"| boolean | false +`shadow` | Hide widget when there are no mails | boolean | false \ No newline at end of file From cce1bce3306b774f3a8a35128f76c93f26960c29 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:16:55 -0700 Subject: [PATCH 005/303] Created Layouts (markdown) --- Layouts.md | 271 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 271 insertions(+) create mode 100644 Layouts.md diff --git a/Layouts.md b/Layouts.md new file mode 100644 index 0000000..b5aacc5 --- /dev/null +++ b/Layouts.md @@ -0,0 +1,271 @@ +Currently, there are **7** layouts. + + lain/layout + . + |-- cascade + |-- cascadetile + |-- centerwork + |-- termfair + |-- uselessfair + |-- uselesspiral + `-- uselesstile + +Just add your favourites to ``layouts`` table: + + layouts = + { + ... + lain.layout.termfair, + lain.layout.uselesstile, + ... + } + +Or set them on specific tags like this: + + awful.layout.set(lain.layout.uselessfair, tags[1][7]) + +How do layouts work? +========================= + +cascade +------- + +Cascade all windows of a tag. + +You can control the offsets by setting those two variables: + + lain.layout.cascade.cascade_offset_x = 64 + lain.layout.cascade.cascade_offset_y = 16 + +The following reserves space for 5 windows: + + lain.layout.cascade.nmaster = 5 + +That is, no window will get resized upon the creation of a new window, +unless there's more than 5 windows. + +cascadetile +----------- + +Similar to `awful.layout.suit.tile` layout, however, clients in the slave +column are cascaded instead of tiled. + +Left column size can be set, otherwise is controlled by `mwfact` of the +tag. Additional windows will be opened in another column on the right. +New windows are placed above old windows. + +Whether the slave column is placed on top of the master window or not is +controlled by the value of `ncol`. A value of 1 means "overlapping slave column" +and anything else means "don't overlap windows". + +Usage example: + + lain.layout.cascadetile.cascade_offset_x = 2 + lain.layout.cascadetile.cascade_offset_y = 32 + lain.layout.cascadetile.extra_padding = 5 + lain.layout.cascadetile.nmaster = 5 + lain.layout.ncol = 1 + +`extra_padding` reduces the size of the master window if "overlapping +slave column" is activated. This allows you to see if there are any +windows in your slave column. + +Setting `cascade_offset_x` to a very small value or even 0 is reccommended to avoid wasting space. + +centerwork +---------- + +You start with one window, centered horizontally: + + +--------------------------+ + | +----------+ | + | | | | + | | | | + | | | | + | | MAIN | | + | | | | + | | | | + | | | | + | | | | + | +----------+ | + +--------------------------+ + +This is your main working window. You do most of the work right here. +Sometimes, you may want to open up additional windows. They're put in +the following four slots: + + +--------------------------+ + | +---+ +----------+ +---+ | + | | | | | | | | + | | 0 | | | | 1 | | + | | | | | | | | + | +---+ | MAIN | +---+ | + | +---+ | | +---+ | + | | | | | | | | + | | 2 | | | | 3 | | + | | | | | | | | + | +---+ +----------+ +---+ | + +--------------------------+ + +Yes, the number "four" is fixed. In total, you can only have five open +windows with this layout. Additional windows are not managed and set to +floating mode. **This is intentional**. + +You can set the order of the four auxiliary windows. This is the default +configuration: + + lain.layout.centerwork.top_left = 0 + lain.layout.centerwork.top_right = 1 + lain.layout.centerwork.bottom_left = 2 + lain.layout.centerwork.bottom_right = 3 + +This means: The bottom left slot will be occupied by the third window +(not counting the main window). Suppose you want your windows to appear +in this order: + + +--------------------------+ + | +---+ +----------+ +---+ | + | | | | | | | | + | | 3 | | | | 0 | | + | | | | | | | | + | +---+ | MAIN | +---+ | + | +---+ | | +---+ | + | | | | | | | | + | | 2 | | | | 1 | | + | | | | | | | | + | +---+ +----------+ +---+ | + +--------------------------+ + +This would require you to use these settings: + + lain.layout.centerwork.top_left = 3 + lain.layout.centerwork.top_right = 0 + lain.layout.centerwork.bottom_left = 2 + lain.layout.centerwork.bottom_right = 1 + +*Please note:* If you use Awesome's default configuration, navigation in +this layout may be very confusing. How do you get from the main window +to satellite ones depends on the order in which the windows are opened. +Thus, use of `awful.client.focus.bydirection()` is suggested. +Here's an example: + + globalkeys = awful.util.table.join( + ... + awful.key({ modkey }, "j", + function() + awful.client.focus.bydirection("down") + if client.focus then client.focus:raise() end + end), + awful.key({ modkey }, "k", + function() + awful.client.focus.bydirection("up") + if client.focus then client.focus:raise() end + end), + awful.key({ modkey }, "h", + function() + awful.client.focus.bydirection("left") + if client.focus then client.focus:raise() end + end), + awful.key({ modkey }, "l", + function() + awful.client.focus.bydirection("right") + if client.focus then client.focus:raise() end + end), + ... + ) + +termfair +-------- + +I do a lot of work on terminals. The common tiling algorithms usually +maximize windows, so you'll end up with a terminal that has about 200 +columns or more. That's way too much. Have you ever read a manpage in a +terminal of this size? + +This layout restricts the size of each window. Each window will have the +same width but is variable in height. Furthermore, windows are +left-aligned. The basic workflow is as follows (the number above the +screen is the number of open windows, the number in a cell is the fixed +number of a client): + + (1) (2) (3) + +---+---+---+ +---+---+---+ +---+---+---+ + | | | | | | | | | | | | + | 1 | | | -> | 2 | 1 | | -> | 3 | 2 | 1 | -> + | | | | | | | | | | | | + +---+---+---+ +---+---+---+ +---+---+---+ + + (4) (5) (6) + +---+---+---+ +---+---+---+ +---+---+---+ + | 4 | | | | 5 | 4 | | | 6 | 5 | 4 | + +---+---+---+ -> +---+---+---+ -> +---+---+---+ + | 3 | 2 | 1 | | 3 | 2 | 1 | | 3 | 2 | 1 | + +---+---+---+ +---+---+---+ +---+---+---+ + +The first client will be located in the left column. When opening +another window, this new window will be placed in the left column while +moving the first window into the middle column. Once a row is full, +another row above it will be created. + +Default number of columns and rows are respectively taken from `nmaster` +and `ncol` values in `awful.tag`, but you can set your own. + +For example, this sets `termfair` to 3 columns and at least 1 row: + + lain.layout.termfair.nmaster = 3 + lain.layout.termfair.ncol = 1 + +uselessfair, uselesspiral & uselesstile +--------------------------------------- +These are duplicates of the stock `fair`, `spiral` and `tile` layouts. +However, "useless gaps" (see below) have been added. + +Useless gaps +============ + +Useless gaps are gaps between windows. They are "useless" because they +serve no special purpose despite increasing overview. I find it easier +to recognize window boundaries if windows are set apart a little bit. + +The `uselessfair` layout, for example, looks like this: + + +================+ + # # + # +---+ +---+ # + # | 1 | | | # + # +---+ | | # + # | 3 | # + # +---+ | | # + # | 2 | | | # + # +---+ +---+ # + # # + +================+ + +All of lain layouts provide useless gaps. To set the width of the gaps, +you have to add an item called `useless_gap_width` in your `theme.lua`. +If it doesn't exist, the width will default to 0. +Example: + + ... + theme.useless_gap_width = "5" + ... + +What about layout icons? +======================== + +They are located in ``lain/icons/layout``. + +To use them, add lines to your ``theme.lua`` like this: + + ... + theme.lain_icons = os.getenv("HOME") .. "/.config/awesome/lain/icons/layout/default/" + theme.layout_termfair = theme.lain_icons .. "termfairw.png" + theme.layout_cascade = theme.lain_icons .. "cascadew.png" + theme.layout_cascadetile = theme.lain_icons .. "cascadetilew.png" + theme.layout_centerwork = theme.lain_icons .. "centerworkw.png" + ... + +Credits goes to [Nicolas Estibals](https://github.com/nestibal) for creating +layout icons for default theme. + +You can use them as a template for your custom versions. \ No newline at end of file From b7cdfbeaacdf9d767a963576b05ef9386e50045a Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:20:25 -0700 Subject: [PATCH 006/303] Updated Layouts (markdown) --- Layouts.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/Layouts.md b/Layouts.md index b5aacc5..7f50efe 100644 --- a/Layouts.md +++ b/Layouts.md @@ -63,8 +63,8 @@ Usage example: lain.layout.cascadetile.cascade_offset_x = 2 lain.layout.cascadetile.cascade_offset_y = 32 lain.layout.cascadetile.extra_padding = 5 - lain.layout.cascadetile.nmaster = 5 - lain.layout.ncol = 1 + lain.layout.cascadetile.nmaster = 5 + lain.layout.ncol = 1 `extra_padding` reduces the size of the master window if "overlapping slave column" is activated. This allows you to see if there are any @@ -150,7 +150,7 @@ Thus, use of `awful.client.focus.bydirection()` is suggested. Here's an example: globalkeys = awful.util.table.join( - ... + ... awful.key({ modkey }, "j", function() awful.client.focus.bydirection("down") @@ -218,6 +218,7 @@ For example, this sets `termfair` to 3 columns and at least 1 row: uselessfair, uselesspiral & uselesstile --------------------------------------- These are duplicates of the stock `fair`, `spiral` and `tile` layouts. + However, "useless gaps" (see below) have been added. Useless gaps @@ -246,9 +247,7 @@ you have to add an item called `useless_gap_width` in your `theme.lua`. If it doesn't exist, the width will default to 0. Example: - ... theme.useless_gap_width = "5" - ... What about layout icons? ======================== @@ -257,13 +256,11 @@ They are located in ``lain/icons/layout``. To use them, add lines to your ``theme.lua`` like this: - ... theme.lain_icons = os.getenv("HOME") .. "/.config/awesome/lain/icons/layout/default/" theme.layout_termfair = theme.lain_icons .. "termfairw.png" theme.layout_cascade = theme.lain_icons .. "cascadew.png" theme.layout_cascadetile = theme.lain_icons .. "cascadetilew.png" theme.layout_centerwork = theme.lain_icons .. "centerworkw.png" - ... Credits goes to [Nicolas Estibals](https://github.com/nestibal) for creating layout icons for default theme. From 6c93e00e676792632a81435a96e7ddbaebae859a Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:24:05 -0700 Subject: [PATCH 007/303] Created imap (markdown) --- imap.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 imap.md diff --git a/imap.md b/imap.md new file mode 100644 index 0000000..f12a1e7 --- /dev/null +++ b/imap.md @@ -0,0 +1,64 @@ +Check new mails over IMAP protocol. + +Dependencies: + +- Python3 + +New mails are notified through a notification like this: + + +---------------------------------------------------+ + | +---+ | + | |\ /| donald@disney.org has 3 new messages | + | +---+ | + | Latest From: Mickey Mouse | + | Subject: Re: pay raise | + | | + | Not after what you did yesterday. | + | Daisy told me everything [...] | + | | + +---------------------------------------------------+ + +Text will be cut if the mail is too long. + + myimapcheck = lain.widgets.imap(args) + +The function takes a table as argument. Required table parameters are: + +Variable | Type +--- | --- +`server` | string +`mail` | string +`password` | string + +while the optional are: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`port` | IMAP port | int | 993 +`refresh_timeout` | Refresh timeout seconds | int | 60 +`header` | Text to show before value | string | " Mail " +`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" +`color_newmail` | New mail value color | string | `beautiful.fg_focus` or "#FFFFFF" +`color_nomail` | No mail value color | string | `beautiful.fg_normal` or "#FFFFFF" +`mail_encoding` | Mail character encoding | string | autodetected +`maxlen` | Maximum chars to display in notification | int | 200 +`app` | Mail program to spawn on click | string | "mutt" +`shadow` | Hide widget when there are no mails | boolean | false +`is_plain` | Define whether `password` is a plain password (true) or a function that retrieves it (false) | boolean | false + +Let's focus better on `is_plain`. + +You can just set your password like this: + + args.is_plain = false + args.password = "mypassword" + +and you'll have the same security provided by `~/.netrc` + +**Or** you can use a keyring, like [python keyring](https://pypi.python.org/pypi/keyring): + + args.password = "keyring get password" + +When `is_plain == false`, it *executes* `password` before using it, so you can also use whatever password fetching solution you want. + +You can also define your custom icon for the naughty notification. Just set `lain_mail_notify` into `theme.lua`. \ No newline at end of file From 4a72f6f3942a0838ff8a13fffcd4c3a08736e753 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:25:06 -0700 Subject: [PATCH 008/303] Updated imap (markdown) --- imap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/imap.md b/imap.md index f12a1e7..3c049dd 100644 --- a/imap.md +++ b/imap.md @@ -53,7 +53,7 @@ You can just set your password like this: args.is_plain = false args.password = "mypassword" -and you'll have the same security provided by `~/.netrc` +and you'll have the same security provided by `~/.netrc`. **Or** you can use a keyring, like [python keyring](https://pypi.python.org/pypi/keyring): From 11d7af8cf33203a30f49a447a466079b022a8f43 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:26:19 -0700 Subject: [PATCH 009/303] Updated imap (markdown) --- imap.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/imap.md b/imap.md index 3c049dd..5f8ce30 100644 --- a/imap.md +++ b/imap.md @@ -61,4 +61,6 @@ and you'll have the same security provided by `~/.netrc`. When `is_plain == false`, it *executes* `password` before using it, so you can also use whatever password fetching solution you want. -You can also define your custom icon for the naughty notification. Just set `lain_mail_notify` into `theme.lua`. \ No newline at end of file +You can also define your custom icon for the naughty notification. Just set `lain_mail_notify` into `theme.lua`: + + theme.lain_mail_notify = "/path/to/my/icon" \ No newline at end of file From c1d7ccacb1671088bfa9089b76916e1a9792bed6 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:27:10 -0700 Subject: [PATCH 010/303] Created fs (markdown) --- fs.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 fs.md diff --git a/fs.md b/fs.md new file mode 100644 index 0000000..98016fb --- /dev/null +++ b/fs.md @@ -0,0 +1,32 @@ +Shows disk space usage for a set partition. + +Displays a notification when the partition is full or has low space. + + mypartition = lain.widgets.fs() + +The function takes a table as optional argument, which can contain: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`partition` | Partition to monitor | string | "/" +`refresh_timeout` | Refresh timeout seconds | int | 600 +`header` | Text to show before value | string | " Hdd " +`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" +`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" +`footer` | Text to show after value | string | "%" +`shadow` | Hide the widget if `partition` < 90 | boolean | false + +**Note**: `footer` color is `color`. + +`lain.widgets.fs` outputs the following table: + +Variable | Type +--- | --- +`widget` | `wibox.widget.textbox` +`show` | function + +You can display a notification of current disk space usage with the following key binding: + + awful.key({ altkey }, "h", function () mypartition.show(7) end), + +where ``altkey = "Mod1"`` and ``show`` argument is an optional integer, meaning timeout seconds. \ No newline at end of file From d866043cd7ef8b9861573fba00f9e95b186f261d Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:28:21 -0700 Subject: [PATCH 011/303] Created cpu (markdown) --- cpu.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 cpu.md diff --git a/cpu.md b/cpu.md new file mode 100644 index 0000000..bdcc128 --- /dev/null +++ b/cpu.md @@ -0,0 +1,15 @@ +Shows the average CPU usage percent for a given amount of time. + + mycpuusage = lain.widgets.cpu() + +The function takes a table as optional argument, which can contain: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`refresh_timeout` | Refresh timeout seconds | int | 10 +`header` | Text to show before value | string | " Vol " +`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" +`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" +`footer` | Text to add after value | string | "%" + +**Note**: `footer` color is `color`. \ No newline at end of file From 022552ba3389c8b617c216e0fa2ded8571353555 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:28:39 -0700 Subject: [PATCH 012/303] Updated cpu (markdown) --- cpu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpu.md b/cpu.md index bdcc128..ce59a15 100644 --- a/cpu.md +++ b/cpu.md @@ -7,7 +7,7 @@ The function takes a table as optional argument, which can contain: Variable | Meaning | Type | Default --- | --- | --- | --- `refresh_timeout` | Refresh timeout seconds | int | 10 -`header` | Text to show before value | string | " Vol " +`header` | Text to show before value | string | " Cpu " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" `footer` | Text to add after value | string | "%" From 82d4aa066309b80e870a3b0b8e346b888cae4004 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:30:54 -0700 Subject: [PATCH 013/303] Created calendar (markdown) --- calendar.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 calendar.md diff --git a/calendar.md b/calendar.md new file mode 100644 index 0000000..06e1b48 --- /dev/null +++ b/calendar.md @@ -0,0 +1,35 @@ +Attaches a calendar to a ``widget``. Example: + + lain.widgets.calendar:attach(mytextclock) + +- Left click: switch to previous month. +- Right click: switch to next month. + +Optionally you can call the function with background and foreground colors arguments, both or just one: + + lain.widgets.calendar:attach(mytextclock, "#FFFFFF", "#000000") + -- or + lain.widgets.calendar:attach(mytextclock, "#FFFFFF") + -- or + lain.widgets.calendar:attach(mytextclock, nil, "#000000") + +Notification will show an icon displaying current day, and formatted output +from ``cal`` with current day highlighted. + +Calendar icons are placed in [lain/icons/cal](https://github.com/copycat-killer/lain/tree/master/icons/cal), default set being ``white``. + +You can add your own set, and tell lain to use it like this: + + lain.widgets.calendar.icons_dir = lain.widgets.icons_dir .. "cal/myicons" + +also, you can set notification font size: + + lain.widgets.calendar.font_size = 14 + +default is 12. + +Finally, you can call the notification with a key binding like this: + + awful.key({ altkey }, "c", function () lain.widgets.calendar:show(7) end), + +where ``altkey = "Mod1"`` and ``show`` argument is an optional integer, meaning timeout seconds. \ No newline at end of file From bde0a1a4175c0f2fb4ee6e318949f0884c1636ef Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:33:28 -0700 Subject: [PATCH 014/303] Created borderbox (markdown) --- borderbox.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 borderbox.md diff --git a/borderbox.md b/borderbox.md new file mode 100644 index 0000000..cdeece2 --- /dev/null +++ b/borderbox.md @@ -0,0 +1,47 @@ +Creates a thin wibox at a position relative to another wibox. + +This allows to create "borders" for your wiboxes. + + lain.widget.borderbox(relbox, s, args) + +`relbox` and `s` (an integer being screen number) are required arguments, `args` is an optional table +which can contain: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`position` | Position of the additional box | string | "above" +`color` | Color of the additional box | string | `#FFFFFF` +`size` | Size in pixels of the additional box | int | 1 + +Possible values for `.position`: `above`, `below`, `left` and `right`. + +### Example usage + +Think of this as a wibox: + + [======================] + +If `args.position = "above"`, then you'll get an additional wibox below +the existing one: + + ________________________ + [======================] + +It'll match position and size of the existing wibox. + +If your main wiboxes are stored in a table called `mywibox` (one wibox +for each screen) and are located at the bottom of your screen, then this +adds a borderbox on top of them: + + -- Layout section + for s = 1, screen.count() do + ... + + -- Most likely, you'll want to do this as well: + awful.screen.padding(screen[s], { bottom = 1 }) + + -- Create the box and place it above the existing box. + lain.widgets.borderbox(mywibox[s], s, { position = "above" } ) + + ... + end \ No newline at end of file From 0fb405d2a53257a83661b1cb1bbc8f23ff9b7c41 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:34:00 -0700 Subject: [PATCH 015/303] Created bat (markdown) --- bat.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 bat.md diff --git a/bat.md b/bat.md new file mode 100644 index 0000000..9e2d8c5 --- /dev/null +++ b/bat.md @@ -0,0 +1,18 @@ +Shows the remaining time and percentage capacity of your laptop battery, as well as +the current wattage. + +Displays a notification when battery is low or critical. + + mybattery = lain.widgets.bat() + +The function takes a table as optional argument, which can contain: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`battery` | Identifier of the battery | string | "BAT0" +`show_all` | Show all values (true), or only remaining capacity (false) | boolean | false +`refresh_timeout` | Refresh timeout seconds | int | 30 +`header` | Text to show before value | string | " Vol " +`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" +`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" +`shadow` | Hide the widget when battery is not present | boolean | false \ No newline at end of file From c4b8e98d191882af19038ff776d5b697745256da Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:37:03 -0700 Subject: [PATCH 016/303] Created alsabar (markdown) --- alsabar.md | 81 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 alsabar.md diff --git a/alsabar.md b/alsabar.md new file mode 100644 index 0000000..a4d1768 --- /dev/null +++ b/alsabar.md @@ -0,0 +1,81 @@ +Shows and controls alsa volume with a progressbar. + +Dependencies: + +- alsa-utils + +Plus tooltips, notifications, and color changes at mute/unmute switch. + + myvolumebar = lain.widgets.alsabar() + +* Left click: Launch `alsamixer` in your `terminal`. +* Right click: Mute/unmute. +* Scroll wheel: Increase/decrase volume. + +The function takes a table as optional argument, which can contain: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`width` | Bar width | int | 63 +`height` | Bar height | int | 1 +`ticks` | Set bar ticks on | boolean | true +`ticks_size` | Ticks size | int | 7 +`vertical` | Set the bar vertical | boolean | false +`channel` | Mixer channel | string | "Master" +`step` | Step at which volume is increased/decreased | string | "5%" +`colors` | Bar colors | table | see **colors** +`notifications` | Notifications settings | table | see **notifications** + +### colors + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`background` | Bar backgrund color | string | `beautiful.bg_normal` +`mute` | Bar mute color | string | "#EB8F8F" +`unmute` | Bar unmute color | string | "#A4CE8A" + +### notifications + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`font` | Notifications font | string | The one defined in `beautiful.font` +`font_size` | Notifications font size | string | "11" +`bar_size` | Wibox height | int | 18 + +It's **crucial** to set `notifications.bar_size` to your `mywibox[s]` height, +**if** you have set it different than default (18). + +`lain.widgets.alsabar` outputs the following table: + +Variable | Type +--- | --- +`widget` | `awful.widget.progressbar` +`channel` | string +`step` | string +`notify` | function + +Finally, you can control the widget with the following key bindings: + + -- Volume control + awful.key({ altkey }, "Up", + function () + awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "+") + volume.notify() + end), + awful.key({ altkey }, "Down", + function () + awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "-") + volume.notify() + end), + awful.key({ altkey }, "m", + function () + awful.util.spawn("amixer set Master playback toggle") + volume.notify() + end), + awful.key({ altkey, "Control" }, "m", + function () + awful.util.spawn("amixer set Master playback 100%", false ) + volume.notify() + end), + +where `altkey = "Mod1"`. \ No newline at end of file From 8b82ccb058471a0684d3c0608a8d18b8a11975a9 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:37:23 -0700 Subject: [PATCH 017/303] Updated alsabar (markdown) --- alsabar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/alsabar.md b/alsabar.md index a4d1768..76e1205 100644 --- a/alsabar.md +++ b/alsabar.md @@ -2,7 +2,7 @@ Shows and controls alsa volume with a progressbar. Dependencies: -- alsa-utils +- alsa-utils (of course) Plus tooltips, notifications, and color changes at mute/unmute switch. From 31e3ed277d41e5fc6cbeca33b4285f4ece6da46d Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:38:35 -0700 Subject: [PATCH 018/303] Updated alsabar (markdown) --- alsabar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/alsabar.md b/alsabar.md index 76e1205..53c49b4 100644 --- a/alsabar.md +++ b/alsabar.md @@ -54,7 +54,7 @@ Variable | Type `step` | string `notify` | function -Finally, you can control the widget with the following key bindings: +Finally, you can control the widget with key bindings like these: -- Volume control awful.key({ altkey }, "Up", From 201e219a1849e5d74604550c4d88bfdbc4535899 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:39:52 -0700 Subject: [PATCH 019/303] Created alsa (markdown) --- alsa.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 alsa.md diff --git a/alsa.md b/alsa.md new file mode 100644 index 0000000..5a3497b --- /dev/null +++ b/alsa.md @@ -0,0 +1,52 @@ +Shows and controls alsa volume with a textbox. + + myvolume = lain.widgets.alsa() + +* Left click: Launch `alsamixer` in your `terminal`. +* Right click: Mute/unmute. +* Scroll wheel: Increase/decrase volume. + +The function takes a table as optional argument, which can contain: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`channel` | Mixer channel | string | "Master" +`step` | Step at which volume is increased/decreased | string | "1%" +`header` | Text to show before value | string | " Vol " +`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" +`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" + +and outputs the following table: + +Variable | Type +--- | --- +`widget` | `awful.widget.textbox` +`channel` | string +`step` | string +`notify` | function + +Finally, you can control the widget with key bindings like these: + + -- Volume control + awful.key({ altkey }, "Up", + function () + awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "+") + volume.notify() + end), + awful.key({ altkey }, "Down", + function () + awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "-") + volume.notify() + end), + awful.key({ altkey }, "m", + function () + awful.util.spawn("amixer set Master playback toggle") + volume.notify() + end), + awful.key({ altkey, "Control" }, "m", + function () + awful.util.spawn("amixer set Master playback 100%", false ) + volume.notify() + end), + +where `altkey = "Mod1"`. \ No newline at end of file From e25277ef15b7bcbdcbd2033e6f1488f042111610 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:40:38 -0700 Subject: [PATCH 020/303] Updated fs (markdown) --- fs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fs.md b/fs.md index 98016fb..0659682 100644 --- a/fs.md +++ b/fs.md @@ -25,7 +25,7 @@ Variable | Type `widget` | `wibox.widget.textbox` `show` | function -You can display a notification of current disk space usage with the following key binding: +You can display a notification of current disk space usage with a key binding like this: awful.key({ altkey }, "h", function () mypartition.show(7) end), From d6a60f6c89ea5421b21723f12b07888cda3f5530 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:41:20 -0700 Subject: [PATCH 021/303] Created Widgets (markdown) --- Widgets.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 Widgets.md diff --git a/Widgets.md b/Widgets.md new file mode 100644 index 0000000..cbf3fb9 --- /dev/null +++ b/Widgets.md @@ -0,0 +1,9 @@ +### Foreword + +Every widget is output by a `function`. + +Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`. + +We say this because, for some widget, `function` return a table to be used for notification and update purposes. + +### Index \ No newline at end of file From e483d3810e703986b52b0b26b643466cede56e65 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:10:14 -0700 Subject: [PATCH 022/303] Updated imap (markdown) --- imap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/imap.md b/imap.md index 5f8ce30..085cb8d 100644 --- a/imap.md +++ b/imap.md @@ -2,7 +2,7 @@ Check new mails over IMAP protocol. Dependencies: -- Python3 +- python3 New mails are notified through a notification like this: From d5e38892f0d7df3a2d34760101c322fbf7f795f9 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:18:36 -0700 Subject: [PATCH 023/303] Updated alsa (markdown) --- alsa.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/alsa.md b/alsa.md index 5a3497b..3b485c2 100644 --- a/alsa.md +++ b/alsa.md @@ -18,12 +18,12 @@ Variable | Meaning | Type | Default and outputs the following table: -Variable | Type ---- | --- -`widget` | `awful.widget.textbox` -`channel` | string -`step` | string -`notify` | function +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`channel` | Alsa channel | string +`step` | Increase/decrease step | string +`notify` | The notification | function Finally, you can control the widget with key bindings like these: From 04217d3bf616375fad343fec425d54fa71d4a9d9 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:19:48 -0700 Subject: [PATCH 024/303] Updated alsabar (markdown) --- alsabar.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/alsabar.md b/alsabar.md index 53c49b4..8275101 100644 --- a/alsabar.md +++ b/alsabar.md @@ -47,12 +47,12 @@ It's **crucial** to set `notifications.bar_size` to your `mywibox[s]` height, `lain.widgets.alsabar` outputs the following table: -Variable | Type ---- | --- -`widget` | `awful.widget.progressbar` -`channel` | string -`step` | string -`notify` | function +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `awful.widget.progressbar` +`channel` | Alsa channel | string +`step` | Increase/decrease step | string +`notify` | The notification | function Finally, you can control the widget with key bindings like these: From 6e227023200a7a03139d10265ba182bd2b7aa023 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:21:12 -0700 Subject: [PATCH 025/303] Updated fs (markdown) --- fs.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/fs.md b/fs.md index 0659682..951f73b 100644 --- a/fs.md +++ b/fs.md @@ -20,10 +20,10 @@ Variable | Meaning | Type | Default `lain.widgets.fs` outputs the following table: -Variable | Type ---- | --- -`widget` | `wibox.widget.textbox` -`show` | function +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`show` | The notification | function You can display a notification of current disk space usage with a key binding like this: From 14162d53c96c4fbf6205ed5c30edc2e4890e77c7 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:21:34 -0700 Subject: [PATCH 026/303] Updated fs (markdown) --- fs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fs.md b/fs.md index 951f73b..3b43d8c 100644 --- a/fs.md +++ b/fs.md @@ -25,7 +25,7 @@ Variable | Meaning | Type `widget` | The widget | `wibox.widget.textbox` `show` | The notification | function -You can display a notification of current disk space usage with a key binding like this: +You can display the notification with a key binding like this: awful.key({ altkey }, "h", function () mypartition.show(7) end), From 10e87f1bd87291cb1a82c9e2d19929d4f6cdf779 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:22:29 -0700 Subject: [PATCH 027/303] Updated calendar (markdown) --- calendar.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/calendar.md b/calendar.md index 06e1b48..9330df7 100644 --- a/calendar.md +++ b/calendar.md @@ -1,6 +1,6 @@ -Attaches a calendar to a ``widget``. Example: +Attaches a calendar to a ``widget``. - lain.widgets.calendar:attach(mytextclock) + lain.widgets.calendar:attach(mywidget) - Left click: switch to previous month. - Right click: switch to next month. From 978e912a0a08bbf19aec66e19b4fe8dfe4b0c524 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:22:53 -0700 Subject: [PATCH 028/303] Updated calendar (markdown) --- calendar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/calendar.md b/calendar.md index 9330df7..bfceac9 100644 --- a/calendar.md +++ b/calendar.md @@ -1,4 +1,4 @@ -Attaches a calendar to a ``widget``. +Attaches a calendar to a widget. lain.widgets.calendar:attach(mywidget) From d56d42ecd829b65a31e74dddf8b2c6a600dd357a Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:25:10 -0700 Subject: [PATCH 029/303] Updated alsa (markdown) --- alsa.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/alsa.md b/alsa.md index 3b485c2..7500bf8 100644 --- a/alsa.md +++ b/alsa.md @@ -23,7 +23,7 @@ Variable | Meaning | Type `widget` | The widget | `wibox.widget.textbox` `channel` | Alsa channel | string `step` | Increase/decrease step | string -`notify` | The notification | function +`notify` | Update `widget` | function Finally, you can control the widget with key bindings like these: From 4fd9ef1d072166be3951f87451713d17a815c28c Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:30:54 -0700 Subject: [PATCH 030/303] Created mpd (markdown) --- mpd.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 mpd.md diff --git a/mpd.md b/mpd.md new file mode 100644 index 0000000..17acab8 --- /dev/null +++ b/mpd.md @@ -0,0 +1,67 @@ +Shows mpd status in a textbox. + + mympd = lain.widgets.mpd() + +Now playing songs are notified like this: + + +--------------------------------------------------------+ + | +-------+ | + | |/^\_/^\| Now playing | + | |\ O O /| Cannibal Corpse (Hammer Smashed Face) - 1993 | + | | '.o.' | Hammer Smashed Face (Radio Disney Version) | + | +-------+ | + +--------------------------------------------------------+ + +Dependencies + +- imagemagick + +The function takes a table as optional argument, which can contain: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`password` | Mpd password | string | "" +`host` | Mpd server | string | "127.0.0.1" +`port` | Mpd port | string | "6600" +`music_dir` | Music directory | string | "~/Music" +`refresh_timeout` | Refresh timeout seconds | int | 1 +`color_artist` | Artist value color | string | `beautiful.fg_normal` or "#FFFFFF" +`color_song` | Song value color | string | `beautiful.fg_focus` or "#FFFFFF" +`spr` | Separator text between artist and song values | string | " " +`app` | Music program to spawn on click | string | "ncmpcpp" +`shadow` | Hide widget when there are no songs playing | boolean | false + +**Note**: `spr` can be a markup text. + +`lain.widgets.mpd` outputs the following table: + +Variable | Meaning | Type +--- | --- | --- +`widget` | The textbox | `wibox.widget.textbox` +`notify` | The notification | function + +Finally, you can control the widget with key bindings like these: + + -- MPD control + awful.key({ altkey, "Control" }, "Up", + function () + awful.util.spawn_with_shell( "mpc toggle || ncmpcpp toggle || ncmpc toggle || pms toggle", false ) + mympd.notify() + end), + awful.key({ altkey, "Control" }, "Down", + function () + awful.util.spawn_with_shell( "mpc stop || ncmpcpp stop || ncmpc stop || pms stop", false ) + mympd.notify() + end), + awful.key({ altkey, "Control" }, "Left", + function () + awful.util.spawn_with_shell( "mpc prev || ncmpcpp prev || ncmpc prev || pms prev", false ) + mympd.notify() + end), + awful.key({ altkey, "Control" }, "Right", + function () + awful.util.spawn_with_shell( "mpc next || ncmpcpp next || ncmpc next || pms next", false ) + mympd.notify() + end), + +where `altkey = "Mod1"`. \ No newline at end of file From 3a79e2bd99a112bfb08483cf2d55dd7604f1e3da Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:34:31 -0700 Subject: [PATCH 031/303] Updated alsabar (markdown) --- alsabar.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/alsabar.md b/alsabar.md index 8275101..52fa417 100644 --- a/alsabar.md +++ b/alsabar.md @@ -56,26 +56,26 @@ Variable | Meaning | Type Finally, you can control the widget with key bindings like these: - -- Volume control - awful.key({ altkey }, "Up", - function () - awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "+") - volume.notify() - end), - awful.key({ altkey }, "Down", - function () - awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "-") - volume.notify() - end), - awful.key({ altkey }, "m", - function () - awful.util.spawn("amixer set Master playback toggle") - volume.notify() - end), - awful.key({ altkey, "Control" }, "m", - function () - awful.util.spawn("amixer set Master playback 100%", false ) - volume.notify() - end), + -- Volume control + awful.key({ altkey }, "Up", + function () + awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "+") + volume.notify() + end), + awful.key({ altkey }, "Down", + function () + awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "-") + volume.notify() + end), + awful.key({ altkey }, "m", + function () + awful.util.spawn("amixer set Master playback toggle") + volume.notify() + end), + awful.key({ altkey, "Control" }, "m", + function () + awful.util.spawn("amixer set Master playback 100%", false ) + volume.notify() + end), where `altkey = "Mod1"`. \ No newline at end of file From 7d464df335205fa6ab1178051f23f58a3d3880a4 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:34:48 -0700 Subject: [PATCH 032/303] Updated alsabar (markdown) --- alsabar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/alsabar.md b/alsabar.md index 52fa417..c9e3b49 100644 --- a/alsabar.md +++ b/alsabar.md @@ -76,6 +76,6 @@ Finally, you can control the widget with key bindings like these: function () awful.util.spawn("amixer set Master playback 100%", false ) volume.notify() - end), + end), where `altkey = "Mod1"`. \ No newline at end of file From 862213c785736c8e3c5d038683257030ca00b673 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:35:37 -0700 Subject: [PATCH 033/303] Updated alsa (markdown) --- alsa.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/alsa.md b/alsa.md index 7500bf8..fb9b28f 100644 --- a/alsa.md +++ b/alsa.md @@ -27,26 +27,26 @@ Variable | Meaning | Type Finally, you can control the widget with key bindings like these: - -- Volume control - awful.key({ altkey }, "Up", - function () - awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "+") - volume.notify() - end), - awful.key({ altkey }, "Down", - function () - awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "-") - volume.notify() - end), - awful.key({ altkey }, "m", - function () - awful.util.spawn("amixer set Master playback toggle") - volume.notify() - end), - awful.key({ altkey, "Control" }, "m", - function () - awful.util.spawn("amixer set Master playback 100%", false ) - volume.notify() - end), + -- Volume control + awful.key({ altkey }, "Up", + function () + awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "+") + volume.notify() + end), + awful.key({ altkey }, "Down", + function () + awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "-") + volume.notify() + end), + awful.key({ altkey }, "m", + function () + awful.util.spawn("amixer set Master playback toggle") + volume.notify() + end), + awful.key({ altkey, "Control" }, "m", + function () + awful.util.spawn("amixer set Master playback 100%", false ) + volume.notify() + end), where `altkey = "Mod1"`. \ No newline at end of file From 8fc9c620eeb9b410a2bcb36c65b15d73b5e5c9e1 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:37:51 -0700 Subject: [PATCH 034/303] Updated mpd (markdown) --- mpd.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/mpd.md b/mpd.md index 17acab8..d86b2c6 100644 --- a/mpd.md +++ b/mpd.md @@ -1,4 +1,4 @@ -Shows mpd status in a textbox. +Shows MPD status in a textbox. mympd = lain.widgets.mpd() @@ -20,9 +20,9 @@ The function takes a table as optional argument, which can contain: Variable | Meaning | Type | Default --- | --- | --- | --- -`password` | Mpd password | string | "" -`host` | Mpd server | string | "127.0.0.1" -`port` | Mpd port | string | "6600" +`password` | MPD password | string | "" +`host` | MPD server | string | "127.0.0.1" +`port` | MPD port | string | "6600" `music_dir` | Music directory | string | "~/Music" `refresh_timeout` | Refresh timeout seconds | int | 1 `color_artist` | Artist value color | string | `beautiful.fg_normal` or "#FFFFFF" From 186e3351969927785355bc4c982483ccac9b4f03 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:55:46 -0700 Subject: [PATCH 035/303] Created net (markdown) --- net.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 net.md diff --git a/net.md b/net.md new file mode 100644 index 0000000..58b27e3 --- /dev/null +++ b/net.md @@ -0,0 +1,30 @@ +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: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`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. + +Possible value for `units` are stored in table `lain.widgets.net.units`, which contains: + + { + ["b"] = 1, + ["kb"] = 1024, + ["mb"] = 1024^2, + ["gb"] = 1024^3 + } + + From 2201da1aff925d0f0506defe93cae094ec1e8406 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:56:53 -0700 Subject: [PATCH 036/303] Updated net (markdown) --- net.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/net.md b/net.md index 58b27e3..868fb68 100644 --- a/net.md +++ b/net.md @@ -20,11 +20,7 @@ Variable | Meaning | Type | Default Possible value for `units` are stored in table `lain.widgets.net.units`, which contains: - { - ["b"] = 1, - ["kb"] = 1024, - ["mb"] = 1024^2, - ["gb"] = 1024^3 - } - - + ["b"] = 1, + ["kb"] = 1024, + ["mb"] = 1024^2, + ["gb"] = 1024^3 \ No newline at end of file From e4c6b75c4937970478bdee0b6eac04e9ed7be1f4 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:57:14 -0700 Subject: [PATCH 037/303] Updated net (markdown) --- net.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/net.md b/net.md index 868fb68..c3a635c 100644 --- a/net.md +++ b/net.md @@ -20,7 +20,7 @@ Variable | Meaning | Type | Default Possible value for `units` are stored in table `lain.widgets.net.units`, which contains: - ["b"] = 1, - ["kb"] = 1024, + ["b"] = 1, + ["kb"] = 1024, ["mb"] = 1024^2, ["gb"] = 1024^3 \ No newline at end of file From a4b6e75ba37146a84c8cfbd8eeb435061677f0d9 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 04:57:32 -0700 Subject: [PATCH 038/303] Updated net (markdown) --- net.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/net.md b/net.md index c3a635c..59390dc 100644 --- a/net.md +++ b/net.md @@ -22,5 +22,5 @@ Possible value for `units` are stored in table `lain.widgets.net.units`, which c ["b"] = 1, ["kb"] = 1024, - ["mb"] = 1024^2, - ["gb"] = 1024^3 \ No newline at end of file + ["mb"] = 1024^2, + ["gb"] = 1024^3 \ No newline at end of file From 296e0172a4a15f52c4b39fa3c1a8c9706c374057 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:03:04 -0700 Subject: [PATCH 039/303] Created sysload (markdown) --- sysload.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 sysload.md diff --git a/sysload.md b/sysload.md new file mode 100644 index 0000000..5b925b1 --- /dev/null +++ b/sysload.md @@ -0,0 +1,14 @@ +Show the current system load in a textbox. + + mysysload = lain.widgets.systemload() + +The function takes a table as optional argument, which can contain: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`show_all` | Show all the three values (true), or only the first one (false) | boolean | false +`refresh_timeout` | Refresh timeout seconds | int | 5 +`header` | Text to show before value | string | " Load " +`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" +`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" +`app` | Proc program to spawn on click | string | "top" \ No newline at end of file From ce4a3cd07665a8ad0d8f86d676e65a78da491b65 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:03:21 -0700 Subject: [PATCH 040/303] Updated sysload (markdown) --- sysload.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sysload.md b/sysload.md index 5b925b1..0e57a8f 100644 --- a/sysload.md +++ b/sysload.md @@ -1,6 +1,6 @@ Show the current system load in a textbox. - mysysload = lain.widgets.systemload() + mysysload = lain.widgets.sysload() The function takes a table as optional argument, which can contain: From a33ec3d1dad5b724d2b86821e7517ae684286564 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:07:01 -0700 Subject: [PATCH 041/303] Created temp (markdown) --- temp.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 temp.md diff --git a/temp.md b/temp.md new file mode 100644 index 0000000..60d03e2 --- /dev/null +++ b/temp.md @@ -0,0 +1,13 @@ +Show the current core temperature in a textbox. Reads from `/sys/class/thermal`, so value is expressed in Celsius. + + mytemp = lain.widgets.temp() + +The function takes a table as optional argument, which can contain: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`refresh_timeout` | Refresh timeout seconds | int | 5 +`header` | Text to show before value | string | " Temp " +`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" +`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" +`footer` | Text to show after value | string | "C " \ No newline at end of file From 5217a727ddb9a5d3c1afb1aacddb6d29adbd3b99 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:07:17 -0700 Subject: [PATCH 042/303] Updated temp (markdown) --- temp.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/temp.md b/temp.md index 60d03e2..11a8aa1 100644 --- a/temp.md +++ b/temp.md @@ -1,4 +1,6 @@ -Show the current core temperature in a textbox. Reads from `/sys/class/thermal`, so value is expressed in Celsius. +Show the current core temperature in a textbox. + +Reads from `/sys/class/thermal`, so value is expressed in Celsius. mytemp = lain.widgets.temp() From c4b5b25067dd79700982bde92ac9c176e846b68a Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:08:42 -0700 Subject: [PATCH 043/303] Updated mem (markdown) --- mem.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mem.md b/mem.md index 58ccf72..1efdb3a 100644 --- a/mem.md +++ b/mem.md @@ -1,4 +1,4 @@ -Show used memory and total memory in MiB. +Shows memory status (in MiB) in a textbox. mymem = lain.widgets.mem() @@ -11,7 +11,7 @@ Variable | Meaning | Type | Default `refresh_timeout` | Refresh timeout seconds | int | 10 `show_swap` | Show amount of used swap space? | boolean | false `show_total` | Show amout of total memory? | boolean | false -`header` | Text to show before value | string | " Vol " +`header` | Text to show before value | string | " Mem " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" `footer` | Text to show after value | string | "MB" From 85b4fcb759b050c4f6763272875d6603e174db65 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:09:48 -0700 Subject: [PATCH 044/303] Updated maildir (markdown) --- maildir.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/maildir.md b/maildir.md index df5f6fe..28de551 100644 --- a/maildir.md +++ b/maildir.md @@ -17,10 +17,10 @@ Maildirs are structured as follows: . therefore the widget checks whether there are files in the `new` directories. -If there's new mail, the textbox will say something like "mail: bugs(3), system(1)", otherwise it says +If there's new mails, the textbox will say something like "mail: bugs(3), system(1)", otherwise it says "no mail". - mymaildir= lain.widgets.maildir("/path/to/my/maildir") + mymaildir = lain.widgets.maildir("/path/to/my/maildir") The function takes a table as optional argument, which can contain: From e058524601d80006095656ffdf806c1bd3d415c9 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:10:43 -0700 Subject: [PATCH 045/303] Updated maildir (markdown) --- maildir.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/maildir.md b/maildir.md index 28de551..c35b2f9 100644 --- a/maildir.md +++ b/maildir.md @@ -1,4 +1,4 @@ -Checks your maildirs. +Shows maildirs status in a textbox. Maildirs are structured as follows: From 4b6422456be44bc26ac1f1335e125f96245dbb81 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:11:28 -0700 Subject: [PATCH 046/303] Updated imap (markdown) --- imap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/imap.md b/imap.md index 085cb8d..a11759a 100644 --- a/imap.md +++ b/imap.md @@ -1,4 +1,4 @@ -Check new mails over IMAP protocol. +Show mail status in a textbox over IMAP protocol. Dependencies: From bcafb3f44da056e8453893e2517c86c37d42b554 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:11:42 -0700 Subject: [PATCH 047/303] Updated imap (markdown) --- imap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/imap.md b/imap.md index a11759a..2a70a4c 100644 --- a/imap.md +++ b/imap.md @@ -1,4 +1,4 @@ -Show mail status in a textbox over IMAP protocol. +Shows mail status in a textbox over IMAP protocol. Dependencies: From d153d6dbe50f48419d0a2dca266ac9f60a95a480 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:12:13 -0700 Subject: [PATCH 048/303] Updated cpu (markdown) --- cpu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpu.md b/cpu.md index ce59a15..01af669 100644 --- a/cpu.md +++ b/cpu.md @@ -1,4 +1,4 @@ -Shows the average CPU usage percent for a given amount of time. +Shows in a textbox the average CPU usage percent for a given amount of time. mycpuusage = lain.widgets.cpu() From f19d67a8fea9681befe6ca3658213b1abe5e60c8 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:12:52 -0700 Subject: [PATCH 049/303] Updated calendar (markdown) --- calendar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/calendar.md b/calendar.md index bfceac9..182c805 100644 --- a/calendar.md +++ b/calendar.md @@ -1,4 +1,4 @@ -Attaches a calendar to a widget. +Attaches a calendar notification to a widget. lain.widgets.calendar:attach(mywidget) From 1c3ec6c8c71836e3770c2df3e2354b4479b0e747 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:13:26 -0700 Subject: [PATCH 050/303] Updated bat (markdown) --- bat.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/bat.md b/bat.md index 9e2d8c5..3ff9e65 100644 --- a/bat.md +++ b/bat.md @@ -1,4 +1,4 @@ -Shows the remaining time and percentage capacity of your laptop battery, as well as +Shows in a textbox the remaining time and percentage capacity of your laptop battery, as well as the current wattage. Displays a notification when battery is low or critical. @@ -12,7 +12,7 @@ Variable | Meaning | Type | Default `battery` | Identifier of the battery | string | "BAT0" `show_all` | Show all values (true), or only remaining capacity (false) | boolean | false `refresh_timeout` | Refresh timeout seconds | int | 30 -`header` | Text to show before value | string | " Vol " +`header` | Text to show before value | string | " Bat " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" `shadow` | Hide the widget when battery is not present | boolean | false \ No newline at end of file From e022767b56ddeb392761b619c2ac01d3a6594efe Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:14:53 -0700 Subject: [PATCH 051/303] Updated alsa (markdown) --- alsa.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/alsa.md b/alsa.md index fb9b28f..f978bce 100644 --- a/alsa.md +++ b/alsa.md @@ -1,4 +1,4 @@ -Shows and controls alsa volume with a textbox. +Shows and controls alsa volume. myvolume = lain.widgets.alsa() From 6535da261c1309e360df5323ef2c06a80b005d56 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:15:53 -0700 Subject: [PATCH 052/303] Updated alsa (markdown) --- alsa.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/alsa.md b/alsa.md index f978bce..fb9b28f 100644 --- a/alsa.md +++ b/alsa.md @@ -1,4 +1,4 @@ -Shows and controls alsa volume. +Shows and controls alsa volume with a textbox. myvolume = lain.widgets.alsa() From ea982fc1b0ce01530a8c7fa368131d6ea8bf1f9e Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:18:02 -0700 Subject: [PATCH 053/303] Updated Home (markdown) --- Home.md | 1 - Index.md | 3 +++ 2 files changed, 3 insertions(+), 1 deletion(-) delete mode 100644 Home.md create mode 100644 Index.md diff --git a/Home.md b/Home.md deleted file mode 100644 index a520d81..0000000 --- a/Home.md +++ /dev/null @@ -1 +0,0 @@ -Welcome to the lain wiki! \ No newline at end of file diff --git a/Index.md b/Index.md new file mode 100644 index 0000000..e14945d --- /dev/null +++ b/Index.md @@ -0,0 +1,3 @@ +- [Layouts](https://github.com/copycat-killer/lain/wiki/Layouts) +- [Widgets](https://github.com/copycat-killer/lain/wiki/Widgets) +- Utilities \ No newline at end of file From ac9d15f7a39843d0136c0ec970573dfbf79edf3b Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:19:32 -0700 Subject: [PATCH 054/303] Updated Index (markdown) --- Index.md => Home.md | 2 ++ 1 file changed, 2 insertions(+) rename Index.md => Home.md (85%) diff --git a/Index.md b/Home.md similarity index 85% rename from Index.md rename to Home.md index e14945d..434dfdc 100644 --- a/Index.md +++ b/Home.md @@ -1,3 +1,5 @@ +### Index + - [Layouts](https://github.com/copycat-killer/lain/wiki/Layouts) - [Widgets](https://github.com/copycat-killer/lain/wiki/Widgets) - Utilities \ No newline at end of file From d6071f5dbc2b8534c7c1c9af11645570b5f5bfae Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:20:29 -0700 Subject: [PATCH 055/303] Updated Home (markdown) --- Home.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Home.md b/Home.md index 434dfdc..f8b1142 100644 --- a/Home.md +++ b/Home.md @@ -1,5 +1,10 @@ +### Installation + +Simply clone this repository into your Awesome directory. + ### Index +- [To start](https://github.com/copycat-killer/lain/wiki/To-start) - [Layouts](https://github.com/copycat-killer/lain/wiki/Layouts) - [Widgets](https://github.com/copycat-killer/lain/wiki/Widgets) - Utilities \ No newline at end of file From 1d74c3ddec81e125cc6539cfc242e641db72ebdf Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:27:01 -0700 Subject: [PATCH 056/303] Updated Widgets (markdown) --- Widgets.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/Widgets.md b/Widgets.md index cbf3fb9..7c1349e 100644 --- a/Widgets.md +++ b/Widgets.md @@ -1,4 +1,5 @@ -### Foreword +[<- home](https://github.com/copycat-killer/lain/wiki) + Every widget is output by a `function`. @@ -6,4 +7,19 @@ Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`. We say this because, for some widget, `function` return a table to be used for notification and update purposes. -### Index \ No newline at end of file +------- + +- [alsa](https://github.com/copycat-killer/lain/wiki/alsa) +- [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) +- [bat](https://github.com/copycat-killer/lain/wiki/bat) +- [borderbox](https://github.com/copycat-killer/lain/wiki/borderbox) +- [calendar](https://github.com/copycat-killer/lain/wiki/caldendar) +- [cpu](https://github.com/copycat-killer/lain/wiki/cpu) +- [fs](https://github.com/copycat-killer/lain/wiki/fs) +- [imap](https://github.com/copycat-killer/lain/wiki/imap) +- [maildir](https://github.com/copycat-killer/lain/wiki/maildir) +- [mem](https://github.com/copycat-killer/lain/wiki/mem) +- [mpd](https://github.com/copycat-killer/lain/wiki/mpd) +- [net](https://github.com/copycat-killer/lain/wiki/net) +- [sysload](https://github.com/copycat-killer/lain/wiki/sysload) +- [temp](https://github.com/copycat-killer/lain/wiki/temp) \ No newline at end of file From 251c9f74feff7dc1634a0f9e59aa252bffebc178 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:27:20 -0700 Subject: [PATCH 057/303] Updated Widgets (markdown) --- Widgets.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/Widgets.md b/Widgets.md index 7c1349e..f6fde73 100644 --- a/Widgets.md +++ b/Widgets.md @@ -1,14 +1,11 @@ [<- home](https://github.com/copycat-killer/lain/wiki) - Every widget is output by a `function`. Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`. We say this because, for some widget, `function` return a table to be used for notification and update purposes. -------- - - [alsa](https://github.com/copycat-killer/lain/wiki/alsa) - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) - [bat](https://github.com/copycat-killer/lain/wiki/bat) From 50e6e90b62a2582a5549b27efe2546ebb015cfe0 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:28:39 -0700 Subject: [PATCH 058/303] Updated To start (markdown) --- To-start.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/To-start.md b/To-start.md index 9135be2..5a3f3db 100644 --- a/To-start.md +++ b/To-start.md @@ -1,3 +1,5 @@ +[<- home](https://github.com/copycat-killer/lain/wiki) + All you have to do is to include the module: local lain = require("lain") From b40fb56ece3ee72d867b6c8dc2ffc1d9dfd98da1 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:28:58 -0700 Subject: [PATCH 059/303] Updated Layouts (markdown) --- Layouts.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Layouts.md b/Layouts.md index 7f50efe..cc5b75d 100644 --- a/Layouts.md +++ b/Layouts.md @@ -1,3 +1,5 @@ +[<- home](https://github.com/copycat-killer/lain/wiki) + Currently, there are **7** layouts. lain/layout From 50ce8518ebdb923fcf529cb9fb345a139751c4ca Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:29:27 -0700 Subject: [PATCH 060/303] Created Utilities (markdown) --- Utilities.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 Utilities.md diff --git a/Utilities.md b/Utilities.md new file mode 100644 index 0000000..7bf82a0 --- /dev/null +++ b/Utilities.md @@ -0,0 +1 @@ +[<- home](https://github.com/copycat-killer/lain/wiki) \ No newline at end of file From 7d33cc722e204467baae3921002f55b125bf5b07 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:30:13 -0700 Subject: [PATCH 061/303] Updated Home (markdown) --- Home.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Home.md b/Home.md index f8b1142..5dfbd14 100644 --- a/Home.md +++ b/Home.md @@ -7,4 +7,4 @@ Simply clone this repository into your Awesome directory. - [To start](https://github.com/copycat-killer/lain/wiki/To-start) - [Layouts](https://github.com/copycat-killer/lain/wiki/Layouts) - [Widgets](https://github.com/copycat-killer/lain/wiki/Widgets) -- Utilities \ No newline at end of file +- [Utilities](https://github.com/copycat-killer/lain/wiki/Utilities) \ No newline at end of file From 35fe9a32d45c54587ba2654fd4f4b8d46f551f7b Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:30:47 -0700 Subject: [PATCH 062/303] Updated To start (markdown) --- To-start.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/To-start.md b/To-start.md index 5a3f3db..309e09b 100644 --- a/To-start.md +++ b/To-start.md @@ -25,4 +25,6 @@ Something like this: -- elaborate cmd end - lain.widgets.terminal = footerm \ No newline at end of file + lain.widgets.terminal = footerm + +[<- home](https://github.com/copycat-killer/lain/wiki) \ No newline at end of file From 4d76f6251673758997cfae5f20c89ed4a9763d8e Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:31:05 -0700 Subject: [PATCH 063/303] Updated Utilities (markdown) --- Utilities.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Utilities.md b/Utilities.md index 7bf82a0..c3bbf8b 100644 --- a/Utilities.md +++ b/Utilities.md @@ -1 +1,3 @@ +[<- home](https://github.com/copycat-killer/lain/wiki) + [<- home](https://github.com/copycat-killer/lain/wiki) \ No newline at end of file From 1333924b33e22a16a7c06fee78e8dc9174e59d31 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:31:25 -0700 Subject: [PATCH 064/303] Updated Layouts (markdown) --- Layouts.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Layouts.md b/Layouts.md index cc5b75d..f9dd490 100644 --- a/Layouts.md +++ b/Layouts.md @@ -267,4 +267,6 @@ To use them, add lines to your ``theme.lua`` like this: Credits goes to [Nicolas Estibals](https://github.com/nestibal) for creating layout icons for default theme. -You can use them as a template for your custom versions. \ No newline at end of file +You can use them as a template for your custom versions. + +[<- home](https://github.com/copycat-killer/lain/wiki) \ No newline at end of file From dac05366f71c6d2774a7eae74c54f567e20df7e4 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:31:49 -0700 Subject: [PATCH 065/303] Updated To start (markdown) --- To-start.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/To-start.md b/To-start.md index 309e09b..36f32a0 100644 --- a/To-start.md +++ b/To-start.md @@ -26,5 +26,3 @@ Something like this: end lain.widgets.terminal = footerm - -[<- home](https://github.com/copycat-killer/lain/wiki) \ No newline at end of file From 5c1a24baba7f8bb1192a6e4f762dd2271a81580c Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:33:08 -0700 Subject: [PATCH 066/303] Updated temp (markdown) --- temp.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/temp.md b/temp.md index 11a8aa1..92d7d06 100644 --- a/temp.md +++ b/temp.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + Show the current core temperature in a textbox. Reads from `/sys/class/thermal`, so value is expressed in Celsius. From 26085f0c1ada5805a857467d82c5978c1a99d083 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:33:23 -0700 Subject: [PATCH 067/303] Updated sysload (markdown) --- sysload.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/sysload.md b/sysload.md index 0e57a8f..65b5eec 100644 --- a/sysload.md +++ b/sysload.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + Show the current system load in a textbox. mysysload = lain.widgets.sysload() From 02e6f1361ee690954d69e046e8d0fb3fccf694a2 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:33:41 -0700 Subject: [PATCH 068/303] Updated net (markdown) --- net.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/net.md b/net.md index 59390dc..b02c239 100644 --- a/net.md +++ b/net.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + Monitors network interfaces and shows current traffic in a textbox. mynet = lain.widgets.net() From 0f18138d4d6da391fabec1a0f63a91d35af24bdd Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:33:53 -0700 Subject: [PATCH 069/303] Updated mpd (markdown) --- mpd.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/mpd.md b/mpd.md index d86b2c6..27f3faf 100644 --- a/mpd.md +++ b/mpd.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + Shows MPD status in a textbox. mympd = lain.widgets.mpd() From e5e479ac7190ccb12c6d67e785c86579f7a0faeb Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:34:12 -0700 Subject: [PATCH 070/303] Updated mem (markdown) --- mem.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/mem.md b/mem.md index 1efdb3a..173452d 100644 --- a/mem.md +++ b/mem.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + Shows memory status (in MiB) in a textbox. mymem = lain.widgets.mem() From e3e59600a5421339789dbc98e0db33d016c2cd76 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:34:27 -0700 Subject: [PATCH 071/303] Updated imap (markdown) --- imap.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/imap.md b/imap.md index 2a70a4c..d7e68b4 100644 --- a/imap.md +++ b/imap.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + Shows mail status in a textbox over IMAP protocol. Dependencies: From 885ff3eb65ce2bb8d650c02cad6752d7ea2ce2b5 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:34:38 -0700 Subject: [PATCH 072/303] Updated fs (markdown) --- fs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/fs.md b/fs.md index 3b43d8c..4946fe7 100644 --- a/fs.md +++ b/fs.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + Shows disk space usage for a set partition. Displays a notification when the partition is full or has low space. From 3221d82b6ada0d6c7e2a11d77228c997ed1bbcd2 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:34:51 -0700 Subject: [PATCH 073/303] Updated cpu (markdown) --- cpu.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cpu.md b/cpu.md index 01af669..9dcc894 100644 --- a/cpu.md +++ b/cpu.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + Shows in a textbox the average CPU usage percent for a given amount of time. mycpuusage = lain.widgets.cpu() From cf8601a25fd04bf384fdd7cb9a7bc21a4d39b3ee Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:35:10 -0700 Subject: [PATCH 074/303] Updated borderbox (markdown) --- borderbox.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/borderbox.md b/borderbox.md index cdeece2..e4d7afb 100644 --- a/borderbox.md +++ b/borderbox.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + Creates a thin wibox at a position relative to another wibox. This allows to create "borders" for your wiboxes. From e084da5fa8984448bb4a0e07391dbae10b056afb Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:35:22 -0700 Subject: [PATCH 075/303] Updated bat (markdown) --- bat.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/bat.md b/bat.md index 3ff9e65..79c17da 100644 --- a/bat.md +++ b/bat.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + Shows in a textbox the remaining time and percentage capacity of your laptop battery, as well as the current wattage. From ec0505310f2886bfe38a61e5f8940b75c0b53c19 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:35:32 -0700 Subject: [PATCH 076/303] Updated alsabar (markdown) --- alsabar.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/alsabar.md b/alsabar.md index c9e3b49..9338ff8 100644 --- a/alsabar.md +++ b/alsabar.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + Shows and controls alsa volume with a progressbar. Dependencies: From cf9b62087a65da4cdfb8b2c34b245bff7056e2cc Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:35:43 -0700 Subject: [PATCH 077/303] Updated alsa (markdown) --- alsa.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/alsa.md b/alsa.md index fb9b28f..4cfa8f3 100644 --- a/alsa.md +++ b/alsa.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + Shows and controls alsa volume with a textbox. myvolume = lain.widgets.alsa() From df5d4de45bfcca28473faf1d251c7f2534dc4b0f Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 05:36:42 -0700 Subject: [PATCH 078/303] Updated Utilities (markdown) --- Utilities.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/Utilities.md b/Utilities.md index c3bbf8b..45fd0fa 100644 --- a/Utilities.md +++ b/Utilities.md @@ -1,3 +1 @@ [<- home](https://github.com/copycat-killer/lain/wiki) - -[<- home](https://github.com/copycat-killer/lain/wiki) \ No newline at end of file From e00770894268540277d819b0139939d2972d9411 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 06:27:18 -0700 Subject: [PATCH 079/303] Updated Utilities (markdown) --- Utilities.md | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) diff --git a/Utilities.md b/Utilities.md index 45fd0fa..d9790da 100644 --- a/Utilities.md +++ b/Utilities.md @@ -1 +1,86 @@ [<- home](https://github.com/copycat-killer/lain/wiki) + +menu\_clients\_current\_tags +---------------------------- + +Similar to `awful.menu.clients()`, but this menu only shows the clients +of currently visible tags. Use it with a key binding like this: + + awful.key({ "Mod1" }, "Tab", function() + awful.menu.menu_keys.down = { "Down", "Alt_L", "Tab", "j" } + awful.menu.menu_keys.up = { "Up", "k" } + lain.util.menu_clients_current_tags({ width = 350 }, { keygrabber = true }) + end), + +magnify\_client +--------------- + +Set a client to floating and resize it in the same way the "magnifier" +layout does it. Place it on the "current" screen (derived from the mouse +position). This allows you to magnify any client you wish, regardless of +the currently used layout. Use it with a client keybinding like this: + + clientkeys = awful.util.table.join( + ... + awful.key({ modkey, "Control" }, "m", lain.util.magnify_client), + ... + ) + +If you want to "de-magnify" it, just reset the clients floating state to +`false` (hit `Mod4`+`CTRL`+`Space`, for example). + +niceborder\_{focus, unfocus} +---------------------------- + +By default, your `rc.lua` contains something like this: + + client.connect_signal("focus", function(c) c.border_color = beautiful.border_focus end) + client.connect_signal("unfocus", function(c) c.border_color = beautiful.border_normal end) + +You can change it to this: + + client.connect_signal("focus", lain.util.niceborder_focus(c)) + client.connect_signal("unfocus", lain.util.niceborder_unfocus(c)) + +Now, when a client is focused or unfocused, Awesome will look up its +nice value in `/proc//stat`. If it's less than 0, the client is +classified as "high priority"; if it's greater than 0, the client is +classified as "low priority". If it's equal to 0, nothing special +happens. + +This requires to define additional colors in your `theme.lua`. For example: + + theme.border_focus_highprio = "#FF0000" + theme.border_normal_highprio = "#A03333" + + theme.border_focus_lowprio = "#3333FF" + theme.border_normal_lowprio = "#333366" + +tag\_view\_nonempty +------------------- + +This function lets you jump to the next/previous non-empty tag. +It takes two arguments: + +* `direction`: `1` for next non-empty tag, `-1` for previous. +* `sc`: Screen which the taglist is in. Default is `mouse.screen` or `1`. This + argument is optional. + +You can use it with key bindings like these: + + -- Non-empty tag browsing + awful.key({ altkey }, "Left", function () lain.util.tag_view_nonempty(-1) end), + awful.key({ altkey }, "Right", function () lain.util.tag_view_nonempty(1) end), + +where `altkey = "Mod1"`. + +prompt\_rename\_tag +------------------- + +This function enables you to dynamically rename the current tag you have focused. + +You can use it with a key binding like this: + + awful.key({ modkey, "Shift" }, "r", function () lain.util.prompt_rename_tag(mypromptbox) end) + +Credits goes to [minism](https://bbs.archlinux.org/viewtopic.php?pid=1315135#p1315135). \ No newline at end of file From ee627f468c6f390534c551f7bc6fa1c55e4772f5 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 06:35:52 -0700 Subject: [PATCH 080/303] Updated Utilities (markdown) --- Utilities.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/Utilities.md b/Utilities.md index d9790da..4fc80e4 100644 --- a/Utilities.md +++ b/Utilities.md @@ -1,5 +1,45 @@ [<- home](https://github.com/copycat-killer/lain/wiki) +markup +------ + +This is a submodule which helps you markupping your text. + +First, call it like this: + + local markup = require("lain.util.markup") + +then you can call its functions: + + +-- markup + | + |`-- bold() Set bold. + |`-- italic() Set italicized text. + |`-- strike() Set strikethrough text. + |`-- underline() Set underlined text. + |`-- monospace() Set monospaced text. + |`-- big() Set bigger text. + |`-- small() Set smaller text. + |`-- font() Set the font of the text. + | + |`--+ bg + | | + | |`-- color() Set background color. + | |`-- focus() Set focus background color. + | |`-- normal() Set normal background color. + | `-- urgent() Set urgent background color. + | + |`--+ fg + | | + | |`-- color() Set foreground color. + | |`-- focus() Set focus foreground color. + | |`-- normal() Set normal foreground color. + | `-- urgent() Set urgent foreground color. + | + |`-- focus() Set both foreground and background focus colors. + |`-- normal() Set both foreground and background normal colors. + `-- urgent() Set both foreground and background urgent colors. + menu\_clients\_current\_tags ---------------------------- From 2b664e5d77ceaa6f0c7d48e18c4940ad7ac043ea Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 06:42:07 -0700 Subject: [PATCH 081/303] Updated Utilities (markdown) --- Utilities.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/Utilities.md b/Utilities.md index 4fc80e4..168d95f 100644 --- a/Utilities.md +++ b/Utilities.md @@ -5,7 +5,7 @@ markup This is a submodule which helps you markupping your text. -First, call it like this: +First, require it like this: local markup = require("lain.util.markup") @@ -40,6 +40,11 @@ then you can call its functions: |`-- normal() Set both foreground and background normal colors. `-- urgent() Set both foreground and background urgent colors. +they all take one argument, which is the text to markup, except `fg.color()` and `bg.color()`: + + markup.fg.color(text, color) + markup.bg.color(text, color) + menu\_clients\_current\_tags ---------------------------- From 1c5e9e93b9a3fbd7eeabfa441e9fbb31b3499526 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 06:42:31 -0700 Subject: [PATCH 082/303] Updated Utilities (markdown) --- Utilities.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Utilities.md b/Utilities.md index 168d95f..8bb7597 100644 --- a/Utilities.md +++ b/Utilities.md @@ -40,7 +40,7 @@ then you can call its functions: |`-- normal() Set both foreground and background normal colors. `-- urgent() Set both foreground and background urgent colors. -they all take one argument, which is the text to markup, except `fg.color()` and `bg.color()`: +they all take one argument, which is the text to markup, except `fg.color` and `bg.color`: markup.fg.color(text, color) markup.bg.color(text, color) From 88c301fe2d894c8d819233f0c7d6a03590d94676 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 06:43:33 -0700 Subject: [PATCH 083/303] Updated Home (markdown) --- Home.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Home.md b/Home.md index 5dfbd14..b98a1dd 100644 --- a/Home.md +++ b/Home.md @@ -1,3 +1,5 @@ +Welcome to the Lain wiki! + ### Installation Simply clone this repository into your Awesome directory. From 7d89def8baf408b1618a18e3a0fe8977c5f669b5 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 08:02:39 -0700 Subject: [PATCH 084/303] Created yawn (rest) --- yawn.rest | 133 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 133 insertions(+) create mode 100644 yawn.rest diff --git a/yawn.rest b/yawn.rest new file mode 100644 index 0000000..f8fc130 --- /dev/null +++ b/yawn.rest @@ -0,0 +1,133 @@ +========================================= +Yahoo's Awesome (WM) Weather Notification +========================================= + +---------------- +Lain integration +---------------- + +:Author: Luke Bonham +:License: WTFPLv2_ +:Version: 2.0-git + +Description +----------- + +Yawn is a module for Awesome WM providing brief and compact +weather notification via Naughty and Yahoo! Weather API. + +Originally a port of perceptive_, it became a completely new module after various improvements and style changes. + +----- +Usage +----- + +You can ``register`` Yawn to get a set of widgets, or ``attach`` it to +an existent widget. + +register +^^^^^^^^ + +Call: :: + + lain.widgets.yawn(id, args) + +Arguments: + +``id`` + An integer that defines the WOEID code of your city. + To obtain it you can google 'yahoo weather %CITYNAME%' and follow the first link. + It will look like:: + + http://weather.yahoo.com/united-states/california/san-diego-2487889/ + + and the last number in that link will be the ID you need. +``args`` + An optional table which can contain the following settings: + ``u`` + Units. Type: string. Possible values: "c" (Celsius), "f" (Fahrenheit). Default: "c". + + ``toshow`` + What to show. Type: string. Possible values: "units", "forecast", "both". + Default: "forecast". + + ``units_color`` + Color of units text. Type: string. Possible values: hexadecimal color + codes. + + ``forecast_color`` + Color of forecast text. Type: string. Possible values: hexadecimal color + codes. + + ``notification_color`` + Color of notification text. Type: string. Possible values: hexadecimal color + codes. + + ``spr`` + A separator. Type: string. You can define it when ``toshow`` is set to "both". + + ``footer`` + A footer. Type: string. You can define it when ``toshow`` is set to + "both". + +The function creates an imagebox icon and a textbox widget. Add them to you wibox like this: :: + + right_layout:add(lain.widgets.yawn.icon) + right_layout:add(lain.widgets.yawn.widget) + +Hovering over ``yawn.icon`` will display the notification. + +attach +^^^^^^ + +Call: :: + + lain.widgets.yawn.attach(widget, id, args) + +Arguments: + +``widget`` + The widget which you want to attach yawn to. +``id`` + same as in ``register`` +``args`` + same as in ``register`` + +Hovering over ``widget`` will display the notification. + +-------------- +Popup shortcut +-------------- + +You can also create a keybinding for the weather popup like this: :: + + globalkeys = awful.util.table.join( + ... + awful.key( { "Mod1" }, "w", function () lain.widgets.yawn.show(5) end ) + ... + +where ``show`` argument is an integer defining timeout seconds. + +------------ +Localization +------------ + +Default language is English, but Yawn can be localized. +Move to ``localizations`` subdirectory and fill ``localization_template``. + +Once you're done, rename it like your locale id. In my case: :: + + $ lua + Lua 5.2.2 Copyright (C) 1994-2013 Lua.org, PUC-Rio + > print(os.getenv("LANG"):match("(%S*$*)[.]")) + it_IT + > + +hence I named my file "it_IT" (Italian localization). + +**NOTE:** If you create a localization, feel free to send me! I will add it. + +.. _WTFPLv2: http://www.wtfpl.net +.. _perceptive: https://github.com/ioga/perceptive +.. _Tamsyn: http://www.fial.com/~scott/tamsyn-font/ +.. _Rainbow: https://github.com/copycat-killer/awesome-copycats> \ No newline at end of file From cef70fe99fc0a6a868ba76e0509aeeed202f44cf Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 08:11:23 -0700 Subject: [PATCH 085/303] Updated yawn (rest) --- yawn.rest | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/yawn.rest b/yawn.rest index f8fc130..8991040 100644 --- a/yawn.rest +++ b/yawn.rest @@ -1,10 +1,4 @@ -========================================= -Yahoo's Awesome (WM) Weather Notification -========================================= - ----------------- -Lain integration ----------------- +*This is an integration of this* module_. :Author: Luke Bonham :License: WTFPLv2_ @@ -127,6 +121,7 @@ hence I named my file "it_IT" (Italian localization). **NOTE:** If you create a localization, feel free to send me! I will add it. +.. _module: https://github.com/copycat-killer/yawn .. _WTFPLv2: http://www.wtfpl.net .. _perceptive: https://github.com/ioga/perceptive .. _Tamsyn: http://www.fial.com/~scott/tamsyn-font/ From d4707ba3acb85dd10753848d661aa591660aff72 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 08:12:13 -0700 Subject: [PATCH 087/303] Updated yawn (rest) --- yawn.rest | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yawn.rest b/yawn.rest index 8991040..4551597 100644 --- a/yawn.rest +++ b/yawn.rest @@ -1,4 +1,4 @@ -*This is an integration of this* module_. +(*Integration of this* module_) :Author: Luke Bonham :License: WTFPLv2_ From 3412fcbd9201a035f948182f0e4b943331c133c4 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 08:12:59 -0700 Subject: [PATCH 088/303] Updated Widgets (markdown) --- Widgets.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Widgets.md b/Widgets.md index f6fde73..53c6f04 100644 --- a/Widgets.md +++ b/Widgets.md @@ -19,4 +19,5 @@ We say this because, for some widget, `function` return a table to be used for n - [mpd](https://github.com/copycat-killer/lain/wiki/mpd) - [net](https://github.com/copycat-killer/lain/wiki/net) - [sysload](https://github.com/copycat-killer/lain/wiki/sysload) -- [temp](https://github.com/copycat-killer/lain/wiki/temp) \ No newline at end of file +- [temp](https://github.com/copycat-killer/lain/wiki/temp) +- [yawn](https://github.com/copycat-killer/lain/wiki/yawn) \ No newline at end of file From 0ef5a7d0006868e9c11cad2861435b8f884aa9ac Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 11:32:52 -0700 Subject: [PATCH 089/303] Updated To start (markdown) --- To-start.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/To-start.md b/To-start.md index 36f32a0..a2be5ff 100644 --- a/To-start.md +++ b/To-start.md @@ -1,6 +1,4 @@ -[<- home](https://github.com/copycat-killer/lain/wiki) - -All you have to do is to include the module: +All you have to do to include the module: local lain = require("lain") From 194f362372d5c4098d1f8498d95fe10dd2d506d2 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 11:33:09 -0700 Subject: [PATCH 090/303] Updated Layouts (markdown) --- Layouts.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/Layouts.md b/Layouts.md index f9dd490..7c4ff41 100644 --- a/Layouts.md +++ b/Layouts.md @@ -1,5 +1,3 @@ -[<- home](https://github.com/copycat-killer/lain/wiki) - Currently, there are **7** layouts. lain/layout From 7ff53f54e9a868170c38948c2ddd62fc79222c93 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 11:33:31 -0700 Subject: [PATCH 091/303] Updated Widgets (markdown) --- Widgets.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/Widgets.md b/Widgets.md index 53c6f04..cdcac1b 100644 --- a/Widgets.md +++ b/Widgets.md @@ -1,5 +1,3 @@ -[<- home](https://github.com/copycat-killer/lain/wiki) - Every widget is output by a `function`. Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`. From c32b6e91edba7d9a6672dbd294f7cfa7bfacc42a Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 11:33:45 -0700 Subject: [PATCH 092/303] Updated Utilities (markdown) --- Utilities.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/Utilities.md b/Utilities.md index 8bb7597..3cf188e 100644 --- a/Utilities.md +++ b/Utilities.md @@ -1,5 +1,3 @@ -[<- home](https://github.com/copycat-killer/lain/wiki) - markup ------ From 8d112ea2cd0ed4abab24f16fbca0ae688bb6fc7b Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 11:35:11 -0700 Subject: [PATCH 093/303] Updated Utilities (markdown) --- Utilities.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Utilities.md b/Utilities.md index 3cf188e..cbf8c0f 100644 --- a/Utilities.md +++ b/Utilities.md @@ -49,7 +49,8 @@ menu\_clients\_current\_tags Similar to `awful.menu.clients()`, but this menu only shows the clients of currently visible tags. Use it with a key binding like this: - awful.key({ "Mod1" }, "Tab", function() + awful.key({ "Mod1" }, "Tab", + function() awful.menu.menu_keys.down = { "Down", "Alt_L", "Tab", "j" } awful.menu.menu_keys.up = { "Up", "k" } lain.util.menu_clients_current_tags({ width = 350 }, { keygrabber = true }) From 67a821b750f9ba0bbc990bd6f2f07cec467ab0fc Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 11:36:21 -0700 Subject: [PATCH 094/303] Updated Widgets (markdown) --- Widgets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Widgets.md b/Widgets.md index cdcac1b..6e6d361 100644 --- a/Widgets.md +++ b/Widgets.md @@ -8,7 +8,7 @@ We say this because, for some widget, `function` return a table to be used for n - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) - [bat](https://github.com/copycat-killer/lain/wiki/bat) - [borderbox](https://github.com/copycat-killer/lain/wiki/borderbox) -- [calendar](https://github.com/copycat-killer/lain/wiki/caldendar) +- [calendar](https://github.com/copycat-killer/lain/wiki/calendar) - [cpu](https://github.com/copycat-killer/lain/wiki/cpu) - [fs](https://github.com/copycat-killer/lain/wiki/fs) - [imap](https://github.com/copycat-killer/lain/wiki/imap) From 59d91e51b01ff74af47190c0bd9e25ef97f83018 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 16:20:57 -0700 Subject: [PATCH 095/303] Updated calendar (markdown) --- calendar.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/calendar.md b/calendar.md index 182c805..1d63a65 100644 --- a/calendar.md +++ b/calendar.md @@ -1,11 +1,11 @@ Attaches a calendar notification to a widget. - lain.widgets.calendar:attach(mywidget) + lain.widgets.calendar:attach(widget) - Left click: switch to previous month. - Right click: switch to next month. -Optionally you can call the function with background and foreground colors arguments, both or just one: +Optionally you can call the function with bg and fg colors arguments, both or just one: lain.widgets.calendar:attach(mytextclock, "#FFFFFF", "#000000") -- or @@ -13,6 +13,8 @@ Optionally you can call the function with background and foreground colors argum -- or lain.widgets.calendar:attach(mytextclock, nil, "#000000") +default bg and fg colors are `beautiful.bg_normal` and `beautiful.fg_focus`. + Notification will show an icon displaying current day, and formatted output from ``cal`` with current day highlighted. From 54dc002251d1ce8e4304a601533db3df1cdbad6c Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 16:35:54 -0700 Subject: [PATCH 097/303] Updated calendar (markdown) --- calendar.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/calendar.md b/calendar.md index 1d63a65..2b75840 100644 --- a/calendar.md +++ b/calendar.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + Attaches a calendar notification to a widget. lain.widgets.calendar:attach(widget) From 28de71f2dff723991cae7495ff46026bf64295c7 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 16:37:33 -0700 Subject: [PATCH 098/303] Updated mpd (markdown) --- mpd.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/mpd.md b/mpd.md index 27f3faf..33a0dd6 100644 --- a/mpd.md +++ b/mpd.md @@ -46,24 +46,24 @@ Finally, you can control the widget with key bindings like these: -- MPD control awful.key({ altkey, "Control" }, "Up", - function () - awful.util.spawn_with_shell( "mpc toggle || ncmpcpp toggle || ncmpc toggle || pms toggle", false ) - mympd.notify() - end), + function () + awful.util.spawn_with_shell("mpc toggle || ncmpcpp toggle || ncmpc toggle || pms toggle") + mpdwidget.notify() + end), awful.key({ altkey, "Control" }, "Down", - function () - awful.util.spawn_with_shell( "mpc stop || ncmpcpp stop || ncmpc stop || pms stop", false ) - mympd.notify() - end), + function () + awful.util.spawn_with_shell("mpc stop || ncmpcpp stop || ncmpc stop || pms stop") + mpdwidget.notify() + end), awful.key({ altkey, "Control" }, "Left", - function () - awful.util.spawn_with_shell( "mpc prev || ncmpcpp prev || ncmpc prev || pms prev", false ) - mympd.notify() - end), + function () + awful.util.spawn_with_shell("mpc prev || ncmpcpp prev || ncmpc prev || pms prev") + mpdwidget.notify() + end), awful.key({ altkey, "Control" }, "Right", - function () - awful.util.spawn_with_shell( "mpc next || ncmpcpp next || ncmpc next || pms next", false ) - mympd.notify() - end), + function () + awful.util.spawn_with_shell("mpc next || ncmpcpp next || ncmpc next || pms next") + mpdwidget.notify() + end), where `altkey = "Mod1"`. \ No newline at end of file From d34ff4b11ff7ffe2b26d459977bea173e0db2f65 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 05:01:10 -0700 Subject: [PATCH 099/303] Updated Home (markdown) --- Home.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Home.md b/Home.md index b98a1dd..9342879 100644 --- a/Home.md +++ b/Home.md @@ -2,7 +2,9 @@ Welcome to the Lain wiki! ### Installation -Simply clone this repository into your Awesome directory. +Simply clone this repository into your Awesome directory: + + git clone https://github.com/copycat-killer/lain.git ~/.config/awesome/lain ### Index From 5de0628f0dd7221c11e364c0ad3b3ca169e5e107 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 05:15:50 -0700 Subject: [PATCH 100/303] Updated mpd (markdown) --- mpd.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mpd.md b/mpd.md index 33a0dd6..4b97f05 100644 --- a/mpd.md +++ b/mpd.md @@ -27,8 +27,8 @@ Variable | Meaning | Type | Default `port` | MPD port | string | "6600" `music_dir` | Music directory | string | "~/Music" `refresh_timeout` | Refresh timeout seconds | int | 1 -`color_artist` | Artist value color | string | `beautiful.fg_normal` or "#FFFFFF" -`color_song` | Song value color | string | `beautiful.fg_focus` or "#FFFFFF" +`header_color` | Artist value color | string | `beautiful.fg_normal` or "#FFFFFF" +`color` | Song value color | string | `beautiful.fg_focus` or "#FFFFFF" `spr` | Separator text between artist and song values | string | " " `app` | Music program to spawn on click | string | "ncmpcpp" `shadow` | Hide widget when there are no songs playing | boolean | false From 3c0d8fea91aa3fc158c4314bbb96304d6b275f81 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 05:20:21 -0700 Subject: [PATCH 101/303] Updated imap (markdown) --- imap.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/imap.md b/imap.md index d7e68b4..47e7b51 100644 --- a/imap.md +++ b/imap.md @@ -40,8 +40,7 @@ Variable | Meaning | Type | Default `refresh_timeout` | Refresh timeout seconds | int | 60 `header` | Text to show before value | string | " Mail " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" -`color_newmail` | New mail value color | string | `beautiful.fg_focus` or "#FFFFFF" -`color_nomail` | No mail value color | string | `beautiful.fg_normal` or "#FFFFFF" +`color` | Mail value color | string | `beautiful.fg_focus` or "#FFFFFF" `mail_encoding` | Mail character encoding | string | autodetected `maxlen` | Maximum chars to display in notification | int | 200 `app` | Mail program to spawn on click | string | "mutt" From 9ceccbb5982ac45646e0dc4ed3ae5fbfa6832f3c Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 06:14:11 -0700 Subject: [PATCH 102/303] Updated yawn (rest => markdown) --- yawn.md | 89 +++++++++++++++++++++++++++++++++++++ yawn.rest | 128 ------------------------------------------------------ 2 files changed, 89 insertions(+), 128 deletions(-) create mode 100644 yawn.md delete mode 100644 yawn.rest diff --git a/yawn.md b/yawn.md new file mode 100644 index 0000000..fa6e91c --- /dev/null +++ b/yawn.md @@ -0,0 +1,89 @@ +Yahoo's Awesome Weather notification +----------- + +Yawn provides brief and compact weather notification via Naughty and Yahoo! Weather API. + +Usage +----- + +You can ``register`` Yawn to get a set of widgets, or ``attach`` it to +an existent widget. + +### register + + yawn = lain.widgets.yawn(id, args) + +- ``id`` + + An integer that defines the WOEID code of your city. + To obtain it you can google 'yahoo weather %CITYNAME%' and follow the first link. + It will look like: + + http://weather.yahoo.com/united-states/california/san-diego-2487889/ + + and the last number in that link will be the ID you need. + +- ``args`` + + An optional table which can contain the following settings: + + Variables | Meaning | Type | Possible values | Default value + --- | --- | --- | --- | --- + `u` | Units | string | "c" (Celsius), "f" (Fahrenheit) | "c" + `toshow` | What to show | string | "forecast", "units", "both" | "forecast" + `color` | ``yawn.widget`` color | string | hexadecimal colors | + +The function creates an imagebox icon and a textbox widget. Add them to you wibox like this: + + right_layout:add(yawn.icon) + right_layout:add(yawn.widget) + +Hovering over ``yawn.icon`` will display the notification. + +### attach + + lain.widgets.yawn.attach(widget, id, args) + +Arguments: + +- ``widget`` + + The widget which you want to attach yawn to. + +- ``id`` + + Same as in ``register``. + +- ``args`` + + Same as in ``register``. + +Hovering over ``widget`` will display the notification. + +Popup shortcut +-------------- + +You can also create a keybinding for the weather popup like this: :: + + awful.key( { "Mod1" }, "w", function () yawn.show(5) end ) + +where ``show`` argument is an integer defining timeout seconds. + +Localization +------------ + +Default language is English, but Yawn can be localized. + +Move to `localizations` subdirectory and fill `localization_template`. + +Once you're done, rename it like your locale id. In my case: + + $ lua + Lua 5.2.2 Copyright (C) 1994-2013 Lua.org, PUC-Rio + > print(os.getenv("LANG"):match("(%S*$*)[.]")) + it_IT + > + +hence I named my file "it_IT" (Italian localization). + +**NOTE:** If you create a localization, feel free to send me! I will add it. \ No newline at end of file diff --git a/yawn.rest b/yawn.rest deleted file mode 100644 index 4551597..0000000 --- a/yawn.rest +++ /dev/null @@ -1,128 +0,0 @@ -(*Integration of this* module_) - -:Author: Luke Bonham -:License: WTFPLv2_ -:Version: 2.0-git - -Description ------------ - -Yawn is a module for Awesome WM providing brief and compact -weather notification via Naughty and Yahoo! Weather API. - -Originally a port of perceptive_, it became a completely new module after various improvements and style changes. - ------ -Usage ------ - -You can ``register`` Yawn to get a set of widgets, or ``attach`` it to -an existent widget. - -register -^^^^^^^^ - -Call: :: - - lain.widgets.yawn(id, args) - -Arguments: - -``id`` - An integer that defines the WOEID code of your city. - To obtain it you can google 'yahoo weather %CITYNAME%' and follow the first link. - It will look like:: - - http://weather.yahoo.com/united-states/california/san-diego-2487889/ - - and the last number in that link will be the ID you need. -``args`` - An optional table which can contain the following settings: - ``u`` - Units. Type: string. Possible values: "c" (Celsius), "f" (Fahrenheit). Default: "c". - - ``toshow`` - What to show. Type: string. Possible values: "units", "forecast", "both". - Default: "forecast". - - ``units_color`` - Color of units text. Type: string. Possible values: hexadecimal color - codes. - - ``forecast_color`` - Color of forecast text. Type: string. Possible values: hexadecimal color - codes. - - ``notification_color`` - Color of notification text. Type: string. Possible values: hexadecimal color - codes. - - ``spr`` - A separator. Type: string. You can define it when ``toshow`` is set to "both". - - ``footer`` - A footer. Type: string. You can define it when ``toshow`` is set to - "both". - -The function creates an imagebox icon and a textbox widget. Add them to you wibox like this: :: - - right_layout:add(lain.widgets.yawn.icon) - right_layout:add(lain.widgets.yawn.widget) - -Hovering over ``yawn.icon`` will display the notification. - -attach -^^^^^^ - -Call: :: - - lain.widgets.yawn.attach(widget, id, args) - -Arguments: - -``widget`` - The widget which you want to attach yawn to. -``id`` - same as in ``register`` -``args`` - same as in ``register`` - -Hovering over ``widget`` will display the notification. - --------------- -Popup shortcut --------------- - -You can also create a keybinding for the weather popup like this: :: - - globalkeys = awful.util.table.join( - ... - awful.key( { "Mod1" }, "w", function () lain.widgets.yawn.show(5) end ) - ... - -where ``show`` argument is an integer defining timeout seconds. - ------------- -Localization ------------- - -Default language is English, but Yawn can be localized. -Move to ``localizations`` subdirectory and fill ``localization_template``. - -Once you're done, rename it like your locale id. In my case: :: - - $ lua - Lua 5.2.2 Copyright (C) 1994-2013 Lua.org, PUC-Rio - > print(os.getenv("LANG"):match("(%S*$*)[.]")) - it_IT - > - -hence I named my file "it_IT" (Italian localization). - -**NOTE:** If you create a localization, feel free to send me! I will add it. - -.. _module: https://github.com/copycat-killer/yawn -.. _WTFPLv2: http://www.wtfpl.net -.. _perceptive: https://github.com/ioga/perceptive -.. _Tamsyn: http://www.fial.com/~scott/tamsyn-font/ -.. _Rainbow: https://github.com/copycat-killer/awesome-copycats> \ No newline at end of file From 2c616b6b27047ef8f807d6edb80c4da005701903 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 06:15:08 -0700 Subject: [PATCH 103/303] Updated yawn (markdown) --- yawn.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yawn.md b/yawn.md index fa6e91c..b58846c 100644 --- a/yawn.md +++ b/yawn.md @@ -48,7 +48,7 @@ Arguments: - ``widget`` - The widget which you want to attach yawn to. + The widget which you want to attach Yawn to. - ``id`` From e10db094153d2d2cc605aac179a0f18ed7161929 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 06:19:10 -0700 Subject: [PATCH 104/303] Updated yawn (markdown) --- yawn.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/yawn.md b/yawn.md index b58846c..070bf2e 100644 --- a/yawn.md +++ b/yawn.md @@ -1,7 +1,6 @@ -Yahoo's Awesome Weather notification ------------ +(YAhoo! Weather Notification) -Yawn provides brief and compact weather notification via Naughty and Yahoo! Weather API. +Yawn provides brief and compact Yahoo! Weather notification. Usage ----- @@ -63,7 +62,7 @@ Hovering over ``widget`` will display the notification. Popup shortcut -------------- -You can also create a keybinding for the weather popup like this: :: +You can also create a keybinding for the weather popup like this: awful.key( { "Mod1" }, "w", function () yawn.show(5) end ) From 24144da70de059d5eb5b81d0bd6bf61ce6b36dd6 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 09:12:28 -0700 Subject: [PATCH 105/303] Updated calendar (markdown) --- calendar.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/calendar.md b/calendar.md index 2b75840..5b4587d 100644 --- a/calendar.md +++ b/calendar.md @@ -7,7 +7,7 @@ Attaches a calendar notification to a widget. - Left click: switch to previous month. - Right click: switch to next month. -Optionally you can call the function with bg and fg colors arguments, both or just one: +Optionally you can call the function with fg and bg colors arguments, both or just one: lain.widgets.calendar:attach(mytextclock, "#FFFFFF", "#000000") -- or @@ -15,7 +15,7 @@ Optionally you can call the function with bg and fg colors arguments, both or ju -- or lain.widgets.calendar:attach(mytextclock, nil, "#000000") -default bg and fg colors are `beautiful.bg_normal` and `beautiful.fg_focus`. +default fg and fb colors are `beautiful.fg_focus` and `beautiful.bg_normal`. Notification will show an icon displaying current day, and formatted output from ``cal`` with current day highlighted. From 87e14e029c7112a6628d0ef149d65d675ef5c5c6 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 09:29:56 -0700 Subject: [PATCH 106/303] Updated cpu (markdown) --- cpu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpu.md b/cpu.md index 9dcc894..7f7cd82 100644 --- a/cpu.md +++ b/cpu.md @@ -9,7 +9,7 @@ The function takes a table as optional argument, which can contain: Variable | Meaning | Type | Default --- | --- | --- | --- `refresh_timeout` | Refresh timeout seconds | int | 10 -`header` | Text to show before value | string | " Cpu " +`header` | Text to show before value | string | "Cpu" `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" `footer` | Text to add after value | string | "%" From c0d4434ee153a9dcc7d9ee471ab34a12d5abfa79 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 09:30:21 -0700 Subject: [PATCH 107/303] Updated cpu (markdown) --- cpu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpu.md b/cpu.md index 7f7cd82..8a3d5d8 100644 --- a/cpu.md +++ b/cpu.md @@ -9,7 +9,7 @@ The function takes a table as optional argument, which can contain: Variable | Meaning | Type | Default --- | --- | --- | --- `refresh_timeout` | Refresh timeout seconds | int | 10 -`header` | Text to show before value | string | "Cpu" +`header` | Text to show before value | string | "Cpu " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" `footer` | Text to add after value | string | "%" From cd5dc23194baf0c769e2ee78537529b1815cb083 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 09:30:32 -0700 Subject: [PATCH 108/303] Updated bat (markdown) --- bat.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bat.md b/bat.md index 79c17da..2d80786 100644 --- a/bat.md +++ b/bat.md @@ -14,7 +14,7 @@ Variable | Meaning | Type | Default `battery` | Identifier of the battery | string | "BAT0" `show_all` | Show all values (true), or only remaining capacity (false) | boolean | false `refresh_timeout` | Refresh timeout seconds | int | 30 -`header` | Text to show before value | string | " Bat " +`header` | Text to show before value | string | "Bat " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" `shadow` | Hide the widget when battery is not present | boolean | false \ No newline at end of file From 41d5a985db4af03af4f658ce69e97e599d97106e Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 09:31:22 -0700 Subject: [PATCH 109/303] Updated fs (markdown) --- fs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fs.md b/fs.md index 4946fe7..ccb7386 100644 --- a/fs.md +++ b/fs.md @@ -12,7 +12,7 @@ Variable | Meaning | Type | Default --- | --- | --- | --- `partition` | Partition to monitor | string | "/" `refresh_timeout` | Refresh timeout seconds | int | 600 -`header` | Text to show before value | string | " Hdd " +`header` | Text to show before value | string | "Hdd " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" `footer` | Text to show after value | string | "%" From 07040e6db6de9fba139c9a60d0c453962dc4276e Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 09:33:20 -0700 Subject: [PATCH 110/303] Updated imap (markdown) --- imap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/imap.md b/imap.md index 47e7b51..e30f688 100644 --- a/imap.md +++ b/imap.md @@ -38,7 +38,7 @@ Variable | Meaning | Type | Default --- | --- | --- | --- `port` | IMAP port | int | 993 `refresh_timeout` | Refresh timeout seconds | int | 60 -`header` | Text to show before value | string | " Mail " +`header` | Text to show before value | string | "Mail " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Mail value color | string | `beautiful.fg_focus` or "#FFFFFF" `mail_encoding` | Mail character encoding | string | autodetected From 787612387af2e39504084d3cde7f7d69eb16d442 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 09:34:36 -0700 Subject: [PATCH 111/303] Updated mem (markdown) --- mem.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mem.md b/mem.md index 173452d..69db14b 100644 --- a/mem.md +++ b/mem.md @@ -13,7 +13,7 @@ Variable | Meaning | Type | Default `refresh_timeout` | Refresh timeout seconds | int | 10 `show_swap` | Show amount of used swap space? | boolean | false `show_total` | Show amout of total memory? | boolean | false -`header` | Text to show before value | string | " Mem " +`header` | Text to show before value | string | "Mem " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" `footer` | Text to show after value | string | "MB" From 806d7f3a97b19235c49240bd8d718cd0150fa08e Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 09:51:36 -0700 Subject: [PATCH 112/303] Updated bat (markdown) --- bat.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bat.md b/bat.md index 2d80786..79c17da 100644 --- a/bat.md +++ b/bat.md @@ -14,7 +14,7 @@ Variable | Meaning | Type | Default `battery` | Identifier of the battery | string | "BAT0" `show_all` | Show all values (true), or only remaining capacity (false) | boolean | false `refresh_timeout` | Refresh timeout seconds | int | 30 -`header` | Text to show before value | string | "Bat " +`header` | Text to show before value | string | " Bat " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" `shadow` | Hide the widget when battery is not present | boolean | false \ No newline at end of file From 09c8c2d740ff589236ea02416d7b81e65ab1338d Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 09:51:51 -0700 Subject: [PATCH 113/303] Updated cpu (markdown) --- cpu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpu.md b/cpu.md index 8a3d5d8..9dcc894 100644 --- a/cpu.md +++ b/cpu.md @@ -9,7 +9,7 @@ The function takes a table as optional argument, which can contain: Variable | Meaning | Type | Default --- | --- | --- | --- `refresh_timeout` | Refresh timeout seconds | int | 10 -`header` | Text to show before value | string | "Cpu " +`header` | Text to show before value | string | " Cpu " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" `footer` | Text to add after value | string | "%" From c07a1c8721596823a948b76f48feb61a6b309fee Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 09:52:01 -0700 Subject: [PATCH 114/303] Updated cpu (markdown) --- cpu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpu.md b/cpu.md index 9dcc894..1dce16e 100644 --- a/cpu.md +++ b/cpu.md @@ -12,6 +12,6 @@ Variable | Meaning | Type | Default `header` | Text to show before value | string | " Cpu " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" -`footer` | Text to add after value | string | "%" +`footer` | Text to add after value | string | "% " **Note**: `footer` color is `color`. \ No newline at end of file From 4986ccc0192fac14ffe0f6a9d69ad99325ea98a9 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 09:52:39 -0700 Subject: [PATCH 115/303] Updated fs (markdown) --- fs.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/fs.md b/fs.md index ccb7386..eb67110 100644 --- a/fs.md +++ b/fs.md @@ -12,10 +12,10 @@ Variable | Meaning | Type | Default --- | --- | --- | --- `partition` | Partition to monitor | string | "/" `refresh_timeout` | Refresh timeout seconds | int | 600 -`header` | Text to show before value | string | "Hdd " +`header` | Text to show before value | string | " Hdd " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" -`footer` | Text to show after value | string | "%" +`footer` | Text to show after value | string | " " `shadow` | Hide the widget if `partition` < 90 | boolean | false **Note**: `footer` color is `color`. From 57a0abbbf759c0a4ced125a9ff0ada943851d5ae Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 09:54:06 -0700 Subject: [PATCH 116/303] Updated imap (markdown) --- imap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/imap.md b/imap.md index e30f688..47e7b51 100644 --- a/imap.md +++ b/imap.md @@ -38,7 +38,7 @@ Variable | Meaning | Type | Default --- | --- | --- | --- `port` | IMAP port | int | 993 `refresh_timeout` | Refresh timeout seconds | int | 60 -`header` | Text to show before value | string | "Mail " +`header` | Text to show before value | string | " Mail " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Mail value color | string | `beautiful.fg_focus` or "#FFFFFF" `mail_encoding` | Mail character encoding | string | autodetected From 29157ca037eb6d2ab785fd7024bc1a116a9e8a87 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 09:55:18 -0700 Subject: [PATCH 117/303] Updated mem (markdown) --- mem.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mem.md b/mem.md index 69db14b..68c6748 100644 --- a/mem.md +++ b/mem.md @@ -13,9 +13,9 @@ Variable | Meaning | Type | Default `refresh_timeout` | Refresh timeout seconds | int | 10 `show_swap` | Show amount of used swap space? | boolean | false `show_total` | Show amout of total memory? | boolean | false -`header` | Text to show before value | string | "Mem " +`header` | Text to show before value | string | " Mem " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" -`footer` | Text to show after value | string | "MB" +`footer` | Text to show after value | string | "MB " **Note**: `footer` color is `color`. \ No newline at end of file From 825ea53e63a016ed60e4342353ed0c4521a3ec8b Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 10:20:49 -0700 Subject: [PATCH 118/303] Updated mpd (markdown) --- mpd.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/mpd.md b/mpd.md index 4b97f05..4a3398a 100644 --- a/mpd.md +++ b/mpd.md @@ -29,11 +29,12 @@ Variable | Meaning | Type | Default `refresh_timeout` | Refresh timeout seconds | int | 1 `header_color` | Artist value color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Song value color | string | `beautiful.fg_focus` or "#FFFFFF" +`footer` | Text to append to values | string | "" `spr` | Separator text between artist and song values | string | " " `app` | Music program to spawn on click | string | "ncmpcpp" `shadow` | Hide widget when there are no songs playing | boolean | false -**Note**: `spr` can be a markup text. +**Note**: `footer` and `spr` can be markup text. `lain.widgets.mpd` outputs the following table: From f075850c6b45229efa768dc62a776420fed5b420 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 10:21:51 -0700 Subject: [PATCH 119/303] Updated mpd (markdown) --- mpd.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mpd.md b/mpd.md index 4a3398a..1d35f02 100644 --- a/mpd.md +++ b/mpd.md @@ -29,12 +29,12 @@ Variable | Meaning | Type | Default `refresh_timeout` | Refresh timeout seconds | int | 1 `header_color` | Artist value color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Song value color | string | `beautiful.fg_focus` or "#FFFFFF" -`footer` | Text to append to values | string | "" `spr` | Separator text between artist and song values | string | " " +`footer` | Text to append after values | string | "" `app` | Music program to spawn on click | string | "ncmpcpp" `shadow` | Hide widget when there are no songs playing | boolean | false -**Note**: `footer` and `spr` can be markup text. +**Note**: `spr` and `footer` can be markup text. `lain.widgets.mpd` outputs the following table: From 13e970ca857ef64905ab64883d5621d326a36319 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 16:42:15 -0700 Subject: [PATCH 120/303] Updated net (markdown) --- net.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/net.md b/net.md index b02c239..82772d7 100644 --- a/net.md +++ b/net.md @@ -14,11 +14,12 @@ Variable | Meaning | Type | Default `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` can be a markup text. +**Note**: `spr` and `footer` can be a markup text. Possible value for `units` are stored in table `lain.widgets.net.units`, which contains: From a9073b7f86fe7540bad749c5d035f43c7ddd183d Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 16:51:10 -0700 Subject: [PATCH 121/303] Updated alsabar (markdown) --- alsabar.md | 1 + 1 file changed, 1 insertion(+) diff --git a/alsabar.md b/alsabar.md index 9338ff8..9b5a711 100644 --- a/alsabar.md +++ b/alsabar.md @@ -42,6 +42,7 @@ Variable | Meaning | Type | Default --- | --- | --- | --- `font` | Notifications font | string | The one defined in `beautiful.font` `font_size` | Notifications font size | string | "11" +`color` | Notifications color | string | `beautiful.fg_focus` `bar_size` | Wibox height | int | 18 It's **crucial** to set `notifications.bar_size` to your `mywibox[s]` height, From 14886c85add2201b0fee20692f609a610502f450 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 8 Sep 2013 17:09:36 -0700 Subject: [PATCH 122/303] Updated mpd (markdown) --- mpd.md | 1 + 1 file changed, 1 insertion(+) diff --git a/mpd.md b/mpd.md index 1d35f02..7640b4c 100644 --- a/mpd.md +++ b/mpd.md @@ -27,6 +27,7 @@ Variable | Meaning | Type | Default `port` | MPD port | string | "6600" `music_dir` | Music directory | string | "~/Music" `refresh_timeout` | Refresh timeout seconds | int | 1 +`pre` | Text before values | string | "" `header_color` | Artist value color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Song value color | string | `beautiful.fg_focus` or "#FFFFFF" `spr` | Separator text between artist and song values | string | " " From 33f0fe93e0a581dedf4991e2cccacb82396e6eb0 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 9 Sep 2013 04:52:53 -0700 Subject: [PATCH 123/303] Updated alsa (markdown) --- alsa.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/alsa.md b/alsa.md index 4cfa8f3..337f7e8 100644 --- a/alsa.md +++ b/alsa.md @@ -17,8 +17,11 @@ Variable | Meaning | Type | Default `header` | Text to show before value | string | " Vol " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" +`footer` | Text to append after value | string | "" -and outputs the following table: +*Note*: `footer` can be markup text. + +`lain.widgets.alsa` outputs the following table: Variable | Meaning | Type --- | --- | --- From babddf023fba21f391c7309f30b48d82de92ea3f Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 9 Sep 2013 04:53:58 -0700 Subject: [PATCH 124/303] Updated alsa (markdown) --- alsa.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/alsa.md b/alsa.md index 337f7e8..2ca1746 100644 --- a/alsa.md +++ b/alsa.md @@ -17,7 +17,7 @@ Variable | Meaning | Type | Default `header` | Text to show before value | string | " Vol " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" -`footer` | Text to append after value | string | "" +`footer` | Text to append after value | string | " " *Note*: `footer` can be markup text. From 33b02c39b04508303a01a91a3481c254a8227fe5 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 9 Sep 2013 04:58:26 -0700 Subject: [PATCH 125/303] Updated bat (markdown) --- bat.md | 1 + 1 file changed, 1 insertion(+) diff --git a/bat.md b/bat.md index 79c17da..5d89b14 100644 --- a/bat.md +++ b/bat.md @@ -17,4 +17,5 @@ Variable | Meaning | Type | Default `header` | Text to show before value | string | " Bat " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" +`footer` | Text to append after value | string | " " `shadow` | Hide the widget when battery is not present | boolean | false \ No newline at end of file From 131ccc38a7f306a19c6b756dbf3d203f4b6d34e3 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 9 Sep 2013 04:59:05 -0700 Subject: [PATCH 126/303] Updated bat (markdown) --- bat.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/bat.md b/bat.md index 5d89b14..8b24151 100644 --- a/bat.md +++ b/bat.md @@ -18,4 +18,6 @@ Variable | Meaning | Type | Default `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" `footer` | Text to append after value | string | " " -`shadow` | Hide the widget when battery is not present | boolean | false \ No newline at end of file +`shadow` | Hide the widget when battery is not present | boolean | false + +**Note**: `footer` can be markup text. \ No newline at end of file From 9f9b4c959dfbcb6ae82d56cf1cedb7eb04f791e8 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 9 Sep 2013 05:00:23 -0700 Subject: [PATCH 127/303] Updated fs (markdown) --- fs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fs.md b/fs.md index eb67110..7ee1f5c 100644 --- a/fs.md +++ b/fs.md @@ -18,7 +18,7 @@ Variable | Meaning | Type | Default `footer` | Text to show after value | string | " " `shadow` | Hide the widget if `partition` < 90 | boolean | false -**Note**: `footer` color is `color`. +**Note**: `footer` can be markup text. `lain.widgets.fs` outputs the following table: From d685704da2cabc0af5425066a599c2ce2ffd90d6 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 9 Sep 2013 05:01:17 -0700 Subject: [PATCH 128/303] Updated fs (markdown) --- fs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fs.md b/fs.md index 7ee1f5c..eb67110 100644 --- a/fs.md +++ b/fs.md @@ -18,7 +18,7 @@ Variable | Meaning | Type | Default `footer` | Text to show after value | string | " " `shadow` | Hide the widget if `partition` < 90 | boolean | false -**Note**: `footer` can be markup text. +**Note**: `footer` color is `color`. `lain.widgets.fs` outputs the following table: From 4e5236d8f385f2c629f972c091633551c6e20615 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 9 Sep 2013 05:03:26 -0700 Subject: [PATCH 129/303] Updated imap (markdown) --- imap.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/imap.md b/imap.md index 47e7b51..97cd437 100644 --- a/imap.md +++ b/imap.md @@ -41,12 +41,15 @@ Variable | Meaning | Type | Default `header` | Text to show before value | string | " Mail " `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color` | Mail value color | string | `beautiful.fg_focus` or "#FFFFFF" +`footer` | Text to append after value | string | " " `mail_encoding` | Mail character encoding | string | autodetected `maxlen` | Maximum chars to display in notification | int | 200 `app` | Mail program to spawn on click | string | "mutt" `shadow` | Hide widget when there are no mails | boolean | false `is_plain` | Define whether `password` is a plain password (true) or a function that retrieves it (false) | boolean | false +**Note**: `footer` can be markup text. + Let's focus better on `is_plain`. You can just set your password like this: From 2a11ae6544d4bf2f1c0e3f772aa3c4cc1797788a Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 9 Sep 2013 05:06:06 -0700 Subject: [PATCH 130/303] Updated maildir (markdown) --- maildir.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/maildir.md b/maildir.md index c35b2f9..bd81c02 100644 --- a/maildir.md +++ b/maildir.md @@ -33,5 +33,8 @@ Variable | Meaning | Type | Default `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" `color_newmail` | New mail value color | string | `beautiful.fg_focus` or "#FFFFFF" `color_nomail` | No mail value color | string | `beautiful.fg_normal` or "#FFFFFF" +`footer` | Text to append after value | string | " " `app` | Mail program to spawn on click | string | "mutt"| boolean | false -`shadow` | Hide widget when there are no mails | boolean | false \ No newline at end of file +`shadow` | Hide widget when there are no mails | boolean | false + +**Note**: `footer` can be markup text. \ No newline at end of file From 199853fdda10f110417f50312a7b6b0d598de25c Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 9 Sep 2013 05:06:43 -0700 Subject: [PATCH 131/303] Updated maildir (markdown) --- maildir.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/maildir.md b/maildir.md index bd81c02..a30e59f 100644 --- a/maildir.md +++ b/maildir.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + Shows maildirs status in a textbox. Maildirs are structured as follows: From 38e27c67b35942ab98d5aea4dbe855f56d88eb73 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 9 Sep 2013 05:14:40 -0700 Subject: [PATCH 132/303] Updated mpd (markdown) --- mpd.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/mpd.md b/mpd.md index 7640b4c..2a0ba32 100644 --- a/mpd.md +++ b/mpd.md @@ -27,9 +27,9 @@ Variable | Meaning | Type | Default `port` | MPD port | string | "6600" `music_dir` | Music directory | string | "~/Music" `refresh_timeout` | Refresh timeout seconds | int | 1 -`pre` | Text before values | string | "" -`header_color` | Artist value color | string | `beautiful.fg_normal` or "#FFFFFF" -`color` | Song value color | string | `beautiful.fg_focus` or "#FFFFFF" +`header` | Text before values | string | "" +`artist_color` | Artist value color | string | `beautiful.fg_normal` or "#FFFFFF" +`song_color` | Song value color | string | `beautiful.fg_focus` or "#FFFFFF" `spr` | Separator text between artist and song values | string | " " `footer` | Text to append after values | string | "" `app` | Music program to spawn on click | string | "ncmpcpp" From 096ca0ee5a5ba0e395562096ec6f98ef4c192bc2 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 9 Sep 2013 14:54:04 -0700 Subject: [PATCH 133/303] Updated Home (markdown) --- Home.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Home.md b/Home.md index 9342879..6c93aae 100644 --- a/Home.md +++ b/Home.md @@ -1,5 +1,14 @@ Welcome to the Lain wiki! +### Dependencies + +Package | Requested by +--- | --- +alsa-utils | [alsa](https://github.com/copycat-killer/lain/wiki/alsa), [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) +curl | widget types accessing network resources +imagemagick | [mpd](https://github.com/copycat-killer/lain/wiki/mpd) +python3 | [imap](https://github.com/copycat-killer/lain/wiki/imap) + ### Installation Simply clone this repository into your Awesome directory: From da6e722094189b34b4e74e966a3974358ca4af24 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 12:24:16 -0700 Subject: [PATCH 134/303] Destroyed To start (markdown) --- To-start.md | 26 -------------------------- 1 file changed, 26 deletions(-) delete mode 100644 To-start.md diff --git a/To-start.md b/To-start.md deleted file mode 100644 index a2be5ff..0000000 --- a/To-start.md +++ /dev/null @@ -1,26 +0,0 @@ -All you have to do to include the module: - - local lain = require("lain") - -Some widgets require a terminal, lain default is `xterm`, but can be changed: - - lain.widgets.terminal = "urxvtc" - -or - - lain.widgets.terminal = terminal - -providing you have something like this: - - terminal = "urxvtc" - -in your `rc.lua`. - -`terminal` may also be a lua function that accepts one parameter. -Something like this: - - function footerm(cmd) - -- elaborate cmd - end - - lain.widgets.terminal = footerm From 166c95e88afacd2e19f3848cbf2c7d9e07fd3f0e Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 12:25:53 -0700 Subject: [PATCH 135/303] Updated Home (markdown) --- Home.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/Home.md b/Home.md index 6c93aae..74f336f 100644 --- a/Home.md +++ b/Home.md @@ -15,9 +15,12 @@ Simply clone this repository into your Awesome directory: git clone https://github.com/copycat-killer/lain.git ~/.config/awesome/lain -### Index +then include it in your `rc.lua`: + + local lain = require("lain") + +### Submodules -- [To start](https://github.com/copycat-killer/lain/wiki/To-start) - [Layouts](https://github.com/copycat-killer/lain/wiki/Layouts) - [Widgets](https://github.com/copycat-killer/lain/wiki/Widgets) - [Utilities](https://github.com/copycat-killer/lain/wiki/Utilities) \ No newline at end of file From 31c8cd320082db6d9ed48916e4fcc34a03c7effa Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 12:31:48 -0700 Subject: [PATCH 136/303] Updated Widgets (markdown) --- Widgets.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Widgets.md b/Widgets.md index 6e6d361..86c1f46 100644 --- a/Widgets.md +++ b/Widgets.md @@ -4,6 +4,8 @@ Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`. We say this because, for some widget, `function` return a table to be used for notification and update purposes. +Almost all widgets can be set by an input function called `settings`: you can markup textboxes and do other customizations within it. + - [alsa](https://github.com/copycat-killer/lain/wiki/alsa) - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) - [bat](https://github.com/copycat-killer/lain/wiki/bat) From 333f61b04331afe07de8dd3f5aa54241d4895371 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 12:32:17 -0700 Subject: [PATCH 137/303] Updated Widgets (markdown) --- Widgets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Widgets.md b/Widgets.md index 86c1f46..8accde9 100644 --- a/Widgets.md +++ b/Widgets.md @@ -4,7 +4,7 @@ Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`. We say this because, for some widget, `function` return a table to be used for notification and update purposes. -Almost all widgets can be set by an input function called `settings`: you can markup textboxes and do other customizations within it. +Almost all widgets can be set by an input function called `settings`: you can markup textboxes and do whatever customization within it. - [alsa](https://github.com/copycat-killer/lain/wiki/alsa) - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) From 4ec5d224ab2c2f4e019c9bc832d090ef22729872 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 12:32:50 -0700 Subject: [PATCH 138/303] Updated Widgets (markdown) --- Widgets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Widgets.md b/Widgets.md index 8accde9..0772360 100644 --- a/Widgets.md +++ b/Widgets.md @@ -2,7 +2,7 @@ Every widget is output by a `function`. Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`. -We say this because, for some widget, `function` return a table to be used for notification and update purposes. +We say this because, for some widget, `function` returns a table to be used for notification and update purposes. Almost all widgets can be set by an input function called `settings`: you can markup textboxes and do whatever customization within it. From 8bc29ccaa72dc1d05b3d42d714182a5dd4bebde8 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 12:56:10 -0700 Subject: [PATCH 139/303] Updated Widgets (markdown) --- Widgets.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/Widgets.md b/Widgets.md index 0772360..2138b27 100644 --- a/Widgets.md +++ b/Widgets.md @@ -2,9 +2,22 @@ Every widget is output by a `function`. Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`. -We say this because, for some widget, `function` returns a table to be used for notification and update purposes. +This is said because, for some widgets, `function` returns a table to be used for notification and update purposes. -Almost all widgets can be set by an input function called `settings`: you can markup textboxes and do whatever customization within it. +Every widget may take either a table or a list of variables as argument. + +If it takes a table, you have to define a function variable called `settings` in it: with this you can markup textboxes using predefined variables and do whatever customization you want. + +I'll give an example: + + mycpu = lain.widgets.cpu({ + timeout = 4, + settings = function() + widgets:set_markup("Cpu " .. usage) + end + }) + +check the sections for all the details. - [alsa](https://github.com/copycat-killer/lain/wiki/alsa) - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) From 25c6bd19e3742e78df8585004d8dd71f59d168ee Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 12:58:14 -0700 Subject: [PATCH 140/303] Updated Widgets (markdown) --- Widgets.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/Widgets.md b/Widgets.md index 2138b27..42021bd 100644 --- a/Widgets.md +++ b/Widgets.md @@ -8,7 +8,7 @@ Every widget may take either a table or a list of variables as argument. If it takes a table, you have to define a function variable called `settings` in it: with this you can markup textboxes using predefined variables and do whatever customization you want. -I'll give an example: +I'll give an example just to take a grasp, see the sections for all the details: mycpu = lain.widgets.cpu({ timeout = 4, @@ -17,8 +17,6 @@ I'll give an example: end }) -check the sections for all the details. - - [alsa](https://github.com/copycat-killer/lain/wiki/alsa) - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) - [bat](https://github.com/copycat-killer/lain/wiki/bat) From 8b11927a993ae71df4a7e36ddde366f872c9c6d7 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 13:00:23 -0700 Subject: [PATCH 141/303] Updated Widgets (markdown) --- Widgets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Widgets.md b/Widgets.md index 42021bd..a798c67 100644 --- a/Widgets.md +++ b/Widgets.md @@ -8,7 +8,7 @@ Every widget may take either a table or a list of variables as argument. If it takes a table, you have to define a function variable called `settings` in it: with this you can markup textboxes using predefined variables and do whatever customization you want. -I'll give an example just to take a grasp, see the sections for all the details: +Here follows a simple example, see the sections for all the details: mycpu = lain.widgets.cpu({ timeout = 4, From 4f5402652ab7896eef7eda6f4cd1bcab0fe62495 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 13:01:39 -0700 Subject: [PATCH 142/303] Updated Widgets (markdown) --- Widgets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Widgets.md b/Widgets.md index a798c67..c0a7dd6 100644 --- a/Widgets.md +++ b/Widgets.md @@ -13,7 +13,7 @@ Here follows a simple example, see the sections for all the details: mycpu = lain.widgets.cpu({ timeout = 4, settings = function() - widgets:set_markup("Cpu " .. usage) + widget:set_markup("Cpu " .. usage) end }) From d29477dac35903da00e1fe6669a2a3e90b8f1096 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 13:19:34 -0700 Subject: [PATCH 143/303] Updated Widgets (markdown) --- Widgets.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/Widgets.md b/Widgets.md index c0a7dd6..7130cc3 100644 --- a/Widgets.md +++ b/Widgets.md @@ -6,9 +6,15 @@ This is said because, for some widgets, `function` returns a table to be used fo Every widget may take either a table or a list of variables as argument. -If it takes a table, you have to define a function variable called `settings` in it: with this you can markup textboxes using predefined variables and do whatever customization you want. +If it takes a table, you have to define a function variable called `settings` in it, in order to make your customizations. -Here follows a simple example, see the sections for all the details: +To markup the textbox, call `widget:set_markup(...)` within `settings`. + +You can feed `set_markup` with predefined arguments, see the sections for all the details. + +`widget` is a textbox, so you can also threat it like any other `wibox.widget.textbox`. + +Here follows an example: mycpu = lain.widgets.cpu({ timeout = 4, @@ -17,6 +23,8 @@ Here follows a simple example, see the sections for all the details: end }) +--- + - [alsa](https://github.com/copycat-killer/lain/wiki/alsa) - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) - [bat](https://github.com/copycat-killer/lain/wiki/bat) From f654775d456afe4f5868288007ff17a0887ddd8d Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 13:25:23 -0700 Subject: [PATCH 144/303] Updated alsa (markdown) --- alsa.md | 30 +++++++++++++----------------- 1 file changed, 13 insertions(+), 17 deletions(-) diff --git a/alsa.md b/alsa.md index 2ca1746..3e31c74 100644 --- a/alsa.md +++ b/alsa.md @@ -4,43 +4,39 @@ Shows and controls alsa volume with a textbox. myvolume = lain.widgets.alsa() -* Left click: Launch `alsamixer` in your `terminal`. -* Right click: Mute/unmute. -* Scroll wheel: Increase/decrase volume. - -The function takes a table as optional argument, which can contain: +### input table Variable | Meaning | Type | Default --- | --- | --- | --- +`timeout` | Refresh timeout seconds | int | 5 `channel` | Mixer channel | string | "Master" -`step` | Step at which volume is increased/decreased | string | "1%" -`header` | Text to show before value | string | " Vol " -`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" -`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" -`footer` | Text to append after value | string | " " +`settings` | User settings | function | empty function -*Note*: `footer` can be markup text. +`settings` can be fed with the following variables: -`lain.widgets.alsa` outputs the following table: +Variable | Meaning | Type | Values +--- | --- | --- | --- +volume.level | Self explained | int | 0-100 +volume.status | Device status | string | "on", "off" + +### output table Variable | Meaning | Type --- | --- | --- `widget` | The widget | `wibox.widget.textbox` -`channel` | Alsa channel | string -`step` | Increase/decrease step | string -`notify` | Update `widget` | function +`notify` | Force update `widget` | function Finally, you can control the widget with key bindings like these: -- Volume control awful.key({ altkey }, "Up", function () - awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "+") + awful.util.spawn("amixer sset Master 1%+") volume.notify() end), awful.key({ altkey }, "Down", function () - awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "-") + awful.util.spawn("amixer sset Master 1%-") volume.notify() end), awful.key({ altkey }, "m", From a28129e686929438f8d0115cab638b62ddd79bc5 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 13:28:54 -0700 Subject: [PATCH 145/303] Updated alsabar (markdown) --- alsabar.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/alsabar.md b/alsabar.md index 9b5a711..549b28a 100644 --- a/alsabar.md +++ b/alsabar.md @@ -1,12 +1,6 @@ [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) -Shows and controls alsa volume with a progressbar. - -Dependencies: - -- alsa-utils (of course) - -Plus tooltips, notifications, and color changes at mute/unmute switch. +Shows and controls alsa volume with a progressbar and provides tooltips, notifications, and color changes at mute/unmute switch. myvolumebar = lain.widgets.alsabar() @@ -48,7 +42,7 @@ Variable | Meaning | Type | Default It's **crucial** to set `notifications.bar_size` to your `mywibox[s]` height, **if** you have set it different than default (18). -`lain.widgets.alsabar` outputs the following table: +### output table Variable | Meaning | Type --- | --- | --- @@ -57,7 +51,7 @@ Variable | Meaning | Type `step` | Increase/decrease step | string `notify` | The notification | function -Finally, you can control the widget with key bindings like these: +You can control the widget with key bindings like these: -- Volume control awful.key({ altkey }, "Up", From f75714659a5564a6b287d73887d0e0a7d4e6c878 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 13:29:07 -0700 Subject: [PATCH 146/303] Updated alsa (markdown) --- alsa.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/alsa.md b/alsa.md index 3e31c74..2029e8c 100644 --- a/alsa.md +++ b/alsa.md @@ -26,7 +26,7 @@ Variable | Meaning | Type `widget` | The widget | `wibox.widget.textbox` `notify` | Force update `widget` | function -Finally, you can control the widget with key bindings like these: +You can control the widget with key bindings like these: -- Volume control awful.key({ altkey }, "Up", From afd328fe2598ea9d8621fe17abdd098f30a731e2 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 13:31:03 -0700 Subject: [PATCH 147/303] Updated alsa (markdown) --- alsa.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/alsa.md b/alsa.md index 2029e8c..7ad0a6e 100644 --- a/alsa.md +++ b/alsa.md @@ -2,7 +2,7 @@ Shows and controls alsa volume with a textbox. - myvolume = lain.widgets.alsa() + volume = lain.widgets.alsa() ### input table From cb04a2e7413ce1f09734218e10e6193cabfc23ac Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 13:32:32 -0700 Subject: [PATCH 148/303] Updated bat (markdown) --- bat.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/bat.md b/bat.md index 8b24151..1f8bf1f 100644 --- a/bat.md +++ b/bat.md @@ -7,17 +7,14 @@ Displays a notification when battery is low or critical. mybattery = lain.widgets.bat() -The function takes a table as optional argument, which can contain: +### input table Variable | Meaning | Type | Default --- | --- | --- | --- +`timeout` | Refresh timeout seconds | int | 30 `battery` | Identifier of the battery | string | "BAT0" -`show_all` | Show all values (true), or only remaining capacity (false) | boolean | false -`refresh_timeout` | Refresh timeout seconds | int | 30 -`header` | Text to show before value | string | " Bat " -`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" -`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" -`footer` | Text to append after value | string | " " -`shadow` | Hide the widget when battery is not present | boolean | false +`settings` | User settings | function | empty function -**Note**: `footer` can be markup text. \ No newline at end of file +### output + +A textbox. \ No newline at end of file From 79d92fa9a967508614b76a49ecf7c3035e85756e Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 13:40:31 -0700 Subject: [PATCH 149/303] Updated calendar (markdown) --- calendar.md | 32 +++++++++++--------------------- 1 file changed, 11 insertions(+), 21 deletions(-) diff --git a/calendar.md b/calendar.md index 5b4587d..fa4e563 100644 --- a/calendar.md +++ b/calendar.md @@ -2,37 +2,27 @@ Attaches a calendar notification to a widget. - lain.widgets.calendar:attach(widget) + lain.widgets.calendar:attach(widget, args) - Left click: switch to previous month. - Right click: switch to next month. -Optionally you can call the function with fg and bg colors arguments, both or just one: +`args` is an optional table which can contain: - lain.widgets.calendar:attach(mytextclock, "#FFFFFF", "#000000") - -- or - lain.widgets.calendar:attach(mytextclock, "#FFFFFF") - -- or - lain.widgets.calendar:attach(mytextclock, nil, "#000000") +Variable | Meaning | Type | Default +--- | --- | --- | --- +`icons` | Path to calendar icons | string | [lain/icons/cal/white](https://github.com/copycat-killer/lain/tree/master/icons/cal/white) +`font_size` | Calendar font size | int | 12 +`fg` | Calendar foreground color | string | `beautiful.fg_normal` +`bg` | Calendar background color | string | `beautiful.bg_normal` +`position` | Calendar position | string | "top_right" -default fg and fb colors are `beautiful.fg_focus` and `beautiful.bg_normal`. +`position` possible values are defined [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify). Notification will show an icon displaying current day, and formatted output from ``cal`` with current day highlighted. -Calendar icons are placed in [lain/icons/cal](https://github.com/copycat-killer/lain/tree/master/icons/cal), default set being ``white``. - -You can add your own set, and tell lain to use it like this: - - lain.widgets.calendar.icons_dir = lain.widgets.icons_dir .. "cal/myicons" - -also, you can set notification font size: - - lain.widgets.calendar.font_size = 14 - -default is 12. - -Finally, you can call the notification with a key binding like this: +You can call the notification with a key binding like this: awful.key({ altkey }, "c", function () lain.widgets.calendar:show(7) end), From ef94494c302809eaab16cee7241113613464713e Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 13:42:18 -0700 Subject: [PATCH 150/303] Updated cpu (markdown) --- cpu.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/cpu.md b/cpu.md index 1dce16e..3c49f64 100644 --- a/cpu.md +++ b/cpu.md @@ -4,14 +4,13 @@ Shows in a textbox the average CPU usage percent for a given amount of time. mycpuusage = lain.widgets.cpu() -The function takes a table as optional argument, which can contain: +### input table Variable | Meaning | Type | Default --- | --- | --- | --- -`refresh_timeout` | Refresh timeout seconds | int | 10 -`header` | Text to show before value | string | " Cpu " -`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" -`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" -`footer` | Text to add after value | string | "% " +`timeout` | Refresh timeout seconds | int | 10 +`settings` | User settings | function | empty function -**Note**: `footer` color is `color`. \ No newline at end of file +### output + +A textbox. \ No newline at end of file From 70c9def8dac705aeecb2cef133e5dc862e89419d Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 13:43:13 -0700 Subject: [PATCH 151/303] Updated cpu (markdown) --- cpu.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cpu.md b/cpu.md index 3c49f64..5cafceb 100644 --- a/cpu.md +++ b/cpu.md @@ -11,6 +11,8 @@ Variable | Meaning | Type | Default `timeout` | Refresh timeout seconds | int | 10 `settings` | User settings | function | empty function +`settings` can be fed with `usage`, which is the cpu use percentage. + ### output A textbox. \ No newline at end of file From 9f2ae8e9f97d7b385af4f4356ea59de768ea59a9 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 13:46:24 -0700 Subject: [PATCH 152/303] Updated bat (markdown) --- bat.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/bat.md b/bat.md index 1f8bf1f..04c80dd 100644 --- a/bat.md +++ b/bat.md @@ -15,6 +15,8 @@ Variable | Meaning | Type | Default `battery` | Identifier of the battery | string | "BAT0" `settings` | User settings | function | empty function +`settings` can be fed with `bat_now` table, which contains the following strings: `status`, `perc`, `time`, `watt`. + ### output A textbox. \ No newline at end of file From 4774effb291e18881a3b1b9d5f8ceb9a501e156c Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 13:47:26 -0700 Subject: [PATCH 153/303] Updated cpu (markdown) --- cpu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpu.md b/cpu.md index 5cafceb..4994e1d 100644 --- a/cpu.md +++ b/cpu.md @@ -11,7 +11,7 @@ Variable | Meaning | Type | Default `timeout` | Refresh timeout seconds | int | 10 `settings` | User settings | function | empty function -`settings` can be fed with `usage`, which is the cpu use percentage. +`settings` can be fed with the string `usage`, which means the cpu use percentage. ### output From 2746279ac013321d0c551320be38bc24765c798c Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:00:43 -0700 Subject: [PATCH 154/303] Updated fs (markdown) --- fs.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/fs.md b/fs.md index eb67110..f1aa353 100644 --- a/fs.md +++ b/fs.md @@ -6,21 +6,30 @@ Displays a notification when the partition is full or has low space. mypartition = lain.widgets.fs() -The function takes a table as optional argument, which can contain: +### input table Variable | Meaning | Type | Default --- | --- | --- | --- +`timeout` | Refresh timeout seconds -| int | 600 `partition` | Partition to monitor | string | "/" -`refresh_timeout` | Refresh timeout seconds | int | 600 -`header` | Text to show before value | string | " Hdd " -`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" -`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" -`footer` | Text to show after value | string | " " -`shadow` | Hide the widget if `partition` < 90 | boolean | false +`settings` | User settings | function | empty function -**Note**: `footer` color is `color`. +`settings` can use the following `partition` related value strings: `used`, `available`, `size_mb`, `size_gb`. -`lain.widgets.fs` outputs the following table: +It can also use value strings in these formats: + + fs_info[p .. "used_p"] + fs_info[p .. "avail_p"] + fs_info[p .. "size_mb"] + fs_info[p .. "size_gb"] + +where `p` is the "mount" column of the output of `df` command (`/`, `/home`, `/boot`, ...). + +This means you can set the widget for a certain partition, but you can look up at others too. + +Finally, `settings` can modify `notification_preset` table too. This table will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. + +### output table Variable | Meaning | Type --- | --- | --- From 267315c413ae0724c2ea63347a599eae167e4793 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:00:59 -0700 Subject: [PATCH 155/303] Updated alsa (markdown) --- alsa.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/alsa.md b/alsa.md index 7ad0a6e..f632717 100644 --- a/alsa.md +++ b/alsa.md @@ -12,7 +12,7 @@ Variable | Meaning | Type | Default `channel` | Mixer channel | string | "Master" `settings` | User settings | function | empty function -`settings` can be fed with the following variables: +`settings` can use the following variables: Variable | Meaning | Type | Values --- | --- | --- | --- From 2135b08bbd2792edec90f96a5641d10b22bf8476 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:01:35 -0700 Subject: [PATCH 156/303] Updated bat (markdown) --- bat.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bat.md b/bat.md index 04c80dd..ec10057 100644 --- a/bat.md +++ b/bat.md @@ -15,7 +15,7 @@ Variable | Meaning | Type | Default `battery` | Identifier of the battery | string | "BAT0" `settings` | User settings | function | empty function -`settings` can be fed with `bat_now` table, which contains the following strings: `status`, `perc`, `time`, `watt`. +`settings` can use the `bat_now` table, which contains the following strings: `status`, `perc`, `time`, `watt`. ### output From ad2bd8dffb902b905b11e2cd6a29ddd152ff69b5 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:02:15 -0700 Subject: [PATCH 157/303] Updated cpu (markdown) --- cpu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpu.md b/cpu.md index 4994e1d..11bf53f 100644 --- a/cpu.md +++ b/cpu.md @@ -11,7 +11,7 @@ Variable | Meaning | Type | Default `timeout` | Refresh timeout seconds | int | 10 `settings` | User settings | function | empty function -`settings` can be fed with the string `usage`, which means the cpu use percentage. +`settings` can use the string `usage`, which is the cpu use percentage. ### output From 2ba0ba631e4bb323de2b26d8d690f3f977d61cec Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:02:56 -0700 Subject: [PATCH 158/303] Updated fs (markdown) --- fs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fs.md b/fs.md index f1aa353..07f59a6 100644 --- a/fs.md +++ b/fs.md @@ -23,7 +23,7 @@ It can also use value strings in these formats: fs_info[p .. "size_mb"] fs_info[p .. "size_gb"] -where `p` is the "mount" column of the output of `df` command (`/`, `/home`, `/boot`, ...). +where `p` is the "mount" column of the output of `df` command ("/", "/home", "/boot", ...). This means you can set the widget for a certain partition, but you can look up at others too. From 49e226be45dd4178d37bd99848b8a7e72684bee4 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:03:36 -0700 Subject: [PATCH 159/303] Updated fs (markdown) --- fs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fs.md b/fs.md index 07f59a6..6525e41 100644 --- a/fs.md +++ b/fs.md @@ -23,7 +23,7 @@ It can also use value strings in these formats: fs_info[p .. "size_mb"] fs_info[p .. "size_gb"] -where `p` is the "mount" column of the output of `df` command ("/", "/home", "/boot", ...). +where `p` is the last column of the output of `df` ("/", "/home", "/boot", ...). This means you can set the widget for a certain partition, but you can look up at others too. From 609b11882958381f668e25316ba1b575fd1096af Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:04:23 -0700 Subject: [PATCH 160/303] Updated fs (markdown) --- fs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fs.md b/fs.md index 6525e41..bb57c3a 100644 --- a/fs.md +++ b/fs.md @@ -23,7 +23,7 @@ It can also use value strings in these formats: fs_info[p .. "size_mb"] fs_info[p .. "size_gb"] -where `p` is the last column of the output of `df` ("/", "/home", "/boot", ...). +where `p` is the last column of `df` ("/", "/home", "/boot", ...). This means you can set the widget for a certain partition, but you can look up at others too. From ae93d3bd3d0e9b0d5adea7861a97e95e05787fa0 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:13:33 -0700 Subject: [PATCH 161/303] Updated fs (markdown) --- fs.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/fs.md b/fs.md index bb57c3a..883008d 100644 --- a/fs.md +++ b/fs.md @@ -27,7 +27,9 @@ where `p` is the last column of `df` ("/", "/home", "/boot", ...). This means you can set the widget for a certain partition, but you can look up at others too. -Finally, `settings` can modify `notification_preset` table too. This table will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. +Finally, `settings` can modify `notification_preset` table too. This table will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. Default definition: + + notification_preset = { fg = beautiful.fg_normal } ### output table From b8adbea6d8f24316b8f41897ddda67f3ffbc8965 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:14:30 -0700 Subject: [PATCH 162/303] Updated fs (markdown) --- fs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fs.md b/fs.md index 883008d..46bcbc2 100644 --- a/fs.md +++ b/fs.md @@ -23,7 +23,7 @@ It can also use value strings in these formats: fs_info[p .. "size_mb"] fs_info[p .. "size_gb"] -where `p` is the last column of `df` ("/", "/home", "/boot", ...). +where `p` is the last column of `df` command ("/", "/home", "/boot", ...). This means you can set the widget for a certain partition, but you can look up at others too. From 37c3546f5143dbb71985dc0adf47ef5c8c38ca26 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:17:21 -0700 Subject: [PATCH 163/303] Updated imap (markdown) --- imap.md | 45 ++++++++++++++++++++++++--------------------- 1 file changed, 24 insertions(+), 21 deletions(-) diff --git a/imap.md b/imap.md index 97cd437..7b8e761 100644 --- a/imap.md +++ b/imap.md @@ -2,10 +2,6 @@ Shows mail status in a textbox over IMAP protocol. -Dependencies: - -- python3 - New mails are notified through a notification like this: +---------------------------------------------------+ @@ -26,29 +22,22 @@ Text will be cut if the mail is too long. The function takes a table as argument. Required table parameters are: -Variable | Type ---- | --- -`server` | string -`mail` | string -`password` | string +Variable | Meaning | Type +--- | --- | --- +`server` | Mail server | string +`mail` | User mail | string +`password` | User password | string while the optional are: Variable | Meaning | Type | Default --- | --- | --- | --- `port` | IMAP port | int | 993 -`refresh_timeout` | Refresh timeout seconds | int | 60 -`header` | Text to show before value | string | " Mail " -`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" -`color` | Mail value color | string | `beautiful.fg_focus` or "#FFFFFF" -`footer` | Text to append after value | string | " " -`mail_encoding` | Mail character encoding | string | autodetected +`timeout` | Refresh timeout seconds | int | 60 +`encoding` | Mail character encoding | string | autodetected `maxlen` | Maximum chars to display in notification | int | 200 -`app` | Mail program to spawn on click | string | "mutt" -`shadow` | Hide widget when there are no mails | boolean | false `is_plain` | Define whether `password` is a plain password (true) or a function that retrieves it (false) | boolean | false - -**Note**: `footer` can be markup text. +`settings` | User settings | function Let's focus better on `is_plain`. @@ -65,6 +54,20 @@ and you'll have the same security provided by `~/.netrc`. When `is_plain == false`, it *executes* `password` before using it, so you can also use whatever password fetching solution you want. -You can also define your custom icon for the naughty notification. Just set `lain_mail_notify` into `theme.lua`: +`settings` can use the string `mailcount`, whose possible values are: - theme.lain_mail_notify = "/path/to/my/icon" \ No newline at end of file +- "0" +- "invalid credentials" +- string number + +and can modify `notification_preset` table, which will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. Default definition: + + notification _preset = { + icon = lain/icons/mail.png, + timeout = 8, + position = "top_left" + } + +### output + +A textbox. \ No newline at end of file From fb5ef55cba1b3dc5b6dac1efb3cdecc4b63bf90b Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:25:32 -0700 Subject: [PATCH 164/303] Updated imap (markdown) --- imap.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/imap.md b/imap.md index 7b8e761..501ffac 100644 --- a/imap.md +++ b/imap.md @@ -1,5 +1,7 @@ [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) +**Please be warned**: as for now, this works fine in normal link situations, but is discouraged to use it if your connection is sobbing, since it may cause some short freezes. I am at work to solve this. + Shows mail status in a textbox over IMAP protocol. New mails are notified through a notification like this: From 00d2e82a82a918bef76e59c018ec9ef9b3570379 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:26:48 -0700 Subject: [PATCH 165/303] Updated imap (markdown) --- imap.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/imap.md b/imap.md index 501ffac..87a69e9 100644 --- a/imap.md +++ b/imap.md @@ -1,6 +1,8 @@ [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) -**Please be warned**: as for now, this works fine in normal link situations, but is discouraged to use it if your connection is sobbing, since it may cause some short freezes. I am at work to solve this. +**Please be warned**: as for now, this works fine in normal link situations, but is discouraged to use it if your connection is sobbing, since it may cause some short freezes. I am working on socket libraries to solve this. If you're a Python programmer, feel free to lend a hand. + +--- Shows mail status in a textbox over IMAP protocol. From 4f366fef945fcecdc0a8e8d58ca5ccdfe6a93c26 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:27:24 -0700 Subject: [PATCH 166/303] Updated imap (markdown) --- imap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/imap.md b/imap.md index 87a69e9..cf5324d 100644 --- a/imap.md +++ b/imap.md @@ -1,6 +1,6 @@ [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) -**Please be warned**: as for now, this works fine in normal link situations, but is discouraged to use it if your connection is sobbing, since it may cause some short freezes. I am working on socket libraries to solve this. If you're a Python programmer, feel free to lend a hand. +**Please be warned**: as for now, this works fine in normal link situations, but is discouraged to use it if your connection is sobbing, since it may cause some short freezes due to timeout issues. I am working on socket libraries to solve this. If you're a Python programmer, feel free to lend a hand. --- From ff0865c837bfbcd4073ee1bbaa4652d5dd64898c Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:28:03 -0700 Subject: [PATCH 167/303] Updated imap (markdown) --- imap.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/imap.md b/imap.md index cf5324d..e583410 100644 --- a/imap.md +++ b/imap.md @@ -1,6 +1,8 @@ [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) -**Please be warned**: as for now, this works fine in normal link situations, but is discouraged to use it if your connection is sobbing, since it may cause some short freezes due to timeout issues. I am working on socket libraries to solve this. If you're a Python programmer, feel free to lend a hand. +**Please be warned**: as for now, this works fine in normal link situations, but is discouraged to use it if your connection is sobbing, since it may cause some short freezes due to timeout issues. I am working on socket libraries to solve this. + +If you're a Python programmer, feel free to lend a hand. --- From 0e9db489f57aa77474e33cb0355936301254d421 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:31:01 -0700 Subject: [PATCH 168/303] Updated maildir (markdown) --- maildir.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/maildir.md b/maildir.md index a30e59f..355ecdd 100644 --- a/maildir.md +++ b/maildir.md @@ -24,19 +24,16 @@ If there's new mails, the textbox will say something like "mail: bugs(3), system mymaildir = lain.widgets.maildir("/path/to/my/maildir") -The function takes a table as optional argument, which can contain: +### input table Variable | Meaning | Type | Default --- | --- | --- | --- +`timeout` | Refresh timeout seconds | int | 60 `mailpath` | Path to your maildir | string | "~/Mail" -`ignore_boxes` | A list of boxes to ignore | table | empty table -`refresh_timeout` | Refresh timeout seconds | int | 60 -`header` | Text to show before value | string | " Mail " -`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" -`color_newmail` | New mail value color | string | `beautiful.fg_focus` or "#FFFFFF" -`color_nomail` | No mail value color | string | `beautiful.fg_normal` or "#FFFFFF" -`footer` | Text to append after value | string | " " -`app` | Mail program to spawn on click | string | "mutt"| boolean | false -`shadow` | Hide widget when there are no mails | boolean | false +`settings` | User settings | function | empty function -**Note**: `footer` can be markup text. \ No newline at end of file +`settings` can use the string `newmail`, which format will be something like defined above, or "no mail". + +### output + +A textbox. \ No newline at end of file From 78a106822996d3a32b63282bbd4a2f385973cea0 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:33:06 -0700 Subject: [PATCH 169/303] Updated mem (markdown) --- mem.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/mem.md b/mem.md index 68c6748..067dc25 100644 --- a/mem.md +++ b/mem.md @@ -10,12 +10,11 @@ contain: Variable | Meaning | Type | Default --- | --- | --- | --- -`refresh_timeout` | Refresh timeout seconds | int | 10 -`show_swap` | Show amount of used swap space? | boolean | false -`show_total` | Show amout of total memory? | boolean | false -`header` | Text to show before value | string | " Mem " -`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" -`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" -`footer` | Text to show after value | string | "MB " +`timeout` | Refresh timeout seconds | int | 10 +`settings` | User settings | function | empty function -**Note**: `footer` color is `color`. \ No newline at end of file +`settings` can use the strings `used` (memory used MB) and `swapused` (swap used MB). + +### output + +A textbox. \ No newline at end of file From 7c26a6028abe49d5976bd941e3b131460ded3f3d Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:40:31 -0700 Subject: [PATCH 170/303] Updated Widgets (markdown) --- Widgets.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/Widgets.md b/Widgets.md index 7130cc3..1a26b80 100644 --- a/Widgets.md +++ b/Widgets.md @@ -1,8 +1,6 @@ Every widget is output by a `function`. -Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`. - -This is said because, for some widgets, `function` returns a table to be used for notification and update purposes. +For some widgets, `function` returns a `wibox.widget.textbox`, for others a table to be used for notification and update purposes. Every widget may take either a table or a list of variables as argument. From fdf4eabebbf43e519528686df8c155ae56282982 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:47:19 -0700 Subject: [PATCH 172/303] Updated mpd (markdown) --- mpd.md | 42 ++++++++++++++++++++++++++---------------- 1 file changed, 26 insertions(+), 16 deletions(-) diff --git a/mpd.md b/mpd.md index 2a0ba32..ab36d15 100644 --- a/mpd.md +++ b/mpd.md @@ -2,7 +2,7 @@ Shows MPD status in a textbox. - mympd = lain.widgets.mpd() + mpdwidget = lain.widgets.mpd() Now playing songs are notified like this: @@ -14,37 +14,47 @@ Now playing songs are notified like this: | +-------+ | +--------------------------------------------------------+ -Dependencies - -- imagemagick - The function takes a table as optional argument, which can contain: Variable | Meaning | Type | Default --- | --- | --- | --- +`timeout` | Refresh timeout seconds | int | 1 `password` | MPD password | string | "" `host` | MPD server | string | "127.0.0.1" `port` | MPD port | string | "6600" `music_dir` | Music directory | string | "~/Music" -`refresh_timeout` | Refresh timeout seconds | int | 1 -`header` | Text before values | string | "" -`artist_color` | Artist value color | string | `beautiful.fg_normal` or "#FFFFFF" -`song_color` | Song value color | string | `beautiful.fg_focus` or "#FFFFFF" -`spr` | Separator text between artist and song values | string | " " -`footer` | Text to append after values | string | "" -`app` | Music program to spawn on click | string | "ncmpcpp" -`shadow` | Hide widget when there are no songs playing | boolean | false +`settings` | User settings | function | empty function -**Note**: `spr` and `footer` can be markup text. +`settings` can use `mpd_now` table, which contains the following string values: -`lain.widgets.mpd` outputs the following table: +- state +- file +- artist +- title +- album +- date + +and can modify `notification_preset` table, which will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. Default definition: + + notification _preset = { + title = "Now playing", + text = mpd_now.artist .. " (" .. + mpd_now.album .. ") - " .. + mpd_now.date .. "\n" .. + mpd_now.title, + fg = beautiful.fg_normal or "#FFFFFF", + bg = beautiful.bg_normal or "#000000", + timeout = 6 + } + +### output table Variable | Meaning | Type --- | --- | --- `widget` | The textbox | `wibox.widget.textbox` `notify` | The notification | function -Finally, you can control the widget with key bindings like these: +You can control the widget with key bindings like these: -- MPD control awful.key({ altkey, "Control" }, "Up", From 5fbbc64b81283c74a09f19db03647cf8e74ce736 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:52:25 -0700 Subject: [PATCH 173/303] Updated mpd (markdown) --- mpd.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mpd.md b/mpd.md index ab36d15..8b35e81 100644 --- a/mpd.md +++ b/mpd.md @@ -14,7 +14,7 @@ Now playing songs are notified like this: | +-------+ | +--------------------------------------------------------+ -The function takes a table as optional argument, which can contain: +### input table Variable | Meaning | Type | Default --- | --- | --- | --- From f2a9d548e6172987c554cdd1261c1008e2670328 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:55:52 -0700 Subject: [PATCH 174/303] 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 From 8f907725c6bc5016c27da6b384a79200167af346 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 14:56:45 -0700 Subject: [PATCH 175/303] Updated net (markdown) --- net.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/net.md b/net.md index 096b6a0..bace937 100644 --- a/net.md +++ b/net.md @@ -15,4 +15,8 @@ Variable | Meaning | Type | Default Possible other values for `units` are 1 (byte) or multiple of 1024: 1024^2 (mb), 1024^3 (gb), ... . -`settings` can use the following `iface` strings: `carrier`, `state`, `sent`, `received`. \ No newline at end of file +`settings` can use the following `iface` strings: `carrier`, `state`, `sent`, `received`. + +### output + +A textbox. \ No newline at end of file From 8c08dcd844dae10295858419e95babe7072e4910 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 15:00:37 -0700 Subject: [PATCH 176/303] Updated sysload (markdown) --- sysload.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/sysload.md b/sysload.md index 65b5eec..234770b 100644 --- a/sysload.md +++ b/sysload.md @@ -4,13 +4,15 @@ Show the current system load in a textbox. mysysload = lain.widgets.sysload() -The function takes a table as optional argument, which can contain: +### input table Variable | Meaning | Type | Default --- | --- | --- | --- -`show_all` | Show all the three values (true), or only the first one (false) | boolean | false -`refresh_timeout` | Refresh timeout seconds | int | 5 -`header` | Text to show before value | string | " Load " -`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" -`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" -`app` | Proc program to spawn on click | string | "top" \ No newline at end of file +`timeout` | Refresh timeout seconds | int | 5 +`settings` | User settings | function | empty function + +`settings` can use strings `a`, `b` and `c`, which are loadavg over 1, 5, and 15 minutes. + +### output + +A textbox. \ No newline at end of file From bc2e09d6d9e0d88a8175a337397af9b535a31624 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 15:02:23 -0700 Subject: [PATCH 177/303] Updated temp (markdown) --- temp.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/temp.md b/temp.md index 92d7d06..f7315b6 100644 --- a/temp.md +++ b/temp.md @@ -10,8 +10,7 @@ The function takes a table as optional argument, which can contain: Variable | Meaning | Type | Default --- | --- | --- | --- -`refresh_timeout` | Refresh timeout seconds | int | 5 -`header` | Text to show before value | string | " Temp " -`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" -`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" -`footer` | Text to show after value | string | "C " \ No newline at end of file +`timeout` | Refresh timeout seconds | int | 5 +`settings` | User settings | function | empty function + +`settings` can use the string `coretemp_now`, which means current core temperature, expressed in Celsius (linux standard). \ No newline at end of file From e996c58363672b7ca530b02bbd38010adfc2a9e9 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 15:03:57 -0700 Subject: [PATCH 178/303] Updated cpu (markdown) --- cpu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpu.md b/cpu.md index 11bf53f..ae490b0 100644 --- a/cpu.md +++ b/cpu.md @@ -8,7 +8,7 @@ Shows in a textbox the average CPU usage percent for a given amount of time. Variable | Meaning | Type | Default --- | --- | --- | --- -`timeout` | Refresh timeout seconds | int | 10 +`timeout` | Refresh timeout seconds | int | 5 `settings` | User settings | function | empty function `settings` can use the string `usage`, which is the cpu use percentage. From 62bc3c8be1eaf8668f8139c853864beeed8fa3b1 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 15:04:34 -0700 Subject: [PATCH 179/303] Updated mem (markdown) --- mem.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mem.md b/mem.md index 067dc25..80e6a88 100644 --- a/mem.md +++ b/mem.md @@ -10,7 +10,7 @@ contain: Variable | Meaning | Type | Default --- | --- | --- | --- -`timeout` | Refresh timeout seconds | int | 10 +`timeout` | Refresh timeout seconds | int | 3 `settings` | User settings | function | empty function `settings` can use the strings `used` (memory used MB) and `swapused` (swap used MB). From c6b46f1382933684c6ae33741e188e11ac609cde Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 10 Sep 2013 15:10:43 -0700 Subject: [PATCH 180/303] Updated yawn (markdown) --- yawn.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/yawn.md b/yawn.md index 070bf2e..6a087cc 100644 --- a/yawn.md +++ b/yawn.md @@ -24,15 +24,18 @@ an existent widget. - ``args`` - An optional table which can contain the following settings: + A required table which can contain: Variables | Meaning | Type | Possible values | Default value --- | --- | --- | --- | --- `u` | Units | string | "c" (Celsius), "f" (Fahrenheit) | "c" - `toshow` | What to show | string | "forecast", "units", "both" | "forecast" - `color` | ``yawn.widget`` color | string | hexadecimal colors | + `timeout` | Refresh timeout seconds | int | integers | 600 + `settings` | User settings | function | function | empty function -The function creates an imagebox icon and a textbox widget. Add them to you wibox like this: + `settings` can use strings `forecast`, `units', and can modify `notification_preset` table, which + will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. + +The function `register` creates an imagebox icon and a textbox widget. Add them to you wibox like this: right_layout:add(yawn.icon) right_layout:add(yawn.widget) From 11b916170373c3fab2707613f051c8ab72ef0db8 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 05:46:07 -0700 Subject: [PATCH 181/303] Updated Utilities (markdown) --- Utilities.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Utilities.md b/Utilities.md index cbf8c0f..7e18683 100644 --- a/Utilities.md +++ b/Utilities.md @@ -1,11 +1,11 @@ markup ------ -This is a submodule which helps you markupping your text. +Made markup easier! First, require it like this: - local markup = require("lain.util.markup") + local markup = lain.util.markup then you can call its functions: From cb3a0d0927c8dd6acc2ee5eea6fdd9dfa5b4a7ca Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 05:46:54 -0700 Subject: [PATCH 182/303] Updated Utilities (markdown) --- Utilities.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Utilities.md b/Utilities.md index 7e18683..6afff16 100644 --- a/Utilities.md +++ b/Utilities.md @@ -46,7 +46,7 @@ they all take one argument, which is the text to markup, except `fg.color` and ` menu\_clients\_current\_tags ---------------------------- -Similar to `awful.menu.clients()`, but this menu only shows the clients +Similar to `awful.menu.clients`, but this menu only shows the clients of currently visible tags. Use it with a key binding like this: awful.key({ "Mod1" }, "Tab", From c7f82ee59ad1edb2126b8e933bf4c24e602d5ef1 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 07:09:56 -0700 Subject: [PATCH 183/303] Updated mpd (markdown) --- mpd.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mpd.md b/mpd.md index 8b35e81..bd7232e 100644 --- a/mpd.md +++ b/mpd.md @@ -27,7 +27,7 @@ Variable | Meaning | Type | Default `settings` can use `mpd_now` table, which contains the following string values: -- state +- state (possible values: "play", "pause", "stop") - file - artist - title From 1a8b3a69e7b8a6969e0798046e9d30c56fe626c7 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 07:19:34 -0700 Subject: [PATCH 184/303] Updated fs (markdown) --- fs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fs.md b/fs.md index 46bcbc2..44be2b2 100644 --- a/fs.md +++ b/fs.md @@ -14,7 +14,7 @@ Variable | Meaning | Type | Default `partition` | Partition to monitor | string | "/" `settings` | User settings | function | empty function -`settings` can use the following `partition` related value strings: `used`, `available`, `size_mb`, `size_gb`. +`settings` can use the following `partition` related float values: `used` and `available`, `size_mb`, `size_gb`. It can also use value strings in these formats: From 1273f51f1c9242eb8b5c9e0774707e67bc210617 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 07:28:25 -0700 Subject: [PATCH 185/303] Updated yawn (markdown) --- yawn.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yawn.md b/yawn.md index 6a087cc..5b111bd 100644 --- a/yawn.md +++ b/yawn.md @@ -32,7 +32,7 @@ an existent widget. `timeout` | Refresh timeout seconds | int | integers | 600 `settings` | User settings | function | function | empty function - `settings` can use strings `forecast`, `units', and can modify `notification_preset` table, which + `settings` can use strings `forecast`, `units`, and can modify `notification_preset` table, which will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. The function `register` creates an imagebox icon and a textbox widget. Add them to you wibox like this: From b31152ab6e56233a9c8589c53a08068d065a3480 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 09:36:42 -0700 Subject: [PATCH 186/303] Updated imap (markdown) --- imap.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/imap.md b/imap.md index e583410..6590ee7 100644 --- a/imap.md +++ b/imap.md @@ -1,8 +1,6 @@ [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) -**Please be warned**: as for now, this works fine in normal link situations, but is discouraged to use it if your connection is sobbing, since it may cause some short freezes due to timeout issues. I am working on socket libraries to solve this. - -If you're a Python programmer, feel free to lend a hand. +**Please be warned**: this is a temporary solution, since it works fine in normal situations but causes little freezes if connection is sobbing. I am working on something much more solid. --- From c5ddfd66999bdaf0fa48a60f4ad4f2f1afa52c0c Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 09:39:38 -0700 Subject: [PATCH 187/303] Updated alsa (markdown) --- alsa.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/alsa.md b/alsa.md index f632717..af1139a 100644 --- a/alsa.md +++ b/alsa.md @@ -24,7 +24,7 @@ volume.status | Device status | string | "on", "off" Variable | Meaning | Type --- | --- | --- `widget` | The widget | `wibox.widget.textbox` -`notify` | Force update `widget` | function +`update` | Update `widget` | function You can control the widget with key bindings like these: @@ -32,22 +32,22 @@ You can control the widget with key bindings like these: awful.key({ altkey }, "Up", function () awful.util.spawn("amixer sset Master 1%+") - volume.notify() + volume.update() end), awful.key({ altkey }, "Down", function () awful.util.spawn("amixer sset Master 1%-") - volume.notify() + volume.update() end), awful.key({ altkey }, "m", function () awful.util.spawn("amixer set Master playback toggle") - volume.notify() + volume.update() end), awful.key({ altkey, "Control" }, "m", function () awful.util.spawn("amixer set Master playback 100%", false ) - volume.notify() + volume.update() end), where `altkey = "Mod1"`. \ No newline at end of file From a5fea2962eb61b0c26000cf07e30148f2e95becc Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 09:40:33 -0700 Subject: [PATCH 188/303] Updated alsa (markdown) --- alsa.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/alsa.md b/alsa.md index af1139a..65314d2 100644 --- a/alsa.md +++ b/alsa.md @@ -31,12 +31,12 @@ You can control the widget with key bindings like these: -- Volume control awful.key({ altkey }, "Up", function () - awful.util.spawn("amixer sset Master 1%+") + awful.util.spawn("amixer set Master 1%+") volume.update() end), awful.key({ altkey }, "Down", function () - awful.util.spawn("amixer sset Master 1%-") + awful.util.spawn("amixer set Master 1%-") volume.update() end), awful.key({ altkey }, "m", From 274515ca18170fbe39613c600de2e21f842b71ea Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 09:41:14 -0700 Subject: [PATCH 189/303] Updated alsabar (markdown) --- alsabar.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/alsabar.md b/alsabar.md index 549b28a..7763fe4 100644 --- a/alsabar.md +++ b/alsabar.md @@ -56,12 +56,12 @@ You can control the widget with key bindings like these: -- Volume control awful.key({ altkey }, "Up", function () - awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "+") + awful.util.spawn("amixer set " .. volume.channel .. " " .. volume.step .. "+") volume.notify() end), awful.key({ altkey }, "Down", function () - awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "-") + awful.util.spawn("amixer set " .. volume.channel .. " " .. volume.step .. "-") volume.notify() end), awful.key({ altkey }, "m", From 45187b81f5c1e87d0a45150e9d7e2783dc26a74a Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 10:06:31 -0700 Subject: [PATCH 190/303] Updated mpd (markdown) --- mpd.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/mpd.md b/mpd.md index bd7232e..2f7a24c 100644 --- a/mpd.md +++ b/mpd.md @@ -38,13 +38,9 @@ and can modify `notification_preset` table, which will be the preset for the nau notification _preset = { title = "Now playing", - text = mpd_now.artist .. " (" .. - mpd_now.album .. ") - " .. - mpd_now.date .. "\n" .. - mpd_now.title, - fg = beautiful.fg_normal or "#FFFFFF", - bg = beautiful.bg_normal or "#000000", - timeout = 6 + timeout = 6, + text = string.format("%s (%s) - %s\n%s", mpd_now.artist, + mpd_now.album, mpd_now.date, mpd_now.title) } ### output table From 5694a737cba6bc0eba866ceff01ae05f28241bf8 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 10:10:07 -0700 Subject: [PATCH 191/303] Updated yawn (markdown) --- yawn.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/yawn.md b/yawn.md index 5b111bd..a9a1a7b 100644 --- a/yawn.md +++ b/yawn.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + (YAhoo! Weather Notification) Yawn provides brief and compact Yahoo! Weather notification. From bf7ba2df9868eea04447aa27b8e938a0dbbee5cb Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 10:40:47 -0700 Subject: [PATCH 194/303] Updated imap (markdown) --- imap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/imap.md b/imap.md index 6590ee7..491bc31 100644 --- a/imap.md +++ b/imap.md @@ -1,6 +1,6 @@ [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) -**Please be warned**: this is a temporary solution, since it works fine in normal situations but causes little freezes if connection is sobbing. I am working on something much more solid. +**Please be warned**: this is a temporary solution, since it works fine in normal situations but may causes little freezes if connection is sobbing. I am working on something much more solid. --- From c3710289e82623e3f6cb659f050ccb099f43d13d Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 10:51:45 -0700 Subject: [PATCH 195/303] Updated imap (markdown) --- imap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/imap.md b/imap.md index 491bc31..3063bec 100644 --- a/imap.md +++ b/imap.md @@ -1,6 +1,6 @@ [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) -**Please be warned**: this is a temporary solution, since it works fine in normal situations but may causes little freezes if connection is sobbing. I am working on something much more solid. +**Please be warned**: this is a temporary solution, I am working on something much more solid. --- From 5dcb340bc32738d7a9cc9df08a3465380fa3f063 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 10:54:18 -0700 Subject: [PATCH 196/303] Updated Widgets (markdown) --- Widgets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Widgets.md b/Widgets.md index 1a26b80..e812db2 100644 --- a/Widgets.md +++ b/Widgets.md @@ -10,7 +10,7 @@ To markup the textbox, call `widget:set_markup(...)` within `settings`. You can feed `set_markup` with predefined arguments, see the sections for all the details. -`widget` is a textbox, so you can also threat it like any other `wibox.widget.textbox`. +`widget` is a textbox, so you can threat it like any other `wibox.widget.textbox`. Here follows an example: From e475ad70ef8504d795e6966343d59c93589673bd Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 16:17:09 -0700 Subject: [PATCH 197/303] Updated imap (markdown) --- imap.md | 39 +++++++++++---------------------------- 1 file changed, 11 insertions(+), 28 deletions(-) diff --git a/imap.md b/imap.md index 3063bec..af29cb3 100644 --- a/imap.md +++ b/imap.md @@ -1,28 +1,16 @@ [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) -**Please be warned**: this is a temporary solution, I am working on something much more solid. - ---- - Shows mail status in a textbox over IMAP protocol. + myimapcheck = lain.widgets.imap(args) + New mails are notified through a notification like this: - +---------------------------------------------------+ - | +---+ | - | |\ /| donald@disney.org has 3 new messages | - | +---+ | - | Latest From: Mickey Mouse | - | Subject: Re: pay raise | - | | - | Not after what you did yesterday. | - | Daisy told me everything [...] | - | | - +---------------------------------------------------+ - -Text will be cut if the mail is too long. - - myimapcheck = lain.widgets.imap(args) + +--------------------------------------------+ + | +---+ | + | |\ /| donald@disney.org has 3 new messages | + | +---+ | + +--------------------------------------------+ The function takes a table as argument. Required table parameters are: @@ -38,8 +26,6 @@ Variable | Meaning | Type | Default --- | --- | --- | --- `port` | IMAP port | int | 993 `timeout` | Refresh timeout seconds | int | 60 -`encoding` | Mail character encoding | string | autodetected -`maxlen` | Maximum chars to display in notification | int | 200 `is_plain` | Define whether `password` is a plain password (true) or a function that retrieves it (false) | boolean | false `settings` | User settings | function @@ -58,20 +44,17 @@ and you'll have the same security provided by `~/.netrc`. When `is_plain == false`, it *executes* `password` before using it, so you can also use whatever password fetching solution you want. -`settings` can use the string `mailcount`, whose possible values are: +`settings` can use the value `mailcount`, an integer greater or equal to zero, and can modify `notification_preset` table, which will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. -- "0" -- "invalid credentials" -- string number - -and can modify `notification_preset` table, which will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. Default definition: +Default definition: notification _preset = { icon = lain/icons/mail.png, - timeout = 8, position = "top_left" } +Note that `mailcount` is 0 either if there are no new mails or credentials are invalid, so make sure you get the right settings. + ### output A textbox. \ No newline at end of file From ab90053aabc49930e1e6f599a4521a12ef1ccf2a Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 17:25:35 -0700 Subject: [PATCH 198/303] Updated imap (markdown) --- imap.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/imap.md b/imap.md index af29cb3..7b232a1 100644 --- a/imap.md +++ b/imap.md @@ -1,10 +1,10 @@ [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) -Shows mail status in a textbox over IMAP protocol. +Shows mail count in a textbox fetching over IMAP. myimapcheck = lain.widgets.imap(args) -New mails are notified through a notification like this: +New mails are notified like this: +--------------------------------------------+ | +---+ | From 70023036714a2485bfd1c7e44869ea06ebe6b037 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 11 Sep 2013 17:26:08 -0700 Subject: [PATCH 199/303] Updated Home (markdown) --- Home.md | 1 - 1 file changed, 1 deletion(-) diff --git a/Home.md b/Home.md index 74f336f..6b7b58d 100644 --- a/Home.md +++ b/Home.md @@ -7,7 +7,6 @@ Package | Requested by alsa-utils | [alsa](https://github.com/copycat-killer/lain/wiki/alsa), [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) curl | widget types accessing network resources imagemagick | [mpd](https://github.com/copycat-killer/lain/wiki/mpd) -python3 | [imap](https://github.com/copycat-killer/lain/wiki/imap) ### Installation From b339c79167c772f40d57c0dcd8864ae52c53431a Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 08:04:28 -0700 Subject: [PATCH 200/303] Updated alsabar (markdown) --- alsabar.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/alsabar.md b/alsabar.md index 7763fe4..ad5b1bf 100644 --- a/alsabar.md +++ b/alsabar.md @@ -1,6 +1,6 @@ [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) -Shows and controls alsa volume with a progressbar and provides tooltips, notifications, and color changes at mute/unmute switch. +Shows and controls alsa volume with a progressbar; provides tooltips, notifications, and color changes at mute/unmute switch. myvolumebar = lain.widgets.alsabar() @@ -12,6 +12,7 @@ The function takes a table as optional argument, which can contain: Variable | Meaning | Type | Default --- | --- | --- | --- +`timeout` | Refresh timeout seconds | int | 4 `width` | Bar width | int | 63 `height` | Bar height | int | 1 `ticks` | Set bar ticks on | boolean | true From 2330b7d079c29caa3064e40a8b64939af90e30da Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 08:43:38 -0700 Subject: [PATCH 202/303] Updated fs (markdown) --- fs.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/fs.md b/fs.md index 44be2b2..5588ca7 100644 --- a/fs.md +++ b/fs.md @@ -27,9 +27,9 @@ where `p` is the last column of `df` command ("/", "/home", "/boot", ...). This means you can set the widget for a certain partition, but you can look up at others too. -Finally, `settings` can modify `notification_preset` table too. This table will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. Default definition: +Finally, `settings` can modify `fs_notification_preset` table too. This table will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. Default definition: - notification_preset = { fg = beautiful.fg_normal } + fs_notification_preset = { fg = beautiful.fg_normal } ### output table From f397b6a1b17682514d68c3c70012b5d6952b951f Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 08:44:22 -0700 Subject: [PATCH 203/303] Updated imap (markdown) --- imap.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/imap.md b/imap.md index 7b232a1..ba92d0f 100644 --- a/imap.md +++ b/imap.md @@ -44,11 +44,11 @@ and you'll have the same security provided by `~/.netrc`. When `is_plain == false`, it *executes* `password` before using it, so you can also use whatever password fetching solution you want. -`settings` can use the value `mailcount`, an integer greater or equal to zero, and can modify `notification_preset` table, which will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. +`settings` can use the value `mailcount`, an integer greater or equal to zero, and can modify `mail_notification_preset` table, which will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. Default definition: - notification _preset = { + mail_notification _preset = { icon = lain/icons/mail.png, position = "top_left" } From b88ee61d325c2afcc43ee25ba79c07a7c991d0d5 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 08:47:10 -0700 Subject: [PATCH 204/303] Updated mpd (markdown) --- mpd.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mpd.md b/mpd.md index 2f7a24c..51467e1 100644 --- a/mpd.md +++ b/mpd.md @@ -34,9 +34,9 @@ Variable | Meaning | Type | Default - album - date -and can modify `notification_preset` table, which will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. Default definition: +and can modify `mpd_notification_preset` table, which will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. Default definition: - notification _preset = { + mpd_notification _preset = { title = "Now playing", timeout = 6, text = string.format("%s (%s) - %s\n%s", mpd_now.artist, From 08b707a1589e2328dfa25e13026c63567f8404c5 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 08:52:53 -0700 Subject: [PATCH 205/303] Updated yawn (markdown) --- yawn.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yawn.md b/yawn.md index a9a1a7b..30d160c 100644 --- a/yawn.md +++ b/yawn.md @@ -34,7 +34,7 @@ an existent widget. `timeout` | Refresh timeout seconds | int | integers | 600 `settings` | User settings | function | function | empty function - `settings` can use strings `forecast`, `units`, and can modify `notification_preset` table, which + `settings` can use strings `forecast`, `units`, and can modify `yawn_notification_preset` table, which will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. The function `register` creates an imagebox icon and a textbox widget. Add them to you wibox like this: From dc7eb86389b2d9ebd515029328c61313af73af66 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 09:07:46 -0700 Subject: [PATCH 206/303] Updated alsabar (markdown) --- alsabar.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/alsabar.md b/alsabar.md index ad5b1bf..7a90478 100644 --- a/alsabar.md +++ b/alsabar.md @@ -67,12 +67,12 @@ You can control the widget with key bindings like these: end), awful.key({ altkey }, "m", function () - awful.util.spawn("amixer set Master playback toggle") + awful.util.spawn("amixer set " .. volume.channel .. " playback toggle") volume.notify() end), awful.key({ altkey, "Control" }, "m", function () - awful.util.spawn("amixer set Master playback 100%", false ) + awful.util.spawn("amixer set " .. volume.channel .. " playback 100%", false ) volume.notify() end), From f439acc2f30b1d6c81ce2d2621bbc080a691c4e8 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 09:15:04 -0700 Subject: [PATCH 207/303] Updated mpd (markdown) --- mpd.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/mpd.md b/mpd.md index 51467e1..de945b4 100644 --- a/mpd.md +++ b/mpd.md @@ -56,22 +56,22 @@ You can control the widget with key bindings like these: awful.key({ altkey, "Control" }, "Up", function () awful.util.spawn_with_shell("mpc toggle || ncmpcpp toggle || ncmpc toggle || pms toggle") - mpdwidget.notify() + mpdwidget.update() end), awful.key({ altkey, "Control" }, "Down", function () awful.util.spawn_with_shell("mpc stop || ncmpcpp stop || ncmpc stop || pms stop") - mpdwidget.notify() + mpdwidget.update() end), awful.key({ altkey, "Control" }, "Left", function () awful.util.spawn_with_shell("mpc prev || ncmpcpp prev || ncmpc prev || pms prev") - mpdwidget.notify() + mpdwidget.update() end), awful.key({ altkey, "Control" }, "Right", function () awful.util.spawn_with_shell("mpc next || ncmpcpp next || ncmpc next || pms next") - mpdwidget.notify() + mpdwidget.update() end), where `altkey = "Mod1"`. \ No newline at end of file From 8f1b80f2843b9c13d68d56fd82c9f5eada721bfd Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 09:37:19 -0700 Subject: [PATCH 208/303] Updated alsa (markdown) --- alsa.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/alsa.md b/alsa.md index 65314d2..6cc8b59 100644 --- a/alsa.md +++ b/alsa.md @@ -16,8 +16,8 @@ Variable | Meaning | Type | Default Variable | Meaning | Type | Values --- | --- | --- | --- -volume.level | Self explained | int | 0-100 -volume.status | Device status | string | "on", "off" +volume_now.level | Self explained | int | 0-100 +volume_now.status | Device status | string | "on", "off" ### output table @@ -32,22 +32,22 @@ You can control the widget with key bindings like these: awful.key({ altkey }, "Up", function () awful.util.spawn("amixer set Master 1%+") - volume.update() + volumewidget.update() end), awful.key({ altkey }, "Down", function () awful.util.spawn("amixer set Master 1%-") - volume.update() + volumewidget.update() end), awful.key({ altkey }, "m", function () awful.util.spawn("amixer set Master playback toggle") - volume.update() + volumewidget.update() end), awful.key({ altkey, "Control" }, "m", function () awful.util.spawn("amixer set Master playback 100%", false ) - volume.update() + volumewidget.update() end), where `altkey = "Mod1"`. \ No newline at end of file From e24890443bbe0ed8c17376038f2cf3040f1b4663 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 09:37:35 -0700 Subject: [PATCH 209/303] Updated alsa (markdown) --- alsa.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/alsa.md b/alsa.md index 6cc8b59..abe82b8 100644 --- a/alsa.md +++ b/alsa.md @@ -2,7 +2,7 @@ Shows and controls alsa volume with a textbox. - volume = lain.widgets.alsa() + volumewidget = lain.widgets.alsa() ### input table From 54f3782d4b02a2818e5f168597f038186c185de0 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 09:37:54 -0700 Subject: [PATCH 210/303] Updated alsa (markdown) --- alsa.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/alsa.md b/alsa.md index abe82b8..daf4016 100644 --- a/alsa.md +++ b/alsa.md @@ -16,8 +16,8 @@ Variable | Meaning | Type | Default Variable | Meaning | Type | Values --- | --- | --- | --- -volume_now.level | Self explained | int | 0-100 -volume_now.status | Device status | string | "on", "off" +`volume_now.level` | Self explained | int | 0-100 +`volume_now.status` | Device status | string | "on", "off" ### output table From 264c9bbed32bd3c012c4b4ba369ac747b7498749 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 09:57:10 -0700 Subject: [PATCH 212/303] Updated alsabar (markdown) --- alsabar.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/alsabar.md b/alsabar.md index 7a90478..711c8ce 100644 --- a/alsabar.md +++ b/alsabar.md @@ -58,22 +58,22 @@ You can control the widget with key bindings like these: awful.key({ altkey }, "Up", function () awful.util.spawn("amixer set " .. volume.channel .. " " .. volume.step .. "+") - volume.notify() + myvolumebar.notify() end), awful.key({ altkey }, "Down", function () awful.util.spawn("amixer set " .. volume.channel .. " " .. volume.step .. "-") - volume.notify() + myvolumeba.notify() end), awful.key({ altkey }, "m", function () awful.util.spawn("amixer set " .. volume.channel .. " playback toggle") - volume.notify() + myvolumebar.notify() end), awful.key({ altkey, "Control" }, "m", function () awful.util.spawn("amixer set " .. volume.channel .. " playback 100%", false ) - volume.notify() + myvolumebar.notify() end), where `altkey = "Mod1"`. \ No newline at end of file From 98a5a66ac0944bcbf0745520ab75612ec553db0d Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 12:32:27 -0700 Subject: [PATCH 213/303] Updated net (markdown) --- net.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/net.md b/net.md index bace937..a1b6d35 100644 --- a/net.md +++ b/net.md @@ -13,9 +13,9 @@ Variable | Meaning | Type | Default `units` | Units | int | 1024 (kilobytes) `settings` | User settings | function | empty function -Possible other values for `units` are 1 (byte) or multiple of 1024: 1024^2 (mb), 1024^3 (gb), ... . +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: `carrier`, `state`, `sent`, `received`. +`settings` can use the following `iface` strings: `carrier` ("0", "1"), `state` ("up", "down"), `sent`, `received` (numbers). ### output From 86223d5eed3657032571f1166266a39021061b9f Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 12:33:04 -0700 Subject: [PATCH 214/303] Updated net (markdown) --- net.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/net.md b/net.md index a1b6d35..f1cd095 100644 --- a/net.md +++ b/net.md @@ -15,7 +15,11 @@ Variable | Meaning | Type | Default 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: `carrier` ("0", "1"), `state` ("up", "down"), `sent`, `received` (numbers). +`settings` can use the following `iface` strings: + +- `carrier` ("0", "1"); +- `state` ("up", "down"); +- `sent` and `received` (numbers). ### output From cbeeb53e91b72faa7ae03fee8f3647060c95062c Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 12:34:21 -0700 Subject: [PATCH 215/303] Updated bat (markdown) --- bat.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/bat.md b/bat.md index ec10057..27a0d32 100644 --- a/bat.md +++ b/bat.md @@ -15,7 +15,12 @@ Variable | Meaning | Type | Default `battery` | Identifier of the battery | string | "BAT0" `settings` | User settings | function | empty function -`settings` can use the `bat_now` table, which contains the following strings: `status`, `perc`, `time`, `watt`. +`settings` can use the `bat_now` table, which contains the following strings: + +- `status` ("Not present", "Charging", "Discharging"); +-`perc`; +- `time`; +- `watt`. ### output From eedc61870026beb0e3ffed7e2c54f395a07a5072 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 12:34:40 -0700 Subject: [PATCH 216/303] Updated bat (markdown) --- bat.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bat.md b/bat.md index 27a0d32..50c14e8 100644 --- a/bat.md +++ b/bat.md @@ -18,7 +18,7 @@ Variable | Meaning | Type | Default `settings` can use the `bat_now` table, which contains the following strings: - `status` ("Not present", "Charging", "Discharging"); --`perc`; +- `perc`; - `time`; - `watt`. From c7780c093a218f82d7a2bcdc9dac2d62ed88153b Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 12:47:57 -0700 Subject: [PATCH 217/303] Updated mem (markdown) --- mem.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mem.md b/mem.md index 80e6a88..1079ca5 100644 --- a/mem.md +++ b/mem.md @@ -13,7 +13,7 @@ Variable | Meaning | Type | Default `timeout` | Refresh timeout seconds | int | 3 `settings` | User settings | function | empty function -`settings` can use the strings `used` (memory used MB) and `swapused` (swap used MB). +`settings` can use the strings `mem_now.used` (memory used MB) and `mem_now.swapused` (swap used MB). ### output From 8e38f676fff8bd8de4dc0ce51dc32a259d57dc0e Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 12:49:36 -0700 Subject: [PATCH 218/303] Updated sysload (markdown) --- sysload.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sysload.md b/sysload.md index 234770b..4ed61a8 100644 --- a/sysload.md +++ b/sysload.md @@ -11,7 +11,7 @@ Variable | Meaning | Type | Default `timeout` | Refresh timeout seconds | int | 5 `settings` | User settings | function | empty function -`settings` can use strings `a`, `b` and `c`, which are loadavg over 1, 5, and 15 minutes. +`settings` can use strings `load_1`, `load_5` and `load_15`, which are loadavg over 1, 5, and 15 minutes. ### output From c0ce11202cad1ea905765e6af7fa491b4d8274c7 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 15:15:22 -0700 Subject: [PATCH 219/303] Updated net (markdown) --- net.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/net.md b/net.md index f1cd095..6a1c52d 100644 --- a/net.md +++ b/net.md @@ -17,9 +17,9 @@ Possible other values for `units` are 1 (byte) or multiple of 1024: 1024^2 (mb), `settings` can use the following `iface` strings: -- `carrier` ("0", "1"); -- `state` ("up", "down"); -- `sent` and `received` (numbers). +- `net_now.carrier` ("0", "1"); +- `net_now.state` ("up", "down"); +- `net_now.sent` and `net_now.received` (numbers). ### output From d3d29c7640ce2eeea578e28838b853ac152dc88d Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 15:26:46 -0700 Subject: [PATCH 220/303] Updated cpu (markdown) --- cpu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpu.md b/cpu.md index ae490b0..e42180c 100644 --- a/cpu.md +++ b/cpu.md @@ -11,7 +11,7 @@ Variable | Meaning | Type | Default `timeout` | Refresh timeout seconds | int | 5 `settings` | User settings | function | empty function -`settings` can use the string `usage`, which is the cpu use percentage. +`settings` can use the string `cpu_now.usage`, which is the cpu use percentage. ### output From 0eb70991d480b7e3104832b877c6f2afbf778542 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 15:27:04 -0700 Subject: [PATCH 221/303] Updated Widgets (markdown) --- Widgets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Widgets.md b/Widgets.md index e812db2..8395445 100644 --- a/Widgets.md +++ b/Widgets.md @@ -17,7 +17,7 @@ Here follows an example: mycpu = lain.widgets.cpu({ timeout = 4, settings = function() - widget:set_markup("Cpu " .. usage) + widget:set_markup("Cpu " .. cpu_now.usage) end }) From 4c5a81537a6bff59550b4b41223201ea8b826b64 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 15:38:37 -0700 Subject: [PATCH 222/303] Updated alsabar (markdown) --- alsabar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/alsabar.md b/alsabar.md index 711c8ce..e50b5c7 100644 --- a/alsabar.md +++ b/alsabar.md @@ -47,7 +47,7 @@ It's **crucial** to set `notifications.bar_size` to your `mywibox[s]` height, Variable | Meaning | Type --- | --- | --- -`widget` | The widget | `awful.widget.progressbar` +`bar` | The widget | `awful.widget.progressbar` `channel` | Alsa channel | string `step` | Increase/decrease step | string `notify` | The notification | function From 547487e7309966c5ceab7d57fea97590c5bb013c Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 17:29:55 -0700 Subject: [PATCH 223/303] Updated temp (markdown) --- temp.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/temp.md b/temp.md index f7315b6..91f3031 100644 --- a/temp.md +++ b/temp.md @@ -1,16 +1,20 @@ [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) -Show the current core temperature in a textbox. +Shows the current core temperature in a textbox. Reads from `/sys/class/thermal`, so value is expressed in Celsius. mytemp = lain.widgets.temp() -The function takes a table as optional argument, which can contain: +### input table Variable | Meaning | Type | Default --- | --- | --- | --- `timeout` | Refresh timeout seconds | int | 5 `settings` | User settings | function | empty function -`settings` can use the string `coretemp_now`, which means current core temperature, expressed in Celsius (linux standard). \ No newline at end of file +`settings` can use the string `coretemp_now`, which means current core temperature, expressed in Celsius (linux standard). + +### output + +A textbox. \ No newline at end of file From d34fda22b4d7174a52fc5fb214f2af9f1865ee7b Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 17:31:12 -0700 Subject: [PATCH 224/303] Updated sysload (markdown) --- sysload.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sysload.md b/sysload.md index 4ed61a8..3e53881 100644 --- a/sysload.md +++ b/sysload.md @@ -1,6 +1,6 @@ [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) -Show the current system load in a textbox. +Shows the current system load. mysysload = lain.widgets.sysload() From 6be1560149f3883e24bb68f5f7e4450851fba347 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 17:32:07 -0700 Subject: [PATCH 225/303] Updated net (markdown) --- net.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/net.md b/net.md index 6a1c52d..f857239 100644 --- a/net.md +++ b/net.md @@ -15,7 +15,7 @@ Variable | Meaning | Type | Default 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: +`settings` can use the following `iface` related strings: - `net_now.carrier` ("0", "1"); - `net_now.state` ("up", "down"); From ea28dce997a7656df7821a1e0a7e8d955a43f8f1 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 17:33:41 -0700 Subject: [PATCH 226/303] Updated mpd (markdown) --- mpd.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mpd.md b/mpd.md index de945b4..8a25d04 100644 --- a/mpd.md +++ b/mpd.md @@ -48,7 +48,7 @@ and can modify `mpd_notification_preset` table, which will be the preset for the Variable | Meaning | Type --- | --- | --- `widget` | The textbox | `wibox.widget.textbox` -`notify` | The notification | function +`update` | The notification | function You can control the widget with key bindings like these: From b0c5550824b4a51f07ac74d6a032cee46978abc3 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 17:34:20 -0700 Subject: [PATCH 227/303] Updated mem (markdown) --- mem.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/mem.md b/mem.md index 1079ca5..ba37923 100644 --- a/mem.md +++ b/mem.md @@ -4,9 +4,7 @@ Shows memory status (in MiB) in a textbox. mymem = lain.widgets.mem() - -The function takes a table as an optional argument. That table may -contain: +# input table Variable | Meaning | Type | Default --- | --- | --- | --- From bcd63c82008752f00d732ac7ff70ebde01829bd6 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 17:34:34 -0700 Subject: [PATCH 228/303] Updated mem (markdown) --- mem.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mem.md b/mem.md index ba37923..84b7ad2 100644 --- a/mem.md +++ b/mem.md @@ -4,7 +4,7 @@ Shows memory status (in MiB) in a textbox. mymem = lain.widgets.mem() -# input table +### input table Variable | Meaning | Type | Default --- | --- | --- | --- From 7a95e1868808f2222dc0841135cd866b6eca3a67 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 17:38:16 -0700 Subject: [PATCH 229/303] Updated fs (markdown) --- fs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fs.md b/fs.md index 5588ca7..e30c473 100644 --- a/fs.md +++ b/fs.md @@ -14,7 +14,7 @@ Variable | Meaning | Type | Default `partition` | Partition to monitor | string | "/" `settings` | User settings | function | empty function -`settings` can use the following `partition` related float values: `used` and `available`, `size_mb`, `size_gb`. +`settings` can use the following `partition` related float values: `used`, `available`, `size_mb`, `size_gb`. It can also use value strings in these formats: From fb09ee4af8c314eed06a01b1aa147f5b6a5a442e Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 12 Sep 2013 17:41:39 -0700 Subject: [PATCH 230/303] Updated alsabar (markdown) --- alsabar.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/alsabar.md b/alsabar.md index e50b5c7..6dea44f 100644 --- a/alsabar.md +++ b/alsabar.md @@ -40,8 +40,7 @@ Variable | Meaning | Type | Default `color` | Notifications color | string | `beautiful.fg_focus` `bar_size` | Wibox height | int | 18 -It's **crucial** to set `notifications.bar_size` to your `mywibox[s]` height, -**if** you have set it different than default (18). +It's **crucial** to set `notifications.bar_size` to your `mywibox[s]` height. ### output table From 72bc5d131a4f85474d95b3b5895085ab521bb47e Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Fri, 13 Sep 2013 14:00:43 -0700 Subject: [PATCH 231/303] Updated alsabar (markdown) --- alsabar.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/alsabar.md b/alsabar.md index 6dea44f..f694c69 100644 --- a/alsabar.md +++ b/alsabar.md @@ -2,7 +2,7 @@ Shows and controls alsa volume with a progressbar; provides tooltips, notifications, and color changes at mute/unmute switch. - myvolumebar = lain.widgets.alsabar() + volume = lain.widgets.alsabar() * Left click: Launch `alsamixer` in your `terminal`. * Right click: Mute/unmute. @@ -53,26 +53,26 @@ Variable | Meaning | Type You can control the widget with key bindings like these: - -- Volume control + -- ALSA volume control awful.key({ altkey }, "Up", - function () - awful.util.spawn("amixer set " .. volume.channel .. " " .. volume.step .. "+") - myvolumebar.notify() - end), + function () + awful.util.spawn("amixer -q set " .. volume.channel .. " " .. volume.step .. "+") + volume.notify() + end), awful.key({ altkey }, "Down", - function () - awful.util.spawn("amixer set " .. volume.channel .. " " .. volume.step .. "-") - myvolumeba.notify() - end), + function () + awful.util.spawn("amixer -q set " .. volume.channel .. " " .. volume.step .. "-") + volume.notify() + end), awful.key({ altkey }, "m", - function () - awful.util.spawn("amixer set " .. volume.channel .. " playback toggle") - myvolumebar.notify() - end), - awful.key({ altkey, "Control" }, "m", - function () - awful.util.spawn("amixer set " .. volume.channel .. " playback 100%", false ) - myvolumebar.notify() - end), + function () + awful.util.spawn("amixer -q set " .. volume.channel .. " playback toggle") + volume.notify() + end), + awful.key({ altkey, "Control" }, "m", + function () + awful.util.spawn("amixer -q set " .. volume.channel .. " playback 100%") + volume.notify() + end), where `altkey = "Mod1"`. \ No newline at end of file From 18af84d88ecbdedee3048e65aa6ff2df130252e9 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Fri, 13 Sep 2013 14:11:07 -0700 Subject: [PATCH 232/303] Updated Widgets (markdown) --- Widgets.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Widgets.md b/Widgets.md index 8395445..981e4e1 100644 --- a/Widgets.md +++ b/Widgets.md @@ -21,6 +21,8 @@ Here follows an example: end }) +If you want to see more complex applications, check [awesome-copycats](https://github.com/copycat-killer/awesome-copycats). + --- - [alsa](https://github.com/copycat-killer/lain/wiki/alsa) From 7cc2212955829ddf925e11e9f9744679b8a4336a Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Fri, 13 Sep 2013 15:04:30 -0700 Subject: [PATCH 233/303] Updated mpd (markdown) --- mpd.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/mpd.md b/mpd.md index 8a25d04..70a7938 100644 --- a/mpd.md +++ b/mpd.md @@ -14,6 +14,12 @@ Now playing songs are notified like this: | +-------+ | +--------------------------------------------------------+ +You need a file like this + + "(front|cover|art|Folder|folder)\.(jpg|jpeg|png|gif)$" + +in the album folder in order to show album art in the notification too. + ### input table Variable | Meaning | Type | Default @@ -23,6 +29,7 @@ Variable | Meaning | Type | Default `host` | MPD server | string | "127.0.0.1" `port` | MPD port | string | "6600" `music_dir` | Music directory | string | "~/Music" +`cover_size` | Album art notification size | int | 100 `settings` | User settings | function | empty function `settings` can use `mpd_now` table, which contains the following string values: From 938c23eea12ae13dd709007ff5e75b80902eeafc Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Fri, 13 Sep 2013 15:05:37 -0700 Subject: [PATCH 234/303] Updated mpd (markdown) --- mpd.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mpd.md b/mpd.md index 70a7938..62d6e4b 100644 --- a/mpd.md +++ b/mpd.md @@ -16,7 +16,7 @@ Now playing songs are notified like this: You need a file like this - "(front|cover|art|Folder|folder)\.(jpg|jpeg|png|gif)$" + (front|cover|art|Folder|folder)\.(jpg|jpeg|png|gif)$ in the album folder in order to show album art in the notification too. From 8e18573717b105546da6ab785bb2479c52d61044 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Fri, 13 Sep 2013 15:05:58 -0700 Subject: [PATCH 235/303] Updated mpd (markdown) --- mpd.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mpd.md b/mpd.md index 62d6e4b..44d7826 100644 --- a/mpd.md +++ b/mpd.md @@ -18,7 +18,7 @@ You need a file like this (front|cover|art|Folder|folder)\.(jpg|jpeg|png|gif)$ -in the album folder in order to show album art in the notification too. +in the album folder in order to show album art too. ### input table From 1d9cf86d9368646cc11d1fca3ee3445026a26261 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Fri, 13 Sep 2013 15:06:13 -0700 Subject: [PATCH 236/303] Updated mpd (markdown) --- mpd.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mpd.md b/mpd.md index 44d7826..7db0498 100644 --- a/mpd.md +++ b/mpd.md @@ -16,7 +16,7 @@ Now playing songs are notified like this: You need a file like this - (front|cover|art|Folder|folder)\.(jpg|jpeg|png|gif)$ + (front|cover|art|Folder|folder)\.(jpg|jpeg|png|gif) in the album folder in order to show album art too. From 94d05ef9e159e1322e76313c1a9bf87c553f1406 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 14 Sep 2013 08:11:13 -0700 Subject: [PATCH 237/303] Updated Layouts (markdown) --- Layouts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Layouts.md b/Layouts.md index 7c4ff41..07184a4 100644 --- a/Layouts.md +++ b/Layouts.md @@ -247,7 +247,7 @@ you have to add an item called `useless_gap_width` in your `theme.lua`. If it doesn't exist, the width will default to 0. Example: - theme.useless_gap_width = "5" + theme.useless_gap_width = 5 What about layout icons? ======================== From f28575f988791b7a7fa632d9a00c8d3edcac3df1 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 17 Sep 2013 15:14:40 -0700 Subject: [PATCH 238/303] Updated Home (markdown) --- Home.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Home.md b/Home.md index 6b7b58d..63ede55 100644 --- a/Home.md +++ b/Home.md @@ -8,6 +8,8 @@ alsa-utils | [alsa](https://github.com/copycat-killer/lain/wiki/alsa), [alsabar] curl | widget types accessing network resources imagemagick | [mpd](https://github.com/copycat-killer/lain/wiki/mpd) +*(Why ImageMagick? Because Cairo doesn't do high quality filtering at the moment)* + ### Installation Simply clone this repository into your Awesome directory: From b91dae564d5a5358c94375bfa160121dcc408b86 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 17 Sep 2013 15:15:07 -0700 Subject: [PATCH 239/303] Updated Home (markdown) --- Home.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Home.md b/Home.md index 63ede55..78f40c6 100644 --- a/Home.md +++ b/Home.md @@ -8,7 +8,7 @@ alsa-utils | [alsa](https://github.com/copycat-killer/lain/wiki/alsa), [alsabar] curl | widget types accessing network resources imagemagick | [mpd](https://github.com/copycat-killer/lain/wiki/mpd) -*(Why ImageMagick? Because Cairo doesn't do high quality filtering at the moment)* +*(Why ImageMagick? Because Cairo doesn't do high quality filtering at the moment.)* ### Installation From a14469d9f649e9d95956c6c460313b8708537a92 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 17 Sep 2013 15:26:32 -0700 Subject: [PATCH 240/303] Updated mpd (markdown) --- mpd.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/mpd.md b/mpd.md index 7db0498..0e2eca5 100644 --- a/mpd.md +++ b/mpd.md @@ -16,7 +16,7 @@ Now playing songs are notified like this: You need a file like this - (front|cover|art|Folder|folder)\.(jpg|jpeg|png|gif) + (Front|front|Cover|cover|Art|art|Folder|folder)\.(jpg|jpeg|png|gif) in the album folder in order to show album art too. @@ -30,6 +30,7 @@ Variable | Meaning | Type | Default `port` | MPD port | string | "6600" `music_dir` | Music directory | string | "~/Music" `cover_size` | Album art notification size | int | 100 +`default_art` | Default art | string | "" `settings` | User settings | function | empty function `settings` can use `mpd_now` table, which contains the following string values: From 782da3605278f67cc13fbd408324aaf3b86a7eba Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 18 Sep 2013 06:53:48 -0700 Subject: [PATCH 241/303] Updated Utilities (markdown) --- Utilities.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/Utilities.md b/Utilities.md index 6afff16..de9f56b 100644 --- a/Utilities.md +++ b/Utilities.md @@ -127,4 +127,27 @@ You can use it with a key binding like this: awful.key({ modkey, "Shift" }, "r", function () lain.util.prompt_rename_tag(mypromptbox) end) -Credits goes to [minism](https://bbs.archlinux.org/viewtopic.php?pid=1315135#p1315135). \ No newline at end of file +Credits goes to [minism](https://bbs.archlinux.org/viewtopic.php?pid=1315135#p1315135). + +useless\_gaps\_resize +--------------------- + +Changes `beautiful.useless_gaps_width` on the fly, if present. + +The function takes an integer argument, being the amount of pixel to add/remove to gaps. + +You could use it with these keybindings: + + -- On the fly useless gaps change + awful.key({ altkey, "Control" }, "+", function () lain.util.useless_gaps_resize(1) end), + awful.key({ altkey, "Control" }, "-", function () lain.util.useless_gaps_resize(-1) end), + +where `altkey=Mod1`, or you could use it as a button like this: + + mywidget:buttons(awful.util.table.join ( + awful.button({}, 4, function() lain.util.useless_gaps_resize(-1) end), + awful.button({}, 5, function() lain.util.useless_gaps_resize(1) end) + end) + )) + +so when hovering the mouse over `mywidget`, you can adjust useless gaps size by scrolling with the mouse wheel. \ No newline at end of file From ac945dddbed50cd0db89763a3380937598647e84 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 18 Sep 2013 06:54:08 -0700 Subject: [PATCH 242/303] Updated Utilities (markdown) --- Utilities.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Utilities.md b/Utilities.md index de9f56b..3f00c35 100644 --- a/Utilities.md +++ b/Utilities.md @@ -132,7 +132,7 @@ Credits goes to [minism](https://bbs.archlinux.org/viewtopic.php?pid=1315135#p13 useless\_gaps\_resize --------------------- -Changes `beautiful.useless_gaps_width` on the fly, if present. +Changes `beautiful.useless_gaps_width` on the fly. The function takes an integer argument, being the amount of pixel to add/remove to gaps. From 388ca69c813c312b295ecbbefc5308eded243026 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 18 Sep 2013 06:55:03 -0700 Subject: [PATCH 243/303] Updated Utilities (markdown) --- Utilities.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Utilities.md b/Utilities.md index 3f00c35..a5c29ac 100644 --- a/Utilities.md +++ b/Utilities.md @@ -142,7 +142,7 @@ You could use it with these keybindings: awful.key({ altkey, "Control" }, "+", function () lain.util.useless_gaps_resize(1) end), awful.key({ altkey, "Control" }, "-", function () lain.util.useless_gaps_resize(-1) end), -where `altkey=Mod1`, or you could use it as a button like this: +where `altkey=Mod1`, or you could use it like this: mywidget:buttons(awful.util.table.join ( awful.button({}, 4, function() lain.util.useless_gaps_resize(-1) end), From 1b929ba3aaa4534a5569c62620bebc3fe71137d6 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 18 Sep 2013 07:55:30 -0700 Subject: [PATCH 244/303] Updated Utilities (markdown) --- Utilities.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Utilities.md b/Utilities.md index a5c29ac..3797f3c 100644 --- a/Utilities.md +++ b/Utilities.md @@ -70,8 +70,7 @@ the currently used layout. Use it with a client keybinding like this: ... ) -If you want to "de-magnify" it, just reset the clients floating state to -`false` (hit `Mod4`+`CTRL`+`Space`, for example). +If you want to "de-magnify" it, just retype the keybinding. niceborder\_{focus, unfocus} ---------------------------- From ed32756a35e1cd4ca8141966a634910c1e5a4e0a Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 19 Sep 2013 05:01:28 -0700 Subject: [PATCH 245/303] Updated Home (markdown) --- Home.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Home.md b/Home.md index 78f40c6..aad783f 100644 --- a/Home.md +++ b/Home.md @@ -2,11 +2,11 @@ Welcome to the Lain wiki! ### Dependencies -Package | Requested by ---- | --- -alsa-utils | [alsa](https://github.com/copycat-killer/lain/wiki/alsa), [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) -curl | widget types accessing network resources -imagemagick | [mpd](https://github.com/copycat-killer/lain/wiki/mpd) +Package | Requested by | Reason +--- | --- | --- +alsa-utils | [alsa](https://github.com/copycat-killer/lain/wiki/alsa), [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) | / +curl | widgets accessing network resources | Lua socket is not a core library. +imagemagick | [mpd](https://github.com/copycat-killer/lain/wiki/mpd) | Cairo doesn't do high quality filtering. *(Why ImageMagick? Because Cairo doesn't do high quality filtering at the moment.)* From c97650a177d4c3c6fbac039cbfc9876249fcf878 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 19 Sep 2013 05:02:06 -0700 Subject: [PATCH 246/303] Updated Home (markdown) --- Home.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Home.md b/Home.md index aad783f..5afbc2c 100644 --- a/Home.md +++ b/Home.md @@ -2,9 +2,9 @@ Welcome to the Lain wiki! ### Dependencies -Package | Requested by | Reason +Package | Requested by | Reason of choice --- | --- | --- -alsa-utils | [alsa](https://github.com/copycat-killer/lain/wiki/alsa), [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) | / +alsa-utils | [alsa](https://github.com/copycat-killer/lain/wiki/alsa), [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) | / curl | widgets accessing network resources | Lua socket is not a core library. imagemagick | [mpd](https://github.com/copycat-killer/lain/wiki/mpd) | Cairo doesn't do high quality filtering. From a14dd68ecd7141173323f5a73b37391c0bc1ad3c Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 19 Sep 2013 05:04:08 -0700 Subject: [PATCH 247/303] Updated Home (markdown) --- Home.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Home.md b/Home.md index 5afbc2c..bc479c0 100644 --- a/Home.md +++ b/Home.md @@ -5,7 +5,7 @@ Welcome to the Lain wiki! Package | Requested by | Reason of choice --- | --- | --- alsa-utils | [alsa](https://github.com/copycat-killer/lain/wiki/alsa), [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) | / -curl | widgets accessing network resources | Lua socket is not a core library. +curl | widgets accessing network resources | LuaSocket is not a core library. LuaSSL is out of date. imagemagick | [mpd](https://github.com/copycat-killer/lain/wiki/mpd) | Cairo doesn't do high quality filtering. *(Why ImageMagick? Because Cairo doesn't do high quality filtering at the moment.)* From 3e324fd005797905bbf7b83be884f1e0a948931e Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 19 Sep 2013 06:24:58 -0700 Subject: [PATCH 248/303] Updated borderbox (markdown) --- borderbox.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/borderbox.md b/borderbox.md index e4d7afb..5ac0b04 100644 --- a/borderbox.md +++ b/borderbox.md @@ -40,7 +40,7 @@ adds a borderbox on top of them: ... -- Most likely, you'll want to do this as well: - awful.screen.padding(screen[s], { bottom = 1 }) + awful.screen.padding(screen[s], "bottom") -- Create the box and place it above the existing box. lain.widgets.borderbox(mywibox[s], s, { position = "above" } ) From 1f35c5057ff4efca355c0f5b6f5e0bbec2ee6d99 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 19 Sep 2013 06:27:57 -0700 Subject: [PATCH 249/303] Updated borderbox (markdown) --- borderbox.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/borderbox.md b/borderbox.md index 5ac0b04..9fd138c 100644 --- a/borderbox.md +++ b/borderbox.md @@ -15,7 +15,7 @@ Variable | Meaning | Type | Default `color` | Color of the additional box | string | `#FFFFFF` `size` | Size in pixels of the additional box | int | 1 -Possible values for `.position`: `above`, `below`, `left` and `right`. +Possible values for `.position`: `top`, `bottom`, `left` and `right`. ### Example usage From 1368b031aa5d4b29a30c8f24b4bebde2f9d08ece Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 19 Sep 2013 06:55:39 -0700 Subject: [PATCH 250/303] Updated borderbox (markdown) --- borderbox.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/borderbox.md b/borderbox.md index 9fd138c..a56026a 100644 --- a/borderbox.md +++ b/borderbox.md @@ -43,7 +43,7 @@ adds a borderbox on top of them: awful.screen.padding(screen[s], "bottom") -- Create the box and place it above the existing box. - lain.widgets.borderbox(mywibox[s], s, { position = "above" } ) + lain.widgets.borderbox(mywibox[s], s ) ... end \ No newline at end of file From 0b6de84ac137d74efd9eeaaf38267fd16bec9dd1 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 19 Sep 2013 11:27:46 -0700 Subject: [PATCH 251/303] Updated Home (markdown) --- Home.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/Home.md b/Home.md index bc479c0..a7bee69 100644 --- a/Home.md +++ b/Home.md @@ -8,8 +8,6 @@ alsa-utils | [alsa](https://github.com/copycat-killer/lain/wiki/alsa), [alsabar] curl | widgets accessing network resources | LuaSocket is not a core library. LuaSSL is out of date. imagemagick | [mpd](https://github.com/copycat-killer/lain/wiki/mpd) | Cairo doesn't do high quality filtering. -*(Why ImageMagick? Because Cairo doesn't do high quality filtering at the moment.)* - ### Installation Simply clone this repository into your Awesome directory: From f92b3ac0c9dec3a6c8d046ce3d97add99a3a1e5e Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 19 Sep 2013 12:06:19 -0700 Subject: [PATCH 252/303] Updated Utilities (markdown) --- Utilities.md | 112 +++++++++++++++++++++++++++------------------------ 1 file changed, 59 insertions(+), 53 deletions(-) diff --git a/Utilities.md b/Utilities.md index 3797f3c..3ab9245 100644 --- a/Utilities.md +++ b/Utilities.md @@ -43,6 +43,64 @@ they all take one argument, which is the text to markup, except `fg.color` and ` markup.fg.color(text, color) markup.bg.color(text, color) +dynamic tagging +--------------- + +That is: + +- create a new tag; +- rename current tag; +- delete current tag. + +If you delete a tag, any rule set on it shall be broken, so be careful. + +Use it with key bindings like these: + + awful.key({ modkey, "Shift" }, "n", function () lain.util.create_tag(mypromptbox) end), + awful.key({ modkey, "Shift" }, "r", function () lain.util.rename_tag(mypromptbox) end), + awful.key({ modkey, "Shift" }, "d", function () lain.util.delete_tag() end), + +useless\_gaps\_resize +--------------------- + +Changes `beautiful.useless_gaps_width` on the fly. + +The function takes an integer argument, being the amount of pixel to add/remove to gaps. + +You could use it with these keybindings: + + -- On the fly useless gaps change + awful.key({ altkey, "Control" }, "+", function () lain.util.useless_gaps_resize(1) end), + awful.key({ altkey, "Control" }, "-", function () lain.util.useless_gaps_resize(-1) end), + +where `altkey=Mod1`, or you could use it like this: + + mywidget:buttons(awful.util.table.join ( + awful.button({}, 4, function() lain.util.useless_gaps_resize(-1) end), + awful.button({}, 5, function() lain.util.useless_gaps_resize(1) end) + end) + )) + +so when hovering the mouse over `mywidget`, you can adjust useless gaps size by scrolling with the mouse wheel. + +tag\_view\_nonempty +------------------- + +This function lets you jump to the next/previous non-empty tag. +It takes two arguments: + +* `direction`: `1` for next non-empty tag, `-1` for previous. +* `sc`: Screen which the taglist is in. Default is `mouse.screen` or `1`. This + argument is optional. + +You can use it with key bindings like these: + + -- Non-empty tag browsing + awful.key({ altkey }, "Left", function () lain.util.tag_view_nonempty(-1) end), + awful.key({ altkey }, "Right", function () lain.util.tag_view_nonempty(1) end), + +where `altkey = "Mod1"`. + menu\_clients\_current\_tags ---------------------------- @@ -97,56 +155,4 @@ This requires to define additional colors in your `theme.lua`. For example: theme.border_normal_highprio = "#A03333" theme.border_focus_lowprio = "#3333FF" - theme.border_normal_lowprio = "#333366" - -tag\_view\_nonempty -------------------- - -This function lets you jump to the next/previous non-empty tag. -It takes two arguments: - -* `direction`: `1` for next non-empty tag, `-1` for previous. -* `sc`: Screen which the taglist is in. Default is `mouse.screen` or `1`. This - argument is optional. - -You can use it with key bindings like these: - - -- Non-empty tag browsing - awful.key({ altkey }, "Left", function () lain.util.tag_view_nonempty(-1) end), - awful.key({ altkey }, "Right", function () lain.util.tag_view_nonempty(1) end), - -where `altkey = "Mod1"`. - -prompt\_rename\_tag -------------------- - -This function enables you to dynamically rename the current tag you have focused. - -You can use it with a key binding like this: - - awful.key({ modkey, "Shift" }, "r", function () lain.util.prompt_rename_tag(mypromptbox) end) - -Credits goes to [minism](https://bbs.archlinux.org/viewtopic.php?pid=1315135#p1315135). - -useless\_gaps\_resize ---------------------- - -Changes `beautiful.useless_gaps_width` on the fly. - -The function takes an integer argument, being the amount of pixel to add/remove to gaps. - -You could use it with these keybindings: - - -- On the fly useless gaps change - awful.key({ altkey, "Control" }, "+", function () lain.util.useless_gaps_resize(1) end), - awful.key({ altkey, "Control" }, "-", function () lain.util.useless_gaps_resize(-1) end), - -where `altkey=Mod1`, or you could use it like this: - - mywidget:buttons(awful.util.table.join ( - awful.button({}, 4, function() lain.util.useless_gaps_resize(-1) end), - awful.button({}, 5, function() lain.util.useless_gaps_resize(1) end) - end) - )) - -so when hovering the mouse over `mywidget`, you can adjust useless gaps size by scrolling with the mouse wheel. \ No newline at end of file + theme.border_normal_lowprio = "#333366" \ No newline at end of file From c2c9b33024fc905f900ca861189bb3ef5f7d7468 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 19 Sep 2013 16:49:45 -0700 Subject: [PATCH 254/303] Updated alsabar (markdown) --- alsabar.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/alsabar.md b/alsabar.md index f694c69..39506b0 100644 --- a/alsabar.md +++ b/alsabar.md @@ -13,6 +13,7 @@ The function takes a table as optional argument, which can contain: Variable | Meaning | Type | Default --- | --- | --- | --- `timeout` | Refresh timeout seconds | int | 4 +`settings` | User settings | function | empty function `width` | Bar width | int | 63 `height` | Bar height | int | 1 `ticks` | Set bar ticks on | boolean | true @@ -42,6 +43,8 @@ Variable | Meaning | Type | Default It's **crucial** to set `notifications.bar_size` to your `mywibox[s]` height. +`settings` can use the integer `alsa_level` and `alsa_status`. + ### output table Variable | Meaning | Type From 36a0534651749f23bf9786ba47912b498938c103 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 19 Sep 2013 16:54:37 -0700 Subject: [PATCH 255/303] Updated alsabar (markdown) --- alsabar.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/alsabar.md b/alsabar.md index 39506b0..31a7b23 100644 --- a/alsabar.md +++ b/alsabar.md @@ -43,8 +43,12 @@ Variable | Meaning | Type | Default It's **crucial** to set `notifications.bar_size` to your `mywibox[s]` height. -`settings` can use the integer `alsa_level` and `alsa_status`. +`settings` can use the following variables: +Variable | Meaning | Type | Values +--- | --- | --- | --- +`volume_now.level` | Self explained | int | 0-100 +`volume_now.status` | Device status | string | "on", "off" ### output table Variable | Meaning | Type From 476e9f57bb66cec635ce61170a57f49299e6c715 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 19 Sep 2013 18:05:20 -0700 Subject: [PATCH 256/303] Updated alsabar (markdown) --- alsabar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/alsabar.md b/alsabar.md index 31a7b23..fa5f209 100644 --- a/alsabar.md +++ b/alsabar.md @@ -38,7 +38,7 @@ Variable | Meaning | Type | Default --- | --- | --- | --- `font` | Notifications font | string | The one defined in `beautiful.font` `font_size` | Notifications font size | string | "11" -`color` | Notifications color | string | `beautiful.fg_focus` +`color` | Notifications color | string | `beautiful.fg_normal` `bar_size` | Wibox height | int | 18 It's **crucial** to set `notifications.bar_size` to your `mywibox[s]` height. From b5c1b95be234987449a79ab0767d215a54e325ac Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 24 Sep 2013 09:15:38 -0700 Subject: [PATCH 257/303] Updated Home (markdown) --- Home.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Home.md b/Home.md index a7bee69..e8271f3 100644 --- a/Home.md +++ b/Home.md @@ -6,7 +6,7 @@ Package | Requested by | Reason of choice --- | --- | --- alsa-utils | [alsa](https://github.com/copycat-killer/lain/wiki/alsa), [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) | / curl | widgets accessing network resources | LuaSocket is not a core library. LuaSSL is out of date. -imagemagick | [mpd](https://github.com/copycat-killer/lain/wiki/mpd) | Cairo doesn't do high quality filtering. +imagemagick | album arts in [mpd](https://github.com/copycat-killer/lain/wiki/mpd) notifications | Cairo doesn't do high quality filtering. ### Installation From 8622f98860287bb756b083fe73ebb9ff3a586e64 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 25 Sep 2013 03:30:55 -0700 Subject: [PATCH 258/303] Updated Home (markdown) --- Home.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/Home.md b/Home.md index e8271f3..6cdae23 100644 --- a/Home.md +++ b/Home.md @@ -1,6 +1,7 @@ Welcome to the Lain wiki! -### Dependencies +Dependencies +------------------ Package | Requested by | Reason of choice --- | --- | --- @@ -8,17 +9,25 @@ alsa-utils | [alsa](https://github.com/copycat-killer/lain/wiki/alsa), [alsabar] curl | widgets accessing network resources | LuaSocket is not a core library. LuaSSL is out of date. imagemagick | album arts in [mpd](https://github.com/copycat-killer/lain/wiki/mpd) notifications | Cairo doesn't do high quality filtering. -### Installation +Installation +--------------- -Simply clone this repository into your Awesome directory: +### Arch Linux + +[AUR package](https://aur.archlinux.org/packages/lain/) + +### Other distributions git clone https://github.com/copycat-killer/lain.git ~/.config/awesome/lain -then include it in your `rc.lua`: +Usage +-------- + +First, include it in your `rc.lua`: local lain = require("lain") -### Submodules +Then check out the submodules you want: - [Layouts](https://github.com/copycat-killer/lain/wiki/Layouts) - [Widgets](https://github.com/copycat-killer/lain/wiki/Widgets) From 2882ef92c6b9454ca153f729003fa2374fb7ef55 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 25 Sep 2013 06:05:56 -0700 Subject: [PATCH 259/303] Created task (markdown) --- task.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 task.md diff --git a/task.md b/task.md new file mode 100644 index 0000000..8c68ac0 --- /dev/null +++ b/task.md @@ -0,0 +1,30 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + +Attaches a [taskwarrior](http://taskwarrior.org/projects/show/taskwarrior) notification to a widget, and lets to add/search tasks from the promptbox. + + lain.widgets.contrib.task:attach(widget, args) + +`args` is an optional table which can contain: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`font_size` | Calendar font size | int | 12 +`fg` | Calendar foreground color | string | `beautiful.fg_normal` +`bg` | Calendar background color | string | `beautiful.bg_normal` +`position` | Calendar position | string | "top_right" +`timeout` | Notification timeout seconds | int | 7 + +`position` possible values are defined [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify). + +Notification will show the output of `task` command. + +You can call the notification with a key binding like this: + + awful.key({ modkey, altkey }, "t", lain.widgets.task.show), + +where ``altkey = "Mod1"``. + +And you can prompt to add/search a task with key bindings like these: + + awful.key({ modkey, }, "t", lain.widgets.contrib.task.prompt_add), + awful.key({ modkey, "Shift" }, "t", lain.widgets.contrib.task.prompt_search), \ No newline at end of file From fbe1673b191642a54c673c4f96947dab707dfdfe Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 25 Sep 2013 06:06:11 -0700 Subject: [PATCH 260/303] Updated Widgets (markdown) --- Widgets.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/Widgets.md b/Widgets.md index 981e4e1..b534f15 100644 --- a/Widgets.md +++ b/Widgets.md @@ -1,3 +1,6 @@ +General usage +------------- + Every widget is output by a `function`. For some widgets, `function` returns a `wibox.widget.textbox`, for others a table to be used for notification and update purposes. @@ -23,7 +26,8 @@ Here follows an example: If you want to see more complex applications, check [awesome-copycats](https://github.com/copycat-killer/awesome-copycats). ---- +Index +----- - [alsa](https://github.com/copycat-killer/lain/wiki/alsa) - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) @@ -39,4 +43,9 @@ If you want to see more complex applications, check [awesome-copycats](https://g - [net](https://github.com/copycat-killer/lain/wiki/net) - [sysload](https://github.com/copycat-killer/lain/wiki/sysload) - [temp](https://github.com/copycat-killer/lain/wiki/temp) -- [yawn](https://github.com/copycat-killer/lain/wiki/yawn) \ No newline at end of file +- [yawn](https://github.com/copycat-killer/lain/wiki/yawn) + +User contributed widgets +------------------------ + +- [task](https://github.com/copycat-killer/lain/wiki/task) \ No newline at end of file From 91217d6bad68401ee926ca79d3ef917525507321 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 25 Sep 2013 06:06:43 -0700 Subject: [PATCH 261/303] Updated Widgets (markdown) --- Widgets.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Widgets.md b/Widgets.md index b534f15..acb7075 100644 --- a/Widgets.md +++ b/Widgets.md @@ -45,7 +45,7 @@ Index - [temp](https://github.com/copycat-killer/lain/wiki/temp) - [yawn](https://github.com/copycat-killer/lain/wiki/yawn) -User contributed widgets ------------------------- +User contributed +---------------- - [task](https://github.com/copycat-killer/lain/wiki/task) \ No newline at end of file From 807599b7446b4866a8a2030b9a0fb4fd4f9ce754 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 25 Sep 2013 06:10:33 -0700 Subject: [PATCH 262/303] Updated Widgets (markdown) --- Widgets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Widgets.md b/Widgets.md index acb7075..ebe0810 100644 --- a/Widgets.md +++ b/Widgets.md @@ -45,7 +45,7 @@ Index - [temp](https://github.com/copycat-killer/lain/wiki/temp) - [yawn](https://github.com/copycat-killer/lain/wiki/yawn) -User contributed +Users contributed ---------------- - [task](https://github.com/copycat-killer/lain/wiki/task) \ No newline at end of file From fcc07d942c009d5089f8d32a61e1f2bafaf2b137 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 25 Sep 2013 08:02:02 -0700 Subject: [PATCH 263/303] Updated Home (markdown) --- Home.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Home.md b/Home.md index 6cdae23..9ba8362 100644 --- a/Home.md +++ b/Home.md @@ -23,7 +23,7 @@ Installation Usage -------- -First, include it in your `rc.lua`: +First, include it into your `rc.lua`: local lain = require("lain") From 42fea93dc41c0afb25a30094bea2469a1a9b63db Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 26 Sep 2013 02:51:15 -0700 Subject: [PATCH 264/303] Created tpbat (markdown) --- tpbat.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 tpbat.md diff --git a/tpbat.md b/tpbat.md new file mode 100644 index 0000000..38c30c9 --- /dev/null +++ b/tpbat.md @@ -0,0 +1,5 @@ +A battery widget that works with Lenovo ThinkPad laptops using [tp_smapi](http://www.thinkwiki.org/wiki/Tp_smapi. Includes hover notification with more details. + + tpbatwidget = lain.widgets.contrib.tpbat() + +Configuration is identical to [main bat widget's](https://github.com/copycat-killer/lain/wiki/bat). \ No newline at end of file From ae62d5d942b01709b05f32ac3738c692e563e3c8 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 26 Sep 2013 02:51:28 -0700 Subject: [PATCH 265/303] Updated tpbat (markdown) --- tpbat.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tpbat.md b/tpbat.md index 38c30c9..cb21a6b 100644 --- a/tpbat.md +++ b/tpbat.md @@ -1,4 +1,4 @@ -A battery widget that works with Lenovo ThinkPad laptops using [tp_smapi](http://www.thinkwiki.org/wiki/Tp_smapi. Includes hover notification with more details. +A battery widget that works with Lenovo ThinkPad laptops using [tp_smapi](http://www.thinkwiki.org/wiki/Tp_smapi). Includes hover notification with more details. tpbatwidget = lain.widgets.contrib.tpbat() From 5d51493ae8c83abcdc9f0087b9b3dbb3cf83b1b5 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 26 Sep 2013 02:51:39 -0700 Subject: [PATCH 266/303] Updated tpbat (markdown) --- tpbat.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tpbat.md b/tpbat.md index cb21a6b..7eebc79 100644 --- a/tpbat.md +++ b/tpbat.md @@ -1,4 +1,6 @@ -A battery widget that works with Lenovo ThinkPad laptops using [tp_smapi](http://www.thinkwiki.org/wiki/Tp_smapi). Includes hover notification with more details. +A battery widget that works with Lenovo ThinkPad laptops using [tp_smapi](http://www.thinkwiki.org/wiki/Tp_smapi). + +Includes hover notification with more details. tpbatwidget = lain.widgets.contrib.tpbat() From 9ff45882695f6e0d02d0f5c68a11c7d09d0909cf Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 26 Sep 2013 02:51:59 -0700 Subject: [PATCH 267/303] Updated tpbat (markdown) --- tpbat.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tpbat.md b/tpbat.md index 7eebc79..3d0b0e8 100644 --- a/tpbat.md +++ b/tpbat.md @@ -1,3 +1,5 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + A battery widget that works with Lenovo ThinkPad laptops using [tp_smapi](http://www.thinkwiki.org/wiki/Tp_smapi). Includes hover notification with more details. From 4a81ad47d143e42e8b9de92ebb8cd963d5bd6515 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 26 Sep 2013 02:52:49 -0700 Subject: [PATCH 268/303] Updated Widgets (markdown) --- Widgets.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Widgets.md b/Widgets.md index ebe0810..8a8945b 100644 --- a/Widgets.md +++ b/Widgets.md @@ -48,4 +48,5 @@ Index Users contributed ---------------- -- [task](https://github.com/copycat-killer/lain/wiki/task) \ No newline at end of file +- [task](https://github.com/copycat-killer/lain/wiki/task) +- [tpbat](https://github.com/copycat-killer/lain/wiki/tpbat) \ No newline at end of file From 089c10dff4317654c8436ddef408d993d617e202 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 28 Sep 2013 04:04:24 -0700 Subject: [PATCH 269/303] Updated Utilities (markdown) --- Utilities.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Utilities.md b/Utilities.md index 3ab9245..84fe3fa 100644 --- a/Utilities.md +++ b/Utilities.md @@ -50,6 +50,7 @@ That is: - create a new tag; - rename current tag; +- move current tag; - delete current tag. If you delete a tag, any rule set on it shall be broken, so be careful. @@ -58,6 +59,8 @@ Use it with key bindings like these: awful.key({ modkey, "Shift" }, "n", function () lain.util.create_tag(mypromptbox) end), awful.key({ modkey, "Shift" }, "r", function () lain.util.rename_tag(mypromptbox) end), + awful.key({ modkey, "Shift" }, "r", function () lain.util.move_tag(1) end), -- move next tag + awful.key({ modkey, "Shift" }, "r", function () lain.util.move_tag(-1) end), -- move prev tag awful.key({ modkey, "Shift" }, "d", function () lain.util.delete_tag() end), useless\_gaps\_resize From ea0c45685994189c1ff0a8a8cd3775f52062d951 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Wed, 2 Oct 2013 07:14:45 -0700 Subject: [PATCH 270/303] Updated fs (markdown) --- fs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fs.md b/fs.md index e30c473..1e34f86 100644 --- a/fs.md +++ b/fs.md @@ -14,7 +14,7 @@ Variable | Meaning | Type | Default `partition` | Partition to monitor | string | "/" `settings` | User settings | function | empty function -`settings` can use the following `partition` related float values: `used`, `available`, `size_mb`, `size_gb`. +`settings` can use the following `partition` related float values: `fs_now.used`, `fs_now.available`, `fs_now.size_mb`, `fs_now.size_gb`. It can also use value strings in these formats: From b570fc77aac193cbe0e42763e3285325cf9ea7e5 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Fri, 4 Oct 2013 06:19:52 -0700 Subject: [PATCH 271/303] Updated Layouts (markdown) --- Layouts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Layouts.md b/Layouts.md index 07184a4..d53b945 100644 --- a/Layouts.md +++ b/Layouts.md @@ -247,7 +247,7 @@ you have to add an item called `useless_gap_width` in your `theme.lua`. If it doesn't exist, the width will default to 0. Example: - theme.useless_gap_width = 5 + theme.useless_gap_width = 10 What about layout icons? ======================== From e85974ae28dda46d1f1ad1d5985269ea50ce5e83 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Fri, 4 Oct 2013 09:51:14 -0700 Subject: [PATCH 272/303] Updated Layouts (markdown) --- Layouts.md | 114 +++++++++++++++++++++++++++++++++-------------------- 1 file changed, 71 insertions(+), 43 deletions(-) diff --git a/Layouts.md b/Layouts.md index d53b945..fc302d4 100644 --- a/Layouts.md +++ b/Layouts.md @@ -1,11 +1,12 @@ -Currently, there are **7** layouts. +Currently, there are **8** layouts. lain/layout . + |-- termfair + |-- centerfair |-- cascade |-- cascadetile |-- centerwork - |-- termfair |-- uselessfair |-- uselesspiral `-- uselesstile @@ -27,6 +28,74 @@ Or set them on specific tags like this: How do layouts work? ========================= +termfair +-------- + +I do a lot of work on terminals. The common tiling algorithms usually +maximize windows, so you'll end up with a terminal that has about 200 +columns or more. That's way too much. Have you ever read a manpage in a +terminal of this size? + +This layout restricts the size of each window. Each window will have the +same width but is variable in height. Furthermore, windows are +left-aligned. The basic workflow is as follows (the number above the +screen is the number of open windows, the number in a cell is the fixed +number of a client): + + (1) (2) (3) + +---+---+---+ +---+---+---+ +---+---+---+ + | | | | | | | | | | | | + | 1 | | | -> | 2 | 1 | | -> | 3 | 2 | 1 | -> + | | | | | | | | | | | | + +---+---+---+ +---+---+---+ +---+---+---+ + + (4) (5) (6) + +---+---+---+ +---+---+---+ +---+---+---+ + | 4 | | | | 5 | 4 | | | 6 | 5 | 4 | + +---+---+---+ -> +---+---+---+ -> +---+---+---+ + | 3 | 2 | 1 | | 3 | 2 | 1 | | 3 | 2 | 1 | + +---+---+---+ +---+---+---+ +---+---+---+ + +The first client will be located in the left column. When opening +another window, this new window will be placed in the left column while +moving the first window into the middle column. Once a row is full, +another row above it will be created. + +Default number of columns and rows are respectively taken from `nmaster` +and `ncol` values in `awful.tag`, but you can set your own. + +For example, this sets `termfair` to 3 columns and at least 1 row: + + lain.layout.termfair.nmaster = 3 + lain.layout.termfair.ncol = 1 + +centerfair +---------- + +Similar to `termfair`, but with fixed number of vertical columns. Cols are centerded until there is nmaster columns, then windows are stacked in the slave columns, with at most ncol clients per column if possible. + + (1) (2) (3) + +---+---+---+ +-+---+---+-+ +---+---+---+ + | | | | | | | | | | | | | + | | 1 | | -> | | 1 | 2 | | -> | 1 | 2 | 3 | -> + | | | | | | | | | | | | | + +---+---+---+ +-+---+---+-+ +---+---+---+ + + (4) (5) + +---+---+---+ +---+---+---+ + | | | 3 | | | 2 | 4 | + + 1 + 2 +---+ -> + 1 +---+---+ + | | | 4 | | | 3 | 5 | + +---+---+---+ +---+---+---+ + +Like `termfair`, default number of columns and rows are respectively taken from `nmaster` +and `ncol` values in `awful.tag`, but you can set your own. + +For example: + + lain.layout.centerfair.nmaster = 3 + lain.layout.centerfair.ncol = 1 + cascade ------- @@ -174,47 +243,6 @@ Here's an example: ... ) -termfair --------- - -I do a lot of work on terminals. The common tiling algorithms usually -maximize windows, so you'll end up with a terminal that has about 200 -columns or more. That's way too much. Have you ever read a manpage in a -terminal of this size? - -This layout restricts the size of each window. Each window will have the -same width but is variable in height. Furthermore, windows are -left-aligned. The basic workflow is as follows (the number above the -screen is the number of open windows, the number in a cell is the fixed -number of a client): - - (1) (2) (3) - +---+---+---+ +---+---+---+ +---+---+---+ - | | | | | | | | | | | | - | 1 | | | -> | 2 | 1 | | -> | 3 | 2 | 1 | -> - | | | | | | | | | | | | - +---+---+---+ +---+---+---+ +---+---+---+ - - (4) (5) (6) - +---+---+---+ +---+---+---+ +---+---+---+ - | 4 | | | | 5 | 4 | | | 6 | 5 | 4 | - +---+---+---+ -> +---+---+---+ -> +---+---+---+ - | 3 | 2 | 1 | | 3 | 2 | 1 | | 3 | 2 | 1 | - +---+---+---+ +---+---+---+ +---+---+---+ - -The first client will be located in the left column. When opening -another window, this new window will be placed in the left column while -moving the first window into the middle column. Once a row is full, -another row above it will be created. - -Default number of columns and rows are respectively taken from `nmaster` -and `ncol` values in `awful.tag`, but you can set your own. - -For example, this sets `termfair` to 3 columns and at least 1 row: - - lain.layout.termfair.nmaster = 3 - lain.layout.termfair.ncol = 1 - uselessfair, uselesspiral & uselesstile --------------------------------------- These are duplicates of the stock `fair`, `spiral` and `tile` layouts. From fc8a3e72aecc446f534bec9d39e1215202349d8a Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sun, 6 Oct 2013 15:49:20 -0700 Subject: [PATCH 273/303] Updated Layouts (markdown) --- Layouts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Layouts.md b/Layouts.md index fc302d4..1ddca95 100644 --- a/Layouts.md +++ b/Layouts.md @@ -72,7 +72,7 @@ For example, this sets `termfair` to 3 columns and at least 1 row: centerfair ---------- -Similar to `termfair`, but with fixed number of vertical columns. Cols are centerded until there is nmaster columns, then windows are stacked in the slave columns, with at most ncol clients per column if possible. +Similar to `termfair`, but with fixed number of vertical columns. Cols are centerded until there are `nmaster` columns, then windows are stacked as slaves, with possibly `ncol` clients per column at most. (1) (2) (3) +---+---+---+ +-+---+---+-+ +---+---+---+ From 724142977074eae2aeca552e02209a9bae6f0177 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 12 Nov 2013 01:38:47 -0800 Subject: [PATCH 274/303] Updated task (markdown) --- task.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/task.md b/task.md index 8c68ac0..b4bc7f0 100644 --- a/task.md +++ b/task.md @@ -20,7 +20,7 @@ Notification will show the output of `task` command. You can call the notification with a key binding like this: - awful.key({ modkey, altkey }, "t", lain.widgets.task.show), + awful.key({ modkey, altkey }, "t", lain.widgets.contrib.task.show), where ``altkey = "Mod1"``. From d746d045f22bd8521b60fed5afb754a9e96bfb1d Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 12 Nov 2013 01:38:54 -0800 Subject: [PATCH 275/303] Updated Utilities (markdown) --- Utilities.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Utilities.md b/Utilities.md index 84fe3fa..0e58304 100644 --- a/Utilities.md +++ b/Utilities.md @@ -48,20 +48,20 @@ dynamic tagging That is: -- create a new tag; +- add a new tag; - rename current tag; - move current tag; -- delete current tag. +- remove current tag. If you delete a tag, any rule set on it shall be broken, so be careful. Use it with key bindings like these: - awful.key({ modkey, "Shift" }, "n", function () lain.util.create_tag(mypromptbox) end), + awful.key({ modkey, "Shift" }, "n", function () lain.util.add_tag(mypromptbox) end), awful.key({ modkey, "Shift" }, "r", function () lain.util.rename_tag(mypromptbox) end), awful.key({ modkey, "Shift" }, "r", function () lain.util.move_tag(1) end), -- move next tag - awful.key({ modkey, "Shift" }, "r", function () lain.util.move_tag(-1) end), -- move prev tag - awful.key({ modkey, "Shift" }, "d", function () lain.util.delete_tag() end), + awful.key({ modkey, "Shift" }, "r", function () lain.util.move_tag(-1) end), -- move previous tag + awful.key({ modkey, "Shift" }, "d", function () lain.util.remove_tag() end), useless\_gaps\_resize --------------------- From 3a6a7798f94cffe4677ff70e5b488724398ec507 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 12 Nov 2013 01:39:52 -0800 Subject: [PATCH 276/303] Updated Utilities (markdown) --- Utilities.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Utilities.md b/Utilities.md index 0e58304..e4f114a 100644 --- a/Utilities.md +++ b/Utilities.md @@ -59,8 +59,8 @@ Use it with key bindings like these: awful.key({ modkey, "Shift" }, "n", function () lain.util.add_tag(mypromptbox) end), awful.key({ modkey, "Shift" }, "r", function () lain.util.rename_tag(mypromptbox) end), - awful.key({ modkey, "Shift" }, "r", function () lain.util.move_tag(1) end), -- move next tag - awful.key({ modkey, "Shift" }, "r", function () lain.util.move_tag(-1) end), -- move previous tag + awful.key({ modkey, "Shift" }, "r", function () lain.util.move_tag(1) end), -- move to next tag + awful.key({ modkey, "Shift" }, "r", function () lain.util.move_tag(-1) end), -- move to previous tag awful.key({ modkey, "Shift" }, "d", function () lain.util.remove_tag() end), useless\_gaps\_resize From 27923b165d8b31f8614419277fd3eb44123bd6c0 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 12 Nov 2013 01:50:52 -0800 Subject: [PATCH 277/303] Updated Utilities (markdown) --- Utilities.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Utilities.md b/Utilities.md index e4f114a..2171503 100644 --- a/Utilities.md +++ b/Utilities.md @@ -63,6 +63,8 @@ Use it with key bindings like these: awful.key({ modkey, "Shift" }, "r", function () lain.util.move_tag(-1) end), -- move to previous tag awful.key({ modkey, "Shift" }, "d", function () lain.util.remove_tag() end), +**Note** that these function won't work properly with [Copland theme](https://github.com/copycat-killer/awesome-copycats) or any other configuration that already uses a dynamic tagging module like [Eminent](https://github.com/copycat-killer/awesome-copycats/tree/master/eminent). + useless\_gaps\_resize --------------------- From a7b1e7e0db5db914d519bbe8135f7e29cadfb8b7 Mon Sep 17 00:00:00 2001 From: blueluke Date: Tue, 12 Nov 2013 15:11:54 -0800 Subject: [PATCH 278/303] Removed a misplaced space in mpd_notification_preset variable declaration --- mpd.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mpd.md b/mpd.md index 0e2eca5..646b690 100644 --- a/mpd.md +++ b/mpd.md @@ -44,7 +44,7 @@ Variable | Meaning | Type | Default and can modify `mpd_notification_preset` table, which will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. Default definition: - mpd_notification _preset = { + mpd_notification_preset = { title = "Now playing", timeout = 6, text = string.format("%s (%s) - %s\n%s", mpd_now.artist, From 65c1a3ab6e411aec30c3145178fac9f7fdbab87f Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 28 Nov 2013 00:48:22 -0800 Subject: [PATCH 279/303] Updated Utilities (markdown) --- Utilities.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Utilities.md b/Utilities.md index 2171503..99588b9 100644 --- a/Utilities.md +++ b/Utilities.md @@ -59,8 +59,8 @@ Use it with key bindings like these: awful.key({ modkey, "Shift" }, "n", function () lain.util.add_tag(mypromptbox) end), awful.key({ modkey, "Shift" }, "r", function () lain.util.rename_tag(mypromptbox) end), - awful.key({ modkey, "Shift" }, "r", function () lain.util.move_tag(1) end), -- move to next tag - awful.key({ modkey, "Shift" }, "r", function () lain.util.move_tag(-1) end), -- move to previous tag + awful.key({ modkey, "Shift" }, "Left", function () lain.util.move_tag(1) end), -- move to next tag + awful.key({ modkey, "Shift" }, "Right", function () lain.util.move_tag(-1) end), -- move to previous tag awful.key({ modkey, "Shift" }, "d", function () lain.util.remove_tag() end), **Note** that these function won't work properly with [Copland theme](https://github.com/copycat-killer/awesome-copycats) or any other configuration that already uses a dynamic tagging module like [Eminent](https://github.com/copycat-killer/awesome-copycats/tree/master/eminent). From c6d748757d263251137c8615dc0f2c11eee5cb9c Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 3 Dec 2013 02:29:12 -0800 Subject: [PATCH 280/303] Updated Home (markdown) --- Home.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Home.md b/Home.md index 9ba8362..5581a9e 100644 --- a/Home.md +++ b/Home.md @@ -6,7 +6,7 @@ Dependencies Package | Requested by | Reason of choice --- | --- | --- alsa-utils | [alsa](https://github.com/copycat-killer/lain/wiki/alsa), [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) | / -curl | widgets accessing network resources | LuaSocket is not a core library. LuaSSL is out of date. +curl | widgets accessing network resources | LuaSocket is not a core library, and still not available for Lua 5.2+. LuaSSL is out of date. imagemagick | album arts in [mpd](https://github.com/copycat-killer/lain/wiki/mpd) notifications | Cairo doesn't do high quality filtering. Installation From 53c17b285e286cfae9870c0273aa0d896068b8aa Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 3 Dec 2013 02:29:29 -0800 Subject: [PATCH 281/303] Updated Home (markdown) --- Home.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Home.md b/Home.md index 5581a9e..be89e32 100644 --- a/Home.md +++ b/Home.md @@ -6,7 +6,8 @@ Dependencies Package | Requested by | Reason of choice --- | --- | --- alsa-utils | [alsa](https://github.com/copycat-killer/lain/wiki/alsa), [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) | / -curl | widgets accessing network resources | LuaSocket is not a core library, and still not available for Lua 5.2+. LuaSSL is out of date. +curl | widgets accessing network resources | LuaSocket is not a core library, and still not available for Lua 5.2+. +LuaSSL is out of date. imagemagick | album arts in [mpd](https://github.com/copycat-killer/lain/wiki/mpd) notifications | Cairo doesn't do high quality filtering. Installation From 7b6d89cd4ff2b84fd333c8f6a5f0ef079b845f48 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 5 Dec 2013 01:18:49 -0800 Subject: [PATCH 282/303] Updated Home (markdown) --- Home.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Home.md b/Home.md index be89e32..5581a9e 100644 --- a/Home.md +++ b/Home.md @@ -6,8 +6,7 @@ Dependencies Package | Requested by | Reason of choice --- | --- | --- alsa-utils | [alsa](https://github.com/copycat-killer/lain/wiki/alsa), [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar) | / -curl | widgets accessing network resources | LuaSocket is not a core library, and still not available for Lua 5.2+. -LuaSSL is out of date. +curl | widgets accessing network resources | LuaSocket is not a core library, and still not available for Lua 5.2+. LuaSSL is out of date. imagemagick | album arts in [mpd](https://github.com/copycat-killer/lain/wiki/mpd) notifications | Cairo doesn't do high quality filtering. Installation From 66665bd8d33c016b06f41ff735b2d2ea0834647e Mon Sep 17 00:00:00 2001 From: yawnt Date: Mon, 23 Dec 2013 08:04:02 -0800 Subject: [PATCH 283/303] Created brightness (markdown) --- brightness.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 brightness.md diff --git a/brightness.md b/brightness.md new file mode 100644 index 0000000..590359a --- /dev/null +++ b/brightness.md @@ -0,0 +1,40 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + +Shows brightness level in a textbox. + + volumewidget = lain.widgets.contrib.brightness() + +### input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`timeout` | Refresh timeout seconds | int | 5 +`backlight` | Backlight Video | string | "acpi_video0" +`settings` | User settings | function | empty function + +`settings` can use the following variables: + +Variable | Meaning | Type | Values +--- | --- | --- | --- +`brightness_now` | Brightness level | int | 0-100 + +### output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The widget | `wibox.widget.textbox` +`update` | Update `widget` | function + +You can control the widget with key bindings like these: + + -- Volume control + awful.key({}, "XF86MonBrightnessUp", + function () + awful.util.spawn("xbacklight -inc 1") + brightnesswidget.update() + end), + awful.key({}, "XF86MonBrightnessDown", + function () + awful.util.spawn("xbacklight -dec 1") + brightnesswidget.update() + end), From ba7f3b15ec47e9293628e10565f55fca72dca05f Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 23 Dec 2013 09:10:31 -0800 Subject: [PATCH 284/303] Created brigthness (markdown) --- brigthness.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 brigthness.md diff --git a/brigthness.md b/brigthness.md new file mode 100644 index 0000000..b0dfe76 --- /dev/null +++ b/brigthness.md @@ -0,0 +1,24 @@ +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + +Shows the current level of screen brightness. + + mybrightness = lain.widgets.contrib.brightness() + +### input table + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`backlight` | Card managing backlight | `acpi_video0` +`timeout` | Refresh timeout seconds | int | 5 +`settings` | User settings | function | empty function + +`settings` can use the string `brightness_now`, which indicates the current brightness level. + +### output table + +Variable | Meaning | Type +--- | --- | --- +`widget` | The textbox | `wibox.widget.textbox` +`update` | The notification | function + +You can control the widget with key bindings like these: [TODO] \ No newline at end of file From 09abc245c1190e6db675eccf232afff3af1cf4ac Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 23 Dec 2013 09:11:07 -0800 Subject: [PATCH 285/303] Updated Widgets (markdown) --- Widgets.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Widgets.md b/Widgets.md index 8a8945b..12178e2 100644 --- a/Widgets.md +++ b/Widgets.md @@ -49,4 +49,5 @@ Users contributed ---------------- - [task](https://github.com/copycat-killer/lain/wiki/task) -- [tpbat](https://github.com/copycat-killer/lain/wiki/tpbat) \ No newline at end of file +- [tpbat](https://github.com/copycat-killer/lain/wiki/tpbat) +- [brightness](https://github.com/copycat-killer/lain/wiki/brigthness) \ No newline at end of file From 346db7c907c29bbe01c238c70ef5e2a16060c44c Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 23 Dec 2013 09:14:39 -0800 Subject: [PATCH 287/303] Updated brightness (markdown) --- brightness.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/brightness.md b/brightness.md index 590359a..5a3a9db 100644 --- a/brightness.md +++ b/brightness.md @@ -1,15 +1,15 @@ [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) -Shows brightness level in a textbox. +Shows the current level of screen brightness in a textbox. - volumewidget = lain.widgets.contrib.brightness() + mybrightness = lain.widgets.contrib.brightness() ### input table Variable | Meaning | Type | Default --- | --- | --- | --- `timeout` | Refresh timeout seconds | int | 5 -`backlight` | Backlight Video | string | "acpi_video0" +`backlight` | Backlight video | string | "acpi_video0" `settings` | User settings | function | empty function `settings` can use the following variables: @@ -37,4 +37,4 @@ You can control the widget with key bindings like these: function () awful.util.spawn("xbacklight -dec 1") brightnesswidget.update() - end), + end), \ No newline at end of file From 507d34eec1cf963036d5f30ce8c960cc2b82bdf3 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 23 Dec 2013 09:15:04 -0800 Subject: [PATCH 288/303] Updated Widgets (markdown) --- Widgets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Widgets.md b/Widgets.md index 12178e2..5917aac 100644 --- a/Widgets.md +++ b/Widgets.md @@ -50,4 +50,4 @@ Users contributed - [task](https://github.com/copycat-killer/lain/wiki/task) - [tpbat](https://github.com/copycat-killer/lain/wiki/tpbat) -- [brightness](https://github.com/copycat-killer/lain/wiki/brigthness) \ No newline at end of file +- [brightness](https://github.com/copycat-killer/lain/wiki/brightness) \ No newline at end of file From e379b9649b88e4e88a95731565e65d92c86b2824 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 23 Dec 2013 09:17:57 -0800 Subject: [PATCH 289/303] Destroyed brigthness (markdown) --- brigthness.md | 24 ------------------------ 1 file changed, 24 deletions(-) delete mode 100644 brigthness.md diff --git a/brigthness.md b/brigthness.md deleted file mode 100644 index b0dfe76..0000000 --- a/brigthness.md +++ /dev/null @@ -1,24 +0,0 @@ -[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) - -Shows the current level of screen brightness. - - mybrightness = lain.widgets.contrib.brightness() - -### input table - -Variable | Meaning | Type | Default ---- | --- | --- | --- -`backlight` | Card managing backlight | `acpi_video0` -`timeout` | Refresh timeout seconds | int | 5 -`settings` | User settings | function | empty function - -`settings` can use the string `brightness_now`, which indicates the current brightness level. - -### output table - -Variable | Meaning | Type ---- | --- | --- -`widget` | The textbox | `wibox.widget.textbox` -`update` | The notification | function - -You can control the widget with key bindings like these: [TODO] \ No newline at end of file From 9f6ff057f4b99704d9396a66c4f2896954541d2e Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 24 Dec 2013 03:28:49 -0800 Subject: [PATCH 290/303] Updated brightness (markdown) --- brightness.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/brightness.md b/brightness.md index 5a3a9db..4cd4f8e 100644 --- a/brightness.md +++ b/brightness.md @@ -2,7 +2,7 @@ Shows the current level of screen brightness in a textbox. - mybrightness = lain.widgets.contrib.brightness() + brightnesswidget = lain.widgets.contrib.brightness() ### input table @@ -27,7 +27,7 @@ Variable | Meaning | Type You can control the widget with key bindings like these: - -- Volume control + -- Brightness control awful.key({}, "XF86MonBrightnessUp", function () awful.util.spawn("xbacklight -inc 1") From 0f5d6dc4a543871c3ab7e3c36f6988b3a3ceffa4 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 24 Dec 2013 03:33:15 -0800 Subject: [PATCH 291/303] Updated tpbat (markdown) --- tpbat.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tpbat.md b/tpbat.md index 3d0b0e8..e54f469 100644 --- a/tpbat.md +++ b/tpbat.md @@ -6,4 +6,4 @@ Includes hover notification with more details. tpbatwidget = lain.widgets.contrib.tpbat() -Configuration is identical to [main bat widget's](https://github.com/copycat-killer/lain/wiki/bat). \ No newline at end of file +Configuration is identical to [standard bat widget's](https://github.com/copycat-killer/lain/wiki/bat). \ No newline at end of file From 89807acfccfceb936b18e6e9ebf669bec7e01a16 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 24 Dec 2013 03:33:29 -0800 Subject: [PATCH 292/303] Updated tpbat (markdown) --- tpbat.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tpbat.md b/tpbat.md index e54f469..5a7ba0c 100644 --- a/tpbat.md +++ b/tpbat.md @@ -6,4 +6,4 @@ Includes hover notification with more details. tpbatwidget = lain.widgets.contrib.tpbat() -Configuration is identical to [standard bat widget's](https://github.com/copycat-killer/lain/wiki/bat). \ No newline at end of file +Configuration is identical to [standard battery widget's](https://github.com/copycat-killer/lain/wiki/bat). \ No newline at end of file From c8e07d2ec34cfb12907e4ccb5f29908aa8c98f5a Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 30 Dec 2013 06:57:45 -0800 Subject: [PATCH 293/303] Updated Layouts (markdown) --- Layouts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Layouts.md b/Layouts.md index 1ddca95..045c2c9 100644 --- a/Layouts.md +++ b/Layouts.md @@ -101,7 +101,7 @@ cascade Cascade all windows of a tag. -You can control the offsets by setting those two variables: +You can control the offsets by setting these two variables: lain.layout.cascade.cascade_offset_x = 64 lain.layout.cascade.cascade_offset_y = 16 From 07a230fb1654cc6abc1bd1ea8b36d8dcb3c1ad62 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Thu, 2 Jan 2014 03:16:09 -0800 Subject: [PATCH 294/303] Updated calendar (markdown) --- calendar.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/calendar.md b/calendar.md index fa4e563..b06c453 100644 --- a/calendar.md +++ b/calendar.md @@ -26,4 +26,6 @@ You can call the notification with a key binding like this: awful.key({ altkey }, "c", function () lain.widgets.calendar:show(7) end), -where ``altkey = "Mod1"`` and ``show`` argument is an optional integer, meaning timeout seconds. \ No newline at end of file +where ``altkey = "Mod1"`` and ``show`` argument is an optional integer, meaning timeout seconds. + +**Note that** this widget exploits ``cal`` to do the alignment, in order to avoid more dozens of code lines, but this requires that your system font is monospaced. \ No newline at end of file From 780ce12033c8aa90c5060280cfbdfd6fddc7584f Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 13 Jan 2014 04:01:31 -0800 Subject: [PATCH 295/303] Updated bat (markdown) --- bat.md | 1 + 1 file changed, 1 insertion(+) diff --git a/bat.md b/bat.md index 50c14e8..82e7a8b 100644 --- a/bat.md +++ b/bat.md @@ -13,6 +13,7 @@ Variable | Meaning | Type | Default --- | --- | --- | --- `timeout` | Refresh timeout seconds | int | 30 `battery` | Identifier of the battery | string | "BAT0" +`notify` | Enable notifications | boolean | true `settings` | User settings | function | empty function `settings` can use the `bat_now` table, which contains the following strings: From ac4b4d5d555c94015700c55ff294bf8e7d1645ef Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 14 Jan 2014 00:53:12 -0800 Subject: [PATCH 296/303] Updated bat (markdown) --- bat.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/bat.md b/bat.md index 82e7a8b..c450dbe 100644 --- a/bat.md +++ b/bat.md @@ -13,7 +13,7 @@ Variable | Meaning | Type | Default --- | --- | --- | --- `timeout` | Refresh timeout seconds | int | 30 `battery` | Identifier of the battery | string | "BAT0" -`notify` | Enable notifications | boolean | true +`notify` | Enable notifications | string | "on" `settings` | User settings | function | empty function `settings` can use the `bat_now` table, which contains the following strings: @@ -23,6 +23,8 @@ Variable | Meaning | Type | Default - `time`; - `watt`. +To disable warning notifications, set `notify` to `off`. + ### output A textbox. \ No newline at end of file From b81da3a243ca8be6c778041e2f91cacb31470122 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 14 Jan 2014 00:53:56 -0800 Subject: [PATCH 297/303] Updated bat (markdown) --- bat.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bat.md b/bat.md index c450dbe..6bbb21e 100644 --- a/bat.md +++ b/bat.md @@ -23,7 +23,7 @@ Variable | Meaning | Type | Default - `time`; - `watt`. -To disable warning notifications, set `notify` to `off`. +To disable warning notifications, set `notify` to `"off"`. ### output From 41d28b93ebbeb7e51584032e88c748426ea6cd82 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Tue, 14 Jan 2014 01:05:55 -0800 Subject: [PATCH 298/303] Updated alsabar (markdown) --- alsabar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/alsabar.md b/alsabar.md index fa5f209..6138f2c 100644 --- a/alsabar.md +++ b/alsabar.md @@ -16,7 +16,7 @@ Variable | Meaning | Type | Default `settings` | User settings | function | empty function `width` | Bar width | int | 63 `height` | Bar height | int | 1 -`ticks` | Set bar ticks on | boolean | true +`ticks` | Set bar ticks on | boolean | false `ticks_size` | Ticks size | int | 7 `vertical` | Set the bar vertical | boolean | false `channel` | Mixer channel | string | "Master" From dd10cac1306530f46f0e8506156e1ef21b456fae Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 20 Jan 2014 09:52:35 -0800 Subject: [PATCH 299/303] Updated imap (markdown) --- imap.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/imap.md b/imap.md index ba92d0f..b0d5375 100644 --- a/imap.md +++ b/imap.md @@ -31,16 +31,26 @@ Variable | Meaning | Type | Default Let's focus better on `is_plain`. -You can just set your password like this: +The reason why it's false by default is to discourage the habit of storing passwords in plain files. - args.is_plain = false - args.password = "mypassword" +You can set your password in plain like this: + + myimapcheck = lain.widgets.imap({ + is_plain = true, + password = "myplainpassword", + [...] + }) and you'll have the same security provided by `~/.netrc`. **Or** you can use a keyring, like [python keyring](https://pypi.python.org/pypi/keyring): - args.password = "keyring get password" + myimapcheck = lain.widgets.imap({ + is_plain = true, + password = "myplainpassword", + server = "mail.autistici.org", + mail = "dada@anche.no", + }) When `is_plain == false`, it *executes* `password` before using it, so you can also use whatever password fetching solution you want. From a11f76cf00b430d3f7eec710879847cb654fe17f Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 20 Jan 2014 09:53:32 -0800 Subject: [PATCH 300/303] Updated imap (markdown) --- imap.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/imap.md b/imap.md index b0d5375..7952c81 100644 --- a/imap.md +++ b/imap.md @@ -46,10 +46,8 @@ and you'll have the same security provided by `~/.netrc`. **Or** you can use a keyring, like [python keyring](https://pypi.python.org/pypi/keyring): myimapcheck = lain.widgets.imap({ - is_plain = true, - password = "myplainpassword", - server = "mail.autistici.org", - mail = "dada@anche.no", + password = "keyring get mymail", + [...] }) When `is_plain == false`, it *executes* `password` before using it, so you can also use whatever password fetching solution you want. From 60dc042b1f6fc1f9f3ce9e2b78e75af2f80bfe79 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 20 Jan 2014 10:14:22 -0800 Subject: [PATCH 302/303] Updated imap (markdown) --- imap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/imap.md b/imap.md index 7952c81..f754348 100644 --- a/imap.md +++ b/imap.md @@ -31,7 +31,7 @@ Variable | Meaning | Type | Default Let's focus better on `is_plain`. -The reason why it's false by default is to discourage the habit of storing passwords in plain files. +The reason why it's false by default is to discourage the habit of storing passwords in plain. You can set your password in plain like this: From f996cdb74e7583534256d82706ef63d2b9811b42 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Mon, 20 Jan 2014 10:14:42 -0800 Subject: [PATCH 303/303] Updated imap (markdown) --- imap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/imap.md b/imap.md index f754348..403a61a 100644 --- a/imap.md +++ b/imap.md @@ -33,7 +33,7 @@ Let's focus better on `is_plain`. The reason why it's false by default is to discourage the habit of storing passwords in plain. -You can set your password in plain like this: +So you can set your password in plain like this: myimapcheck = lain.widgets.imap({ is_plain = true,