]> git.madduck.net Git - etc/awesome.git/blobdiff - 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:

Destroyed To start (markdown)
[etc/awesome.git] / calendar.md
index bfceac928f6c9650b4d70c35b36bcd785f957268..5b4587db50c1887533bc0799013260a9f10f2203 100644 (file)
@@ -1,11 +1,13 @@
-Attaches a calendar to a widget.
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
 
 
-    lain.widgets.calendar:attach(mywidget)
+Attaches a calendar notification to a widget.
+
+    lain.widgets.calendar:attach(widget)
 
 - Left click: switch to previous month.
 - Right click: switch to next month.
 
 
 - 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 fg and bg colors arguments, both or just one:
 
     lain.widgets.calendar:attach(mytextclock, "#FFFFFF", "#000000")
     -- or
 
     lain.widgets.calendar:attach(mytextclock, "#FFFFFF", "#000000")
     -- or
@@ -13,6 +15,8 @@ Optionally you can call the function with background and foreground colors argum
     -- or
     lain.widgets.calendar:attach(mytextclock, nil, "#000000")
 
     -- or
     lain.widgets.calendar:attach(mytextclock, nil, "#000000")
 
+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.
 
 Notification will show an icon displaying current day, and formatted output
 from ``cal`` with current day highlighted.