1SIEVE-DUMP(1) Pigeonhole SIEVE-DUMP(1)
2
6 sieve-dump - Pigeonhole's Sieve script binary dump tool
7
9 sieve-dump [options] sieve-binary [out-file]
10
12 The sieve-dump command is part of the Pigeonhole Project (pigeon‐
13 hole(7)), which adds Sieve (RFC 5228) support to the Dovecot secure
14 IMAP and POP3 server (dovecot(1)).
15 Using the sieve-dump command, Sieve binaries, which are produced for
17 instance by sievec(1), can be transformed into a human-readable textual
18 representation. This can provide valuable insight in how the Sieve
19 script is executed. This is also particularly useful to view corrupt
20 binaries that can result from bugs in the Sieve implementation. This
21 tool is intended mainly for development purposes, so normally system
22 administrators and users will not need to use this tool.
23 The format of the output is not explained here in detail, but it should
25 be relatively easy to understand. The Sieve binaries comprise a set of
26 data blocks, each of which can contain arbitrary data. For the base
27 language implementation two blocks are used: the first containing a
28 specification of all required language extensions and the second con‐
29 taining the main Sieve program. Compiled Sieve programs are represented
30 as flat byte code and therefore the dump of the main program is a dis‐
31 assembly listing of the interpreter operations. Extensions can define
32 new operations and use additional blocks. Therefore, the output of
33 sieve-dump depends greatly on the language extensions used when compil‐
34 ing the binary.
35
37 -c config-file
38 Alternative Dovecot configuration file path.
39 -h Produce per-block hexdump output of the whole binary instead of
41 the normal human-readable output.
42 -x extensions
44 Set the available extensions. The parameter is a space-separated
45 list of the active extensions. By prepending the extension iden‐
46 tifiers with + or -, extensions can be included or excluded rel‐
47 ative to the default set of extensions. If no extensions have a
48 + or - prefix, only those extensions that are explicitly listed
49 will be enabled. Unknown extensions are ignored and a warning is
50 produced. By default, all supported extensions are available,
51 except for deprecated extensions or those that are still under
52 development.
53 For example -x "+imapflags -enotify" will enable the deprecated
55 imapflags extension along with all extensions that are available
56 by default, except for the enotify extension.
57
59 sieve-binary
60 Specifies the Sieve binary file that needs to be dumped.
61 out-file
63 Specifies where the output must be written. This argument is
64 optional. If omitted, the output is written to stdout.
65
67 sieve-dump will exit with one of the following values:
68 0 Delivery was successful. (EX_OK, EXIT_SUCCES)
70 1 Operation failed. This is returned for almost all failures.
72 (EXIT_FAILURE)
73 64 Invalid parameter given. (EX_USAGE)
75
77 /usr/local/etc/dovecot/dovecot.conf
78 Dovecot's main configuration file.
79 /usr/local/etc/dovecot/conf.d/90-sieve.conf
81 Sieve interpreter settings (included from Dovecot's main config‐
82 uration file)
83
85 Report bugs, including doveconf -n output, to the Dovecot Mailing List
86 <dovecot@dovecot.org>. Information about reporting Dovecot and Pigeon‐
87 hole bugs is available at: http://dovecot.org/bugreport.html
88
90 dovecot(1), dovecot-lda(1), sieve-test(1), sievec(1), pigeonhole(7)
91Pigeonhole for Dovecot v2.0 2010-08-23 SIEVE-DUMP(1)