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

madduck's git repository

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

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

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

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

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

Updated imap (markdown)
[etc/awesome.git] / calendar.md
1 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
2
3 Attaches a calendar notification to a widget.
4
5     lain.widgets.calendar:attach(widget)
6
7 - Left click: switch to previous month.
8 - Right click: switch to next month.
9
10 Optionally you can call the function with bg and fg colors arguments, both or just one:
11
12     lain.widgets.calendar:attach(mytextclock, "#FFFFFF", "#000000")
13     -- or
14     lain.widgets.calendar:attach(mytextclock, "#FFFFFF")
15     -- or
16     lain.widgets.calendar:attach(mytextclock, nil, "#000000")
17
18 default bg and fg colors are `beautiful.bg_normal` and `beautiful.fg_focus`.
19
20 Notification will show an icon displaying current day, and formatted output
21 from ``cal`` with current day highlighted.
22
23 Calendar icons are placed in [lain/icons/cal](https://github.com/copycat-killer/lain/tree/master/icons/cal), default set being ``white``.
24
25 You can add your own set, and tell lain to use it like this:
26
27     lain.widgets.calendar.icons_dir = lain.widgets.icons_dir .. "cal/myicons"
28
29 also, you can set notification font size:
30
31     lain.widgets.calendar.font_size = 14
32
33 default is 12.
34
35 Finally, you can call the notification with a key binding like this:
36
37     awful.key({ altkey }, "c", function () lain.widgets.calendar:show(7) end),
38
39 where ``altkey = "Mod1"`` and ``show`` argument is an optional integer, meaning timeout seconds.