fixes for lighttpd and php 5.4
[bdrem.git] / README.rst
index b0cb9c1..07d224b 100644 (file)
@@ -3,7 +3,8 @@ bdrem - Birthday reminder by mail
 *********************************
 Birthday reminder that sends out e-mails.
 
-It can also generate ASCII tables on your console/shell and normal HTML pages.
+It can also generate ASCII tables on your console, iCalendar files
+and normal HTML pages.
 
 .. contents::
 
@@ -17,13 +18,14 @@ Data sources
 
   - Multiple date fields per record supported.
 - An LDAP server
-- `Birthday reminder <http://cweiske.de/birthday3.htm>` files (``.bdf``)
+- `Birthday reminder <http://cweiske.de/birthday3.htm>`_ files (``.bdf``)
 
 Output formats
 ==============
 - ASCII table
 - HTML
 - Email (text + HTML parts)
+- iCalendar
 
 
 =====
@@ -80,6 +82,24 @@ If you only want an email if there is a birthday, use ``--stoponempty``::
 Make sure your config file contains ``$mail_from`` and ``$mail_to`` settings.
 
 
+iCalendar
+=========
+Exporting birthday events into an ``.ics`` file is easy::
+
+   $ bdrem --renderer=ical > birthdays.ics
+
+It is possible to access the calendar via HTTP, too::
+
+    http://example.org/bdrem/?renderer=ical
+
+You can subscribe to it in your calendar or email application.
+Integration has been tested with Thunderbird's Lightning__ and Claws Mail's
+vCalendar__ plugin.
+
+__ https://addons.mozilla.org/en-US/thunderbird/addon/lightning/
+__ http://www.claws-mail.org/plugin.php?plugin=vcalendar
+
+
 HTML page
 =========
 Simply point your web browser to the ``.phar`` file, or ``index.php``.
@@ -188,11 +208,11 @@ Dependencies
 - PDO
 - PEAR packages:
 
-  - Console_CommandLine
-  - Console_Table
-  - Mail
-  - Mail_mime
-  - Net_LDAP2
+  - `Console_Color2 <https://pear.php.net/package/Console_Color2>`_
+  - `Console_CommandLine <https://pear.php.net/package/Console_CommandLine>`_
+  - `Console_Table <https://pear.php.net/package/Console_Table>`_
+  - `Mail_mime <https://pear.php.net/package/Mail_mime>`_
+  - `Net_LDAP2 <https://pear.php.net/package/Net_LDAP2>`_
 
 
 =======
@@ -203,6 +223,18 @@ License
 __ http://www.gnu.org/licenses/agpl.html
 
 
+========
+Homepage
+========
+Web site
+   http://cweiske.de/bdrem.htm
+
+Source code
+   http://git.cweiske.de/bdrem.git
+
+   Mirror: https://github.com/cweiske/bdrem
+
+
 ======
 Author
 ======