From a0b5c2fcbd514d0527a390c2f3359e2ea1401ab2 Mon Sep 17 00:00:00 2001 From: Stephan Bosch <stephan@rename-it.nl> Date: Sat, 23 Jan 2010 00:45:11 +0100 Subject: [PATCH] Fixed '-' in man pages. --- doc/man/sieve-filter.1 | 86 ++++++++++++++++++------------------ doc/man/sieve-test.1 | 98 +++++++++++++++++++++--------------------- doc/man/sievec.1 | 44 +++++++++---------- doc/man/sieved.1 | 24 +++++------ 4 files changed, 126 insertions(+), 126 deletions(-) diff --git a/doc/man/sieve-filter.1 b/doc/man/sieve-filter.1 index 115ffe6ab..8ca703185 100644 --- a/doc/man/sieve-filter.1 +++ b/doc/man/sieve-filter.1 @@ -1,12 +1,12 @@ -.TH "SIEVE-FILTER" "1" "5 August 2009" +.TH "SIEVE\-FILTER" "1" "5 August 2009" .SH NAME -sieve-filter \- Sieve mailbox filter tool for the Dovecot secure IMAP server +sieve\-filter \- Sieve mailbox filter tool for the Dovecot secure IMAP server .PP \fBWARNING: \fRThis tool is not finished and should \fB*NOT*\fR be used, unless you feel like testing newly developed 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 [\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 @@ -15,9 +15,9 @@ delve into the complexity of namespaces] .SH DESCRIPTION .PP -The \fBsieve-filter\fP command is part of the Pigeonhole Sieve implementation for the Dovecot secure +The \fBsieve\-filter\fP command is part of the Pigeonhole Sieve implementation for the Dovecot secure IMAP server. Sieve (RFC 5228) is a simple and highly extensible language for filtering -e-mail messages. It can be implemented for any type of mail access protocol, mail +e\-mail messages. It can be implemented for any type of mail access protocol, mail architecture and operating system. The language cannot execute external programs and in its basic form it does not provide the means to cause infinite loops, making it suitable for running securely on mail servers where mail users have no permission run arbitrary programs. @@ -25,55 +25,55 @@ for running securely on mail servers where mail users have no permission run arb The Sieve language was originally meant for filtering messages upon delivery. However, there are occasions when it is desirable to filter messages that are already stored in a mailbox, for instance when a bug in a Sieve script caused many messages to be delivered incorrectly. -Using the sieve-filter tool it is possible to apply a Sieve script on all messages in a particular +Using the sieve\-filter tool it is possible to apply a Sieve script on all messages in a particular mailbox, making it possible to delete messages, to store them in a different folder and to change the assigned IMAP flags and keywords. Attempts to send messages to the outside world are ignored by default for obvious reasons, but, using the proper command line options, it is possible to capture outgoing mail as well. .PP -The command has three mandatory arguments: the \fIscript-file\fP argument, which specifies the path of the -Sieve script, the \fIsource-location\fP argument, which specifies the mail storage of the source mailbox -(e.g. `maildir:~/Maildir'), and the \fIsoure-mailbox\fP argument, which specifies the name of the source +The command has three mandatory arguments: the \fIscript\-file\fP argument, which specifies the path of the +Sieve script, the \fIsource\-location\fP argument, which specifies the mail storage of the source mailbox +(e.g. `maildir:~/Maildir'), and the \fIsoure\-mailbox\fP argument, which specifies the name of the source mailbox within the specified mail storage (e.g. `INBOX.Spam'). .PP This tool does not (yet) use Dovecot's configuration file to obtain information on namespaces and the location of mailboxes. Therefore, any used namespaces need to be specified on the command line. These -specifications directly follow the \fIsource-mailbox\fP parameter. The first specified namespace will +specifications directly follow the \fIsource\-mailbox\fP parameter. The first specified namespace will be the INBOX namespace. .PP -If no namespaces are defined on the commandline, the source-location is used as the default mail store +If no namespaces are defined on the commandline, the source\-location is used as the default mail store where the INBOX is located. This means that the keep action could operate on the folder the message originates from. In this case the message remains untouched and it is not duplicated, but IMAP flags and keywords can be evaluated and changed with the imap4flags extension . If namespaces are defined explicitly, the source location is available as a namespace with prefix `#src/'. .PP -If no options are specified, the sieve-filter command runs in a simulation mode in which it only -prints what would be performed, without actually doing anything. Use the \fB-e\fP option to activate -true script execution. Also, the source mailbox is opened read-only by default, so that the source mailbox -remains unchanged. Use the \fB-W\fP to allow changes in the source mailbox. +If no options are specified, the sieve\-filter command runs in a simulation mode in which it only +prints what would be performed, without actually doing anything. Use the \fB\-e\fP option to activate +true script execution. Also, the source mailbox is opened read\-only by default, so that the source mailbox +remains unchanged. Use the \fB\-W\fP to allow changes in the source mailbox. .SH CAUTION Although this is a very useful tool, it can also be very destructive when used improperly. A small bug in your Sieve script in combination with the wrong command line options could cause it to -discard (many) more e-mails than it was supposed to. Therefore, users are advised to read this manual +discard (many) more e\-mails than it was supposed to. Therefore, users are advised to read this manual carefully and to use the simulation mode first to check what the script will do. .PP \fBMAKING A BACKUP IS IMPERATIVE FOR ANY IMPORTANT MAIL!\fP .PP -By default, it will open the source mailbox in a read-only mode, such that it will not delete any of your -e-mails. However, it can still litter other mailboxes with spurious copies of your e-mails if your +By default, it will open the source mailbox in a read\-only mode, such that it will not delete any of your +e\-mails. However, it can still litter other mailboxes with spurious copies of your e\-mails if your Sieve script decides to do so. .SH OPTIONS .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 -a copy operation is executed by default and the source mailbox is not altered. The \fIsource-action\fP -parameter of the \fB-D\fP option can take four different values: +\fB\-D\fP \fIsource\-action\fP +By default, the sieve\-filter command does not delete the messages from the source mailbox. This means that +a copy operation is executed by default and the source mailbox is not altered. The \fIsource\-action\fP +parameter of the \fB\-D\fP option can take four different values: .RS 7 .TP \fBkeep\fP (default) -Keep messages in source folder. If \fB-W\fR is specified and the source mailbox is the destination of +Keep messages in source folder. If \fB\-W\fR is specified and the source mailbox is the destination of a keep or fileinto action, flags can be changed by the Sieve script. Messages are never duplicated in the source mailbox. .TP @@ -86,51 +86,51 @@ Move messages to the indicated \fIfolder\fP. \fBexpunge\fP Expunge messages, meaning that these are removed irreversibly when the tool finishes filtering. .PP -Note that values other than `keep' have no effect, unless the \fB-W\fP option is specified as well. +Note that values other than `keep' have no effect, unless the \fB\-W\fP option is specified as well. .RE .TP -\fB-e\fP -Turns on execution mode. By default, the sieve-filter command runs in simulation mode in which it +\fB\-e\fP +Turns on execution mode. By default, the sieve\-filter command runs in simulation mode in which it changes nothing, meaning that no mailbox is altered in any way and no actions are performed. It only -prints what would be done. Using this option the sieve-filter command becomes active and performs the +prints what would be done. Using this option the sieve\-filter command becomes active and performs the requested actions. .TP -\fB-f\fP \fIenvelope-sender\fP +\fB\-f\fP \fIenvelope\-sender\fP 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. .TP -\fB-m\fP \fIdefault-mailbox\fP +\fB\-m\fP \fIdefault\-mailbox\fP The mailbox within the default namespace where the keep action stores the message. This is "INBOX" by default. .TP -\fB-Q\fP \fImail-command\fP -Send outgoing e-mail through the specified program. By default, the sieve-filter command ignores +\fB\-Q\fP \fImail\-command\fP +Send outgoing e\-mail through the specified program. By default, the sieve\-filter command ignores Sieve actions such as redirect, reject, vacation and notify, but using this option outgoing messages can be fed to the \fBstdin\fP of an external shell command. This option has no effect in simulation mode, Unless you really know what you are doing, \fBDO NOT USE THIS TO FEED MAIL TO SENDMAIL!\f. .TP -\fB-r\fP \fIrecipient-address\fP +\fB\-r\fP \fIrecipient\-address\fP 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. +envelope part is requested. Some tests and actions will also use this as the owner's e\-mail address. .TP -\fB-S\fP \fIscript-file\fP -Specify additional scripts to be executed before the main script. Multiple \fB-s\fP arguments are +\fB\-S\fP \fIscript\-file\fP +Specify additional scripts to be executed before the main script. Multiple \fB\-s\fP arguments are allowed and the specified scripts are executed sequentially in the order specified at the command line. .TP -\fB-W\fP +\fB\-W\fP Enables write access to the source mailbox. This allows deleting the messages from the source mailbox and changing the assigned IMAP flags and keywords. .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 -relative to the default set of extensions. If no extensions have a \fB+\fP or \fB-\fP prefix, only +\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 +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 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 +For example \fB\-x\fP "+imapflags \-enotify" will enable the deprecated imapflags extension along with all extensions that are available by default, except for the enotify extension. .SH EXAMPLES @@ -140,14 +140,14 @@ extensions that are available by default, except for the enotify extension. .SH AUTHOR .PP -The Sieve implementation for Dovecot was written by Stephan Bosch <stephan@rename-it.nl>. +The Sieve implementation for Dovecot was written by Stephan Bosch <stephan@rename\-it.nl>. .PP Dovecot was written by Timo Sirainen <tss@iki.fi>. .SH "SEE ALSO" .BR sievec (1), .BR sieved (1), -.BR sieve-test (1) +.BR sieve\-test (1) .PP Dovecot website: http://www.dovecot.org .PP diff --git a/doc/man/sieve-test.1 b/doc/man/sieve-test.1 index 3ea71244a..f46113b10 100644 --- a/doc/man/sieve-test.1 +++ b/doc/man/sieve-test.1 @@ -1,105 +1,105 @@ -.TH "SIEVE-TEST" "1" "4 July 2009" +.TH "SIEVE\-TEST" "1" "4 July 2009" .SH NAME -sieve-test \- Sieve script tester for the Dovecot secure IMAP server +sieve\-test \- Sieve script tester for the Dovecot secure IMAP server .SH SYNOPSIS -sieve-test -[\fB-c\fR] -[\fB-d\fR \fIdump-file\fR] -[\fB-e\fR] -[\fB-f\fR \fIenvelope-sender\fR] -[\fB-l\fR \fImail-location\fR] -[\fB-m\fR \fIdefault-mailbox\fR] -[\fB-r\fR \fIrecipient-address\fR] -[\fB-s\fR \fIscript-file\fR] -[\fB-t\fR] -[\fB-x\fR "\fIextension extension ...\fR"] -\fIscript-file\fR \fImail-file\fR +sieve\-test +[\fB\-c\fR] +[\fB\-d\fR \fIdump\-file\fR] +[\fB\-e\fR] +[\fB\-f\fR \fIenvelope\-sender\fR] +[\fB\-l\fR \fImail\-location\fR] +[\fB\-m\fR \fIdefault\-mailbox\fR] +[\fB\-r\fR \fIrecipient\-address\fR] +[\fB\-s\fR \fIscript\-file\fR] +[\fB\-t\fR] +[\fB\-x\fR "\fIextension extension ...\fR"] +\fIscript\-file\fR \fImail\-file\fR .SH DESCRIPTION .PP -The \fBsieve-test\fP command is part of the Pigeonhole Sieve implementation for the Dovecot secure +The \fBsieve\-test\fP command is part of the Pigeonhole Sieve implementation for the Dovecot secure IMAP server. Sieve (RFC 5228) is a simple and highly extensible language for filtering -e-mail messages. It can be implemented for any type of mail access protocol, mail +e\-mail messages. It can be implemented for any type of mail access protocol, mail architecture and operating system. The language cannot execute external programs and in its basic form it does not provide the means to cause infinite loops, making it suitable for running securely on mail servers where mail users have no permission run arbitrary programs. .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 +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 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 +Note that, even when \fB\-e\fP is specified, no messages are ever transmitted to remote SMTP recipients. The outgoing messages are printed 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 provide more detailed information about script execution problems that are reported by the Sieve plugin. .PP -The command has two mandatory arguments: the \fIscript-file\fP argument, which specifies the -script to (compile and) execute, and the \fImail-file\fP argument, which specifies the file -containing the e-mail message to filter. +The command has two mandatory arguments: the \fIscript\-file\fP argument, which specifies the +script to (compile and) execute, and the \fImail\-file\fP argument, which specifies the file +containing the e\-mail message to filter. -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 +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 into a new binary. .SH OPTIONS .TP -\fB-c\fP +\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 +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 Sieve compilation. .TP -\fB-d\fP \fIdump-file\fP +\fB\-d\fP \fIdump\-file\fP Causes a dump of the generated code to be written to the specified file. This is identical to the -dump produced by \fBsieved\fR(1). Using '-' as filename causes the dump to be written to \fBstdout\fP. +dump produced by \fBsieved\fR(1). Using '\-' as filename causes the dump to be written to \fBstdout\fP. .TP -\fB-e\fP +\fB\-e\fP Turns on true execution of the set of actions that results from running the script. In combination -with the \fB-l\fP parameter, the actual delivery of messages can be tested. Note that this will +with the \fB\-l\fP parameter, the actual delivery of 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 -\fB-f\fP \fIenvelope-sender\fP +\fB\-f\fP \fIenvelope\-sender\fP 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. .TP -\fB-l\fP \fImail-location\fP -The location of the user's mail store. The syntax of this option's \fImail-location\fP parameter +\fB\-l\fP \fImail\-location\fP +The location of the user's mail store. The syntax of this option's \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 \fB-l\fP is omitted when \fB-e\fP is specified, mail store actions like fileinto and keep are +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 -\fB-m\fP \fIdefault-mailbox\fP +\fB\-m\fP \fIdefault\-mailbox\fP The mailbox where the keep action stores the message. This is "INBOX" by default. .TP -\fB-r\fP \fIrecipient-address\fP +\fB\-r\fP \fIrecipient\-address\fP 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. +envelope part is requested. Some tests and actions will also use this as the owner's e\-mail address. .TP -\fB-s\fP \fIscript-file\fP -Specify additional scripts to be executed before the main script. Multiple \fB-s\fP arguments are +\fB\-s\fP \fIscript\-file\fP +Specify additional scripts to be executed before the main script. Multiple \fB\-s\fP arguments are allowed and the specified scripts are executed sequentially in the order specified at the command line. .TP -\fB-t\fP +\fB\-t\fP Enable simple trace debugging; prints all encountered byte code instructions to \fBstdout\fP. This is currently only intelligible for developers. .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 -relative to the default set of extensions. If no extensions have a \fB+\fP or \fB-\fP prefix, only +\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 +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 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 +For example \fB\-x\fP "+imapflags \-enotify" will enable the deprecated imapflags extension along with all extensions that are available by default, except for the enotify extension. .SH DEBUG SUPPORT .PP -To improve script debugging, the Sieve command line tools such as \fBsieve-test\fP support a custom +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. .PP @@ -118,10 +118,10 @@ the actual Sieve plugin for the Dovecot LDA does not allow the use of the debug scripts and compiled binaries that refer to de debug extension will fail to be run by the Sieve plugin itself. .PP Note that it is not necessary to enable nor possible to disable the availability of the debug extension with -the \fB-x\fP option. +the \fB\-x\fP option. .SH AUTHOR .PP -Pigeonhole for Dovecot was written by Stephan Bosch <stephan@rename-it.nl>. +Pigeonhole for Dovecot was written by Stephan Bosch <stephan@rename\-it.nl>. .PP Dovecot was written by Timo Sirainen <tss@iki.fi>. .SH "SEE ALSO" diff --git a/doc/man/sievec.1 b/doc/man/sievec.1 index 146c34482..34492720c 100644 --- a/doc/man/sievec.1 +++ b/doc/man/sievec.1 @@ -2,18 +2,18 @@ .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\-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 IMAP server. Sieve (RFC 5228) is a simple and highly extensible language for filtering -e-mail messages. It can be implemented for any type of mail access protocol, mail +e\-mail messages. It can be implemented for any type of mail access protocol, mail architecture and operating system. The language cannot execute external programs and in its basic form it does not provide the means to cause infinite loops, making it suitable for running securely on mail servers where mail users have no permission run arbitrary programs. .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 resulting binary can be used directly to process e\-mail messages during the delivery process. The delivery of mail messages and therefore also the execution of Sieve scripts is performed by Dovecot's local delivery agent (LDA) called \fBdeliver\fP. Usually, it is not necessary to compile the Sieve script manually using \fBsievec\fP, because \fBdeliver\fP will do @@ -22,53 +22,53 @@ permission to write the compiled binary to disk, forcing it to recompile the scr is executed. Using the \fBsievec\fP tool, this can be performed manually by an authorized user to increase performance. .PP -The \fBsievec\fP command accepts two arguments: the \fIscript-file\fP argument specifies the -script to be compiled and the \fIout-file\fR argument specifies where the (binary) output is to +The \fBsievec\fP command accepts two arguments: the \fIscript\-file\fP argument specifies the +script to be compiled and the \fIout\-file\fR argument specifies where the (binary) output is to be written. This Sieve implementation reconizes 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's deliver process will look for a binary file 'dovecot.svbin' when it needs to execute 'dovecot.sieve'. Such filename is chosen automatically for the binary output -when the out-file argument is missing. +when the out\-file argument is missing. .PP -If the \fIscript-file\fP argument is a directory, all files in that directory with a \fI.sieve\fP +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 +\fB\-d\fP option and the \fIout\-file\fP argument are not allowed when the \fIscript\-file\fP argument is a directory. .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 human-readable) dump of the generated Sieve +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 \fBsieved\fP(1) command produces for a stored binary file. This output is mainly useful to find bugs in the compiler that yield corrupt binaries. .SH OPTIONS .TP -\fB-d\fP -Don't write the binary to \fIout-file\fP, but write a textual dump of the binary in -stead. 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 '-'. The output is identical to what the \fBsieved\fP(1) command produces for -a compiled Sieve binary file. Note that this option is not allowed when the \fIout-file\fP argument +\fB\-d\fP +Don't write the binary to \fIout\-file\fP, but write a textual dump of the binary in +stead. 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 '\-'. The output is identical to what the \fBsieved\fP(1) command produces for +a compiled Sieve binary file. Note that this option is not allowed when the \fIout\-file\fP argument is a directory. .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 -relative to the default set of extensions. If no extensions have a \fB+\fP or \fB-\fP prefix, only +\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 +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 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 +For example \fB\-x\fP "+imapflags \-enotify" will enable the deprecated imapflags extension along with all extensions that are available by default, except for the enotify extension. .SH AUTHOR .PP -Pigeonhole for Dovecot was written by Stephan Bosch <stephan@rename-it.nl>. +Pigeonhole for Dovecot was written by Stephan Bosch <stephan@rename\-it.nl>. .PP Dovecot was written by Timo Sirainen <tss@iki.fi>. .SH "SEE ALSO" .BR sieved (1), -.BR sieve-test (1) +.BR sieve\-test (1) .PP Dovecot website: http://www.dovecot.org .PP diff --git a/doc/man/sieved.1 b/doc/man/sieved.1 index 699dc36a9..48d8a22fe 100644 --- a/doc/man/sieved.1 +++ b/doc/man/sieved.1 @@ -2,26 +2,26 @@ .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\-x\fR "\fIextension extension ...\fR"] \fIsieve\-binary\fR [\fIout\-file\fR] .br .SH DESCRIPTION .PP The \fBsieved\fP command is part of the Pigeonhole Sieve implementation for the Dovecot secure IMAP server. Sieve (RFC 5228) is a simple and highly extensible language for filtering -e-mail messages. It can be implemented for any type of mail access protocol, mail +e\-mail messages. It can be implemented for any type of mail access protocol, mail architecture and operating system. The language cannot execute external programs and in its basic form it does not provide the means to cause infinite loops, making it suitable for running securely on mail servers where mail users have no permission run arbitrary programs. .PP Using the \fBsieved\fP command, Sieve binaries, which are produced for instance by -\fBsievec\fP(1), can be transformed into a human-readable textual representation. This can +\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 \fIsieve-binary\fR argument specifies the Sieve binary file that needs to be dumped. The -optional \fIout-file\fR argument specifies where the output must be written. If omitted, the +The \fIsieve\-binary\fR argument specifies the Sieve binary file that needs to be dumped. The +optional \fIout\-file\fR argument specifies where the output must be written. If omitted, the output is written to \fBstdout\fR. .PP The format of the output is not explained here in detail, but it should be relatively easy @@ -34,24 +34,24 @@ 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-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 -relative to the default set of extensions. If no extensions have a \fB+\fP or \fB-\fP prefix, only +\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 +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 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 +For example \fB\-x\fP "+imapflags \-enotify" will enable the deprecated imapflags extension along with all extensions that are available by default, except for the enotify extension. .SH AUTHOR .PP -Pigeonhole for Dovecot was written by Stephan Bosch <stephan@rename-it.nl>. +Pigeonhole for Dovecot was written by Stephan Bosch <stephan@rename\-it.nl>. .PP Dovecot was written by Timo Sirainen <tss@iki.fi>. .SH "SEE ALSO" .BR sievec (1), -.BR sieve-test (1) +.BR sieve\-test (1) .PP Dovecot website: http://www.dovecot.org .PP -- GitLab