Skip to content
Snippets Groups Projects
Commit 68a275be authored by Stephan Bosch's avatar Stephan Bosch
Browse files

Updated documentation: Sieve tools are now using Dovecot configuration by default.

parent 3322ab5a
No related branches found
No related tags found
No related merge requests found
......@@ -7,7 +7,7 @@ Current activities:
Next (in order of descending priority/precedence):
* Make command line tools use Dovecot settings API
* Update man pages to match style of Dovecot man pages.
* Cleanup the test suite
- Make uniform command implementations
- Cleanup test scripts
......
.TH "SIEVE\-FILTER" "1" "5 August 2009"
.TH "SIEVE\-FILTER" "1" "11 July 2010"
.SH NAME
sieve\-filter \- Sieve mailbox filter tool for the Dovecot secure IMAP server
.PP
......@@ -6,7 +6,7 @@ sieve\-filter \- Sieve mailbox filter tool for the Dovecot secure IMAP server
features! The behavior described in this manual page represents the design and not necessarily what the tool currently implements.
.SH SYNOPSIS
sieve\-filter [\fIoptions\fR] \fIscript\-file\fR \fIsource\-location\fR \fIsource\-mailbox\fR [\fIinbox\-namespace\fR [\fInamespace\fR ...]]
sieve\-filter [\fB\-c\fR \fIconfig-file\fR] [\fIoptions\fR] \fIscript\-file\fR \fIsource\-location\fR \fIsource\-mailbox\fR [\fIinbox\-namespace\fR [\fInamespace\fR ...]]
.TP
\fInamepace\fR = [prefix=]location[;option=value,option=value,...]
.TP
......@@ -65,6 +65,9 @@ e\-mails. However, it can still litter other mailboxes with spurious copies of y
Sieve script decides to do so.
.SH OPTIONS
.TP
\fB\-c\fP \fIconfig-file\fP
Alternative Dovecot configuration file path.
.TP
\fB\-D\fP \fIsource\-action\fP
By default, the sieve\-filter command does not delete the messages from the source mailbox. This means that
......
.TH "SIEVE\-TEST" "1" "4 July 2009"
.TH "SIEVE\-TEST" "1" "11 July 2010"
.SH NAME
sieve\-test \- Sieve script tester for the Dovecot secure IMAP server
.SH SYNOPSIS
sieve\-test
[\fB\-c\fR \fIconfig-file\fR]
[\fB\-C\fR]
[\fB\-D\fR]
[\fB\-d\fR \fIdump\-file\fR]
......@@ -44,6 +45,9 @@ with basename and path identical to the specified script. Use the \fB\-C\fP opti
behavior by forcing the script to be compiled into a new binary.
.SH OPTIONS
.TP
\fB\-c\fP \fIconfig-file\fP
Alternative Dovecot configuration file path.
.TP
\fB\-C\fP
Force compilation. By default, the compiled binary is stored on disk. When this binary is found
during the next execution of \fBsieve\-test\fP and its modification time is more recent than the
......
.TH "SIEVEC" "1" "4 July 2009"
.TH "SIEVEC" "1" "11 July 2010"
.SH NAME
sievec \- Sieve script compiler for the Dovecot secure IMAP server
.SH SYNOPSIS
sievec [\fB\-d\fR] [\fB\-x\fR "\fIextension extension ...\fR"] \fIscript\-file\fR [\fIout\-file\fR]
sievec [\fB\-c\fR \fIconfig-file\fR] [\fB\-d\fR] [\fB\-x\fR "\fIextension extension ...\fR"] \fIscript\-file\fR [\fIout\-file\fR]
.SH DESCRIPTION
.PP
The \fBsievec\fP command is part of the Pigeonhole Sieve implementation for the Dovecot secure
......@@ -42,6 +42,9 @@ code to the specified file. The output is then identical to what the \fBsieved\f
for a stored binary file. This output is mainly useful to find bugs in the compiler that yield corrupt
binaries.
.SH OPTIONS
.TP
\fB\-c\fP \fIconfig-file\fP
Alternative Dovecot configuration file path.
.TP
\fB\-d\fP
Don't write the binary to \fIout\-file\fP, but write a textual dump of the binary in
......
.TH "SIEVED" "1" "4 July 2009"
.TH "SIEVED" "1" "11 July 2010"
.SH NAME
sieved \- Sieve script binary dump tool for the Dovecot secure IMAP server
.SH SYNOPSIS
sieved [\fB\-x\fR "\fIextension extension ...\fR"] \fIsieve\-binary\fR [\fIout\-file\fR]
sieved [\fB\-c\fR \fIconfig-file\fR] [\fB\-x\fR "\fIextension extension ...\fR"] \fIsieve\-binary\fR [\fIout\-file\fR]
.br
.SH DESCRIPTION
.PP
......@@ -34,6 +34,9 @@ new operations and use additional blocks. Therefore, the output of \fBsieved\fP
on the language extensions used when compiling the binary.
.SH OPTIONS
.TP
\fB\-c\fP \fIconfig-file\fP
Alternative Dovecot configuration file path.
.TP
\fB\-x\fP "\fIextension extension ...\fP"
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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Consent

On this website, we use the web analytics service Matomo to analyze and review the use of our website. Through the collected statistics, we can improve our offerings and make them more appealing for you. Here, you can decide whether to allow us to process your data and set corresponding cookies for these purposes, in addition to technically necessary cookies. Further information on data protection—especially regarding "cookies" and "Matomo"—can be found in our privacy policy. You can withdraw your consent at any time.