summaryrefslogtreecommitdiff
path: root/Development_Manual
diff options
context:
space:
mode:
authorJeroen van Meeuwen (Ergo Project) <jeroen.van.meeuwen@ergo-project.org>2010-09-08 21:05:15 (GMT)
committerJeroen van Meeuwen (Ergo Project) <jeroen.van.meeuwen@ergo-project.org>2010-09-08 21:05:15 (GMT)
commite38dad55bcb9eb40b56e12e4f41e3cc3bc6edfa0 (patch)
tree5f0a4a0c99e6f5203e3de0ffe58257558b1c8527 /Development_Manual
downloadkolab-docs-e38dad55bcb9eb40b56e12e4f41e3cc3bc6edfa0.tar.gz
Initial commit
Diffstat (limited to 'Development_Manual')
-rw-r--r--Development_Manual/en-US/Author_Group.xml18
-rw-r--r--Development_Manual/en-US/Book_Info.xml28
-rw-r--r--Development_Manual/en-US/Chapter.xml33
-rw-r--r--Development_Manual/en-US/Development_Manual.ent4
-rw-r--r--Development_Manual/en-US/Development_Manual.xml16
-rw-r--r--Development_Manual/en-US/General_Kolab_Server_Components_Packaging_Notes.xml19
-rw-r--r--Development_Manual/en-US/Packaging_Kolab_Components.xml13
-rw-r--r--Development_Manual/en-US/Packaging_Kolab_Server_Components_with_RPM.xml73
-rw-r--r--Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml11
-rw-r--r--Development_Manual/en-US/Part-Kolab_Packaging_with_RPM.xml11
-rw-r--r--Development_Manual/en-US/Preface.xml13
-rw-r--r--Development_Manual/en-US/Revision_History.xml27
-rw-r--r--Development_Manual/en-US/TODO.xml52
-rw-r--r--Development_Manual/publican.cfg7
14 files changed, 325 insertions, 0 deletions
diff --git a/Development_Manual/en-US/Author_Group.xml b/Development_Manual/en-US/Author_Group.xml
new file mode 100644
index 0000000..98ecc97
--- /dev/null
+++ b/Development_Manual/en-US/Author_Group.xml
@@ -0,0 +1,18 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE authorgroup 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;
+]>
+<authorgroup>
+ <author>
+ <firstname>Jeroen</firstname>
+ <surname>van Meeuwen</surname>
+ <lineage>RHCE</lineage>
+ <affiliation>
+ <orgname>Kolab Systems</orgname>
+ <orgdiv>Senior Engineer</orgdiv>
+ </affiliation>
+ <email>vanmeeuwen@kolabsys.com</email>
+ </author>
+</authorgroup>
+
diff --git a/Development_Manual/en-US/Book_Info.xml b/Development_Manual/en-US/Book_Info.xml
new file mode 100644
index 0000000..e129ee3
--- /dev/null
+++ b/Development_Manual/en-US/Book_Info.xml
@@ -0,0 +1,28 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE bookinfo 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;
+]>
+<bookinfo id="book-Development_Manual-Development_Manual">
+ <title>Development Manual</title>
+ <subtitle>short description</subtitle>
+ <productname>Kolab</productname>
+ <productnumber>2.3.0</productnumber>
+ <edition>1</edition>
+ <pubsnumber>0</pubsnumber>
+ <abstract>
+ <para>
+ A short overview and summary of the book's subject and purpose, traditionally no more than one paragraph long. Note: the abstract will appear in the front matter of your book and will also be placed in the description field of the book's RPM spec file.
+ </para>
+ </abstract>
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
+ </imageobject>
+ </inlinemediaobject>
+ </corpauthor>
+ <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</bookinfo>
+
diff --git a/Development_Manual/en-US/Chapter.xml b/Development_Manual/en-US/Chapter.xml
new file mode 100644
index 0000000..056487f
--- /dev/null
+++ b/Development_Manual/en-US/Chapter.xml
@@ -0,0 +1,33 @@
+<?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-Test_Chapter">
+ <title>Test Chapter</title>
+ <para>
+ This is a test paragraph
+ </para>
+ <section id="sect-Development_Manual-Test_Chapter-Test_Section_1">
+ <title>Test Section 1</title>
+ <para>
+ This is a test paragraph in a section
+ </para>
+ </section>
+
+ <section id="sect-Development_Manual-Test_Chapter-Test_Section_2">
+ <title>Test Section 2</title>
+ <para>
+ This is a test paragraph in Section 2
+ <orderedlist>
+ <listitem>
+ <para>
+ listitem text
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ </section>
+
+</chapter>
+
diff --git a/Development_Manual/en-US/Development_Manual.ent b/Development_Manual/en-US/Development_Manual.ent
new file mode 100644
index 0000000..1181807
--- /dev/null
+++ b/Development_Manual/en-US/Development_Manual.ent
@@ -0,0 +1,4 @@
+<!ENTITY PRODUCT "Kolab">
+<!ENTITY BOOKID "Development_Manual">
+<!ENTITY YEAR "2010">
+<!ENTITY HOLDER "| You need to change the HOLDER entity in the en-US/Development_Manual.ent file |">
diff --git a/Development_Manual/en-US/Development_Manual.xml b/Development_Manual/en-US/Development_Manual.xml
new file mode 100644
index 0000000..dede735
--- /dev/null
+++ b/Development_Manual/en-US/Development_Manual.xml
@@ -0,0 +1,16 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE book 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;
+]>
+<book>
+ <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <xi:include href="Part-General_Kolab_Packaging_Notes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Part-Kolab_Packaging_with_RPM.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/General_Kolab_Server_Components_Packaging_Notes.xml b/Development_Manual/en-US/General_Kolab_Server_Components_Packaging_Notes.xml
new file mode 100644
index 0000000..2bc0392
--- /dev/null
+++ b/Development_Manual/en-US/General_Kolab_Server_Components_Packaging_Notes.xml
@@ -0,0 +1,19 @@
+<?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 "Installation_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Development_Manual-General_Kolab_Server_Components_Packaging_Notes">
+ <title>General Kolab Server Components Packaging Notes</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ requires being started after ldap server (standalone)
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+</chapter>
+
diff --git a/Development_Manual/en-US/Packaging_Kolab_Components.xml b/Development_Manual/en-US/Packaging_Kolab_Components.xml
new file mode 100644
index 0000000..2dae317
--- /dev/null
+++ b/Development_Manual/en-US/Packaging_Kolab_Components.xml
@@ -0,0 +1,13 @@
+<?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 "Installation_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Development_Manual-Packaging_Kolab_Components">
+ <title>Packaging Kolab Components</title>
+ <para>
+ About
+ </para>
+
+</chapter>
+
diff --git a/Development_Manual/en-US/Packaging_Kolab_Server_Components_with_RPM.xml b/Development_Manual/en-US/Packaging_Kolab_Server_Components_with_RPM.xml
new file mode 100644
index 0000000..5353477
--- /dev/null
+++ b/Development_Manual/en-US/Packaging_Kolab_Server_Components_with_RPM.xml
@@ -0,0 +1,73 @@
+<?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 "Installation_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Development_Manual-Packaging_Kolab_Server_Components_with_RPM">
+ <title>Packaging Kolab Server Components with RPM</title>
+ <para>
+ Kolab Groupware exists of several components. On the server side, we have:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>kolab</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ FIXME: List the rest of the packages
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <section>
+ <title>kolab-cyrus-imapd</title>
+ <para>
+ Requirements:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>perl-TermReadKey</literal> for perl(Term::ReadKey) capabilities
+ </para>
+ <para>
+ The package is required for %{_bindir}/cyradm
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+
+ <section>
+ <title>Checklist Notes</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Creation of user
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ chkconfig --add services
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Set debug to 9 (/etc/kolab/kolab.globals)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Set loglevel to 15 (/etc/kolab/kolab.globals)
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+</chapter>
+
diff --git a/Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml b/Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml
new file mode 100644
index 0000000..19e6af4
--- /dev/null
+++ b/Development_Manual/en-US/Part-General_Kolab_Packaging_Notes.xml
@@ -0,0 +1,11 @@
+<?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 "Installation_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<part id="part-Development_Manual-General_Kolab_Packaging_Notes">
+ <title>General Kolab Packaging Notes</title>
+
+ <xi:include href="General_Kolab_Server_Components_Packaging_Notes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+</part>
diff --git a/Development_Manual/en-US/Part-Kolab_Packaging_with_RPM.xml b/Development_Manual/en-US/Part-Kolab_Packaging_with_RPM.xml
new file mode 100644
index 0000000..72a9502
--- /dev/null
+++ b/Development_Manual/en-US/Part-Kolab_Packaging_with_RPM.xml
@@ -0,0 +1,11 @@
+<?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 "Installation_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<part id="part-Development_Manual-Kolab_Packaging_with_RPM">
+ <title>Kolab Packaging with RPM</title>
+
+ <xi:include href="Packaging_Kolab_Server_Components_with_RPM.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+</part> \ No newline at end of file
diff --git a/Development_Manual/en-US/Preface.xml b/Development_Manual/en-US/Preface.xml
new file mode 100644
index 0000000..e68be4c
--- /dev/null
+++ b/Development_Manual/en-US/Preface.xml
@@ -0,0 +1,13 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE preface 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;
+]>
+<preface id="pref-Development_Manual-Preface">
+ <title>Preface</title>
+ <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </xi:fallback>
+ </xi:include>
+</preface>
+
diff --git a/Development_Manual/en-US/Revision_History.xml b/Development_Manual/en-US/Revision_History.xml
new file mode 100644
index 0000000..99e8c7d
--- /dev/null
+++ b/Development_Manual/en-US/Revision_History.xml
@@ -0,0 +1,27 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE appendix 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;
+]>
+<appendix id="appe-Development_Manual-Revision_History">
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>0</revnumber>
+ <date>Sun May 16 2010</date>
+ <author>
+ <firstname>Dude</firstname>
+ <surname>McPants</surname>
+ <email>Dude.McPants@example.com</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Initial creation of book by publican</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </simpara>
+</appendix>
+
diff --git a/Development_Manual/en-US/TODO.xml b/Development_Manual/en-US/TODO.xml
new file mode 100644
index 0000000..fd74174
--- /dev/null
+++ b/Development_Manual/en-US/TODO.xml
@@ -0,0 +1,52 @@
+<?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 "Installation_Manual.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Development_Manual-TODO">
+ <title>List of things to do</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ provide a means for kolabd to poll and continue operations as normal, rather then fail on error and stop
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ the setup program is actually supposed to be called setup-kolab
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ keep account of steps completed in the setup program, so that we can continue
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ password prompt on setup should not echo
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ could not write to /usr/lib64/sasl2/smtpd.conf at /usr/sbin/kolab_bootstrap line 465, &lt;STDIN&gt; line 6.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ chgrp /etc/kolab/key.pem /etc/kolab/cert.pem
+chgrp: invalid group `/etc/kolab/key.pem'
+system chgrp /etc/kolab/key.pem /etc/kolab/cert.pem failed: 256 at /usr/sbin/kolab_bootstrap line 193, &lt;STDIN&gt; line 7.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ May 17 09:25:56 laurel perl: No worthy mechs found
+May 17 09:25:56 laurel imap[2587]: auxpropfunc error invalid parameter supplied
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+</chapter>
+
diff --git a/Development_Manual/publican.cfg b/Development_Manual/publican.cfg
new file mode 100644
index 0000000..9b50407
--- /dev/null
+++ b/Development_Manual/publican.cfg
@@ -0,0 +1,7 @@
+# Config::Simple 4.59
+# Sun May 16 19:25:55 2010
+
+xml_lang: en-US
+type: Book
+brand: common
+