Improve documentation.

diff --git a/doc/markdown/configuration/composites.md b/doc/markdown/configuration/composites.md
index fc734af2a7a827e62fb5e91bb68527d4d16e7708..3aa63c072ca85f0b08f63ac81129f763187cc24f 100644 (file)
--- 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 9ddf49689509a125f646b292d43be569647bf21c..a404c77a97ebd94077273824b332fdaf105a6d7e 100644 (file)
--- 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 4244817629640c8c1f3141bc081c3fd0a60e8837..35f70f4e175360d1ac6eab4fda19f8efd52deac2 100644 (file)
--- 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 48fe55365e6d765523e68ce5ae09444280a72bc0..3c1a6376934ec70b31439a3587fa09e3121328c0 100644 (file)
--- 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 71d622a6849b8797f60d726b6529236cbacded6f..3383146cab49d05538eb00839dfd6b0563ae7cbd 100644 (file)
--- 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 a7b85a11cedcbb2ce5f55623ccc63507ee8fcc50..6074c6fb04dafd7bf6bc8a5695982dd462b87386 100644 (file)
--- 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 5caca9150709c9185dc4c7cee66f17cf8ea2a6e2..1f46b4f10f91a6f64e837152d81673e78740c0f5 100644 (file)
--- 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