]> 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:

Updated yawn (rest => markdown)
[etc/awesome.git] / calendar.md
index 06e1b4868788276c973088db9c97d8557d74fa60..2b75840cfc3d83cd208514b966fd79136417004e 100644 (file)
@@ -1,11 +1,13 @@
-Attaches a calendar to a ``widget``. Example:
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
 
-    lain.widgets.calendar:attach(mytextclock)
+Attaches a calendar notification to a widget.
+
+    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 +15,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.