dovecot-2.0-pigeonhole: Update man pages to match style and cont...
pigeonhole at rename-it.nl
pigeonhole at rename-it.nl
Mon Aug 23 01:28:05 EEST 2010
details: http://hg.rename-it.nl/dovecot-2.0-pigeonhole/rev/b2e31e71f20d
changeset: 1384:b2e31e71f20d
user: Stephan Bosch <stephan at rename-it.nl>
date: Mon Aug 23 00:27:08 2010 +0200
description:
Update man pages to match style and content of Dovecot man pages.
diffstat:
.hgignore | 5 +
TODO | 1 -
doc/man/Makefile.am | 30 +++++-
doc/man/pigeonhole.7 | 98 +++++++++++++++++++
doc/man/pigeonhole.7.in | 93 ++++++++++++++++++
doc/man/reporting-bugs.inc | 6 +
doc/man/sed.sh | 11 ++
doc/man/sieve-dump.1 | 61 ------------
doc/man/sieve-dump.1.in | 95 +++++++++++++++++++
doc/man/sieve-filter.1 | 157 -------------------------------
doc/man/sieve-filter.1.in | 160 ++++++++++++++++++++++++++++++++
doc/man/sieve-test.1 | 182 ------------------------------------
doc/man/sieve-test.1.in | 221 ++++++++++++++++++++++++++++++++++++++++++++
doc/man/sievec.1 | 78 ---------------
doc/man/sievec.1.in | 117 +++++++++++++++++++++++
15 files changed, 831 insertions(+), 484 deletions(-)
diffs (truncated from 1398 to 300 lines):
diff -r b5b2763494e5 -r b2e31e71f20d .hgignore
--- a/.hgignore Sat Aug 21 23:23:35 2010 +0200
+++ b/.hgignore Mon Aug 23 00:27:08 2010 +0200
@@ -55,6 +55,11 @@
**/.libs
**/.deps
+doc/man/sievec.1
+doc/man/sieve-dump.1
+doc/man/sieve-test.1
+doc/man/sieve-filter.1
+
src/sieve-tools/sievec
src/sieve-tools/sieve-dump
src/sieve-tools/sieve-test
diff -r b5b2763494e5 -r b2e31e71f20d TODO
--- a/TODO Sat Aug 21 23:23:35 2010 +0200
+++ b/TODO Mon Aug 23 00:27:08 2010 +0200
@@ -10,7 +10,6 @@
Next (in order of descending priority/precedence):
-* Update man pages to match style of Dovecot man pages.
* Enforce ManageSieve protocol syntax better with some of the commands. Some
commands still allow spurious extra arguments.
* Code cleanup:
diff -r b5b2763494e5 -r b2e31e71f20d doc/man/Makefile.am
--- a/doc/man/Makefile.am Sat Aug 21 23:23:35 2010 +0200
+++ b/doc/man/Makefile.am Mon Aug 23 00:27:08 2010 +0200
@@ -2,16 +2,36 @@
if BUILD_UNFINISHED
unfinished_mans = $(unfinished)
-else
-unfinished_dist = $(unfinished)
endif
-EXTRA_DIST = \
- $(unfinished_dist)
+dist_man1_MANS = \
+ sieved.1
-dist_man_MANS = \
+nodist_man1_MANS = \
sievec.1 \
sieve-dump.1 \
sieve-test.1 \
$(unfinished_mans)
+nodist_man7_MANS = \
+ pigeonhole.7
+
+man_includefiles = \
+ $(srcdir)/reporting-bugs.inc
+
+EXTRA_DIST = \
+ sievec.1.in \
+ sieve-dump.1.in \
+ sieve-test.1.in \
+ sieve-filter.1.in \
+ pigeonhole.7.in
+
+CLEANFILES = $(nodist_man1_MANS) $(nodist_man7_MANS)
+
+%.1: $(srcdir)/%.1.in $(man_includefiles) Makefile
+ $(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \
+ < $(srcdir)/$< > $@
+
+%.7: $(srcdir)/%.7.in $(man_includefiles) Makefile
+ $(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \
+ < $(srcdir)/$< > $@
diff -r b5b2763494e5 -r b2e31e71f20d doc/man/pigeonhole.7
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/man/pigeonhole.7 Mon Aug 23 00:27:08 2010 +0200
@@ -0,0 +1,98 @@
+.\" 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 b5b2763494e5 -r b2e31e71f20d doc/man/pigeonhole.7.in
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/man/pigeonhole.7.in Mon Aug 23 00:27:08 2010 +0200
@@ -0,0 +1,93 @@
+.\" 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.
+.\"------------------------------------------------------------------------
+ at INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.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 b5b2763494e5 -r b2e31e71f20d doc/man/reporting-bugs.inc
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/man/reporting-bugs.inc Mon Aug 23 00:27:08 2010 +0200
@@ -0,0 +1,6 @@
+.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
diff -r b5b2763494e5 -r b2e31e71f20d doc/man/sed.sh
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/man/sed.sh Mon Aug 23 00:27:08 2010 +0200
@@ -0,0 +1,11 @@
+#!/bin/sh
+
+SRCDIR="${1:-`pwd`}"
+RUNDIR="${2:-/usr/local/var/run/dovecot}"
+PKGSYSCONFDIR="${3:-/usr/local/etc/dovecot}"
+
+sed -e "/^@INCLUDE:reporting-bugs@$/{
+ r ${SRCDIR}/reporting-bugs.inc
+ d
+ }" | sed -e "s|@pkgsysconfdir@|${PKGSYSCONFDIR}|" -e "s|@rundir@|${RUNDIR}|"
+
diff -r b5b2763494e5 -r b2e31e71f20d doc/man/sieve-dump.1
--- a/doc/man/sieve-dump.1 Sat Aug 21 23:23:35 2010 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,61 +0,0 @@
-.TH "SIEVE-DUMP" "1" "11 July 2010"
More information about the dovecot-cvs
mailing list