summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeroen van Meeuwen (Kolab Systems) <vanmeeuwen@kolabsys.com>2012-11-30 12:54:53 (GMT)
committerJeroen van Meeuwen (Kolab Systems) <vanmeeuwen@kolabsys.com>2012-11-30 12:54:53 (GMT)
commite1318b4d8c88756ddd6daa30d89147c213aa4ff0 (patch)
tree6902ffa4033b60334e696afc9bc32b6e87811a7c
parent77c73e0963382ccf4e753778cd4ebd3390be8b31 (diff)
downloadkolab-docs-e1318b4d8c88756ddd6daa30d89147c213aa4ff0.tar.gz
Add new parts and chapters on development for individual component
-rw-r--r--Development_Manual/en-US/Development_Manual.xml4
-rw-r--r--Development_Manual/en-US/Packaging_with_APT.xml2
-rw-r--r--Development_Manual/en-US/PyKolab-Building_from_Source.xml12
-rw-r--r--Development_Manual/en-US/PyKolab-Source_Code_Management.xml12
-rw-r--r--Development_Manual/en-US/PyKolab-kolabd.xml90
-rw-r--r--Development_Manual/en-US/libcalendaring-Building_from_Source.xml12
-rw-r--r--Development_Manual/en-US/libcalendaring-Source_Code_Management.xml12
-rw-r--r--Development_Manual/en-US/libkolab-Building_from_Source.xml12
-rw-r--r--Development_Manual/en-US/libkolab-Source_Code_Management.xml12
-rw-r--r--Development_Manual/en-US/libkolabxml-Building_from_Source.xml12
-rw-r--r--Development_Manual/en-US/libkolabxml-Source_Code_Management.xml12
-rw-r--r--Development_Manual/en-US/part-PyKolab.xml13
-rw-r--r--Development_Manual/en-US/part-libcalendaring.xml11
-rw-r--r--Development_Manual/en-US/part-libkolab.xml11
-rw-r--r--Development_Manual/en-US/part-libkolabxml.xml11
15 files changed, 237 insertions, 1 deletions
diff --git a/Development_Manual/en-US/Development_Manual.xml b/Development_Manual/en-US/Development_Manual.xml
index 68d6bd5..334678c 100644
--- a/Development_Manual/en-US/Development_Manual.xml
+++ b/Development_Manual/en-US/Development_Manual.xml
@@ -11,6 +11,10 @@
<xi:include href="Localization_and_Internationalization.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Packaging_with_APT.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Packaging_with_RPM.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="part-PyKolab.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="part-libcalendaring.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="part-libkolabxml.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="part-libkolab.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<index />
</book>
diff --git a/Development_Manual/en-US/Packaging_with_APT.xml b/Development_Manual/en-US/Packaging_with_APT.xml
index cbffc75..ad5cadc 100644
--- a/Development_Manual/en-US/Packaging_with_APT.xml
+++ b/Development_Manual/en-US/Packaging_with_APT.xml
@@ -11,7 +11,7 @@
<itemizedlist>
<listitem>
<para>
- A 64-bit system with Debian Squeeze or later,
+ A 64-bit system with Debian Wheezy or later,
</para>
</listitem>
diff --git a/Development_Manual/en-US/PyKolab-Building_from_Source.xml b/Development_Manual/en-US/PyKolab-Building_from_Source.xml
new file mode 100644
index 0000000..f8f44c5
--- /dev/null
+++ b/Development_Manual/en-US/PyKolab-Building_from_Source.xml
@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Development_Manual-Building_PyKolab">
+ <title>Building PyKolab</title>
+ <para>
+ para
+ </para>
+</chapter>
+
diff --git a/Development_Manual/en-US/PyKolab-Source_Code_Management.xml b/Development_Manual/en-US/PyKolab-Source_Code_Management.xml
new file mode 100644
index 0000000..a83110e
--- /dev/null
+++ b/Development_Manual/en-US/PyKolab-Source_Code_Management.xml
@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Development_Manual-PyKolab_SCM">
+ <title>PyKolab SCM</title>
+ <para>
+ para
+ </para>
+</chapter>
+
diff --git a/Development_Manual/en-US/PyKolab-kolabd.xml b/Development_Manual/en-US/PyKolab-kolabd.xml
new file mode 100644
index 0000000..66b54c4
--- /dev/null
+++ b/Development_Manual/en-US/PyKolab-kolabd.xml
@@ -0,0 +1,90 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Development_Manual-kolabd">
+ <title>kolabd</title>
+ <para>
+ The <application>kolabd</application> program is a multi-process daemon that synchronizes changes in the user information, authentication and authorization database with IMAP.
+ </para>
+ <para>
+ This chapter describes the inner workings of <application>kolabd</application>.
+ </para>
+ <section id="sect-Development_Manual-kolabd-Startup">
+ <title>Startup</title>
+ <para>
+ Upon startup, <application>kolabd</application> determines which domain name spaces to synchronize the user information, authentication and authorization databases for.
+ </para>
+ <para>
+ If set, it uses the following settings in the <literal>[ldap]</literal> section of <filename>/etc/kolab/kolab.conf</filename> to determine the list of domain name spaces:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ domain_base_dn = cn=kolab,cn=config
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ domain_filter = (&amp;(associatedDomain=*))
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ domain_name_attribute = associateddomain
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ domain_rootdn_attribute = inetdomainbasedn
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+ <para>
+ If not set, <application>kolabd</application> will assume the only domain name space is the primary domain.
+ </para>
+ <para>
+ A process is started for each of the domain name spaces.
+ </para>
+ <para>
+ Each of the domain name space specific processes starts synchronization utilizing either of the following LDAP supported controls (in order of appearance):
+ </para>
+ <para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Persistent Search control (RFC XXXX)
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ LDAP Content Synchronization Operation (RFC 4533)
+ </para>
+
+ </listitem>
+ <listitem>
+ <para>
+ Paged Search Results (RFC XXXX)
+ </para>
+
+ </listitem>
+
+ </orderedlist>
+
+ </para>
+
+ </section>
+
+
+</chapter>
+
diff --git a/Development_Manual/en-US/libcalendaring-Building_from_Source.xml b/Development_Manual/en-US/libcalendaring-Building_from_Source.xml
new file mode 100644
index 0000000..66f8444
--- /dev/null
+++ b/Development_Manual/en-US/libcalendaring-Building_from_Source.xml
@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Development_Manual-Building_libcalendaring">
+ <title>Building libcalendaring</title>
+ <para>
+ para
+ </para>
+</chapter>
+
diff --git a/Development_Manual/en-US/libcalendaring-Source_Code_Management.xml b/Development_Manual/en-US/libcalendaring-Source_Code_Management.xml
new file mode 100644
index 0000000..5ccb634
--- /dev/null
+++ b/Development_Manual/en-US/libcalendaring-Source_Code_Management.xml
@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Development_Manual-libcalendaring_SCM">
+ <title>libcalendaring SCM</title>
+ <para>
+ para
+ </para>
+</chapter>
+
diff --git a/Development_Manual/en-US/libkolab-Building_from_Source.xml b/Development_Manual/en-US/libkolab-Building_from_Source.xml
new file mode 100644
index 0000000..3626a90
--- /dev/null
+++ b/Development_Manual/en-US/libkolab-Building_from_Source.xml
@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Development_Manual-Building_libkolab">
+ <title>Building libkolab</title>
+ <para>
+ para
+ </para>
+</chapter>
+
diff --git a/Development_Manual/en-US/libkolab-Source_Code_Management.xml b/Development_Manual/en-US/libkolab-Source_Code_Management.xml
new file mode 100644
index 0000000..281c394
--- /dev/null
+++ b/Development_Manual/en-US/libkolab-Source_Code_Management.xml
@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Development_Manual-libkolab_SCM">
+ <title>libkolab SCM</title>
+ <para>
+ para
+ </para>
+</chapter>
+
diff --git a/Development_Manual/en-US/libkolabxml-Building_from_Source.xml b/Development_Manual/en-US/libkolabxml-Building_from_Source.xml
new file mode 100644
index 0000000..2aa9a71
--- /dev/null
+++ b/Development_Manual/en-US/libkolabxml-Building_from_Source.xml
@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Development_Manual-Building_libkolabxml">
+ <title>Building libkolabxml</title>
+ <para>
+ para
+ </para>
+</chapter>
+
diff --git a/Development_Manual/en-US/libkolabxml-Source_Code_Management.xml b/Development_Manual/en-US/libkolabxml-Source_Code_Management.xml
new file mode 100644
index 0000000..988b347
--- /dev/null
+++ b/Development_Manual/en-US/libkolabxml-Source_Code_Management.xml
@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Development_Manual-libkolabxml_SCM">
+ <title>libkolabxml SCM</title>
+ <para>
+ para
+ </para>
+</chapter>
+
diff --git a/Development_Manual/en-US/part-PyKolab.xml b/Development_Manual/en-US/part-PyKolab.xml
new file mode 100644
index 0000000..653e5a7
--- /dev/null
+++ b/Development_Manual/en-US/part-PyKolab.xml
@@ -0,0 +1,13 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<part id="part-Development_Manual-PyKolab">
+ <title>PyKolab</title>
+ <xi:include href="PyKolab-Source_Code_Management.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="PyKolab-Building_from_Source.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="PyKolab-kolabd.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+</part>
+
diff --git a/Development_Manual/en-US/part-libcalendaring.xml b/Development_Manual/en-US/part-libcalendaring.xml
new file mode 100644
index 0000000..a51c773
--- /dev/null
+++ b/Development_Manual/en-US/part-libcalendaring.xml
@@ -0,0 +1,11 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<part id="part-Development_Manual-libcalendaring">
+ <title>libcalendaring</title>
+ <xi:include href="libcalendaring-Source_Code_Management.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="libcalendaring-Building_from_Source.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</part>
+
diff --git a/Development_Manual/en-US/part-libkolab.xml b/Development_Manual/en-US/part-libkolab.xml
new file mode 100644
index 0000000..c53443e
--- /dev/null
+++ b/Development_Manual/en-US/part-libkolab.xml
@@ -0,0 +1,11 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<part id="part-Development_Manual-libkolab">
+ <title>libkolab</title>
+ <xi:include href="libkolab-Source_Code_Management.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="libkolab-Building_from_Source.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</part>
+
diff --git a/Development_Manual/en-US/part-libkolabxml.xml b/Development_Manual/en-US/part-libkolabxml.xml
new file mode 100644
index 0000000..8737016
--- /dev/null
+++ b/Development_Manual/en-US/part-libkolabxml.xml
@@ -0,0 +1,11 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Development_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<part id="part-Development_Manual-libkolabxml">
+ <title>libkolabxml</title>
+ <xi:include href="libkolabxml-Source_Code_Management.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="libkolabxml-Building_from_Source.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</part>
+