dovecot-2.0-pigeonhole: Cleaned up manpages and fixed various is...
pigeonhole at rename-it.nl
pigeonhole at rename-it.nl
Mon Aug 23 10:10:37 EEST 2010
details: http://hg.rename-it.nl/dovecot-2.0-pigeonhole/rev/4dd2538ec95b
changeset: 1385:4dd2538ec95b
user: Stephan Bosch <stephan at rename-it.nl>
date: Mon Aug 23 09:10:11 2010 +0200
description:
Cleaned up manpages and fixed various issues (patch by Pascal Volk).
- No longer track the generated pigeonhole.7
- Some makes don't like the 'handy' notation that was used.
- Deleted trailing spaces
- Escaped some dashes
- Replaced some ' and " by \(aq and \(dq
- Sorted manual pages in section 'See also'
(first list all man pages from the lowest section (1)
alphabetical sorted, then the next section ?)
diffstat:
.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(-)
diffs (truncated from 751 to 300 lines):
diff -r b2e31e71f20d -r 4dd2538ec95b .hgignore
--- a/.hgignore Mon Aug 23 00:27:08 2010 +0200
+++ b/.hgignore Mon Aug 23 09:10:11 2010 +0200
@@ -59,6 +59,7 @@
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 -r b2e31e71f20d -r 4dd2538ec95b doc/man/Makefile.am
--- a/doc/man/Makefile.am Mon Aug 23 00:27:08 2010 +0200
+++ b/doc/man/Makefile.am Mon Aug 23 09:10:11 2010 +0200
@@ -28,10 +28,22 @@
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 -r b2e31e71f20d -r 4dd2538ec95b doc/man/pigeonhole.7
--- a/doc/man/pigeonhole.7 Mon Aug 23 00:27:08 2010 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -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 at 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 -r b2e31e71f20d -r 4dd2538ec95b doc/man/pigeonhole.7.in
--- a/doc/man/pigeonhole.7.in Mon Aug 23 00:27:08 2010 +0200
+++ b/doc/man/pigeonhole.7.in Mon Aug 23 09:10:11 2010 +0200
@@ -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 @@
.\"------------------------------------------------------------------------
.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 -r b2e31e71f20d -r 4dd2538ec95b doc/man/sieve-dump.1.in
--- a/doc/man/sieve-dump.1.in Mon Aug 23 00:27:08 2010 +0200
+++ b/doc/man/sieve-dump.1.in Mon Aug 23 09:10:11 2010 +0200
@@ -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 @@
.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 @@
main program is a disassembly listing of the interpreter operations. Extensions
More information about the dovecot-cvs
mailing list