improved doc

- some minor cleanups
- added doc on how to download from git repository
This commit is contained in:
Rainer Gerhards 2008-10-01 11:05:08 +02:00
parent dac6ecacc0
commit aca944b579
2 changed files with 47 additions and 5 deletions

41
doc/build_from_repo.html Normal file
View File

@ -0,0 +1,41 @@
<html><head>
<title>Installing phpLogCon from the source repository</title>
</head>
<body>
<h1>Installing phpLogCon from the source repository</h1>
<p>In most cases, people install phpLogCon either via a package or use an "official"
distribution tarball to generate it. But there may be situations where it is desirable
to install 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>Installing from the repsitory is not much different than building from the source
tarball, except that you need to know how to obtain things.
<h2>Obtaining the Source</h2>
<p>You need to download the sources. PhpLogCon 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/phplogcon.git
<li>http://git.adiscon.com/git/phplogcon.git
</ul>
<p>There is also a browsable version (gitweb) available at
<a href="http://git.adiscon.com/?p=phplogcon.git;a=summary">http://git.adiscon.com/?p=phplogcon.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>Actual Install Process</h2>
<p>The actual installation does not differ from a version obtained via
a tarball. Please see the
<a href="install.html">phpLogCon install guide</a> for details on how to do that.
<p>[<a href="manual.html">manual index</a>] [<a href="http://www.phplogcon.com/">phpLogCon site</a>]</p>
<p><font size="2">This documentation is part of the
<a href="http://www.phplogcon.com/">phpLogCon</a>
project.<br>
Copyright &copy; 2008 by
<a href="http://www.adiscon.com/">Adiscon</a>.
Released under the GNU GPL version 3 or higher.</font></p>
</body></html>

View File

@ -23,22 +23,23 @@ example those that are written by the syslgod.
<li><a href="troubleshoot.html">troubleshooting phpLogCon problems</a></li>
<li><a href="professional_services.html">phpLogCon professional services</a></li>
</ul>
<!--
<p><b>We have some in-depth papers on</b></p>
<ul>
<li><a href="build_from_repo.html">obtaining phpLogCon from the source repository</a></li>
<!--
<li><a href="install.html">installing phpLogCon</a></li>
<li><a href="debug.html">debug support in rsyslog</a></li>
</ul>
-->
</ul>
<p><b>You can also browse the following online resources:</b></p>
<ul>
<li>the <a href="http://http://wiki.rsyslog.com/index.php/PhpLogCon/">phpLogCon
<li>the <a href="http://wiki.rsyslog.com/index.php/PhpLogCon">phpLogCon
wiki</a>, a community resource, part of the greater rsyslog wiki.
<li><a href="http://www.phplogcon.org">phpLogCon online documentation (most current version only)</a></li>
<li><a href="http://www.phplogcon.org/doc">phpLogCon online documentation (most current version only)</a></li>
<li><a href="http://kb.monitorware.com/phplogcon-f39.html">phpLogCon
discussion forum - use this for technical support</a></li>
<li><a href="http://www.rsyslog.com/Topic4.phtml">phpLogCon change log (<b>currently outdated)</b></a></li>
<li><a href="http://www.rsyslog.com/Topic4.phtml">phpLogCon change log</b></a></li>
<li><a href="http://wiki.rsyslog.com/index.php/PhpLogCon_FAQ">phpLogCon FAQ</a></li>
<li><a href="http://www.monitorware.com/en/syslog-enabled-products/">syslog
device configuration guide</a> (off-site)</li>