aboutsummaryrefslogtreecommitdiffstats
path: root/libical/README
blob: 92b2ff6e86f207d13e4bd5b2857858478ca1ed8e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

LIBICAL -- An implementation of basic iCAL protocols

The code and datafiles in this distribution are licensed under the
Mozilla Public License. See http://www.mozilla.org/NPL/MPL-1.0.html
for a copy of the license. Alternately, you may use libical under the
terms of the GNU Library General Public License. See
http://www.fsf.org/copyleft/lesser.html for a copy of the LGPL.

This dual license ensures that the library can be incorporated into
both proprietary code and GPL'd programs, and will benefit from
improvements made by programmers in both realms. I will only accept
changes into my version of the library if they are similarly
dual-licensed.

The code in this distribution implements the iCal protocols as
described in RFC2445 and RFC2446. The code is in very early stages of
development.

Portions of this distribution are (C) Copyright 1996 Apple Computer,
Inc., AT&T Corp., International Business Machines Corporation and
Siemens Rolm Communications Inc. See src/libicalvcal/README.TXT for
details.

This code is under active development. If you would like to contribute
to the project, you can contact me, Eric Busboom, at
eric@softwarestudio.org. The project has a webpage at

    http://softwarestudio.org/libical/index.html 

and a mailing list that you can join by sending the following mail:

    ------------
    To: minimalist@softwarestudio.org
    Subject: subscribe libical
    ------------


Building the library
--------------------

This distribution is developed on Red Hat Linux 6.0 and usually
compiles on SunOS 5.6 and FreeBSD 2.27. I have reports of success of
previous version on MacOS ( with CodeWarrior ) and on UnixWare, but I
don't know about any other systems.

The library is configured with automake. From the root directory, run 

    ./configure

To build all of the Makefiles for your system. If you will be installing the library, you may want to use the --prefix flag to set the directory where the library and header files will be installed. 

    ./configure --prefix=/proj/local/

If configure runs fine, run "make" to build the library and 
"make install" to install it.

Although the distribution uses libtool to generate libraries, it has
shared libraries turned off by default. To create and install shared
libraries use:

    ./configure --enable-shared

The current version of libical focuses on creating and
manipulating iCal objects. With it, you can parse text representations
of iCal components, add and remove sub-components, properties,
parameters and values, and print the components back out as strings. 


Notes for Libical Developers
-------------------

If you don't want to use gcc as the compiler, and you got the sources
from CVS, you should set the CC variable to the path to the compiler
and run "automake --include-deps" to keep automake from using
gcc-specific automatic dependancy tracking.

        > CC=/pkg/SUNWspro/bin/cc; export CC
        > automake --include-deps
        > ./configure --prefix=/proj/local/
        > make

You will not need to re-run automake unless you got the sources from CVS. 

Using the Library
-----------------

There is rudimentary, unfinished documentation in the /doc directory,
and annotated examples in /examples.


Perl Library
------------

There is a perl language binding of this library, LIBICAL. 
It is  available from http://www.softwarestudio.org/libical


