-
Notifications
You must be signed in to change notification settings - Fork 29
/
sieve-dump.1.in
122 lines (120 loc) · 4.71 KB
/
sieve-dump.1.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
.\" Copyright (c) 2010-2017 Pigeonhole authors, see the included COPYING file
.TH "SIEVE\-DUMP" 1 "2016-04-05" "Pigeonhole for Dovecot v2.2" "Pigeonhole"
.\"------------------------------------------------------------------------
.SH NAME
sieve\-dump \- Pigeonhole\(aqs Sieve script binary dump tool
.\"------------------------------------------------------------------------
.SH SYNOPSIS
.B sieve\-dump
.RI [ options ]
.I sieve\-binary
.RI [ out\-file ]
.\"------------------------------------------------------------------------
.SH DESCRIPTION
.PP
The \fBsieve\-dump\fP command is part of the Pigeonhole Project
(\fBpigeonhole\fR(7)), which adds Sieve (RFC 5228) support to the Dovecot
secure IMAP and POP3 server (\fBdovecot\fR(1)).
.PP
Using the \fBsieve\-dump\fP command, Sieve binaries, which are produced for
instance by \fBsievec\fP(1), can be transformed into a human\-readable textual
representation. This can provide valuable insight in how the Sieve script is
executed. This is also particularly useful to view corrupt binaries that can
result from bugs in the Sieve implementation. This tool is intended mainly for
development purposes, so normally system administrators and users will not need
to use this tool.
.PP
The format of the output is not explained here in detail, but it should be
relatively easy to understand. The Sieve binaries comprise a set of data blocks,
each of which can contain arbitrary data. For the base language implementation
two blocks are used: the first containing a specification of all required
language extensions and the second containing the main Sieve program. Compiled
Sieve programs are represented as flat byte code and therefore the dump of the
main program is a disassembly listing of the interpreter operations. Extensions
can define new operations and use additional blocks. Therefore, the output of
\fBsieve\-dump\fP depends greatly on the language extensions used when compiling
the binary.
.\"------------------------------------------------------------------------
.SH OPTIONS
.TP
.BI \-c\ config\-file
Alternative Dovecot configuration file path.
.TP
.B \-D
Enable Sieve debugging.
.TP
.B \-h
Produce per\-block hexdump output of the whole binary instead of the normal
human\-readable output.
.TP
.BI \-o\ setting = value
Overrides the configuration
.I setting
from
.I @pkgsysconfdir@/dovecot.conf
and from the userdb with the given
.IR value .
In order to override multiple settings, the
.B \-o
option may be specified multiple times.
.TP
.BI \-u\ user
Run the Sieve script for the given \fIuser\fP. When omitted, the
.I command
will be executed with the environment of the currently logged in user.
.TP
.BI \-x\ extensions
Set the available extensions. The parameter is a space\-separated list of the
active extensions. By prepending the extension identifiers with \fB+\fP or
\fB\-\fP, extensions can be included or excluded relative to the configured set
of active extensions. If no extensions have a \fB+\fP or \fB\-\fP prefix, only
those extensions that are explicitly listed will be enabled. Unknown extensions
are ignored and a warning is produced.
For example \fB\-x\fP \(dq+imapflags \-enotify\(dq will enable the deprecated
imapflags extension and disable the enotify extension. The rest of the active
extensions depends on the \fIsieve_extensions\fP and
\fIsieve_global_extensions\fP settings. By default, i.e.
when \fIsieve_extensions\fP and \fIsieve_global_extensions\fP remain
unconfigured, all supported extensions are available, except for deprecated
extensions or those that are still under development.
.\"------------------------------------------------------------------------
.SH ARGUMENTS
.TP
.I sieve\-binary
Specifies the Sieve binary file that needs to be dumped.
.TP
.I out\-file
Specifies where the output must be written. This argument is optional. If
omitted, the output is written to \fBstdout\fR.
.\"------------------------------------------------------------------------
.SH "EXIT STATUS"
.B sieve\-dump
will exit with one of the following values:
.TP 4
.B 0
Dump was successful. (EX_OK, EXIT_SUCCESS)
.TP
.B 1
Operation failed. This is returned for almost all failures.
(EXIT_FAILURE)
.TP
.B 64
Invalid parameter given. (EX_USAGE)
.\"------------------------------------------------------------------------
.SH FILES
.TP
.I @pkgsysconfdir@/dovecot.conf
Dovecot\(aqs main configuration file.
.TP
.I @pkgsysconfdir@/conf.d/90\-sieve.conf
Sieve interpreter settings (included from Dovecot\(aqs main configuration file)
.\"------------------------------------------------------------------------
@INCLUDE:reporting-bugs@
.\"------------------------------------------------------------------------
.SH "SEE ALSO"
.BR dovecot (1),
.BR dovecot\-lda (1),
.BR sieve\-filter (1),
.BR sieve\-test (1),
.BR sievec (1),
.BR pigeonhole (7)