summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRainer Gerhards <rgerhards@adiscon.com>2008-09-24 17:51:56 +0200
committerRainer Gerhards <rgerhards@adiscon.com>2008-09-24 17:51:56 +0200
commit58d52a638e453ec4650b01fb5590aeed7416afe3 (patch)
tree8a1c333d5e90304716bb39b856285c20022aff4a /doc
parent9d27767c5a68e83d8910f602d66f4df2b5491689 (diff)
downloadrsyslog-58d52a638e453ec4650b01fb5590aeed7416afe3.tar.gz
rsyslog-58d52a638e453ec4650b01fb5590aeed7416afe3.tar.xz
rsyslog-58d52a638e453ec4650b01fb5590aeed7416afe3.zip
added index.html as an entry point to the manual
thanks to Michael Biebl for suggesting it
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am1
-rw-r--r--doc/index.html32
2 files changed, 33 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 518b90ed..948cb719 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,5 @@
html_files = \
+ index.html \
bugs.html \
debug.html \
features.html \
diff --git a/doc/index.html b/doc/index.html
new file mode 100644
index 00000000..349c8e57
--- /dev/null
+++ b/doc/index.html
@@ -0,0 +1,32 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><title>Welcome to rsyslog</title></head>
+<body>
+<h1>Welcome to rsyslog</h1>
+<p><b><a href="http://www.rsyslog.com/">Rsyslog</a>
+is an enhanced syslogd suitable both for small systems as
+well as large enterprises.</b>
+<p>This page provide a few quick pointers which hopefully make your
+experience with rsyslog a pleasant one. These are
+<ul>
+<li><b>Most importantly, the <a href="manual.html">rsyslog manual</a></b> - this points to locally
+installed documentation which exactly matches the version you have installed.
+It is highly suggested to at least briefly look over these files.
+<li>The <a href="http://www.rsyslog.com">rsyslog web site</a> which offers
+probably every information you'll ever need (ok, just kidding...).
+<li>The <a href="http://www.rsyslog.com/doc-status.html">project status page</a> provides
+information on current releases
+<li>and the <a href="troubleshoot.html">troubleshooting guide</a> hopefully helps if
+things do not immediately work out
+</ul>
+<p>In general, rsyslog supports plain old syslog.conf format, except that the
+config file is now called rsyslog.conf. This should help you get started
+quickly.
+To do the really cool things, though,
+you need to learn a bit about its new features.
+The man pages offer a bare minimum of information (and are still quite long). Read the
+<a href="manual.html">html documentation</a> instead.
+When you change the configuration,
+remember to restart (or HUP) rsyslogd, because otherwise it won't use your
+new settings (and you'll end up totally puzzled why this great config of yours
+does not even work a bit...;))
+</body></html>