Browse Source

Improve formating of README.md

Jonathan Golder 2 years ago
parent
commit
b562662f4b
1 changed files with 19 additions and 11 deletions
  1. 19
    11
      README.md

+ 19
- 11
README.md View File

@@ -1,8 +1,9 @@
1 1
 dotqmail
2 2
 =========
3 3
 
4
-The role will set up the dotqmail files in ansible users home for netqmail server as it is used for example on uberspace.de.
5
-*Make sure you have made a backup of your dotqmail files before running this role since it will overwrite or delete them without any further request!!!*
4
+The role will set up the dotqmail files in ansible users home for netqmail server as it is used for example on [uberspace.de](https://uberspace.de/).
5
+
6
+**Make sure you have made a backup of your dotqmail files before running this role since it will overwrite or delete them without any further request!!!**
6 7
 
7 8
 Requirements
8 9
 ------------
@@ -12,21 +13,28 @@ See variables section what could be configured. The default configuration only p
12 13
 Role Variables
13 14
 --------------
14 15
 
15
-* dotqmail_rootfile  This list of lines is used as content of the root dotqmail file ".qmail" which is treatened separately since it has no extention (and therefore no valid key). Per default it will redirect mails to ./Maildir/ which can be simply overwritten e.g. in inventory files.
16
+* `dotqmail_rootfile`
17
+  This list of lines is used as content of the root dotqmail file ".qmail" which is treatened separately since it has no extention (and therefore no valid key). Per default it will redirect mails to ./Maildir/ which can be simply overwritten e.g. in inventory files.
18
+
19
+* `dotqmail_config_files`
20
+  Can be configured as a dict of lists were the keys are the dotqmail file extentions you like to have and the list entries (which should be strings) are the redirection lines to add to that file.
16 21
 
17
-* dotqmail_config_files  Can be configured as a dict of lists were the keys are the dotqmail file extentions you like to have and the list entries (which should be strings) are the redirection lines to add to that file
18 22
   Example:
19
-    dotqmail_config_files:
20
-      "info" : ["./Maildir/"]
21
-      "mail" : ["./Maildir/", "mail@example.com"]
22 23
 
23
-  The example above will create two dotqmail files ".qmail-info" and ".qmail-mail". The both will redirect the Mails to users Maildir while the latter one will also redirect the mail to address mail@example.com. See (https://wiki.uberspace.de/mail:dotqmail) for more information about dotqmail files and redirection lines syntax.
24
+      dotqmail_config_files:
25
+        "info" : ["./Maildir/"]
26
+        "mail" : ["./Maildir/", "mail@example.com"]
27
+
28
+  The example above will create two dotqmail files ".qmail-info" and ".qmail-mail". The both will redirect the Mails to users Maildir while the latter one will also redirect the mail to address mail@example.com. See [Uberspace Wiki Entry](https://wiki.uberspace.de/mail:dotqmail) for more information about dotqmail files and redirection lines syntax.
24 29
 
25
-* dotqmail_default_files  Has roughly the same function as dotqmail_config_files with the *important* difference that it will be combined with the one above to generate the actual working dict and items here will be overwritten by items of dotqmail_config_files if they use the same extention/dict-key. This is present to enforce basic conformity with RFC 2142.
30
+* `dotqmail_default_files`
31
+  Has roughly the same function as dotqmail_config_files with the *important* difference that it will be combined with the one above to generate the actual working dict and items here will be overwritten by items of dotqmail_config_files if they use the same extention/dict-key. This is present to enforce basic conformity with RFC 2142.
26 32
 
27
-* dotqmail_file  This is the actual dict we work on and normally *should not be changed directly*. It is the combination of dotqmail_config_files over dotqmail_default_files.
33
+* `dotqmail_file`
34
+  This is the actual dict we work on and normally *should not be changed directly*. It is the combination of dotqmail_config_files over dotqmail_default_files.
28 35
 
29
-* dotqmail_prefix  This is the prefix used to detect the dotqmail filename. By default this is ".qmail-" and normally *should not be changed*.
36
+* `dotqmail_prefix`
37
+  This is the prefix used to detect the dotqmail filename. By default this is ".qmail-" and normally *should not be changed*.
30 38
 
31 39
 Dependencies
32 40
 ------------