Eric Busboom
eric@softwarestudio.org
7ee099d'>Sync to new bsd.autotools.mkade2010-12-041-1/+1 * Punt autoconf267->autoconf268ade2010-10-161-1/+1 * Autotools update. Read ports/UPDATING 20100915 for details.ade2010-09-161-2/+2 * - Fix build on ppcmiwi2010-05-051-11/+0 * - Update to Xorg 7.5miwi2010-05-0113-46/+37 * Given that HAL doesn't work on sparc64 and always needs to be disabledmarius2010-02-081-2/+11 * Update xorg-server and friends to 1.6.5.rnoland2010-02-0711-44/+20 * For ports maintained by ports@FreeBSD.org, remove names and/ordougb2009-12-211-3/+0 * Mark BROKEN on 9.x: does not builderwin2009-12-161-0/+4 * -Repocopy devel/libtool15 -> libtool22 and libltdl15 -> libltdl22.mezz2009-08-031-1/+1 * Allow building on ia64. This does not make it functional, becausemarcel2009-06-202-1/+229 * Convert most of remaining ports that depend on xorg-libraries toamdmi32009-06-091-1/+2 * Update Xserver and friends to 1.6.1rnoland2009-05-0812-41/+35 * Update Xorg server to 1.6.0rnoland2009-04-0419-625/+111 * Given that the x86-centric approach of mmap(2)'ing PCI memory viamarius2009-04-012-1/+14 * Add the patch that I missed in the last commit.rnoland2009-03-091-0/+90 * Add a patch from git to fix issues with gnome-2.25.rnoland2009-03-092-2/+1 * Add a patch to handle memory barriers on amd64 the same as linux.rnoland2009-03-032-1/+12 * Add a patch to deal with the hald/xorg startup race. With this patchrnoland2009-02-082-1/+144 * - Replace open(2)/close(2) pairs with stat(2). Closing mouse device hasjkim2009-02-052-28/+62 * - Partially back out the previous attempt to fix PS/2 protocol support.jkim2009-02-032-14/+23 * Add dependency on dri2proto to more server components.rnoland2009-01-283-3/+6 * Build record and xtrap extensions.flz2009-01-272-2/+7 * add dri2proto depend here as wellrnoland2009-01-261-1/+2 * Add dependency on dri2protornoland2009-01-261-1/+2 * - Update X.org ports to 7.4+ (few ports are more recent than the katamari).flz2009-01-2419-566/+60 * Update CONFIGURE_ARGS for how we pass CONFIGURE_TARGET to configure script.rafan2008-08-211-1/+0 * Conversion from (now defunct) autoconf-2.61 to autoconf-2.62ade2008-08-201-1/+1 * Reset grog@FreeBSD.org: last commit was more than 6 months ago, andlinimon2008-08-071-1/+1 * - fix typo -> plist for -DNOPORTDOCSitetcu2008-07-042-7/+10 * Remove x11-servers/xorg-server-snap as it has been unmaintained for a while.flz2008-06-1916-698/+0 * Update x11-servers/xorg-server to 1.4.2 (security update).flz2008-06-155-681/+4 * Explicitely disable dtrace support for now.flz2008-06-094-4/+4 * Bump portrevision due to upgrade of devel/gettext.edwin2008-06-064-3/+4 * Add upstream patch (don't free not-allocated dbus socket).flz2008-05-292-1/+15 * Disable dtrace support for now as userland tracing isn't supported yet.flz2008-05-271-1/+1 * Add xephyr, a kdrive-based X server. Xephyr will ultimately replace Xnest.flz2008-05-204-0/+55 * Mark xorg-server-snap as DEPRECATED and set EXPIRATION_DATE to next month.flz2008-05-201-0/+2 * Retire xorg-printserver.flz2008-05-165-972/+0 * - Remove unneeded dependency from gtk12/gtk20 [1]miwi2008-04-207-11/+12 * - Auto-detect and use native extended PS/2 protocols with the latest psm(4).jkim2008-04-163-33/+102 * Fix mouse probing issues with HAL support:jkim2008-04-023-1/+154 * - Remove USE_XLIB/USE_X_PREFIX/USE_XPM in favor of USE_XORGmiwi2008-03-261-1/+1 * Add inputproto and xtrans to USE_XORG.flz2008-03-151-2/+3 * Add inputproto and xtrans to USE_XORG.flz2008-03-151-2/+3 * Add patch that fixes xmodmap use in .xinitrc.flz2008-03-132-1/+148 * Remove support for XFree8-4.flz2008-03-0850-2241/+0 * - Check correct POSIX spec. date for clock_gettime(2) whetherjkim2008-03-063-1/+26 * Fix xserver multiple vulnerabilities.flz2008-01-232-1/+516 * - Add local patch to fix alpha build. [1]flz2008-01-023-2/+40 * - OPTIONS'ify.flz2007-12-133-1/+40 * - OPTIONS'ify (HAL, AIGLX, SUID).flz2007-12-131-20/+24 * Fix plist for sparc64. Should be a no-op on other archs, but bumplinimon2007-11-202-13/+14 * Add temporary fix for LEDs. Proper fix will be available in nextflz2007-10-292-1/+21 * Restore default optimization on RELENG_7.flz2007-10-241-4/+0 * - Explicit some configure arguments.flz2007-10-101-11/+7 * Change to new x11-drivers category.nork2007-10-069-382/+0 * Teach xorg-server that FreeBSD >= 700053 supports PCI domains andmarius2007-09-303-0/+395 * Switch autoconf dependencies from 2.53 or 2.59 to 2.61.linimon2007-09-301-2/+2 * - Update X.org ports to 7.3.flz2007-09-1427-406/+147 * - Consistencify descriptionsdanfe2007-07-031-4/+2 * Fix missing Xlibs dependency.danfe2007-07-031-0/+1 * - Fix the build with recent GCC [1]danfe2007-07-013-10/+135 * Band-aid over memory hungry gcc 4.2 when compiling xf86ScanPci.c.lesi2007-06-222-0/+15 * Clenup share/X11 directory upon deinstall.lesi2007-05-312-0/+2 * xorg-fontserver moved from x11-servers to x11-fonts (xfs).flz2007-05-209-160/+0 * - Welcome X.org 7.2 \o/.flz2007-05-20105-3671/+1156 * Fix loading modules on current by adding patch from devel/imake-6 sincelesi2007-02-232-1/+40 * Add vendor patch preventing overwiting of data on the stack or otherlesi2007-01-282-1/+9 * Respect X11BASE.laszlof2006-12-011-0/+5 * - Fix install with Xorg 6.9.0, unbreakpav2006-11-193-14/+31 * Add some old internal FreeType definitions to fix the server runtime. Thesemarcus2006-10-221-1/+4 * Remove the FreeType EXTRA_PATCHES now that they are in XFree86-4-libraries.marcus2006-10-183-12/+3 * Chase the GNOME X11BASE to LOCALBASE move, and fix the build with themarcus2006-10-1414-4/+789 * BROKEN: Does not installkris2006-09-171-0/+2 * NO_PACKAGE is not appropriatekris2006-09-031-1/+0 * Fix crash by bad pcf font.lesi2006-08-265-1/+100 * Fix crash by bad pcf font.lesi2006-08-267-4/+107 * - Add support to Intel 945GMmnag2006-08-212-1/+336 * - s,INSTALLS_SHLIB,USE_LDCONFIG,gclsung2006-08-151-1/+1 * Update to 0.14.6.nork2006-08-133-41/+50 * Update to 1.7.2erwin2006-06-242-5/+5 * Add a better workaround for LP64 bug in ProcRenderCompositeGlyphs() inlesi2006-06-052-1/+12 * Update to 1.71arved2006-05-292-6/+9 * Remove USE_REINPLACE from categories starting with Xedwin2006-05-131-1/+0 * Add my patch for buffer overflow in the Render extension's TriFan/TriStripanholt2006-05-036-1/+30 * Complete removal of cfb from sunffb driver as was done post release inlesi2006-04-202-1/+102 * Add patch from X.Org, fixing privilege escalation.lesi2006-03-222-0/+21 * Add a description of CorePointer, and Cosmetic change.nork2006-03-191-2/+7 * Oops, fix typo.nork2006-03-191-1/+1 * Fix up some parameters and messages.nork2006-03-191-10/+23 * o Refrect my environment values.nork2006-03-193-7/+13 * o Rename .o to .so. [1]nork2006-03-193-10/+16 * Add synaptics-0.14.4, is a driver for the Synaptics TouchPadnork2006-03-198-0/+264 * BROKEN on sparc64: Does not compilekris2006-03-071-0/+1 * Conversion to a single libtool environment.ade2006-02-232-7/+10 * Remove the FreeBSD KEYWORD from all rc.d scripts where it appears.dougb2006-02-212-3/+1 * Fix build on FreeBSD 4.Xlesi2006-02-025-0/+59 * SHA256ifyedwin2006-01-242-0/+2 * Replace ugly "@unexec rmdir %D... 2>/dev/null || true" with @dirrmtryedwin2006-01-226-17/+17 * Fixups after removal of separate mtree file for X_WINDOW_SYSTEM=XOrg case.lesi2006-01-221-4/+4 * Upgrade to X.Org 6.9.0 release.lesi2006-01-2247-1443/+271 * Make rc script require ldconfig so font server starts properly on systemslesi2006-01-064-3/+5 * Update to RC3.anholt2005-12-062-4/+4 * Fix one of the hangs on new GeForce cards using a patch from X.Org CVS.anholt2005-11-302-1/+23 * Update xorg-server-snap to 6.9RC2 (6.9.99.902).anholt2005-11-307-575/+9 * - Add SHA256pav2005-11-263-0/+3 * Mass-conversion to the USE_AUTOTOOLS New World Order. The code presentade2005-11-151-3/+1 * Do not put Apple Cinema Display to sleep right after DDC probe.lesi2005-11-121-4/+14 * If port belongs to X11 distribution different than ${X_WINDOW_SYSTEM} one,lesi2005-11-1224-12/+64 * Update to the 6.8.99.16 snapshot, and add in a fix for a memory leak in cursoranholt2005-10-168-69/+318 * Install rc sript with ".sample" postfix so it does not get executed bylesi2005-09-213-3/+3 * Fix the fix for CAN-2005-2495.lesi2005-09-212-128/+271 * Fix the fix for CAN-2005-2495.lesi2005-09-192-30/+44 * Fix the fix for CAN-2005-2495.lesi2005-09-192-30/+44 * Fix rc script extension.lesi2005-09-173-1/+13 * Fix integer overflow when allocating large pixmaps.lesi2005-09-126-2/+510 * Fix a use-after-free in the cursor code that's easily triggered with -AJ mallocanholt2005-08-272-1/+43 * Fixup plist and man lists for alpha and sparc64.lesi2005-08-012-23/+42 * Grab a patch for keyboard on sparc64 from Xorg CVS. This makes 'kbd' driverlesi2005-08-014-31/+36 * Update to 6.8.99.12, and incorporate the PCI ID fix for a Radeon X600. Add aanholt2005-06-234-3/+56 * [1] Fix the Chipset lines written by xorgcfg for 3dfx cards.anholt2005-06-233-1/+31 * - Install X server setuid root by default, and provide a switchlesi2005-06-216-14/+144 * Fix up plist after modifications to mtree (BSD.x11-4.dist rev. 1.27).lesi2005-06-151-1/+3 * Upgrade to XFree86 4.5.0.lesi2005-06-1549-1120/+412 * During build, munge PATH so that imake's makedepend will get picked up insteadanholt2005-06-131-0/+3 * Update to the 6.8.99.10 snapshot. Merges in many local patches, miscellaneousanholt2005-06-1114-180/+12 * Use appropriate autoconf version (2.53), >= 2.50 is requiredvs2005-05-231-1/+1 * - Correct the ranges of the bus resource windows on sparc64.lesi2005-05-183-1/+78 * Bump max number of buttons supported by mouse driver to 16 so Logitechlesi2005-05-092-0/+12 * Add two missing i386-only drivers to the packing list.anholt2005-05-072-0/+4 * Bring xorg-server-snap port to 6.8.99.5 after repocopy from xorg-server. Thisanholt2005-05-0412-294/+151 * At Kris's request, back out the MACHINE_ARCH spelling correction untilobrien2005-04-121-1/+1 * Assist getting more ports working on AMD64 by obeying theobrien2005-04-111-1/+1 * Speed up extract target by not extracting */CVS/*. From ahze:lesi2005-04-072-0/+2 * Sync with etc/mtree/BSD.x11-4.dist rev. 1.26:lesi2005-03-252-1/+9