[CalendarServer-changes] [3595] CalendarServer/trunk/calendarserver/tools/export.py

source_changes at macosforge.org source_changes at macosforge.org
Mon Jan 19 14:54:26 PST 2009


Revision: 3595
          http://trac.macosforge.org/projects/calendarserver/changeset/3595
Author:   wsanchez at apple.com
Date:     2009-01-19 14:54:26 -0800 (Mon, 19 Jan 2009)
Log Message:
-----------
Add docstring

Modified Paths:
--------------
    CalendarServer/trunk/calendarserver/tools/export.py

Modified: CalendarServer/trunk/calendarserver/tools/export.py
===================================================================
--- CalendarServer/trunk/calendarserver/tools/export.py	2009-01-19 18:13:33 UTC (rev 3594)
+++ CalendarServer/trunk/calendarserver/tools/export.py	2009-01-19 22:54:26 UTC (rev 3595)
@@ -16,6 +16,21 @@
 # limitations under the License.
 ##
 
+"""
+This tool reads calendar data from a series of inputs and generates a
+single iCalendar file which can be opened in many calendar
+applications.
+
+This can be used to quickly create an iCalendar file from a user's
+calendars.
+
+This tool requires access to the calendar server's configuration and
+data storage; it does not operate by talking to the server via the
+network.  It therefore does not apply any of the access restrictions
+that the server would.  As such, one should be midful that data
+exported via this tool may be sensitive.
+"""
+
 import os
 import sys
 from getopt import getopt, GetoptError
@@ -41,7 +56,7 @@
     print ""
     print "Generate an iCalendar file containing the merged content of each calendar"
     print "collection read."
-    print ""
+    print __doc__
     print "options:"
     print "  -h --help: print this help and exit"
     print "  -f --config: Specify caldavd.plist configuration path"
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20090119/c42d36c6/attachment.html>


More information about the calendarserver-changes mailing list