Browse Source

Add notes about performance and lock disabing

Alois Mahdal 6 years ago
parent
commit
63e88ecd60
1 changed files with 8 additions and 2 deletions
  1. 8
    2
      src/imapdomo.skel

+ 8
- 2
src/imapdomo.skel View File

16
             "-c DIR      change to DIR before doing anything"                 \
16
             "-c DIR      change to DIR before doing anything"                 \
17
             "-l          list handlers and exit"                              \
17
             "-l          list handlers and exit"                              \
18
             "-d          turn on debugging mode"                              \
18
             "-d          turn on debugging mode"                              \
19
-            "-N          turn off locking"                                    \
19
+            "-N          turn off locking; make sure that handlers cannot"    \
20
+            "            interfere with each other or that another locking"   \
21
+            "            mechanism is in place.  Also see NOTE below."        \
20
        --                                                                     \
22
        --                                                                     \
21
        "imapdomo will try to read init.lua and handlers/ACTION.lua from its"  \
23
        "imapdomo will try to read init.lua and handlers/ACTION.lua from its"  \
22
        "configuration directory."                                             \
24
        "configuration directory."                                             \
23
        ""                                                                     \
25
        ""                                                                     \
24
        "See imapfilter_config(5)) for guide and API reference.  Few functions"\
26
        "See imapfilter_config(5)) for guide and API reference.  Few functions"\
25
-       "are also available in .imapdomo/common.lua"
27
+       "are also available in .imapdomo/common.lua"                           \
28
+       ""                                                                     \
29
+       "NOTE: Be aware that it's your responsibility to ensure that filters"  \
30
+       "don't cause performance problems. (Trust me, it's not so hard to"     \
31
+       "\"earn\" yourself a nice server ban--I learned that the hard way)."
26
 }
32
 }
27
 
33
 
28
 bug() {
34
 bug() {