From: Vsevolod Stakhov <vsevolod@highsecure.ru>
Date: Thu, 16 Apr 2015 16:19:28 +0000 (+0100)
Subject: Improve documentation.
X-Git-Tag: 0.9.0~225
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=30ee4c04beb36a952c8be03aefd2b3f1f74b5ed1;p=rspamd.git

Improve documentation.
---

diff --git a/doc/markdown/configuration/composites.md b/doc/markdown/configuration/composites.md
index fc734af2a..3aa63c072 100644
--- a/doc/markdown/configuration/composites.md
+++ b/doc/markdown/configuration/composites.md
@@ -1,16 +1,5 @@
 # Rspamd composite symbols
 
-## Table of Contents
-
-* [Options](options.md)
-* [Logging](logging.md)
-* [Metrics](metrics.md)
-* [Composites](composites.md)
-* [User settings](settings.md)
-* [Statistic configuration](statistic.md)
-* [Workers](../workers/index.md)
-* [Modules](../modules/index.md)
-
 ## Introduction
 
 Rspamd composites are used to combine rules and create more complex rules.
diff --git a/doc/markdown/configuration/index.md b/doc/markdown/configuration/index.md
index 9ddf49689..a404c77a9 100644
--- a/doc/markdown/configuration/index.md
+++ b/doc/markdown/configuration/index.md
@@ -4,17 +4,6 @@ Rspamd uses UCL for its configuration. UCL format is described in details in
 this [document](ucl.md). Rspamd defines several variables and macros to extend
 UCL functionality.
 
-## Table of Contents
-
-* [Options](options.md)
-* [Logging](logging.md)
-* [Metrics](metrics.md)
-* [Composites](composites.md)
-* [User settings](settings.md)
-* [Statistic configuration](statistic.md)
-* [Workers](../workers/index.md)
-* [Modules](../modules/index.md)
-
 ## Rspamd variables
 
 - *CONFDIR*: configuration directory for rspamd, it is $PREFIX/etc/rspamd/
diff --git a/doc/markdown/configuration/logging.md b/doc/markdown/configuration/logging.md
index 424481762..35f70f4e1 100644
--- a/doc/markdown/configuration/logging.md
+++ b/doc/markdown/configuration/logging.md
@@ -1,16 +1,5 @@
 # Rspamd logging settings
 
-## Table of Contents
-
-* [Options](options.md)
-* [Logging](logging.md)
-* [Metrics](metrics.md)
-* [Composites](composites.md)
-* [User settings](settings.md)
-* [Statistic configuration](statistic.md)
-* [Workers](../workers/index.md)
-* [Modules](../modules/index.md)
-
 ## Introduction
 Rspamd has a number of logging variants. First of all there are three types of logs that are supported by rspamd: console loggging (just output log messages to console), file logging (output log messages to file) and logging via syslog. Also it is possible to filter logging to specific level:
 
@@ -21,10 +10,8 @@ Rspamd has a number of logging variants. First of all there are three types of l
 
 Also it is possible to turn on debug messages for specific ip addresses. This ability is usefull for testing. For each logging type there are special mandatory parameters: log facility for syslog (read `syslog(3)` manual page for details about facilities), log file for file logging. Also file logging may be buffered for speeding up. For reducing logging noise rspamd detects for sequential identic log messages and replace them with total number of repeats:
 
-```
-#81123(fuzzy): May 11 19:41:54 rspamd file_log_function: Last message repeated 155 times
-#81123(fuzzy): May 11 19:41:54 rspamd process_write_command: fuzzy hash was successfully added
-```
+	#81123(fuzzy): May 11 19:41:54 rspamd file_log_function: Last message repeated 155 times
+	#81123(fuzzy): May 11 19:41:54 rspamd process_write_command: fuzzy hash was successfully added
 
 ## Configuration parameters
 
