From 4d8f7706240a1603468968f47fc7b150b788d62f Mon Sep 17 00:00:00 2001
From: Evgeniy Khramtsov <ekhramtsov@process-one.net>
Date: Mon, 8 Apr 2013 11:12:54 +0200
Subject: Switch to rebar build tool

Use dynamic Rebar configuration
Make iconv dependency optional
Disable transient_supervisors compile option
Add hipe compilation support
Only compile ibrowse and lhttpc when needed
Make it possible to generate an OTP application release
Add --enable-debug compile option
Add --enable-all compiler option
Add --enable-tools configure option
Add --with-erlang configure option.
Add --enable-erlang-version-check configure option.
Add lager support
Improve the test suite
---
 doc/guide.tex | 101 +++++++++++++++++++++++++---------------------------------
 1 file changed, 43 insertions(+), 58 deletions(-)

(limited to 'doc/guide.tex')

diff --git a/doc/guide.tex b/doc/guide.tex
index 69ddd369..5ec3a2ed 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -375,10 +375,31 @@ Some options that you may be interested in modifying:
 	\titem{--enable-pam}
 	Enable the PAM authentication method (see section \ref{pam}).
 
-	\titem{--enable-odbc or --enable-mssql}
+	\titem{--enable-mssql}
 	Required if you want to use an external database.
 	See section~\ref{database} for more information.
 
+        \titem{--enable-tools}
+        Enable the use of development tools.
+
+        \titem{--enable-mysql}
+        Enable MySQL support (see section \ref{mysql}).
+
+        \titem{--enable-pgsql}
+        Enable PostgreSQL support (see section \ref{pgsql}).
+
+        \titem{--enable-zlib}
+        Enable Stream Compression (XEP-0138) using zlib.
+
+        \titem{--enable-stun}
+        Enable STUN support (see section \ref{stun}).
+
+        \titem{--enable-iconv}
+        Enable iconv support. This is needed for \term{mod\_irc} (see seciont \ref{modirc}).
+
+        \titem{--enable-debug}
+        Compile with \term{+debug\_info} enabled.
+
 	\titem{--enable-full-xml}
 	Enable the use of XML based optimisations.
 	It will for example use CDATA to escape characters in the XMPP stream.
@@ -1951,28 +1972,22 @@ For example:
 \makesubsection{mysql}{MySQL}
 \ind{MySQL}\ind{MySQL!schema}
 
-This section describes how to create a MySQL database for ejabberd,
-and configure \ejabberd{} to use it to store authentication and user data.
+There is a file \term{mysql.sql} in the directory \term{odbc}.
+This file contains the \ejabberd{} schema for MySQL. At the end of the file
+you can find information to update your database schema.
+
 
 \makesubsubsection{compilemysql}{Driver Compilation}
 \ind{MySQL!Driver Compilation}
 
 You can skip this step if you installed \ejabberd{} using a binary installer or
-if the binary packages of \ejabberd{} you are using include support for MySQL.
+if the binary packages of \ejabberd{} you are using include support for ODBC.
 
