.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.16.
.TH SIEVE "1" "November 2020" "FSF" "User Commands"
.SH NAME
sieve \- a mail filtering tool.
.SH SYNOPSIS
.B sieve
[\fI\,OPTION\/\fR...] \fI\,SCRIPT\/\fR
.SH DESCRIPTION
GNU sieve \fB\-\-\fR a mail filtering tool.
.TP
\fB\-c\fR, \fB\-\-[no\-]compile\-only\fR
compile script and exit
.TP
\fB\-D\fR, \fB\-\-dump\fR
compile script, dump disassembled sieve code to
terminal and exit
.TP
\fB\-d\fR, \fB\-\-debug\fR[=\fI\,FLAGS\/\fR]
debug flags (defaults to "TPt")
.TP
\fB\-E\fR, \fB\-\-[no\-]expression\fR
treat SCRIPT as Sieve program text
.TP
\fB\-e\fR, \fB\-\-email\fR=\fI\,ADDRESS\/\fR
override user email address
.TP
\fB\-\-environment\fR=\fI\,NAME=VALUE\/\fR
set sieve environment value
.TP
\fB\-f\fR, \fB\-\-mbox\-url\fR=\fI\,MBOX\/\fR
mailbox to sieve (defaults to user's mail spool)
.TP
\fB\-k\fR, \fB\-\-[no\-]keep\-going\fR
keep on going if execution fails on a message
.TP
\fB\-\-line\-info\fR=\fI\,BOOL\/\fR
print source location along with action logs
(default)
.TP
\fB\-n\fR, \fB\-\-[no\-]dry\-run\fR, \fB\-\-no\-actions\fR
do not execute any actions, just print what would
be done
.TP
\fB\-\-no\-program\-name\fR
do not prefix diagnostic messages with the program
name
.TP
\fB\-t\fR, \fB\-\-ticket\fR=\fI\,TICKET\/\fR
ticket file for user authentication
.TP
\fB\-v\fR, \fB\-\-[no\-]verbose\fR
log all actions
.TP
\fB\-\-variable\fR=\fI\,NAME=VALUE\/\fR
set sieve variable
.IP
Global debugging settings
.TP
\fB\-\-debug\-level\fR=\fI\,LEVEL\/\fR
set Mailutils debugging level
.HP
\fB\-\-[no\-]debug\-line\-info\fR show source info with debugging messages
.TP
\fB\-\-log\-facility\fR=\fI\,FACILITY\/\fR
output logs to syslog FACILITY
.TP
\fB\-M\fR, \fB\-\-mailer\fR=\fI\,MAILER\/\fR
use specified URL as the default mailer
.IP
Sieve options
.TP
\fB\-\-clear\-include\-path\fR
clear Sieve include path
.TP
\fB\-\-clear\-library\-path\fR, \fB\-\-clearpath\fR
clear Sieve library path
.TP
\fB\-I\fR, \fB\-\-includedir\fR=\fI\,DIR\/\fR
append DIR to the list of directories searched for
include files
.TP
\fB\-L\fR, \fB\-\-libdir\fR=\fI\,DIR\/\fR
append DIR to the list of directories searched for
library files
.TP
\fB\-\-libdir\-prefix\fR=\fI\,DIR\/\fR
add DIR to the beginning of the list of
directories searched for library files
.IP
Configuration handling
.TP
\fB\-\-config\-file\fR=\fI\,FILE\/\fR
load this configuration file; implies \fB\-\-no\-config\fR
.TP
\fB\-\-config\-lint\fR
check configuration file syntax and exit
.TP
\fB\-\-config\-verbose\fR
verbosely log parsing of the configuration files
.TP
\fB\-\-no\-config\fR
do not load site and user configuration files
.TP
\fB\-\-no\-site\-config\fR
do not load site\-wide configuration file
.TP
\fB\-\-no\-user\-config\fR
do not load user configuration file
.TP
\fB\-\-set\fR=\fI\,PARAM=VALUE\/\fR
set configuration parameter
.IP
Informational options
.TP
\fB\-\-config\-help\fR
show configuration file summary
.TP
\fB\-\-show\-config\-options\fR
show compilation options
.TP
\-?, \fB\-\-help\fR
give this help list
.TP
\fB\-\-usage\fR
give a short usage message
.TP
\fB\-V\fR, \fB\-\-version\fR
print program version
.PP
Mandatory or optional arguments to long options are also mandatory or optional
for any corresponding short options.
.PP
Sieve\-specific debug levels:
.PP
trace1  \-  print parse tree before optimization
trace2  \-  print parse tree after optimization
trace3  \-  print parser traces
trace4  \-  print tests and actions being executed
trace9  \-  print each Sieve instruction being executed
.PP
Compatibility debug flags:
g \- main parser traces
T \- mailutils traces (same as \fB\-\-debug\-level\fR=\fI\,sieve\/\fR.trace0\-trace1)
P \- network protocols (same as \fB\-\-debug\-level\fR=\fI\,sieve\/\fR.=prot)
t \- sieve trace (same as \fB\-\-debug\-level\fR=\fI\,sieve\/\fR.=trace4)
i \- sieve instructions trace (same as \fB\-\-debug\-level\fR=\fI\,sieve\/\fR.=trace9)
.SH "REPORTING BUGS"
Report bugs to <bug\-mailutils@gnu.org>.
.br
GNU Mailutils home page: <http://mailutils.org>
.br
General help using GNU software: <http://www.gnu.org/gethelp/>
.SH COPYRIGHT
Copyright \(co 2007\-2019 Free Software Foundation, inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
The complete GNU mailutils documentation is maintained as a Texinfo
manual. If the
.B mailutils-doc
package is installed, the command
.IP
.B info mailutils
.PP
should give you access to the complete manual.
.br
You can also find this manual online in the GNU mailutils webpage:
.br
https://www.gnu.org/software/mailutils/manual/index.html.
.br
Please note this manpage was automatically generated by the
Debian mailutils packagers. Do not file bugs for its content to the
GNU Mailutils upstream authors.