diff --git a/doc/markdown/configuration/metrics.md b/doc/markdown/configuration/metrics.md
index 48fe55365..3c1a63769 100644
--- a/doc/markdown/configuration/metrics.md
+++ b/doc/markdown/configuration/metrics.md
@@ -1,16 +1,5 @@
 # Rspamd metrics settings
 
-## Table of Contents
-
-* [Options](options.md)
-* [Logging](logging.md)
-* [Metrics](metrics.md)
-* [Composites](composites.md)
-* [User settings](settings.md)
-* [Statistic configuration](statistic.md)
-* [Workers](../workers/index.md)
-* [Modules](../modules/index.md)
-
 ## Introduction
 
 Metrics section provides configuration for symbols weights and actions apllied for a message by rspamd.
diff --git a/doc/markdown/configuration/options.md b/doc/markdown/configuration/options.md
index 71d622a68..3383146ca 100644
--- a/doc/markdown/configuration/options.md
+++ b/doc/markdown/configuration/options.md
@@ -1,14 +1,21 @@
 # Rspamd options settings
 
-## Table of Contents
-
-* [Options](options.md)
-* [Logging](logging.md)
-* [Metrics](metrics.md)
-* [Composites](composites.md)
-* [User settings](settings.md)
-* [Statistic configuration](statistic.md)
-* [Workers](../workers/index.md)
-* [Modules](../modules/index.md)
-
 ## Introduction
+
+~~~nginx
+filters = "chartable,dkim,spf,surbl,regexp,fuzzy_check";
+raw_mode = false;
+one_shot = false;
+cache_file = "$DBDIR/symbols.cache";
+map_watch_interval = 1min;
+dynamic_conf = "$DBDIR/rspamd_dynamic";
+history_file = "$DBDIR/rspamd.history";
+check_all_filters = false;
+dns {
+    timeout = 1s;
+    sockets = 16;
+    retransmits = 5;
+}
+tempdir = "/tmp";
+url_tld = "${PLUGINSDIR}/effective_tld_names.dat";
+~~~
diff --git a/doc/markdown/configuration/settings.md b/doc/markdown/configuration/settings.md
index a7b85a11c..6074c6fb0 100644
--- a/doc/markdown/configuration/settings.md
+++ b/doc/markdown/configuration/settings.md
@@ -1,16 +1,5 @@
 # Rspamd user settings
 
-## Table of Contents
-
-* [Options](options.md)
-* [Logging](logging.md)
-* [Metrics](metrics.md)
-* [Composites](composites.md)
-* [User settings](settings.md)
-* [Statistic configuration](statistic.md)
-* [Workers](../workers/index.md)
-* [Modules](../modules/index.md)
-
 ## Introduction
 
 Rspamd allows to specify custom settings according to incoming messages. Each setting define some set
diff --git a/doc/markdown/configuration/statistic.md b/doc/markdown/configuration/statistic.md
index 5caca9150..1f46b4f10 100644
--- a/doc/markdown/configuration/statistic.md
+++ b/doc/markdown/configuration/statistic.md
@@ -1,14 +1,23 @@
 # Rspamd statistic settings
 
-## Table of Contents
-
-* [Options](options.md)
-* [Logging](logging.md)
-* [Metrics](metrics.md)
-* [Composites](composites.md)
-* [User settings](settings.md)
-* [Statistic configuration](statistic.md)
-* [Workers](../workers/index.md)
-* [Modules](../modules/index.md)
-
 ## Introduction
+
+~~~nginx
+classifier {
+    type = "bayes";
+    tokenizer = "osb-text";
+    metric = "default";
+    min_tokens = 10;
+    max_tokens = 1000;
+    statfile {
+        symbol = "BAYES_HAM";
+        size = 50Mb;
+        path = "$DBDIR/bayes.ham";
+    }
+    statfile {
+        symbol = "BAYES_SPAM";
+        size = 50Mb;
+        path = "$DBDIR/bayes.spam";
+    }
+}
+~~~
\ No newline at end of file