added doc on how to build from source repository

author: Rainer Gerhards <rgerhards@adiscon.com> 2008-10-01 10:44:56 +0200
committer: Rainer Gerhards <rgerhards@adiscon.com> 2008-10-01 10:44:56 +0200
commit: 8a1f6b17698974a1e36c1f0134e4bc4c51c7539f (patch)
tree: 7c6226b5cb420698eddb8cdaddeb8767994f759f /doc
parent: 58d52a638e453ec4650b01fb5590aeed7416afe3 (diff)
download: rsyslog-8a1f6b17698974a1e36c1f0134e4bc4c51c7539f.tar.gz
rsyslog-8a1f6b17698974a1e36c1f0134e4bc4c51c7539f.tar.xz
rsyslog-8a1f6b17698974a1e36c1f0134e4bc4c51c7539f.zip
5 files changed, 73 insertions, 5 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 948cb719..34990d90 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -8,6 +8,7 @@ html_files = \
 	history.html \
 	how2help.html \
 	install.html \
+	build_from_repo.html \
 	ipv6.html \
 	log_rotation_fix_size.html \
 	manual.html \
diff --git a/doc/build_from_repo.html b/doc/build_from_repo.html
new file mode 100644
index 00000000..8d3b20fe
--- /dev/null
+++ b/doc/build_from_repo.html
@@ -0,0 +1,54 @@
+<html><head>
+<title>Building rsyslog from the source repository</title>
+</head>
+<body>
+<h1>Building rsyslog from the source repository</h1>
+<p>In most cases, people install rsyslog either via a package or use an "official"
+distribution tarball to generate it. But there may be situations where it is desirable
+to build directly from the source repository. This is useful for people who would like to
+participate in development or who would like to use the latest, not-yet-released code.
+The later may especially be the case if you are asked to try out an experimental version.
+<p>Building from the repsitory is not much different than building from the source
+tarball, but some files are missing because they are output files and thus do not
+belong into the repository.
+<h2>Obtaining the Source</h2>
+<p>First of all, you need to download the sources. Rsyslog is currently kept in a git
+repository. You can clone this repository either via http or git protocol (with the later
+being much faster. URLS are:
+<ul>
+<li>git://git.adiscon.com/git/rsyslog.git
+<li>http://git.adiscon.com/git/rsyslog.git
+</ul>
+<p>There is also a browsable version (gitweb) available at
+<a href="http://git.adiscon.com/?p=rsyslog.git;a=summary">http://git.adiscon.com/?p=rsyslog.git;a=summary</a>.
+This version also offers snapshots of each commit for easy download. You can use these if
+you do not have git present on your system.
+<p>After you have cloned the repository, you are in the master branch by default. This
+is where we keep the devel branch. If you need any other branch, you need to do
+a "git checkout --track -b branch origin/branch". For example, the command to check out
+the beta branch is "git checkout --track -b beta origin/beta".
+<h2>Prequisites</h2>
+<p>To build the compilation system, you need the <b>pkg-config</b> package (an utility for
+autotools) present on your system. Otherwise, configure will fail with something like
+<pre><code>
+checking for SYSLOG_UNIXAF support... yes
+checking for FSSTND support... yes
+./configure: line 25895: syntax error near unexpected token `RELP,'
+./configure: line 25895: ` PKG_CHECK_MODULES(RELP, relp >= 0.1.1)'
+</code></pre>
+<h2>Creating the Build Environment</h2>
+<p>This is fairly easy: just issue "<b>autoreconf -fvi</b>", which should do everything you need.
+Once this is done, you can follow the usual ./configure steps just like when
+you downloaded an official distribution tarball (see the
+<a href="install.html">rsyslog install guide</a>, starting at step 2,
+for further details about that).
+
+<p>[<a href="manual.html">manual index</a>]
+[<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
+<p><font size="2">This documentation is part of the
+<a href="http://www.rsyslog.com/">rsyslog</a> project.<br>
+Copyright &copy; 2008 by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> and
+<a href="http://www.adiscon.com/">Adiscon</a>. Released under the GNU GPL 
+version 1.2 or higher.</font></p>
+</body>
+</html>
diff --git a/doc/install.html b/doc/install.html
index 661ae943..48b7f649 100644
--- a/doc/install.html
+++ b/doc/install.html
@@ -24,7 +24,11 @@ you volunteer to create one, <a href="mailto:rgerhards@adiscon.com">drop me a
 line</a>). Thus, this guide focuses on installing from the source, which 
 thankfully is <b>quite easy</b>.</p>
 <h3>Step 1 - Download Software</h3>
-<p>For obvious reasons, you need to download rsyslog. Load the most recent build 
+<p>For obvious reasons, you need to download rsyslog. Here, I assume that you
+use a distribution tarball. If you would like to use a version directly from
+the repository, see <a href="build_from_repo.html">build rsyslog from repository</a>
+instead.
+<p>Load the most recent build 
 from <a href="http://www.rsyslog.com/downloads">http://www.rsyslog.com/downloads</a>. 
 Extract the software with &quot;tar xzf -nameOfDownloadSet-&quot;. This will create a new 
 subdirectory rsyslog-version in the current working directory. CD into that. </p>
@@ -150,9 +154,12 @@ comments or bug sighting reports are very welcome. Please
 	<li>2007-07-13 * 
 	<a href="http://www.adiscon.com/en/people/rainer-gerhards.php">Rainer Gerhards</a>&nbsp; 
 	* updated to new autotools-based build system</li>
+	<li>2008-10-01 * 
+	<a href="http://www.adiscon.com/en/people/rainer-gerhards.php">Rainer Gerhards</a>&nbsp; 
+	* added info on building from source repository</li>
 </ul>
 <h3>Copyright</h3>
-<p>Copyright (c)  2005, 2007 
+<p>Copyright &copy;  2005-2008
 <a href="http://www.adiscon.com/en/people/rainer-gerhards.php">Rainer Gerhards</a> and
 <a href="http://www.adiscon.com/en/">Adiscon</a>.</p>
 <p>      Permission is granted to copy, distribute and/or modify this document
@@ -162,6 +169,12 @@ comments or bug sighting reports are very welcome. Please
 	 Texts.  A copy of the license can be viewed at
 <a href="http://www.gnu.org/copyleft/fdl.html">
 http://www.gnu.org/copyleft/fdl.html</a>.</p>
-
+<p>[<a href="manual.html">manual index</a>]
+[<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
+<p><font size="2">This documentation is part of the
+<a href="http://www.rsyslog.com/">rsyslog</a> project.<br>
+Copyright &copy; 2008 by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> and
+<a href="http://www.adiscon.com/">Adiscon</a>. Released under the GNU GPL 
+version 1.2 or higher.</font></p>
 </body>
 </html>
diff --git a/doc/manual.html b/doc/manual.html
index ec0303c3..f0c02fd2 100644
--- a/doc/manual.html
+++ b/doc/manual.html
@@ -50,6 +50,7 @@ modules</a></li><li><a href="man_rsyslogd.html">rsyslogd man page</a>
 <p><b>We have some in-depth papers on</b></p>
 <ul>
 <li><a href="install.html">installing rsyslog</a></li>
+<li><a href="build_from_repo.html">obtaining rsyslog from the source repository</a></li>
 <li><a href="ipv6.html">rsyslog and IPv6</a> (which is fully supported)</li>
 <li><a href="rsyslog_stunnel.html">ssl-encrypting syslog with stunnel</a></li>
 <li><a href="rsyslog_mysql.html">writing syslog messages to MySQL (and other databases as well)</a></li>
diff --git a/doc/rsyslog_conf.html b/doc/rsyslog_conf.html
index 68b7da61..1073cf5e 100644
--- a/doc/rsyslog_conf.html
+++ b/doc/rsyslog_conf.html
@@ -1197,6 +1197,5 @@ When compared to syslogd from sysklogd package, rsyslogd offers
 additional
 <a href="features.html">features</a> (like template
 and database support). For obvious reasons, the syntax for defining
-such features is available in rsyslogd, only.<br>
-&nbsp;</p>
+such features is available in rsyslogd, only.</p>
 </body></html>
author	Rainer Gerhards <rgerhards@adiscon.com>	2008-10-01 10:44:56 +0200
committer	Rainer Gerhards <rgerhards@adiscon.com>	2008-10-01 10:44:56 +0200
commit	8a1f6b17698974a1e36c1f0134e4bc4c51c7539f (patch)
tree	7c6226b5cb420698eddb8cdaddeb8767994f759f /doc
parent	58d52a638e453ec4650b01fb5590aeed7416afe3 (diff)
download	rsyslog-8a1f6b17698974a1e36c1f0134e4bc4c51c7539f.tar.gz rsyslog-8a1f6b17698974a1e36c1f0134e4bc4c51c7539f.tar.xz rsyslog-8a1f6b17698974a1e36c1f0134e4bc4c51c7539f.zip