-\begin{enumerate}
-\item First, install the Erlang mysql library from
-  \footahref{http://www.ejabberd.im/ejabberd-modules/}{ejabberd-modules SVN repository}.
-  Make sure the compiled
-  files are in your Erlang path; you can put them for example in the same
-  directory as your \ejabberd{} .beam files.
-\item Then, configure and install \ejabberd{} with ODBC support enabled (this is
-  also needed for native MySQL support!). This can be done, by using next
-  commands:
+Use \term{--enable-mysql} configure option in order to build \ejabberd{} with
+MySQL support:
 \begin{verbatim}
-./configure --enable-odbc && make install
+./configure --enable-mysql && make install
 \end{verbatim}
-\end{enumerate}
 
 
 \makesubsubsection{mysqlcreatedb}{Create MySQL database}
@@ -2113,7 +2128,9 @@ module option \term{\{db\_type, odbc\}}.
 \makesubsection{mssql}{Microsoft SQL Server}
 \ind{Microsoft SQL Server}\ind{Microsoft SQL Server!schema}
 
-ejabberd can be configured to use Microsoft SQL Server for storing authentication and other information instead of the internal database. MS SQL Server 2000 is known to be supported. You need an ejabberd with the MSSQL patch.
+There is a file \term{mssql.sql} in the directory \term{odbc}.
+This file contains the \ejabberd{} schema for Microsoft SQL Server. At the end of the file
+you can find information to update your database schema.
 
 
 \makesubsubsection{compilemssql}{Driver Compilation}
@@ -2122,11 +2139,10 @@ ejabberd can be configured to use Microsoft SQL Server for storing authenticatio
 You can skip this step if you installed \ejabberd{} using a binary installer or
 if the binary packages of \ejabberd{} you are using include support for ODBC.
 
-If you want to use Microsoft SQL Server with ODBC, you need to configure,
-compile and install \ejabberd{} with support for ODBC and Microsoft SQL Server
-enabled. This can be done, by using next commands:
+Use \term{--enable-mssql} configure option in order to build \ejabberd{} with
+Microsoft SQL Server support:
 \begin{verbatim}
-./configure --enable-odbc --enable-mssql && make install
+./configure --enable-mssql && make install
 \end{verbatim}
 
 
@@ -2181,8 +2197,10 @@ module option \term{\{db\_type, odbc\}}.
 \makesubsection{pgsql}{PostgreSQL}
 \ind{PostgreSQL}\ind{PostgreSQL!schema}
 
-This section describes how to create a MySQL database for ejabberd,
-and configure \ejabberd{} to use it to store authentication and user data.
+There is a file \term{pg.sql} in the directory \term{odbc}.
+This file contains the \ejabberd{} schema for PostgreSQL. At the end of the file
+you can find information to update your database schema.
+
 
 \makesubsubsection{compilepgsql}{Driver Compilation}
 \ind{PostgreSQL!Driver Compilation}
@@ -2191,19 +2209,11 @@ You can skip this step if you installed \ejabberd{} using a binary installer or
 if the binary packages of \ejabberd{} you are using include support for
 PostgreSQL.
 
-\begin{enumerate}
-\item First, install the Erlang pgsql library from
-  \footahref{http://www.ejabberd.im/ejabberd-modules/}{ejabberd-modules SVN repository}.
-  Make sure the compiled
-  files are in your Erlang path; you can put them for example in the same
-  directory as your \ejabberd{} .beam files.
-\item Then, configure, compile and install \ejabberd{} with ODBC support enabled
-  (this is also needed for native PostgreSQL support!). This can be done, by
-  using next commands:
+Use \term{--enable-pgsql} configure option in order to build \ejabberd{} with
+PostgreSQL support:
 \begin{verbatim}
-./configure --enable-odbc && make install
+./configure --enable-pgsql && make install
 \end{verbatim}
-\end{enumerate}
 
 \makesubsubsection{pgsqlcreatedb}{Create PostgreSQL database}
 \ind{PgSQL!Create database}
@@ -2273,31 +2283,6 @@ module option \term{\{db\_type, odbc\}}.
 \makesubsection{odbc}{ODBC Compatible}
 \ind{databases!ODBC}
 
-Although this section will describe \ejabberd{}'s configuration when you want to
-use the ODBC driver, it does not describe the installation and database creation
-of your database. Check the documentation of your database. The tutorial \footahref{http://support.process-one.net/doc/display/MESSENGER/Using+ejabberd+with+MySQL+native+driver}{Using ejabberd with MySQL native driver} also can help you. Note that the tutorial
-contains information about \ejabberd{}'s configuration which is duplicate to
-this section.
-
-
-\makesubsubsection{compileodbc}{Driver Compilation}
-
-You can skip this step if you installed \ejabberd{} using a binary installer or
-if the binary packages of \ejabberd{} you are using include support for
-ODBC.
-
-\begin{enumerate}
-\item First, install the \footahref{http://support.process-one.net/doc/display/CONTRIBS/Yxa}{Erlang
-  MySQL library}. Make sure the compiled files are in your Erlang path; you can
-  put them for example in the same directory as your \ejabberd{} .beam files.
-\item Then, configure, compile and install \ejabberd{} with ODBC support
-  enabled. This can be done, by using next commands:
-\begin{verbatim}
-./configure --enable-odbc && make install
-\end{verbatim}
-\end{enumerate}
-
-
 \makesubsubsection{configureodbc}{Database Connection}
 \ind{ODBC!Database Connection}
 
-- 
cgit v1.2.3

