From f1e6fa4ba79cfd391245ed618f11ba2c30e8c3a1 Mon Sep 17 00:00:00 2001
From: Stephan Bosch <stephan@rename-it.nl>
Date: Mon, 23 Aug 2010 09:10:11 +0200
Subject: [PATCH] =?UTF-8?q?Cleaned=20up=20manpages=20and=20fixed=20various?=
=?UTF-8?q?=20issues=20(patch=20by=20Pascal=20Volk).=20-=20No=20longer=20t?=
=?UTF-8?q?rack=20the=20generated=20pigeonhole.7=20-=20Some=20makes=20don'?=
=?UTF-8?q?t=20like=20the=20'handy'=20notation=20that=20was=20used.=20-=20?=
=?UTF-8?q?Deleted=20trailing=20spaces=20-=20Escaped=20some=20dashes=20-?=
=?UTF-8?q?=20Replaced=20some=20'=20and=20"=20by=20\(aq=20and=20\(dq=20-?=
=?UTF-8?q?=20Sorted=20manual=20pages=20in=20section=20'See=20also'=20=20?=
=?UTF-8?q?=20(first=20list=20all=20man=20pages=20from=20the=20lowest=20se?=
=?UTF-8?q?ction=20(1)=20=20=20alphabetical=20sorted,=20then=20the=20next?=
=?UTF-8?q?=20section=20=E2=80=A6)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.hgignore | 1 +
doc/man/Makefile.am | 20 +++++--
doc/man/pigeonhole.7 | 98 -----------------------------------
doc/man/pigeonhole.7.in | 66 +++++++++++------------
doc/man/sieve-dump.1.in | 36 ++++++-------
doc/man/sieve-test.1.in | 112 ++++++++++++++++++++--------------------
doc/man/sievec.1.in | 60 ++++++++++-----------
7 files changed, 152 insertions(+), 241 deletions(-)
delete mode 100644 doc/man/pigeonhole.7
diff --git a/.hgignore b/.hgignore
index 4996405ab..cb80ae279 100644
--- a/.hgignore
+++ b/.hgignore
@@ -59,6 +59,7 @@ doc/man/sievec.1
doc/man/sieve-dump.1
doc/man/sieve-test.1
doc/man/sieve-filter.1
+doc/man/pigeonhole.7
src/sieve-tools/sievec
src/sieve-tools/sieve-dump
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 1a5eefaa1..905f2cfd4 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -28,10 +28,22 @@ EXTRA_DIST = \
CLEANFILES = $(nodist_man1_MANS) $(nodist_man7_MANS)
-%.1: $(srcdir)/%.1.in $(man_includefiles) Makefile
+sievec.1: $(srcdir)/sievec.1.in $(man_includefiles) Makefile
$(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \
- < $(srcdir)/$< > $@
+ < $(srcdir)/sievec.1.in > sievec.1
-%.7: $(srcdir)/%.7.in $(man_includefiles) Makefile
+sieve-dump.1: $(srcdir)/sieve-dump.1.in $(man_includefiles) Makefile
$(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \
- < $(srcdir)/$< > $@
+ < $(srcdir)/sieve-dump.1.in > sieve-dump.1
+
+sieve-filter.1: $(srcdir)/sieve-filter.1.in $(man_includefiles) Makefile
+ $(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \
+ < $(srcdir)/sieve-filter.1.in > sieve-filter.1
+
+sieve-test.1: $(srcdir)/sieve-test.1.in $(man_includefiles) Makefile
+ $(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \
+ < $(srcdir)/sieve-test.1.in > sieve-test.1
+
+pigeonhole.7: $(srcdir)/pigeonhole.7.in $(man_includefiles) Makefile
+ $(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \
+ < $(srcdir)/pigeonhole.7.in > pigeonhole.7
diff --git a/doc/man/pigeonhole.7 b/doc/man/pigeonhole.7
deleted file mode 100644
index 8ee7e1b75..000000000
--- a/doc/man/pigeonhole.7
+++ /dev/null
@@ -1,98 +0,0 @@
-.\" Copyright (c) 2010 Pigeonhole authors, see the included COPYING file
-.TH "PIGEONHOLE" 7 "2010-08-21" "Pigeonhole for Dovecot v2.0" "Pigeonhole"
-.\"------------------------------------------------------------------------
-.SH NAME
-pigeonhole \- Overview of the Pigeonhole project\(aqs Sieve support for the
-Dovecot secure IMAP and POP3 server
-.\"------------------------------------------------------------------------
-.SH DESCRIPTION
-.PP
-The Pigeonhole project <http://pigeonhole.dovecot.org> adds support for the
-Sieve language (RFC 5228) and the ManageSieve protocol (RFC 5804) to the
-Dovecot Secure IMAP and POP3 Server (\fBdovecot\fR(1)). In the literal sense,
-a pigeonhole is a a hole or recess inside a dovecot for pigeons to nest in.
-It is, however, also the name for one of a series of small, open compartments
-in a cabinet used for filing or sorting mail. As a verb, it describes the act
-of putting an item into one of those pigeonholes. The name "Pigeonhole"
-therefore well describes an important part of the functionality that this
-project adds to Dovecot: sorting and filing e-mail messages.
-.PP
-The Sieve language is used to specify how e-mail needs to be processed. By
-writing Sieve scripts, users can customize how messages are delivered, e.g.
-whether they are forwarded or stored in special folders. Unwanted messages can
-be discarded or rejected, and, when the user is not available, the Sieve
-interpreter can send an automated reply. Above all, the Sieve language is meant
-to be simple, extensible and system independent. And, unlike most other mail
-filtering script languages, it does not allow users to execute arbitrary
-programs. This is particularly useful to prevent virtual users from having full
-access to the mail store. The intention of the language is to make it impossible
-for users to do anything more complex (and dangerous) than write simple mail
-filters.
-.PP
-Using the ManageSieve protocol, users can upload their Sieve scripts remotely,
-without needing direct filesystem access through FTP or SCP. Additionally, a
-ManageSieve server always makes sure that uploaded scripts are valid, preventing
-compile failures at mail delivery.
-.PP
-The Pigeonhole project provides the following items:
-.IP \(bu 4
-The LDA Sieve plugin for Dovecot\(aqs Local Delivery Agent (LDA)
-(\fBdovecot-lda\fR(1)) that facilitates the actual Sieve filtering upon
-delivery.
-.IP \(bu
-The ManageSieve Service that implements the ManageSieve protocol through which
-users can remotely manage Sieve scripts on the server.
-.IP \(bu
-Command line tools that provide the means to manually compile, analyse and test
-Sieve scripts.
-.PP
-The functionality and configuration of the LDA Sieve plugin and the ManageSieve
-service is described in detail in the README and INSTALL files contained in the
-Pigeonhole package and in the Dovecot Wiki
-<http://wiki2.dovecot.org/Pigeonhole>.
-.PP
-The following command line tools are available:
-.TP
-.BR sievec (1)
-Compiles sieve scripts into a binary representation for later execution.
-.TP
-.BR sieve\-test (1)
-The universal Sieve test tool for testing the effect of a Sieve script on a
-particular message.
-.TP
-.BR sieve\-dump (1)
-Dumps the content of a Sieve binary file for (development) debugging purposes.
-.\"------------------------------------------------------------------------
-.SH REPORTING BUGS
-Report bugs, including
-.I doveconf \-n
-output, to the Dovecot Mailing List <dovecot@dovecot.org>.
-Information about reporting Dovecot and Pigeonhole bugs is available at:
-http://dovecot.org/bugreport.html
-.\"------------------------------------------------------------------------
-.SH AUTHOR
-Pigeonhole <http://pigeonhole.dovecot.org> and its manual pages were written by
-the Pigeonhole authors <http://pigeonhole.dovecot.org/doc/AUTHORS>, mainly
-Stephan Bosch <stephan at rename-it.nl>, and are licensed under the terms of the
-LGPLv2.1 license, which is the same license as Dovecot, see
-<http://dovecot.org/doc/COPYING> for details.
-.\"------------------------------------------------------------------------
-.SH "SEE ALSO"
-.BR dovecot (1),
-.BR dovecot\-lda (1),
-.BR sievec (1),
-.BR sieve\-test (1),
-.BR sieve\-dump (1)
-.\"-------------------------------------
-.PP
-Additional resources:
-.IP "Dovecot website"
-http://www.dovecot.org
-.IP "Dovecot v2.0 Wiki"
-http://wiki2.dovecot.org/Pigeonhole
-.IP "Pigeonhole website"
-http://pigeonhole.dovecot.org
-
-
-
-
diff --git a/doc/man/pigeonhole.7.in b/doc/man/pigeonhole.7.in
index 2d590c43f..fe92c1869 100644
--- a/doc/man/pigeonhole.7.in
+++ b/doc/man/pigeonhole.7.in
@@ -1,64 +1,64 @@
.\" Copyright (c) 2010 Pigeonhole authors, see the included COPYING file
-.TH "PIGEONHOLE" 7 "2010-08-21" "Pigeonhole for Dovecot v2.0" "Pigeonhole"
+.TH "PIGEONHOLE" 7 "2010-08-23" "Pigeonhole for Dovecot v2.0" "Pigeonhole"
.\"------------------------------------------------------------------------
.SH NAME
-pigeonhole \- Overview of the Pigeonhole project\(aqs Sieve support for the
+pigeonhole \- Overview of the Pigeonhole project\(aqs Sieve support for the
Dovecot secure IMAP and POP3 server
.\"------------------------------------------------------------------------
.SH DESCRIPTION
.PP
-The Pigeonhole project <http://pigeonhole.dovecot.org> adds support for the
-Sieve language (RFC 5228) and the ManageSieve protocol (RFC 5804) to the
-Dovecot Secure IMAP and POP3 Server (\fBdovecot\fR(1)). In the literal sense,
-a pigeonhole is a a hole or recess inside a dovecot for pigeons to nest in.
-It is, however, also the name for one of a series of small, open compartments
-in a cabinet used for filing or sorting mail. As a verb, it describes the act
-of putting an item into one of those pigeonholes. The name "Pigeonhole"
-therefore well describes an important part of the functionality that this
-project adds to Dovecot: sorting and filing e-mail messages.
+The Pigeonhole project <http://pigeonhole.dovecot.org> adds support for the
+Sieve language (RFC 5228) and the ManageSieve protocol (RFC 5804) to the
+Dovecot Secure IMAP and POP3 Server (\fBdovecot\fR(1)). In the literal sense,
+a pigeonhole is a a hole or recess inside a dovecot for pigeons to nest in.
+It is, however, also the name for one of a series of small, open compartments
+in a cabinet used for filing or sorting mail. As a verb, it describes the act
+of putting an item into one of those pigeonholes. The name \(dqPigeonhole\(dq
+therefore well describes an important part of the functionality that this
+project adds to Dovecot: sorting and filing e\-mail messages.
.PP
-The Sieve language is used to specify how e-mail needs to be processed. By
+The Sieve language is used to specify how e\-mail needs to be processed. By
writing Sieve scripts, users can customize how messages are delivered, e.g.
-whether they are forwarded or stored in special folders. Unwanted messages can
+whether they are forwarded or stored in special folders. Unwanted messages can
be discarded or rejected, and, when the user is not available, the Sieve
interpreter can send an automated reply. Above all, the Sieve language is meant
to be simple, extensible and system independent. And, unlike most other mail
filtering script languages, it does not allow users to execute arbitrary
programs. This is particularly useful to prevent virtual users from having full
access to the mail store. The intention of the language is to make it impossible
-for users to do anything more complex (and dangerous) than write simple mail
+for users to do anything more complex (and dangerous) than write simple mail
filters.
.PP
-Using the ManageSieve protocol, users can upload their Sieve scripts remotely,
+Using the ManageSieve protocol, users can upload their Sieve scripts remotely,
without needing direct filesystem access through FTP or SCP. Additionally, a
-ManageSieve server always makes sure that uploaded scripts are valid, preventing
+ManageSieve server always makes sure that uploaded scripts are valid, preventing
compile failures at mail delivery.
.PP
The Pigeonhole project provides the following items:
.IP \(bu 4
-The LDA Sieve plugin for Dovecot\(aqs Local Delivery Agent (LDA)
-(\fBdovecot-lda\fR(1)) that facilitates the actual Sieve filtering upon
+The LDA Sieve plugin for Dovecot\(aqs Local Delivery Agent (LDA)
+(\fBdovecot\-lda\fR(1)) that facilitates the actual Sieve filtering upon
delivery.
.IP \(bu
-The ManageSieve Service that implements the ManageSieve protocol through which
+The ManageSieve Service that implements the ManageSieve protocol through which
users can remotely manage Sieve scripts on the server.
.IP \(bu
Command line tools that provide the means to manually compile, analyse and test
Sieve scripts.
.PP
The functionality and configuration of the LDA Sieve plugin and the ManageSieve
-service is described in detail in the README and INSTALL files contained in the
+service is described in detail in the README and INSTALL files contained in the
Pigeonhole package and in the Dovecot Wiki
<http://wiki2.dovecot.org/Pigeonhole>.
.PP
The following command line tools are available:
-.TP
+.TP
.BR sievec (1)
-Compiles sieve scripts into a binary representation for later execution.
+Compiles Sieve scripts into a binary representation for later execution.
.TP
.BR sieve\-test (1)
-The universal Sieve test tool for testing the effect of a Sieve script on a
-particular message.
+The universal Sieve test tool for testing the effect of a Sieve script on a
+particular message.
.TP
.BR sieve\-dump (1)
Dumps the content of a Sieve binary file for (development) debugging purposes.
@@ -67,27 +67,23 @@ Dumps the content of a Sieve binary file for (development) debugging purposes.
.\"------------------------------------------------------------------------
.SH AUTHOR
Pigeonhole <http://pigeonhole.dovecot.org> and its manual pages were written by
-the Pigeonhole authors <http://pigeonhole.dovecot.org/doc/AUTHORS>, mainly
-Stephan Bosch <stephan at rename-it.nl>, and are licensed under the terms of the
-LGPLv2.1 license, which is the same license as Dovecot, see
+the Pigeonhole authors <http://pigeonhole.dovecot.org/doc/AUTHORS>, mainly
+Stephan Bosch <stephan at rename\-it.nl>, and are licensed under the terms of the
+LGPLv2.1 license, which is the same license as Dovecot, see
<http://dovecot.org/doc/COPYING> for details.
.\"------------------------------------------------------------------------
.SH "SEE ALSO"
.BR dovecot (1),
.BR dovecot\-lda (1),
-.BR sievec (1),
+.BR sieve\-dump (1),
.BR sieve\-test (1),
-.BR sieve\-dump (1)
+.BR sievec (1)
.\"-------------------------------------
.PP
Additional resources:
-.IP "Dovecot website"
+.IP "Dovecot website"
http://www.dovecot.org
-.IP "Dovecot v2.0 Wiki"
+.IP "Dovecot v2.0 Wiki"
http://wiki2.dovecot.org/Pigeonhole
.IP "Pigeonhole website"
http://pigeonhole.dovecot.org
-
-
-
-
diff --git a/doc/man/sieve-dump.1.in b/doc/man/sieve-dump.1.in
index 3cde03a36..10c381c87 100644
--- a/doc/man/sieve-dump.1.in
+++ b/doc/man/sieve-dump.1.in
@@ -1,5 +1,5 @@
.\" Copyright (c) 2010 Pigeonhole authors, see the included COPYING file
-.TH "SIEVE-DUMP" 1 "2010-08-22" "Pigeonhole for Dovecot v2.0" "Pigeonhole"
+.TH "SIEVE-DUMP" 1 "2010-08-23" "Pigeonhole for Dovecot v2.0" "Pigeonhole"
.\"------------------------------------------------------------------------
.SH NAME
sieve\-dump \- Pigeonhole\(aqs Sieve script binary dump tool
@@ -14,14 +14,14 @@ sieve\-dump \- Pigeonhole\(aqs Sieve script binary dump tool
.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)).
+secure IMAP and POP3 server (\fBdovecot\fR(1)).
.PP
-Using the \fBsieve\-dump\fP command, Sieve binaries, which are produced for
+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
+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
@@ -33,7 +33,7 @@ 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.
+the binary.
.\"------------------------------------------------------------------------
.SH OPTIONS
.TP
@@ -41,26 +41,26 @@ the binary.
Alternative Dovecot configuration file path.
.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
+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 default set of
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. By default, all supported extensions are
+extensions that are explicitly listed will be enabled. Unknown extensions are
+ignored and a warning is produced. By default, all supported extensions are
available, except for deprecated extensions or those that are still under
development.
For example \fB\-x\fP "+imapflags \-enotify" will enable the deprecated
-imapflags extension along with all extensions that are available by default,
+imapflags extension along with all extensions that are available by default,
except for the enotify extension.
.\"------------------------------------------------------------------------
.SH ARGUMENTS
-.TP
+.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
+.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"
@@ -71,7 +71,7 @@ will exit with one of the following values:
Delivery was successful. (EX_OK, EXIT_SUCCES)
.TP
.B 1
-Operation failed. This is returned for almost all failures.
+Operation failed. This is returned for almost all failures.
(EXIT_FAILURE)
.TP
.B 64
@@ -88,8 +88,8 @@ Sieve interpreter settings (included from Dovecot\(aqs main configuration file)
@INCLUDE:reporting-bugs@
.\"------------------------------------------------------------------------
.SH "SEE ALSO"
-.BR pigeonhole (7),
+.BR dovecot (1),
+.BR dovecot\-lda (1),
.BR sieve\-test (1),
.BR sievec (1),
-.BR dovecot (1),
-.BR dovecot-lda (1)
+.BR pigeonhole (7)
diff --git a/doc/man/sieve-test.1.in b/doc/man/sieve-test.1.in
index 29e448306..79abaa2a9 100644
--- a/doc/man/sieve-test.1.in
+++ b/doc/man/sieve-test.1.in
@@ -1,37 +1,37 @@
.\" Copyright (c) 2010 Pigeonhole authors, see the included COPYING file
-.TH "SIEVE-TEST" 1 "2010-08-22" "Pigeonhole for Dovecot v2.0" "Pigeonhole"
+.TH "SIEVE-TEST" 1 "2010-08-23" "Pigeonhole for Dovecot v2.0" "Pigeonhole"
.SH NAME
-sieve\-test \- Pigeonhole\(aqs Sieve script tester
+sieve\-test \- Pigeonhole\(aqs Sieve script tester
.\"------------------------------------------------------------------------
.SH SYNOPSIS
.B sieve\-test
.RI [ options ]
-.I script\-file
+.I script\-file
.I mail\-file
.\"------------------------------------------------------------------------
.SH DESCRIPTION
.PP
The \fBsieve\-test\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)).
+secure IMAP and POP3 server (\fBdovecot\fR(1)).
.PP
Using the \fBsieve\-test\fP command, the execution of Sieve scripts can be
tested. This evaluates the script for the provided message, yielding a set of
Sieve actions. Unless the \fB\-e\fP option is specified, it does not actually
-execute these actions, meaning that it does not store or forward the message
+execute these actions, meaning that it does not store or forward the message
anywere. In stead, it prints a detailed list of what actions would normally take
place. Note that, even when \fB\-e\fP is specified, no messages are ever
transmitted to remote SMTP recipients. The outgoing messages are always printed
-to \fBstdout\fP in stead.
+to \fBstdout\fP in stead.
.PP
-This is a very useful tool to debug the execution of Sieve scripts. It can be
-used to verify newly installed scripts for the intended behaviour and it can
+This is a very useful tool to debug the execution of Sieve scripts. It can be
+used to verify newly installed scripts for the intended behaviour and it can
provide more detailed information about script execution problems that are
-reported by the Sieve plugin, for example by tracing the execution and
-evaluation of commands and tests respectively.
+reported by the Sieve plugin, for example by tracing the execution and
+evaluation of commands and tests respectively.
.\"------------------------------------------------------------------------
.SH OPTIONS
-.TP
+.TP
.BI \-c\ config\-file
Alternative Dovecot configuration file path.
.TP
@@ -40,7 +40,7 @@ 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 script file, it is used and the script
is not compiled again. This option forces the script to be compiled, thus
-ignoring any present binary. Refer to \fBsievec\fP(1) for more information about
+ignoring any present binary. Refer to \fBsievec\fP(1) for more information about
Sieve compilation.
.TP
.B \-D
@@ -48,8 +48,8 @@ Enable Sieve debugging.
.TP
.BI \-d\ dump\-file
Causes a dump of the generated code to be written to the specified file. This is
-identical to the dump produced by \fBsieve\-dump\fR(1). Using '\-' as filename
-causes the dump to be written to \fBstdout\fP.
+identical to the dump produced by \fBsieve\-dump\fR(1). Using \(aq\-\(aq as
+filename causes the dump to be written to \fBstdout\fP.
.TP
.BI \-e
Enables true execution of the set of actions that results from running the
@@ -58,26 +58,26 @@ messages can be tested. Note that this will not transmit any messages to remote
SMTP recipients. Such actions only print the outgoing message to \fBstdout\fP.
.TP
.BI \-f\ envelope\-sender
-The envelope sender or return path. This is what Sieve's envelope test will
-compare to when the "from" envelope part is requested. Also, this is where
-response messages are sent to.
+The envelope sender or return path. This is what Sieve\(aqs envelope test will
+compare to when the \(dqfrom\(dq envelope part is requested. Also, this is
+where response messages are sent to.
.TP
.BI \-l\ mail\-location
-The location of the user's mail store. The syntax of this option's
+The location of the user\(aqs mail store. The syntax of this option\(aqs
\fImail\-location\fP parameter is identical to what is used for the
-mail_location setting in the Dovecot config file. This parameter is typically
-used in combination with \fB\-e\fP to test the actual delivery of messages. If
+mail_location setting in the Dovecot config file. This parameter is typically
+used in combination with \fB\-e\fP to test the actual delivery of messages. If
\fB\-l\fP is omitted when \fB\-e\fP is specified, mail store actions like
fileinto and keep are skipped.
.TP
.BI \-m\ default\-mailbox
-The mailbox where the keep action stores the message. This is "INBOX" by
-default.
+The mailbox where the keep action stores the message. This is \(dqINBOX\(dq
+by default.
.TP
.BI \-r\ recipient\-address
-The envelope recipient address. This is what Sieve's envelope test will compare
-to when the "to" envelope part is requested. Some tests and actions will also
-use this as the owner's e\-mail address.
+The envelope recipient address. This is what Sieve\(aqs envelope test will compare
+to when the \(dqto\(dq envelope part is requested. Some tests and actions will also
+use this as the owner\(aqs e\-mail address.
.TP
.BI \-s\ script\-file
Specify additional scripts to be executed before the main script. Multiple
@@ -87,21 +87,21 @@ line.
.TP
.BI \-t\ trace\-file
Enables runtime trace debugging. Trace debugging provides detailed insight in
-the operations performed by the Sieve script. Refer to the runtime trace
+the operations performed by the Sieve script. Refer to the runtime trace
debugging section below. The trace information is written to the specified file.
Using '\-' as filename causes the trace data to be written to \fBstdout\fP.
.TP
.BI \-T\ trace\-option
Configures runtime trace debugging, which is enabled with the \fP\-t\fP option.
-Refer to the runtime trace debugging section below.
+Refer to the runtime trace debugging section below.
.TP
.BI \-x\ extensions
-Set the available extensions. The parameter is a space\-separated list of the
+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 default set of
-extensions. If no extensions have a \fB+\fP or \fB\-\fP prefix, only those
+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. By default, all supported extensions are
+ignored and a warning is produced. By default, all supported extensions are
available, except for deprecated extensions or those that are still under
development.
@@ -112,23 +112,23 @@ except for the enotify extension.
.SH ARGUMENTS
.TP
.I script\-file
-Specifies the script to (compile and) execute.
+Specifies the script to (compile and) execute.
-Note that this tool looks for a pre\-compiled binary file with a \fI.svbin\fP
+Note that this tool looks for a pre\-compiled binary file with a \fI.svbin\fP
extension and with basename and path identical to the specified script. Use the
-\fB\-C\fP option to disable this behavior by forcing the script to be compiled
+\fB\-C\fP option to disable this behavior by forcing the script to be compiled
into a new binary.
-.TP
+.TP
.I mail\-file
-Specifies the file containing the e\-mail message to test with.
+Specifies the file containing the e\-mail message to test with.
.\"------------------------------------------------------------------------
.SH USAGE
.SS RUNTIME TRACE DEBUGGING
.PP
-Using the \fB-t\fP option, the \fBsieve\-test\fP tool can be configured to print
+Using the \fB\-t\fP option, the \fBsieve\-test\fP tool can be configured to print
detailed trace information on the Sieve script execution to a file or standard
output. For example, the encountered commands, the performed tests and the
-matched values can be printed.
+matched values can be printed.
.PP
The runtime trace can be configured using the \fB\-T\fP option, which can be
specified multiple times. It can be used as follows:
@@ -138,7 +138,7 @@ specified multiple times. It can be used as follows:
Set the detail level of the trace debugging. One of the following values can
be supplied:
.RS 2
-.TP 3
+.TP 3
\fIactions\fP (default)
Only print executed action commands, like keep, fileinto, reject and redirect.
.TP
@@ -150,39 +150,39 @@ Print all executed commands and performed tests.
.TP
\fImatching\fP
Print all executed commands, performed tests and the values matched in those
-tests.
+tests.
.RE
.TP 2
\fB\-Tdebug\fP
-Print debug messages as well. This is usually only useful for developers and
+Print debug messages as well. This is usually only useful for developers and
is likely to produce messy output.
.TP
\fB\-Taddresses\fP
Print byte code addresses for the current trace output. Normally, only the
-current Sieve source code position (line number) is printed. The byte code
-addresses are equal to those listed in a binary dump produced using the
+current Sieve source code position (line number) is printed. The byte code
+addresses are equal to those listed in a binary dump produced using the
\fB\-d\fP option or by the \fBsieve\-dump(1)\fP command.
.\"------------------------------------------------------------------------
.SS DEBUG SIEVE EXTENSION
.PP
-To improve script debugging, the Sieve command line tools such as
+To improve script debugging, the Sieve command line tools such as
\fBsieve\-test\fP support a custom Sieve language extension called
-'vnd.dovecot.debug'. It adds the \fBdebug_print\fP command that allows printing
-debug messages to \fBstdout\fP.
+\(aqvnd.dovecot.debug\(aq. It adds the \fBdebug_print\fP command that allows
+printing debug messages to \fBstdout\fP.
.PP
Example:
.PP
-require "vnd.dovecot.debug";
+require \(dqvnd.dovecot.debug\(dq;
.PP
-if header :contains "subject" "hello" {
+if header :contains \(dqsubject\(dq \(dqhello\(dq {
.PP
- debug_print "Subject header contains hello!";
+ debug_print \(dqSubject header contains hello!\(dq;
.PP
}
.PP
-Other tools like \fBsievec\fP and \fBsieve\-dump\fP also recognize the
-vnd.dovecot.debug extension. In contrast, the actual Sieve plugin for the
-Dovecot LDA (\fBdovecot-lda\fR(1)) does not allow the use of the debug
+Other tools like \fBsievec\fP and \fBsieve\-dump\fP also recognize the
+vnd.dovecot.debug extension. In contrast, the actual Sieve plugin for the
+Dovecot LDA (\fBdovecot\-lda\fR(1)) does not allow the use of the debug
extension. So, keep in mind that scripts and compiled binaries that refer to de
debug extension will fail to be run by the Sieve plugin itself.
.PP
@@ -197,7 +197,7 @@ will exit with one of the following values:
Delivery was successful. (EX_OK, EXIT_SUCCES)
.TP
.B 1
-Operation failed. This is returned for almost all failures.
+Operation failed. This is returned for almost all failures.
(EXIT_FAILURE)
.TP
.B 64
@@ -214,8 +214,8 @@ Sieve interpreter settings (included from Dovecot\(aqs main configuration file)
@INCLUDE:reporting-bugs@
.\"------------------------------------------------------------------------
.SH "SEE ALSO"
-.BR pigeonhole (7),
-.BR sievec (1),
-.BR sieve\-dump (1),
.BR dovecot (1),
-.BR dovecot-lda (1)
+.BR dovecot\-lda (1),
+.BR sieve\-dump (1),
+.BR sievec (1),
+.BR pigeonhole (7)
diff --git a/doc/man/sievec.1.in b/doc/man/sievec.1.in
index 757a203b5..26ac435cc 100644
--- a/doc/man/sievec.1.in
+++ b/doc/man/sievec.1.in
@@ -1,5 +1,5 @@
.\" Copyright (c) 2010 Pigeonhole authors, see the included COPYING file
-.TH "SIEVEC" 1 "2010-08-22" "Pigeonhole for Dovecot v2.0" "Pigeonhole"
+.TH "SIEVEC" 1 "2010-08-23" "Pigeonhole for Dovecot v2.0" "Pigeonhole"
.\"------------------------------------------------------------------------
.SH NAME
sievec \- Pigeonhole\(aqs Sieve script compiler
@@ -7,35 +7,35 @@ sievec \- Pigeonhole\(aqs Sieve script compiler
.SH SYNOPSIS
.B sievec
.RI [ options ]
-.I script\-file
+.I script\-file
.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)).
+secure IMAP and POP3 server (\fBdovecot\fR(1)).
.PP
Using the \fBsievec\fP command, Sieve scripts can be compiled into a binary
representation. The resulting binary can be used directly to process e\-mail
messages during the delivery process. The delivery of mail messages and \- by
means of the LDA Sieve plugin \- also the execution of Sieve scripts is
-performed by Dovecot\aqs local delivery agent (LDA) called \fBdovecot-lda\fP(1).
+performed by Dovecot\aqs local delivery agent (LDA) called \fBdovecot\-lda\fP(1).
Usually, it is not necessaryto compile the Sieve script manually using
-\fBsievec\fP, because \fBdovecot-lda\fP will do this automatically if the binary
-is missing. However, in some cases \fBdovecot-lda\fP does not have permission to
+\fBsievec\fP, because \fBdovecot\-lda\fP will do this automatically if the binary
+is missing. However, in some cases \fBdovecot\-lda\fP does not have permission to
write the compiled binary to disk, forcing it to recompile the script every time
-it is executed. Using the \fBsievec\fP tool, this can be performed manually by
+it is executed. Using the \fBsievec\fP tool, this can be performed manually by
an authorized user to increase performance.
.PP
The Pigeonhole Sieve implementation recognizes files with a \fB.sieve\fP
extension as Sieve scripts and corresponding files with a \fB.svbin\fP extension
as the associated compiled binary. This means for example that Dovecot\(aqs LDA
-process will first look for a binary file "dovecot.svbin" when it needs to
-execute "dovecot.sieve". It will compile a new binary when it is missing.
+process will first look for a binary file \(dqdovecot.svbin\(dq when it needs to
+execute \(dqdovecot.sieve\(dq. It will compile a new binary when it is missing.
.PP
-The \fBsievec\fP command is also useful to verify Sieve scripts before using.
-Additionally, with the \fB\-d\fP option it can output a textual (and thus
+The \fBsievec\fP command is also useful to verify Sieve scripts before using.
+Additionally, with the \fB\-d\fP option it can output a textual (and thus
human\-readable) dump of the generated Sieve code to the specified file. The
output is then identical to what the \fBsieve\-dump\fP(1) command produces for a
stored binary file. This output is mainly useful to find bugs in the compiler
@@ -45,9 +45,9 @@ that yield corrupt binaries.
.TP
.BI \-c\ config\-file
Alternative Dovecot configuration file path.
-.TP
-.B \-d
-Don't write the binary to \fIout\-file\fP, but write a textual dump of the
+.TP
+.B \-d
+Don\(aqt write the binary to \fIout\-file\fP, but write a textual dump of the
binary instead. In this context, the \fIout\-file\fP value '\-' has special
meaning: it causes the the textual dump to be written to \fBstdout\fP.
The \fIout\-file\fP argument may also be omitted, which has the same effect as
@@ -56,32 +56,32 @@ for a compiled Sieve binary file. Note that this option is not allowed when the
\fIout\-file\fP argument is a directory.
.TP
.BI \-x\ extensions
-Set the available extensions. The parameter is a space\-separated list of the
+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 default set of
-extensions. If no extensions have a \fB+\fP or \fB\-\fP prefix, only
-those extensions that are explicitly listed will be enabled. Unknown extensions
+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. By default, all supported extensions are
-available, except for deprecated extensions or those that are still under
-development.
+available, except for deprecated extensions or those that are still under
+development.
For example \fB\-x\fP "+imapflags \-enotify" will enable the deprecated
-imapflags extension along with all extensions that are available by default,
+imapflags extension along with all extensions that are available by default,
except for the enotify extension.
.\"------------------------------------------------------------------------
.SH ARGUMENTS
-.TP
+.TP
.I script\-file
-Specifies the script to be compiled. If the \fIscript\-file\fP argument is a
-directory, all files in that directory with a \fI.sieve\fP extension are
+Specifies the script to be compiled. If the \fIscript\-file\fP argument is a
+directory, all files in that directory with a \fI.sieve\fP extension are
compiled into a corresponding \fI.svbin\fP binary file. The compilation is not
halted upon errors; it attempts to compile as many scripts in the directory as
possible. Note that the \fB\-d\fP option and the \fIout\-file\fP argument are
not allowed when the \fIscript\-file\fP argument is a directory.
-.TP
+.TP
.I out\-file
Specifies where the (binary) output is to be written. This argument is optional.
-If omitted a binary compiled from <scriptname>.sieve is saved as
+If omitted a binary compiled from <scriptname>.sieve is saved as
<scriptname>.svbin. If \fB\-b\fP is specified, the binary dump is output to
\fBstdout\fP.
.\"------------------------------------------------------------------------
@@ -93,7 +93,7 @@ will exit with one of the following values:
Delivery was successful. (EX_OK, EXIT_SUCCES)
.TP
.B 1
-Operation failed. This is returned for almost all failures.
+Operation failed. This is returned for almost all failures.
(EXIT_FAILURE)
.TP
.B 64
@@ -110,8 +110,8 @@ Sieve interpreter settings (included from Dovecot\(aqs main configuration file)
@INCLUDE:reporting-bugs@
.\"------------------------------------------------------------------------
.SH "SEE ALSO"
-.BR pigeonhole (7),
-.BR sieve\-test (1),
-.BR sieve\-dump (1),
.BR dovecot (1),
-.BR dovecot-lda (1)
+.BR dovecot\-lda (1),
+.BR sieve\-dump (1),
+.BR sieve\-test (1),
+.BR pigeonhole (7)
--
GitLab