[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[SCM] GNU Mailutils branch, master, updated. release-2.2-426-g3ec5d07
|
From: |
Sergey Poznyakoff |
|
Subject: |
[SCM] GNU Mailutils branch, master, updated. release-2.2-426-g3ec5d07 |
|
Date: |
Sat, 05 Nov 2011 23:50:10 +0000 |
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GNU Mailutils".
http://git.savannah.gnu.org/cgit/mailutils.git/commit/?id=3ec5d07e67044b614b8beab0e34908b4eec23eab
The branch, master has been updated
via 3ec5d07e67044b614b8beab0e34908b4eec23eab (commit)
from 6d9c7d666f83da5d9f69d7e30b138d1a6e2e69da (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 3ec5d07e67044b614b8beab0e34908b4eec23eab
Author: Sergey Poznyakoff <address@hidden>
Date: Sun Nov 6 01:45:07 2011 +0200
Update docs + minor changes.
* .gitmodules: Add imprimatur.
* Makefile.am: Likewise.
* configure.ac: Likewise.
* doc/Makefile.am: Likewise.
* bootstrap.conf: Comment out make in doc/texinfo
* doc/texinfo/Makefile.am: Rewrite.
* doc/texinfo/fdl.texi: Minor change.
* doc/texinfo/getdate.texi: Minor change.
* doc/texinfo/mailutils.texi: begin rewrite.
* doc/texinfo/mu-mh.texi: Minor change.
* doc/texinfo/programs.texi: begin rewrite.
* doc/texinfo/sieve.texi: Minor change.
* doc/texinfo/usage.texi: Minor change.
* libmailutils/cfg/lexer.l: Allow for @ in unquoted strings
* pop3d/bulletin.c: Relax safety checks for bulletin.db
* pop3d/logindelay.c: Relax safety checks for stat.sb
* pop3d/pop3d.h (DEFAULT_GROUP_DB_SAFETY): New define.
-----------------------------------------------------------------------
Summary of changes:
.gitmodules | 3 +
Makefile.am | 2 +-
bootstrap.conf | 2 +-
configure.ac | 18 +-
doc/Makefile.am | 2 +-
doc/imprimatur | 1 +
doc/texinfo/.gitignore | 4 +
doc/texinfo/Makefile.am | 181 +--
doc/texinfo/fdl.texi | 85 +-
doc/texinfo/getdate.texi | 134 +-
doc/texinfo/mailutils.texi | 436 ++----
doc/texinfo/mu-mh.texi | 74 +-
doc/texinfo/programs.texi | 3751 ++++++++++++++++++++++++++++----------------
doc/texinfo/sieve.texi | 270 ++--
doc/texinfo/usage.texi | 48 +-
libmailutils/cfg/lexer.l | 2 +-
pop3d/bulletin.c | 4 +
pop3d/logindelay.c | 4 +-
pop3d/pop3d.h | 11 +
19 files changed, 2913 insertions(+), 2119 deletions(-)
create mode 160000 doc/imprimatur
diff --git a/.gitmodules b/.gitmodules
index 7c369d4..f3199f7 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -1,3 +1,6 @@
[submodule "gint"]
path = gint
url = git://git.gnu.org.ua/gint.git
+[submodule "doc/imprimatur"]
+ path = doc/imprimatur
+ url = git://git.gnu.org.ua/imprimatur.git
diff --git a/Makefile.am b/Makefile.am
index 8d2f5ab..c97aa4d 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -15,7 +15,7 @@
## You should have received a copy of the GNU General Public License
## along with GNU Mailutils. If not, see <http://www.gnu.org/licenses/>.
-ACLOCAL_AMFLAGS = -I m4 -I am -I gint
+ACLOCAL_AMFLAGS = -I m4 -I am -I gint -I doc/imprimatur
if MU_COND_PYTHON
PYTHON_DIR = python
diff --git a/bootstrap.conf b/bootstrap.conf
index 66621f2..0139225 100644
--- a/bootstrap.conf
+++ b/bootstrap.conf
@@ -100,5 +100,5 @@ done
wget -P m4 http://git.savannah.gnu.org/cgit/radius.git/plain/scripts/radius.m4
# Create included listings for texinfo docs.
-make -C doc/texinfo -f maint.mk
+#make -C doc/texinfo -f maint.mk
diff --git a/configure.ac b/configure.ac
index eaaea12..925a6e0 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1316,23 +1316,7 @@ dnl get sysconfdir expanded.
CPPFLAGS="$CPPFLAGS -DSYSCONFDIR=\\\"\$(sysconfdir)\\\""
# Doc hints.
-# Select a rendition level:
-# DISTRIB for stable releases (at most one dot in the version number)
-# and maintenance releases (two dots, patchlevel < 50)
-# PROOF for alpha releases.
-# PUBLISH can only be required manually when running make in doc/
-AC_SUBST(RENDITION)
-case `echo $VERSION|sed 's/[[^.]]//g'` in
-""|".") RENDITION=DISTRIB;;
-"..") if test `echo $VERSION | sed 's/.*\.//'` -lt 50; then
- RENDITION=DISTRIB
- else
- AC_DEFINE_UNQUOTED([MU_ALPHA_RELEASE], 1,
- [Define if this is an alpha release])
- RENDITION=PROOF
- fi;;
-*) RENDITION=PROOF;;
-esac
+IMPRIMATUR_INIT([doc/imprimatur])
AC_CONFIG_COMMANDS([status],[
cat <<EOF
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 4be7763..9d4a172 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -15,5 +15,5 @@
## You should have received a copy of the GNU General Public License
## along with GNU Mailutils. If not, see <http://www.gnu.org/licenses/>.
-SUBDIRS = texinfo man
+SUBDIRS = imprimatur texinfo man
EXTRA_DIST = ChangeLog.CVS rfc/README
diff --git a/doc/imprimatur b/doc/imprimatur
new file mode 160000
index 0000000..f32ef19
--- /dev/null
+++ b/doc/imprimatur
@@ -0,0 +1 @@
+Subproject commit f32ef1983968e755cd580b06e369476d7e7f88b6
diff --git a/doc/texinfo/.gitignore b/doc/texinfo/.gitignore
index 9e5dd46..1a044fb 100644
--- a/doc/texinfo/.gitignore
+++ b/doc/texinfo/.gitignore
@@ -19,6 +19,10 @@ mailutils.tmp
mailutils.toc
mailutils.tp
mailutils.vr
+mailutils.fl
+mailutils.kw
+mailutils.pdf
+mailutils.pr
mdate-sh
muint.info*
stamp-1
diff --git a/doc/texinfo/Makefile.am b/doc/texinfo/Makefile.am
index dd28976..ec99299 100644
--- a/doc/texinfo/Makefile.am
+++ b/doc/texinfo/Makefile.am
@@ -17,174 +17,53 @@
info_TEXINFOS = mailutils.texi
-INCFILES = \
- addr.inc\
- http.inc\
- mailcap.inc\
- numaddr.inc\
- sfrom.inc\
- url-parse.inc
-
-RENDITION_TEXI=rendition.texi macros.texi
-
mailutils_TEXINFOS = \
- address.texi\
- attribute.texi\
- auth.texi\
- body.texi\
- c-api.texi\
- encoding.texi\
- envelope.texi\
fdl.texi\
- folder.texi\
- framework.texi\
getdate.texi\
- headers.texi\
- imap4.texi\
- iterator.texi\
- libmu_scm.texi\
- libmu_auth.texi\
- libmu_sieve.texi\
- locker.texi\
- mailbox.texi\
- mailcap.texi\
- maildir.texi\
- mailer.texi\
- mbox.texi\
- message.texi\
- mh.texi\
+ macros.texi\
mu-mh.texi\
- mu_address.texi\
- mu_body.texi\
- mu_logger.texi\
- mu_mailbox.texi\
- mu_message.texi\
- mu_mime.texi\
- mu_scm.texi\
- nntp.texi\
- parse822.texi\
- pop3.texi\
programs.texi\
- sendmail.texi\
sieve.texi\
- smtp.texi\
- stream.texi\
usage.texi\
- url.texi\
- $(RENDITION_TEXI)\
- $(INCFILES)
+ version.texi
-DISTCLEANFILES=*.pgs *.kys *.vrs
clean-local:
rm -rf manual
-# The rendering level is one of PUBLISH, DISTRIB or PROOF.
-# Just call `make RENDITION=PROOF [target]' if you want PROOF rendition.
-
-MAKEINFOFLAGS=-D$(RENDITION)
-GENDOCS=gendocs.sh
-TEXI2DVI=texi2dvi -t '@set $(RENDITION)' -E
-
-# Make sure you set TEXINPUTS.
-# TEXINPUTS=/usr/share/texmf/pdftex/plain/misc/ is ok for most distributions
-
-TEXINPUTS=$(srcdir):$(top_srcdir)/build-aux:$$TEXINPUTS
-
-manual:
- TEXINPUTS=$(srcdir):$(top_srcdir)/build-aux:$(TEXINPUTS) \
- MAKEINFO="$(MAKEINFO) $(MAKEINFOFLAGS)" \
- TEXI2DVI="$(TEXI2DVI) -t @finalout" \
- $(GENDOCS) --texi2html $(PACKAGE) '$(PACKAGE_NAME) manual'
+AM_MAKEINFOFLAGS = @IMPRIMATUR_MAKEINFOFLAGS@
+# Imprimatur setup
+imprimatur_INPUT=$(info_TEXINFOS) $(mailutils_TEXINFOS)
+include ../imprimatur/imprimatur.mk
+#CHECK_DOCS=$(top_srcdir)/@IMPRIMATUR_MODULE_DIR@/check-docs.sh
-
-EXTRA_DIST=gendocs_template mastermenu.el untabify.el
+# Checking
+all-check-docs: imprimatur-basic-checks
-master-menu:
- emacs -batch -l mastermenu.el -f make-master-menu $(info_TEXINFOS)
+check-docs:
+ @$(MAKE) -k all-check-docs
-untabify:
- emacs -batch -l untabify.el $(info_TEXINFOS) $(mailutils_TEXINFOS)
+#
-fix-sentence-spacing:
- for file in $(info_TEXINFOS) $(mailutils_TEXINFOS); \
- do \
- if grep -q '\. address@hidden' $$file; then \
- mv $$file $${file}~; \
- sed -r 's/\. (address@hidden)/. \1/g' $${file}~ >
$$file; \
- fi; \
- done
+master-menu: imprimatur-master-menu
+untabify: imprimatur-untabify
+final: imprimatur-final
-final: untabify fix-sentence-spacing master-menu
+# Web manual
+#EXTRA_DIST = \
+# gendocs_template
-
-# Checks
-check-tabs:
- @if test -n "`cat $(info_TEXINFOS) $(mailutils_TEXINFOS) |\
- tr -d -c '\t'`"; then \
- echo >&2 "Sources contain tabs; run make untabify"; \
- false; \
- fi
-
-check-sentence-spacing:
- @if grep -q '\. address@hidden' $(info_TEXINFOS)
$(mailutils_TEXINFOS); then \
- echo >&2 "Sources contain double-space sentence separators"; \
- echo >&2 "Run make fix-sentence-spacing to fix"; \
- fi
-
-check-format: check-tabs check-sentence-spacing
-
-check-refs:
- @for file in $(info_TEXINFOS) $(mailutils_TEXINFOS); \
- do \
- sed -e = $$file | \
- sed -n
'N;/@FIXME-.*ref/{s/\(^[0-9][0-9]*\)address@hidden([^}]*\)}.*/'$$file':\1:
\2/gp}'; \
- done > address@hidden; \
- if [ -s address@hidden ]; then \
- echo >&2 "Unresolved cross-references:"; \
- cat address@hidden >&2;\
- rm address@hidden; \
- else \
- rm -f address@hidden; \
- fi
-
-check-fixmes:
- @for file in $(info_TEXINFOS) $(mailutils_TEXINFOS); \
- do \
- sed -e = $$file | \
- sed -n
'N;/@FIXME{/{s/\(^[0-9][0-9]*\)address@hidden([^}]*\).*/'$$file':\1: \2/gp}'; \
- done > address@hidden; \
- if [ -s address@hidden ]; then \
- echo >&2 "Unresolved FIXMEs:"; \
- cat address@hidden >&2; \
- rm address@hidden; \
- false; \
- else \
- rm -f address@hidden; \
- fi
-
-check-writeme:
- @grep -Hn @WRITEME $(info_TEXINFOS) $(mailutils_TEXINFOS) >
address@hidden; \
- if [ -s address@hidden ]; then \
- echo "Empty nodes:"; \
- cat address@hidden; \
- rm address@hidden; \
- false;\
- else \
- rm address@hidden; \
- fi
+GENDOCS=gendocs.sh
+TEXI2DVI=texi2dvi -t '@set $(RENDITION)' -E
-check-unrevised:
- @grep -Hn @UNREVISED $(info_TEXINFOS) $(mailutils_TEXINFOS) >
address@hidden; \
- if [ -s address@hidden ]; then \
- echo >&2 "Unrevised nodes:"; \
- cat address@hidden >&2; \
- rm address@hidden; \
- false;\
- else \
- rm address@hidden; \
- fi
+.PHONY: manual
+manual:
+ TEXINPUTS=$(srcdir):$(top_srcdir)/build-aux:$(TEXINPUTS) \
+ MAKEINFO="$(MAKEINFO) $(MAKEINFOFLAGS) $(AM_MAKEINFOFLAGS)" \
+ TEXI2DVI="$(TEXI2DVI)" \
+ TEXI2HTML="texi2html $(AM_MAKEINFOFLAGS)" \
+ $(GENDOCS) --texi2html $(PACKAGE) '$(PACKAGE_NAME) manual'
-all-check-docs: check-format check-writeme check-unrevised check-refs
check-fixmes
+manual.tar.bz2: manual
+ tar cfj manual.tar.bz2 manual
-check-docs:
- $(MAKE) -k all-check-docs
+man-tar: manual.tar.bz2
diff --git a/doc/texinfo/fdl.texi b/doc/texinfo/fdl.texi
index ab401d0..31cf840 100644
--- a/doc/texinfo/fdl.texi
+++ b/doc/texinfo/fdl.texi
@@ -1,6 +1,3 @@
address@hidden fdl.info
address@hidden GNU FDL
address@hidden GNU Free Documentation License
@cindex FDL, GNU Free Documentation License
@center Version 1.2, November 2002
@@ -26,16 +23,16 @@ to get credit for their work, while not being considered
responsible
for modifications made by others.
This License is a kind of ``copyleft'', which means that derivative
-works of the document must themselves be free in the same sense. It
+works of the document must themselves be free in the same sense. It
complements the GNU General Public License, which is a copyleft
license designed for free software.
We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
-software does. But this License is not limited to software manuals;
+software does. But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
-whether it is published as a printed book. We recommend this License
+whether it is published as a printed book. We recommend this License
principally for works whose purpose is instruction or reference.
@item
@@ -43,11 +40,11 @@ APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work, in any medium, that
contains a notice placed by the copyright holder saying it can be
-distributed under the terms of this License. Such a notice grants a
+distributed under the terms of this License. Such a notice grants a
world-wide, royalty-free license, unlimited in duration, to use that
-work under the conditions stated herein. The ``Document'', below,
-refers to any such manual or work. Any member of the public is a
-licensee, and is addressed as ``you''. You accept the license if you
+work under the conditions stated herein. The ``Document'', below,
+refers to any such manual or work. Any member of the public is a
+licensee, and is addressed as ``you''. You accept the license if you
copy, modify or distribute the work in a way requiring permission
under copyright law.
@@ -68,15 +65,15 @@ them.
The ``Invariant Sections'' are certain Secondary Sections whose titles
are designated, as being those of Invariant Sections, in the notice
-that says that the Document is released under this License. If a
+that says that the Document is released under this License. If a
section does not fit the above definition of Secondary then it is not
-allowed to be designated as Invariant. The Document may contain zero
-Invariant Sections. If the Document does not identify any Invariant
+allowed to be designated as Invariant. The Document may contain zero
+Invariant Sections. If the Document does not identify any Invariant
Sections then there are none.
The ``Cover Texts'' are certain short passages of text that are listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
-the Document is released under this License. A Front-Cover Text may
+the Document is released under this License. A Front-Cover Text may
be at most 5 words, and a Back-Cover Text may be at most 25 words.
A ``Transparent'' copy of the Document means a machine-readable copy,
@@ -86,19 +83,19 @@ straightforwardly with generic text editors or (for images
composed of
pixels) generic paint programs or (for drawings) some widely available
drawing editor, and that is suitable for input to text formatters or
for automatic translation to a variety of formats suitable for input
-to text formatters. A copy made in an otherwise Transparent file
+to text formatters. A copy made in an otherwise Transparent file
format whose markup, or absence of markup, has been arranged to thwart
or discourage subsequent modification by readers is not Transparent.
An image format is not Transparent if used for any substantial amount
-of text. A copy that is not ``Transparent'' is called ``Opaque''.
+of text. A copy that is not ``Transparent'' is called ``Opaque''.
Examples of suitable formats for Transparent copies include plain
@sc{ascii} without markup, Texinfo input format, address@hidden input
format, @acronym{SGML} or @acronym{XML} using a publicly available
@acronym{DTD}, and standard-conforming simple @acronym{HTML},
-PostScript or @acronym{PDF} designed for human modification. Examples
+PostScript or @acronym{PDF} designed for human modification. Examples
of transparent image formats include @acronym{PNG}, @acronym{XCF} and
address@hidden Opaque formats include proprietary formats that can be
address@hidden Opaque formats include proprietary formats that can be
read and edited only by proprietary word processors, @acronym{SGML} or
@acronym{XML} for which the @acronym{DTD} and/or processing tools are
not generally available, and the machine-generated @acronym{HTML},
@@ -107,7 +104,7 @@ output purposes only.
The ``Title Page'' means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the material
-this License requires to appear in the title page. For works in
+this License requires to appear in the title page. For works in
formats which do not have any title page as such, ``Title Page'' means
the text near the most prominent appearance of the work's title,
preceding the beginning of the body of the text.
@@ -121,7 +118,7 @@ of such a section when you modify the Document means that
it remains a
section ``Entitled XYZ'' according to this definition.
The Document may include Warranty Disclaimers next to the notice which
-states that this License applies to the Document. These Warranty
+states that this License applies to the Document. These Warranty
Disclaimers are considered to be included by reference in this
License, but only as regards disclaiming warranties: any other
implication that these Warranty Disclaimers may have is void and has
@@ -134,10 +131,10 @@ You may copy and distribute the Document in any medium,
either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no other
-conditions whatsoever to those of this License. You may not use
+conditions whatsoever to those of this License. You may not use
technical measures to obstruct or control the reading or further
-copying of the copies you make or distribute. However, you may accept
-compensation in exchange for copies. If you distribute a large enough
+copying of the copies you make or distribute. However, you may accept
+compensation in exchange for copies. If you distribute a large enough
number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and
@@ -151,10 +148,10 @@ printed covers) of the Document, numbering more than 100,
and the
Document's license notice requires Cover Texts, you must enclose the
copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
-the back cover. Both covers must also clearly and legibly identify
-you as the publisher of these copies. The front cover must present
+the back cover. Both covers must also clearly and legibly identify
+you as the publisher of these copies. The front cover must present
the full title with all words of the title equally prominent and
-visible. You may add other material on the covers in addition.
+visible. You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated
as verbatim copying in other respects.
@@ -189,14 +186,14 @@ the conditions of sections 2 and 3 above, provided that
you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
-of it. In addition, you must do these things in the Modified Version:
+of it. In addition, you must do these things in the Modified Version:
@enumerate A
@item
Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section
-of the Document). You may use the same title as a previous version
+of the Document). You may use the same title as a previous version
if the original publisher of that version gives permission.
@item
@@ -232,7 +229,7 @@ Include an unaltered copy of this License.
@item
Preserve the section Entitled ``History'', Preserve its Title, and add
to it an item stating at least the title, year, new authors, and
-publisher of the Modified Version as given on the Title Page. If
+publisher of the Modified Version as given on the Title Page. If
there is no section Entitled ``History'' in the Document, create one
stating the title, year, authors, and publisher of the Document as
given on its Title Page, then add an item describing the Modified
@@ -242,7 +239,7 @@ Version as stated in the previous sentence.
Preserve the network location, if any, given in the Document for
public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions
-it was based on. These may be placed in the ``History'' section.
+it was based on. These may be placed in the ``History'' section.
You may omit a network location for a work that was published at
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.
@@ -255,11 +252,11 @@ dedications given therein.
@item
Preserve all the Invariant Sections of the Document,
-unaltered in their text and in their titles. Section numbers
+unaltered in their text and in their titles. Section numbers
or the equivalent are not considered part of the section titles.
@item
-Delete any section Entitled ``Endorsements''. Such a section
+Delete any section Entitled ``Endorsements''. Such a section
may not be included in the Modified Version.
@item
@@ -273,7 +270,7 @@ Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all
-of these sections as invariant. To do this, add their titles to the
+of these sections as invariant. To do this, add their titles to the
list of Invariant Sections in the Modified Version's license notice.
These titles must be distinct from any other section titles.
@@ -285,9 +282,9 @@ standard.
You may add a passage of up to five words as a Front-Cover Text, and a
passage of up to 25 words as a Back-Cover Text, to the end of the list
-of Cover Texts in the Modified Version. Only one passage of
+of Cover Texts in the Modified Version. Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or
-through arrangements made by) any one entity. If the Document already
+through arrangements made by) any one entity. If the Document already
includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
@@ -309,7 +306,7 @@ license notice, and that you preserve all their Warranty
Disclaimers.
The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
-copy. If there are multiple Invariant Sections with the same name but
+copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
adding at the end of it, in parentheses, the name of the original
author or publisher of that section if known, or else a unique number.
@@ -319,7 +316,7 @@ Invariant Sections in the license notice of the combined
work.
In the combination, you must combine any sections Entitled ``History''
in the various original documents, forming one section Entitled
``History''; likewise combine any sections Entitled ``Acknowledgements'',
-and any sections Entitled ``Dedications''. You must delete all
+and any sections Entitled ``Dedications''. You must delete all
sections Entitled ``Endorsements.''
@item
@@ -364,11 +361,11 @@ distribute translations of the Document under the terms
of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
translations of some or all Invariant Sections in addition to the
-original versions of these Invariant Sections. You may include a
+original versions of these Invariant Sections. You may include a
translation of this License, and all the license notices in the
Document, and any Warranty Disclaimers, provided that you also include
the original English version of this License and the original versions
-of those notices and disclaimers. In case of a disagreement between
+of those notices and disclaimers. In case of a disagreement between
the translation and the original version of this License or a notice
or disclaimer, the original version will prevail.
@@ -381,9 +378,9 @@ title.
TERMINATION
You may not copy, modify, sublicense, or distribute the Document except
-as expressly provided for under this License. Any other attempt to
+as expressly provided for under this License. Any other attempt to
copy, modify, sublicense or distribute the Document is void, and will
-automatically terminate your rights under this License. However,
+automatically terminate your rights under this License. However,
parties who have received copies, or rights, from you under this
License will not have their licenses terminated so long as such
parties remain in full compliance.
@@ -392,9 +389,9 @@ parties remain in full compliance.
FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised versions
-of the GNU Free Documentation License from time to time. Such new
+of the GNU Free Documentation License from time to time. Such new
versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns. See
+differ in detail to address new problems or concerns. See
@uref{http://www.gnu.org/copyleft/}.
Each version of the License is given a distinguishing version number.
@@ -402,7 +399,7 @@ If the Document specifies that a particular numbered
version of this
License ``or any later version'' applies to it, you have the option of
following the terms and conditions either of that specified version or
of any later version that has been published (not as a draft) by the
-Free Software Foundation. If the Document does not specify a version
+Free Software Foundation. If the Document does not specify a version
number of this License, you may choose any version ever published (not
as a draft) by the Free Software Foundation.
@end enumerate
diff --git a/doc/texinfo/getdate.texi b/doc/texinfo/getdate.texi
index 741d449..0a816a7 100644
--- a/doc/texinfo/getdate.texi
+++ b/doc/texinfo/getdate.texi
@@ -7,7 +7,7 @@
@c under the terms of the GNU Free Documentation License, Version 1.2 or
@c any later version published by the Free Software Foundation; with no
@c Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
address@hidden Texts. A copy of the license is included in the ``GNU Free
address@hidden Texts. A copy of the license is included in the ``GNU Free
@c Documentation License'' file as part of this distribution.
@cindex date input formats
@@ -18,30 +18,30 @@ First, a quote:
@quotation
Our units of temporal measurement, from seconds on up to months, are so
complicated, asymmetrical and disjunctive so as to make coherent mental
-reckoning in time all but impossible. Indeed, had some tyrannical god
+reckoning in time all but impossible. Indeed, had some tyrannical god
contrived to enslave our minds to time, to make it all but impossible
for us to escape subjection to sodden routines and unpleasant surprises,
he could hardly have done better than handing down our present system.
It is like a set of trapezoidal building blocks, with no vertical or
horizontal surfaces, like a language in which the simplest thought
demands ornate constructions, useless particles and lengthy
-circumlocutions. Unlike the more successful patterns of language and
+circumlocutions. Unlike the more successful patterns of language and
science, which enable us to face experience boldly or at least
level-headedly, our system of temporal calculation silently and
persistently encourages our terror of time.
@dots{} It is as though architects had to measure length in feet, width
in meters and height in ells; as though basic instruction manuals
-demanded a knowledge of five different languages. It is no wonder then
+demanded a knowledge of five different languages. It is no wonder then
that we often look into our own immediate past or future, last Tuesday
-or a week from Sunday, with feelings of helpless confusion. @dots{}
+or a week from Sunday, with feelings of helpless confusion. @dots{}
--- Robert Grudin, @cite{Time and the Art of Living}.
@end quotation
This section describes the textual date representations that @sc{gnu}
-programs accept. These are the strings you, as a user, can supply as
-arguments to the various programs. The C interface (via the
+programs accept. These are the strings you, as a user, can supply as
+arguments to the various programs. The C interface (via the
@code{get_date} function) is not described here.
@menu
@@ -65,9 +65,9 @@ arguments to the various programs. The C interface (via the
@cindex items in date strings
A @dfn{date} is a string, possibly empty, containing many items
-separated by whitespace. The whitespace may be omitted when no
-ambiguity arises. The empty string means the beginning of today (i.e.,
-midnight). Order of the items is immaterial. A date string may contain
+separated by whitespace. The whitespace may be omitted when no
+ambiguity arises. The empty string means the beginning of today (i.e.,
+midnight). Order of the items is immaterial. A date string may contain
many flavors of items:
@itemize @bullet
@@ -86,11 +86,11 @@ many flavors of items:
@findex first @r{in date strings}
@findex next @r{in date strings}
@findex last @r{in date strings}
-A few ordinal numbers may be written out in words in some contexts. This is
+A few ordinal numbers may be written out in words in some contexts. This is
most useful for specifying day of the week items or relative items (see
-below). Among the most commonly used ordinal numbers, the word
+below). Among the most commonly used ordinal numbers, the word
@samp{last} stands for @math{-1}, @samp{this} stands for 0, and
address@hidden and @samp{next} both stand for 1. Because the word
address@hidden and @samp{next} both stand for 1. Because the word
@samp{second} stands for the unit of time there is no way to write the
ordinal number 2, but for convenience @samp{third} stands for 3,
@samp{fourth} for 4, @samp{fifth} for 5,
@@ -113,10 +113,10 @@ abbreviations like @samp{AM}, @samp{DST}, @samp{EST},
@samp{first},
The output of the @command{date} command
is not always acceptable as a date string,
not only because of the language problem, but also because there is no
-standard meaning for time zone items like @samp{IST}. When using
+standard meaning for time zone items like @samp{IST}. When using
@command{date} to generate a date string intended to be parsed later,
specify a date format that is independent of language and that does not
-use time zone items other than @samp{UTC} and @samp{Z}. Here are some
+use time zone items other than @samp{UTC} and @samp{Z}. Here are some
ways to do this:
@example
@@ -136,13 +136,13 @@ $ date +'@@%s.%N' # %s and %N are GNU extensions.
@cindex case, ignored in dates
@cindex comments, in dates
-Alphabetic case is completely ignored in dates. Comments may be introduced
+Alphabetic case is completely ignored in dates. Comments may be introduced
between round parentheses, as long as included parentheses are properly
-nested. Hyphens not followed by a digit are currently ignored. Leading
+nested. Hyphens not followed by a digit are currently ignored. Leading
zeros on numbers are ignored.
Invalid dates like @samp{2005-02-29} or times like @samp{24:00} are
-rejected. In the typical case of a host that does not support leap
+rejected. In the typical case of a host that does not support leap
seconds, a time like @samp{23:59:60} is rejected even if it
corresponds to a valid leap second.
@@ -152,9 +152,9 @@ corresponds to a valid leap second.
@cindex calendar date item
-A @dfn{calendar date item} specifies a day of the year. It is
+A @dfn{calendar date item} specifies a day of the year. It is
specified differently, depending on whether the month is specified
-numerically or literally. All these strings specify the same calendar date:
+numerically or literally. All these strings specify the same calendar date:
@example
1972-09-24 # @sc{iso} 8601.
@@ -170,8 +170,8 @@ Sep 24, 1972
24sep72
@end example
-The year can also be omitted. In this case, the last specified year is
-used, or the current year if none. For example:
+The year can also be omitted. In this case, the last specified year is
+used, or the current year if none. For example:
@example
9/24
@@ -185,19 +185,19 @@ Here are the rules.
For numeric months, the @sc{iso} 8601 format
@address@hidden@address@hidden is allowed, where @var{year} is
any positive number, @var{month} is a number between 01 and 12, and
address@hidden is a number between 01 and 31. A leading zero must be present
-if a number is less than ten. If @var{year} is 68 or smaller, then 2000
address@hidden is a number between 01 and 31. A leading zero must be present
+if a number is less than ten. If @var{year} is 68 or smaller, then 2000
is added to it; otherwise, if @var{year} is less than 100,
-then 1900 is added to it. The construct
+then 1900 is added to it. The construct
@address@hidden/@var{day}/@var{year}}, popular in the United States,
-is accepted. Also @address@hidden/@var{day}}, omitting the year.
+is accepted. Also @address@hidden/@var{day}}, omitting the year.
@cindex month names in date strings
@cindex abbreviations for months
Literal months may be spelled out in full: @samp{January},
@samp{February}, @samp{March}, @samp{April}, @samp{May}, @samp{June},
@samp{July}, @samp{August}, @samp{September}, @samp{October},
address@hidden or @samp{December}. Literal months may be abbreviated
address@hidden or @samp{December}. Literal months may be abbreviated
to their first three letters, possibly followed by an abbreviating dot.
It is also permitted to write @samp{Sept} instead of @samp{September}.
@@ -224,13 +224,13 @@ Or, omitting the year:
@cindex time of day item
A @dfn{time of day item} in date strings specifies the time on a given
-day. Here are some examples, all of which represent the same time:
+day. Here are some examples, all of which represent the same time:
@example
20:02:00.000000
20:02
8:02pm
-20:02-0500 # In @sc{est} (U.S. Eastern Standard Time).
+20:02-0500 # In @sc{est} (U.S. Eastern Standard Time).
@end example
More generally, the time of day may be given as
@@ -240,7 +240,7 @@ a number between 0 and 23, @var{minute} is a number between
0 and
@samp{.} or @samp{,} and a fraction containing one or more digits.
Alternatively,
@samp{:@var{second}} can be omitted, in which case it is taken to
-be zero. On the rare hosts that support leap seconds, @var{second}
+be zero. On the rare hosts that support leap seconds, @var{second}
may be 60.
@findex am @r{in date strings}
@@ -249,9 +249,9 @@ may be 60.
@findex noon @r{in date strings}
If the time is followed by @samp{am} or @samp{pm} (or @samp{a.m.}
or @samp{p.m.}), @var{hour} is restricted to run from 1 to 12, and
address@hidden:@var{minute}} may be omitted (taken to be zero). @samp{am}
address@hidden:@var{minute}} may be omitted (taken to be zero). @samp{am}
indicates the first half of the day, @samp{pm} indicates the second
-half of the day. In this notation, 12 is the predecessor of 1:
+half of the day. In this notation, 12 is the predecessor of 1:
midnight is @samp{12am} while noon is @samp{12pm}.
(This is the zero-oriented interpretation of @samp{12am} and @samp{12pm},
as opposed to the old tradition derived from Latin
@@ -269,7 +269,7 @@ You can also separate @var{hh} from @var{mm} with a colon.
When a time zone correction is given this way, it
forces interpretation of the time relative to
Coordinated Universal Time (@sc{utc}), overriding any previous
-specification for the time zone or the local time zone. For example,
+specification for the time zone or the local time zone. For example,
@samp{+0530} and @samp{+05:30} both stand for the time zone 5.5 hours
ahead of @sc{utc} (e.g., India).
This is the best way to
@@ -288,19 +288,19 @@ but not both.
A @dfn{time zone item} specifies an international time zone, indicated
by a small set of letters, e.g., @samp{UTC} or @samp{Z}
for Coordinated Universal
-Time. Any included periods are ignored. By following a
+Time. Any included periods are ignored. By following a
non-daylight-saving time zone by the string @samp{DST} in a separate
word (that is, separated by some white space), the corresponding
daylight saving time zone may be specified.
Alternatively, a non-daylight-saving time zone can be followed by a
-time zone correction, to add the two values. This is normally done
+time zone correction, to add the two values. This is normally done
only for @samp{UTC}; for example, @samp{UTC+05:30} is equivalent to
@samp{+05:30}.
Time zone items other than @samp{UTC} and @samp{Z}
are obsolescent and are not recommended, because they
are ambiguous; for example, @samp{EST} has a different meaning in
-Australia than in the United States. Instead, it's better to use
+Australia than in the United States. Instead, it's better to use
unambiguous numeric time zone corrections like @samp{-0500}, as
described in the previous section.
@@ -319,8 +319,8 @@ The explicit mention of a day of the week will forward the
date
Days of the week may be spelled out in full: @samp{Sunday},
@samp{Monday}, @samp{Tuesday}, @samp{Wednesday}, @samp{Thursday},
address@hidden or @samp{Saturday}. Days may be abbreviated to their
-first three letters, optionally followed by a period. The special
address@hidden or @samp{Saturday}. Days may be abbreviated to their
+first three letters, optionally followed by a period. The special
abbreviations @samp{Tues} for @samp{Tuesday}, @samp{Wednes} for
@samp{Wednesday} and @samp{Thur} or @samp{Thurs} for @samp{Thursday} are
also allowed.
@@ -328,8 +328,8 @@ also allowed.
@findex next @var{day}
@findex last @var{day}
A number may precede a day of the week item to move forward
-supplementary weeks. It is best used in expression like @samp{third
-monday}. In this context, @samp{last @var{day}} or @samp{next
+supplementary weeks. It is best used in expression like @samp{third
+monday}. In this context, @samp{last @var{day}} or @samp{next
@var{day}} is also acceptable; they move one week before or after
the day that @var{day} by itself would represent.
@@ -343,7 +343,7 @@ A comma following a day of the week item is ignored.
@cindex displacement of dates
@dfn{Relative items} adjust a date (or the current date if none) forward
-or backward. The effects of relative items accumulate. Here are some
+or backward. The effects of relative items accumulate. Here are some
examples:
@example
@@ -361,18 +361,18 @@ examples:
@findex hour @r{in date strings}
@findex minute @r{in date strings}
The unit of time displacement may be selected by the string @samp{year}
-or @samp{month} for moving by whole years or months. These are fuzzy
-units, as years and months are not all of equal duration. More precise
+or @samp{month} for moving by whole years or months. These are fuzzy
+units, as years and months are not all of equal duration. More precise
units are @samp{fortnight} which is worth 14 days, @samp{week} worth 7
days, @samp{day} worth 24 hours, @samp{hour} worth 60 minutes,
@samp{minute} or @samp{min} worth 60 seconds, and @samp{second} or
address@hidden worth one second. An @samp{s} suffix on these units is
address@hidden worth one second. An @samp{s} suffix on these units is
accepted and ignored.
@findex ago @r{in date strings}
The unit of time may be preceded by a multiplier, given as an optionally
-signed number. Unsigned numbers are taken as positively signed. No
-number at all implies 1 for a multiplier. Following a relative item by
+signed number. Unsigned numbers are taken as positively signed. No
+number at all implies 1 for a multiplier. Following a relative item by
the string @samp{ago} is equivalent to preceding the unit by a
multiplier with value @math{-1}.
@@ -389,8 +389,8 @@ one day in the past (equivalent to @samp{day ago}).
The strings @samp{now} or @samp{today} are relative items corresponding
to zero-valued time displacement, these strings come from the fact
a zero-valued time displacement represents the current time when not
-otherwise changed by previous items. They may be used to stress other
-items, like in @samp{12:00 today}. The string @samp{this} also has
+otherwise changed by previous items. They may be used to stress other
+items, like in @samp{12:00 today}. The string @samp{this} also has
the meaning of a zero-valued time displacement, but is preferred in
date strings like @samp{this thursday}.
@@ -398,11 +398,11 @@ When a relative item causes the resulting date to cross a
boundary
where the clocks were adjusted, typically for daylight saving time,
the resulting date and time are adjusted accordingly.
-The fuzz in units can cause problems with relative items. For
+The fuzz in units can cause problems with relative items. For
example, @samp{2003-07-31 -1 month} might evaluate to 2003-07-01,
-because 2003-06-31 is an invalid date. To determine the previous
+because 2003-06-31 is an invalid date. To determine the previous
month more reliably, you can ask for the month before the 15th of the
-current month. For example:
+current month. For example:
@example
$ date -R
@@ -414,7 +414,7 @@ Last month was June!
@end example
Also, take care when manipulating dates around clock changes such as
-daylight saving leaps. In a few cases these have added or subtracted
+daylight saving leaps. In a few cases these have added or subtracted
as much as 24 hours from the clock, so it is often wise to adopt
universal time by setting the @env{TZ} environment variable to
@samp{UTC0} before embarking on calendrical calculations.
@@ -436,7 +436,7 @@ calendar date.
If the decimal number is of the form @address@hidden and no other time
of day item appears before it in the date string, then @var{hh} is read
as the hour of the day and @var{mm} as the minute of the hour, for the
-specified time of day. @var{mm} can also be omitted.
+specified time of day. @var{mm} can also be omitted.
If both a calendar date and a time of day appear to the left of a number
in the date string, but no relative item, then the number overrides the
@@ -447,26 +447,26 @@ year.
@section Seconds since the Epoch
If you precede a number with @samp{@@}, it represents an internal time
-stamp as a count of seconds. The number can contain an internal
+stamp as a count of seconds. The number can contain an internal
decimal point (either @samp{.} or @samp{,}); any excess precision not
supported by the internal representation is truncated toward minus
-infinity. Such a number cannot be combined with any other date
+infinity. Such a number cannot be combined with any other date
item, as it specifies a complete time stamp.
@cindex beginning of time, for @acronym{POSIX}
@cindex epoch, for @acronym{POSIX}
Internally, computer times are represented as a count of seconds since
-an epoch---a well-defined point of time. On @acronym{GNU} and
+an epoch---a well-defined point of time. On @acronym{GNU} and
@acronym{POSIX} systems, the epoch is 1970-01-01 00:00:00 @sc{utc}, so
@samp{@@0} represents this time, @samp{@@1} represents 1970-01-01
-00:00:01 @sc{utc}, and so forth. @acronym{GNU} and most other
+00:00:01 @sc{utc}, and so forth. @acronym{GNU} and most other
@acronym{POSIX}-compliant systems support such times as an extension
to @acronym{POSIX}, using negative counts, so that @samp{@@-1}
represents 1969-12-31 23:59:59 @sc{utc}.
Traditional Unix systems count seconds with 32-bit two's-complement
integers and can represent times from 1901-12-13 20:45:52 through
-2038-01-19 03:14:07 @sc{utc}. More modern systems use 64-bit counts
+2038-01-19 03:14:07 @sc{utc}. More modern systems use 64-bit counts
of seconds with nanosecond subcounts, and can represent all the times
in the known lifetime of the universe to a resolution of 1 nanosecond.
@@ -482,9 +482,9 @@ For example, on most hosts @samp{@@915148799} represents
1998-12-31
@vindex TZ
Normally, dates are interpreted using the rules of the current time
zone, which in turn are specified by the @env{TZ} environment
-variable, or by a system default if @env{TZ} is not set. To specify a
+variable, or by a system default if @env{TZ} is not set. To specify a
different set of default time zone rules that apply just to one date,
-start the date with a string of the form @samp{TZ="@var{rule}"}. The
+start the date with a string of the form @samp{TZ="@var{rule}"}. The
two quote characters (@samp{"}) must be present in the date, and any
quotes or backslashes within @var{rule} must be escaped by a
backslash.
@@ -503,7 +503,7 @@ Sun Oct 31 01:30:00 EDT 2004
In this example, the @option{--date} operand begins with its own
@env{TZ} setting, so the rest of that operand is processed according
to @samp{Europe/Paris} rules, treating the string @samp{2004-10-31
-06:30} as if it were in Paris. However, since the output of the
+06:30} as if it were in Paris. However, since the output of the
@command{date} command is processed according to the overall time zone
rules, it uses New York time. (Paris was normally six hours ahead of
New York in 2004, but this example refers to a brief Halloween period
@@ -513,7 +513,7 @@ A @env{TZ} value is a rule that typically names a location
in the
@uref{http://www.twinsun.com/tz/tz-link.htm, @samp{tz} database}.
A recent catalog of location names appears in the
@uref{http://twiki.org/cgi-bin/xtra/tzdate, TWiki Date and Time
-Gateway}. A few address@hidden hosts require a colon before a
+Gateway}. A few address@hidden hosts require a colon before a
location name in a @env{TZ} setting, e.g.,
@samp{TZ=":America/New_York"}.
@@ -521,10 +521,10 @@ The @samp{tz} database includes a wide variety of
locations ranging
from @samp{Arctic/Longyearbyen} to @samp{Antarctica/South_Pole}, but
if you are at sea and have your own private time zone, or if you are
using a address@hidden host that does not support the @samp{tz}
-database, you may need to use a @acronym{POSIX} rule instead. Simple
+database, you may need to use a @acronym{POSIX} rule instead. Simple
@acronym{POSIX} rules like @samp{UTC0} specify a time zone without
daylight saving time; other rules can specify simple daylight saving
-regimes. @xref{TZ Variable,, Specifying the Time Zone with @code{TZ},
+regimes. @xref{TZ Variable,, Specifying the Time Zone with @code{TZ},
libc, The GNU C Library}.
@node Authors of get_date
@@ -538,11 +538,11 @@ libc, The GNU C Library}.
@cindex MacKenzie, David
@cindex Meyering, Jim
@cindex Eggert, Paul
address@hidden was originally implemented by Steven M. Bellovin
address@hidden was originally implemented by Steven M. Bellovin
(@email{smb@@research.att.com}) while at the University of North Carolina
-at Chapel Hill. The code was later tweaked by a couple of people on
+at Chapel Hill. The code was later tweaked by a couple of people on
Usenet, then completely overhauled by Rich $alz (@email{rsalz@@bbn.com})
-and Jim Berets (@email{jberets@@bbn.com}) in August, 1990. Various
+and Jim Berets (@email{jberets@@bbn.com}) in August, 1990. Various
revisions for the @sc{gnu} system were made by David MacKenzie, Jim Meyering,
Paul Eggert and others.
diff --git a/doc/texinfo/mailutils.texi b/doc/texinfo/mailutils.texi
index 5e4ae5e..62faed0 100644
--- a/doc/texinfo/mailutils.texi
+++ b/doc/texinfo/mailutils.texi
@@ -3,12 +3,11 @@
@setfilename mailutils.info
@settitle GNU Mailutils Manual
@setchapternewpage odd
address@hidden
@c %**end of header
@include version.texi
address@hidden macros.texi
@include rendition.texi
address@hidden macros.texi
@c Define indices
@defcodeindex op
@@ -42,7 +41,7 @@
* readmsg: (mailutils)readmsg. Extract Messages from a Folder.
* sieve: (mailutils)sieve. Mail Filtering Utility.
* mimeview: (mailutils)mimeview. View MIME Messages.
-* mailutils-config: (mailutils)mailutils-config. List Information about
Mailutils.
+* mu: (mailutils)mu. Mailutils Multi-Purpose Tool
@end direntry
@end ifinfo
@@ -57,13 +56,9 @@ Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004,
2008, 2009,
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
-and with the Back-Cover Texts as in (a) below. A copy of the license
-is included in the section entitled ``GNU Free Documentation License''.
-
-(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
-this GNU Manual, like GNU software. Copies published by the Free
-Software Foundation raise funds for GNU development.''
+Invariant Sections, no Front-Cover, and no Back-Cover texts.
+A copy of the license is included in the section entitled ``GNU Free
+Documentation License''.
@end copying
@titlepage
@@ -75,9 +70,11 @@ Software Foundation raise funds for GNU development.''
@insertcopying
@end titlepage
address@hidden
@page
@summarycontents
@page
address@hidden ifnothtml
@contents
@ifnottex
@@ -125,6 +122,7 @@ Mailutils Programs
* command line:: Command Line Syntax.
* configuration:: Common Configuration File.
+* debugging::
* frm and from:: List Headers from a Mailbox.
* mail:: Send and Receive Mail.
@@ -145,7 +143,7 @@ Mailutils Programs
* mh:: The MH Message Handling System.
-* mailutils-config:: Get the Information about the Mailutils Build.
+* mu:: Mailutils Multi-Purpose Tool.
Command Line
@@ -177,13 +175,19 @@ Configuration File Syntax
* Comments::
* Statements::
-* Block Statements::
+* Paths::
Server Settings
* General Server Configuration::
* Server Statement::
+Debugging
+
+* Level Syntax::
+* Level BNF::
+* Debugging Categories::
+
@command{mail} --- Send and Receive Mail
* Invoking Mail:: Command Line Options.
@@ -232,6 +236,7 @@ Reading Mail
* Movemail Configuration::
* Movemail Options:: Description of the Available Options
+* Ownership:: Setting Destination Mailbox Ownership
* Summary:: Short Movemail Invocation Summary
@command{readmsg} --- Extract Messages from a Folder
@@ -260,7 +265,7 @@ A Sieve Interpreter
maidag
-* Sendmail-maidag:: Using @command{maidag} with Sendmail.
+* Sendmail-maidag:: Using @command{maidag} with Sendmail.
* Exim-maidag:: Using @command{maidag} with Exim.
* MeTA1-maidag:: Using @command{maidag} with MeTA1.
* Mailbox Quotas::
@@ -279,6 +284,7 @@ Maidag Scripting
* Sieve Maidag Filters::
* Scheme Maidag Filters::
+* Python Maidag Filters::
mimeview
@@ -310,7 +316,7 @@ Configuring @command{comsatd}
* General Settings::
* Security Settings::
address@hidden --- The MH Message Handling System
+MH --- The MH Message Handling System
* Diffs:: Major differences between Mailutils MH and other MH
implementations.
@@ -321,70 +327,32 @@ Major differences between Mailutils MH and other MH
implementations
* Profile Variable Diffs::
* Program Diffs::
address@hidden --- Get the Information about the Mailutils Build
-
-* Compiler Flags:: Getting Compiler Flags.
-* Loader Flags:: Getting Loader Flags.
-* General Information:: Obtaining General Build Information.
-
-Mailutils Libraries
-
-* libmailutils:: The Core Library.
-* libmu_auth:: Auxiliary Library for Authenticating Users.
-* libmu_scm:: Mailutils to Scheme Interface.
-* libmu_sieve:: GNU Implementation of Sieve Mail Filtering.
-
-Framework
-
-* Folder:: Folder.
-* Mailbox:: Mailbox.
-* Mailer:: Protocol Used to Send Mail.
-* Message:: Message.
-* Envelope:: Envelope.
-* Headers:: Headers.
-* Body:: Body.
-* Attribute:: Attribute.
-* Stream:: Stream.
-* Iterator:: Iterator.
-* Authenticator:: Authenticator.
-* Address:: Address.
-* Locker:: Locker.
-* URL:: Uniform Resource Locators.
-* Parse822:: Parsing RFC 822 headers.
-* Mailcap:: Parsing RFC 1524 file.
-
-Authentication Library
-
-* Data Types::
-* Initializing libmu_auth::
-* Module Creation and Destruction::
-* Obtaining Authorization Information::
-* Existing Modules::
-* Using libmu_auth in Your Programs::
-
-Mailutils to Scheme Interface
-
-* Address Functions::
-* Mailbox Functions::
-* Message Functions::
-* MIME Functions::
-* Logging Functions::
-* Other Functions::
-
-Using @file{libmu_scm}
-
-* Direct Linking::
-* Dynamic Linking::
-
-Sieve Library
-
-* Sieve Data Types::
-* Manipulating the Sieve Machine::
-* Logging and Diagnostic Functions::
-* Symbol Space Functions::
-* Memory Allocation::
-* Compiling and Executing the Script::
-* Writing Loadable Commands::
+MU
+
+* mu invocation syntax::
+* mu help::
+* mu info::
+* mu cflags::
+* mu ldflags::
+* mu query::
+* mu 2047::
+* mu filter::
+* mu acl::
+* mu wicket::
+* mu dbm::
+* mu logger::
+* mu pop::
+* mu imap::
+
+mu dbm
+
+* Create a Database::
+* Add Records to a Database::
+* Delete Records::
+* List the Database::
+* Dump the Database::
+* Dump Formats::
+* Dbm Exit Codes::
Sieve Language
@@ -437,36 +405,58 @@ Date Input Formats
@node Introduction
@chapter Introduction
-
-GNU Mailutils is a rich and powerful protocol-independent mail
-framework. It contains a series of useful mail libraries, clients,
-and servers. These are the primary mail utilities for the GNU system.
-The central library is capable of handling electronic mail in various
-mailbox formats and protocols, both local and remote. Specifically,
-this project contains a POP3 server, an IMAP4 server, and a Sieve mail
-filter. It also provides a POSIX `mailx' client, and a collection of
-other handy tools.
-
-The GNU Mailutils libraries supply an ample set of primitives for
-handling electronic mail in programs written in C, C++, Python or
-Scheme.
-
-At the core of Mailutils is libmailutils, a library which provides
-universal access to various mailboxes and protocols: UNIX mailbox,
-Maildir, MH, POP3, IMAP4, Sendmail, SMTP. Mailutils offers functions
-for almost any mail-related task, such as parsing of messages, email
-addresses and URLs, handling MIME messages, listing mail folders,
-mailcap facilities, extensible Sieve filtering, access control lists.
-It supports various modern data security and authentication
-techniques: TLS encryption, SASL and GSSAPI, to name a few.
-The framework is able to work with a wide variety of authorization
-databases, ranging from traditional system password database up to
-RADIUS, SQL and LDAP.
-
-The utilities provided by Mailutils include imap4d and pop3d mail
-servers, mail reporting utility comsatd, general-purpose mail delivery
-agent maidag, mail filtering program sieve, and an implementation of
-MH message handling system.
+GNU Mailutils is a set of libraries and utilities for handling
+electronic mail. It addresses a wide audience and can be of interest
+to application developers, casual users and system administrators alike.
+
+It provides programmers with a consistent API allowing them to
+handle a variety of different mailbox formats transparently and
+without having to delve into complexities of their internal structure.
+While doing so, it also provides interfaces that simplify common
+programming tasks, such as handling lists, parsing configuration
+files, etc. The philosophy of Mailutils is to have a single and
+consistent programming interface for various objects designed to
+handle the same task. It tries to use their similarities to create an
+interface that hides their differences and complexities. This covers
+a wide variety of programming tasks: apart from mailbox handling,
+Mailutils also contains a unified iterface for work with various DBM
+databases and much more.
+
+The utilities built upon these libraries share that same distinctive
+feature: no matter what is the internal structure of an object, it is
+always handled the same way as other objects that do the same task.
+Again, the most common example of this approach are, of course,
+mailboxes. Whatever Mailutils program you use, you can be sure it is
+able to handle various mailbox formats. You even don't have to inform
+it about what type a mailbox is: it will do its best to discover it
+automatically.
+
+This approach sometimes covers entities which are seldom regarded as
+compatible. For example, using Mailutils it is possible to treat an SMTP
+connection as a mailbox opened only for appending new messages. This
+in turn, provides a way for extending the functionality of some
+utilities. As an example, using this concept of mailboxes, the usual
+mail delivery agent becomes able to do things usually reserved for
+mail transport agents only!
+
+At the core of Mailutils is @file{libmailutils}, a library which
+provides an API for accessing a generalized mailbox. A set of
+complementary libraries provide methods for handling particular
+mailbox implementations: UNIX mailbox, Maildir, MH, POP3, IMAP4,
+even SMTP. Mailutils offers functions for almost any mail-related
+task, such as parsing of messages, email addresses and URLs, handling
+MIME messages, listing mail folders, mailcap facilities, extensible
+Sieve filtering, access control lists. It supports various modern
+data security and authentication techniques: TLS encryption, SASL and
+GSSAPI, to name a few. Mailutils is able to work with a wide
+variety of authorization databases, ranging from traditional system
+password database up to RADIUS, SQL and LDAP.
+
+The utilities provided by Mailutils include @command{imap4d} and
address@hidden mail servers, mail reporting utility
address@hidden, general-purpose mail delivery agent
address@hidden, mail filtering program @command{sieve}, an implementation
+of MH message handling system and much more.
All utilities share the same subset of command line options and use
a unified configuration mechanism, which allows to easily configure
@@ -486,17 +476,17 @@ under the GNU FDL, and everything else is licensed under
the GNU GPL.
@section What this Book Contains
@FIXME{This is more a plan on how the document should be structured,
-than a description of its actual structure. However it is:}
+than a description of its actual structure. However it is:}
This book addresses a wide audience of both system administrators
and users that aim to use Mailutils programs, and programmers who wish
-to use Mailutils libraries in their programs. Given this audience,
+to use Mailutils libraries in their programs. Given this audience,
the book is divided in three major parts.
The first part provides a detailed description of each Mailutils
-utility, and advices on how to use them in various situations. This
+utility, and advices on how to use them in various situations. This
part is intended for users and system administrators who are using
-Mailutils programs. If you are not interested in programming using
+Mailutils programs. If you are not interested in programming using
Mailutils, this is the only part you need to read.
Subsequent parts address programmers.
@@ -508,67 +498,37 @@ Mailutils.
Finally, the third part contains a complete Mailutils library
reference.
- This version of the book is not finished. The places that may
+ This version of the book is not finished. The places that may
contain inaccurate information carry prominent notices stating so.
For updated versions of the documentation, visit
address@hidden://www.gnu.org/software/mailutils/manual}. If you have any
-questions, feel free to ask them at the mailing list
address@hidden@@gnu.org}.
address@hidden://mailutils.org/manual}. All material that ends up in this
+document is first published in the Mailutils Wiki, available at
address@hidden://mailutils.org/wiki}. Be sure to visit it for latest
+updates.
+
+ If you have any questions that are not answered there, feel free to
+ask them at the mailing list @email{bug-mailutils@@gnu.org}.
+
address@hidden 3.0 introduced such amount of changes, most of which
+being a complete rewrite of the existing codebase, that the library
+tutorial and reference became hopelessly obsolete. It is my deep
+conviction that using incorrect documentation is much worse than
+having no documentation at all, therefore I have withdrawn the
+obsolete parts from this edition of GNU Mailutils manual. I am doing
+my best to document new Mailutils libraries and hope to be able to
+re-introduce these parts of the documentation soon.}
@node History
@section A bit of History, and why use this package?
@UNREVISED
This package started off to try and handle large mailbox files more
-gracefully then current POP3 servers did. While it handles this task,
-it also allows you to support a variety of different mailbox formats
-without any real effort on your part. Also, if a new format is added
-at a later date, your program will support that new format
-automatically as soon as it is compiled against the new library.
-
address@hidden Programs
address@hidden Mailutils Programs
address@hidden Programs
address@hidden programs.texi
-
address@hidden Libraries
address@hidden Mailutils Libraries
address@hidden Libraries
-
address@hidden
-* libmailutils:: The Core Library.
-* libmu_auth:: Auxiliary Library for Authenticating Users.
-* libmu_scm:: Mailutils to Scheme Interface.
-* libmu_sieve:: GNU Implementation of Sieve Mail Filtering.
address@hidden menu
-
address@hidden libmailutils
address@hidden Framework
address@hidden Framework
address@hidden framework.texi
-
address@hidden libmu_auth
address@hidden Authentication Library
address@hidden Authentication Library
address@hidden libmu_auth
address@hidden libmu_auth.texi
-
address@hidden libmu_scm
address@hidden Mailutils to Scheme Interface
address@hidden Scheme
address@hidden libmu_scm
address@hidden libmu_scm.texi
-
address@hidden libmu_sieve
address@hidden Sieve Library
address@hidden Sieve Library
address@hidden libmu_sieve
address@hidden libmu_sieve.texi
-
address@hidden Sieve Language
address@hidden Sieve Language
address@hidden Sieve Language
address@hidden sieve.texi
+gracefully then available at that time POP3 servers did. While it
+handles this task, it also allows you to support a variety of
+different mailbox formats without any real effort on your part. Also,
+if a new format is added at a later date, your program will support
+that new format automatically as soon as it is compiled against the
+new library.
@node Reporting Bugs
@chapter Reporting Bugs
@@ -576,7 +536,7 @@ automatically as soon as it is compiled against the new
library.
Email bug reports to @email{bug-mailutils@@gnu.org}.
As the purpose of bug reporting is to improve software, please be sure
-to include maximum information when reporting a bug. The information
+to include maximum information when reporting a bug. The information
needed is:
@itemize
@@ -588,15 +548,33 @@ needed is:
The archives of bug-mailutils mailing list are available from
@url{http://mail.gnu.org/@/mailman/@/listinfo/@/bug-mailutils}.
address@hidden Programs
address@hidden Mailutils Programs
address@hidden Programs
address@hidden programs.texi
+
address@hidden Libraries
address@hidden Mailutils Libraries
address@hidden Libraries
address@hidden
+
address@hidden Sieve Language
address@hidden Sieve Language
address@hidden Sieve Language
address@hidden sieve.texi
+
@node News
@chapter Getting News About GNU Mailutils
The two places to look for any news regarding GNU Mailutils are the
-Mailutils homepage at @url{http://www.gnu.org/@/software/@/mailutils}, and the
-project page at @url{http://savannah.gnu.org/@/projects/@/mailutils}.
+Mailutils homepage at @url{http://mailutils.org} or
address@hidden://www.gnu.org/@/software/@/mailutils}, and the project page
+at @url{http://savannah.gnu.org/@/projects/@/mailutils}.
The updated versions of this manual are available online from
address@hidden://www.gnu.org/@/software/@/mailutils/@/manual}.
address@hidden://mailutils.org/manual}. See also
address@hidden://mailutils.org/wiki, Mailutils Wiki} for the latest
+updates.
@node Acknowledgement
@chapter Acknowledgement
@@ -630,128 +608,18 @@ Wojciech Polak @email{polak@@gnu.org}
@node References
@appendix References
-
address@hidden @bullet
address@hidden SMTP
-
address@hidden @minus
address@hidden
address@hidden 2821: Simple Mail Transfer Protocol}
-
address@hidden
address@hidden 2368: The mailto URL scheme}
-
address@hidden
address@hidden 2487: SMTP Service Extension for Secure SMTP over TLS}
address@hidden itemize
-
address@hidden POP3
-
address@hidden @minus
address@hidden
address@hidden 1939: Post Office Protocol - Version 3}
-
address@hidden
address@hidden 1734: POP3 AUTHentication command}
-
address@hidden
address@hidden 1957: Some Observations on Implementations of the Post Office
-Protocol (POP3)}
-
address@hidden
address@hidden 2449: POP3 Extension Mechanism}
-
address@hidden
address@hidden 2384: POP URL Scheme}
-
address@hidden
address@hidden 2595: Using TLS with IMAP, POP3 and ACAP}
address@hidden itemize
-
address@hidden IMAP4
-
address@hidden @minus
address@hidden
address@hidden 2060: INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1}
-
address@hidden
address@hidden 2088: IMAP4 non-synchronizing literals}
-
address@hidden
address@hidden 2193: IMAP4 Mailbox Referrals}
-
address@hidden
address@hidden 2221: IMAP4 Login Referrals}
-
address@hidden
address@hidden 2342: IMAP4 Namespace}
-
address@hidden
address@hidden 2192: IMAP URL Scheme}
-
address@hidden
address@hidden 1731: IMAP4 Authentication Mechanisms}
-
address@hidden
address@hidden 2245: Anonymous SASL Mechanism}
-
address@hidden
address@hidden 2595: Using TLS with IMAP, POP3 and ACAP}
address@hidden itemize
-
address@hidden message formats
-
address@hidden @minus
address@hidden
address@hidden 2822: Internet Message Format}
-
address@hidden
address@hidden 2045: Multipurpose Internet Mail Extensions (MIME) Part One:
-Format of Internet Message Bodies}
-
address@hidden
address@hidden 2046: Multipurpose Internet Mail Extensions (MIME) Part Two:
-Media Types}
-
address@hidden
address@hidden 2047: Multipurpose Internet Mail Extensions (MIME) Part Three:
-Message Header Extensions for Non-ASCII Text}
-
address@hidden
address@hidden 2049: Multipurpose Internet Mail Extensions (MIME) Part Five:
-Conformance Criteria and Examples}
-
address@hidden
address@hidden 2111: Content-ID and Message-ID Uniform Resource Locators}
address@hidden itemize
-
address@hidden miscellaneous related topics
-
address@hidden @minus
address@hidden
address@hidden 1738: Uniform Resource Locators (URL)}
-
address@hidden
address@hidden 2298: An Extensible Message Format for Message Disposition
-Notifications}
-
address@hidden
address@hidden 3028: Sieve: A Mail Filtering Language}
-
address@hidden
address@hidden 3431: Sieve Extension: Relational Tests}
-
address@hidden
address@hidden Email Protocols: A Developer's Guide, by Kevin Johnson}
address@hidden itemize
address@hidden itemize
address@hidden
@node Date Input Formats
@appendix Date Input Formats
@include getdate.texi
address@hidden Usage Vars
address@hidden Configuring Help Summary
@include usage.texi
address@hidden GNU FDL
address@hidden GNU Free Documentation License
@include fdl.texi
@node Function Index
diff --git a/doc/texinfo/mu-mh.texi b/doc/texinfo/mu-mh.texi
index 1442ebb..41cb9ed 100644
--- a/doc/texinfo/mu-mh.texi
+++ b/doc/texinfo/mu-mh.texi
@@ -16,7 +16,7 @@ For the information about the current state of Mailutils MH
implementation please refer to file @file{mh/TODO} in the Mailutils
distribution directory.
-[FIXME]
address@hidden is perhaps not so important now.}
@menu
* Diffs:: Major differences between Mailutils MH and other MH
@@ -27,7 +27,7 @@ distribution directory.
@subsection Major differences between Mailutils MH and other MH implementations
@enumerate 1
address@hidden All programs use usual GNU long options. The support for MH
single-dash
address@hidden All programs use usual GNU long options. The support for MH
single-dash
options is provided for backward compatibility;
@item UUCP addresses are not supported;
@@ -55,16 +55,16 @@ Diffs});
@anchor{decode function}
@deftypefn {MH Format} string decode (string @var{str})
-Decodes the input string @var{str} as per RFC 2047. Useful in printing
+Decodes the input string @var{str} as per RFC 2047. Useful in printing
@samp{From:}, @samp{To:} and @samp{Subject:} headers.
Notice that, unlike the similar NMH function, @code{decode} checks the value
of the global profile variable @code{Charset} (@pxref{Charset variable})
-to determine the charset to output the result in. If this variable is
-not set, @code{decode} returns its argument without any change. If
+to determine the charset to output the result in. If this variable is
+not set, @code{decode} returns its argument without any change. If
this variable is set to @code{auto}, @code{decode} tries to determine
the charset name from the setting of @env{LC_ALL} environment
-variable. Otherwise, the value of @code{Charset} is taken to be the
+variable. Otherwise, the value of @code{Charset} is taken to be the
name of the character set.
@end deftypefn
@@ -75,7 +75,7 @@ Returns package name (string @samp{mailutils}).
@deftypefn {MH Format} string package_string ()
-Returns full package string (e.g. @samp{GNU Mailutils 2.1})
+Returns full package string (e.g. @samp{GNU Mailutils 2.1})
@end deftypefn
@deftypefn {MH Format} string version ()
@@ -86,7 +86,7 @@ Returns mailutils version.
@deftypefn {MH Format} string unre (string @var{str})
The function removes any leading whitespace and eventual @samp{Re:} prefix
-from its argument. Useful for creating subjects in reply messages:
+from its argument. Useful for creating subjects in reply messages:
@smallexample
%<@address@hidden: Re: %(address@hidden@})\\n%>
@@ -96,7 +96,7 @@ from its argument. Useful for creating subjects in reply
messages:
@anchor{reply_regex function}
@deftypefn {MH Format} void reply_regex (string @var{r})
-Sets the regular expression used to recognize reply messages. The
+Sets the regular expression used to recognize reply messages. The
argument @var{r} should be a POSIX extended regular expression.
Matching is case insensitive.
@@ -109,7 +109,7 @@ For example, the following invocation
@noindent
corresponds to English @samp{Re}, Polish @samp{Odp}, Norwegian @samp{Aw} or
German @samp{Ang}, optionally followed by a number in brackets, followed
-by colon and any amount of whitespace. Notice proper quoting of the
+by colon and any amount of whitespace. Notice proper quoting of the
regex metacharacters.
See also @code{Reply-Regex} (@pxref{Reply-Regex variable}) and
@@ -123,12 +123,12 @@ See also @code{Reply-Regex} (@pxref{Reply-Regex
variable}) and
If @var{str} is not given, the value of @samp{Subject:} header is taken.
The function returns true if its argument matches the ``reply subject''
-regular expression. This expression is set via the global profile variable
+regular expression. This expression is set via the global profile variable
@code{Reply-Regex} (@pxref{Reply-Regex variable}) or via the format
function @code{reply_regex}.
This function is useful for creating @samp{Subject:} headers in reply
-messages. For example, consider the following construction:
+messages. For example, consider the following construction:
@smallexample
@group
@@ -139,7 +139,7 @@ messages. For example, consider the following construction:
@end smallexample
If the @samp{Subject:} header already contained reply prefix, this construct
-leaves it unchanged. Otherwise it prepends to it the value of
+leaves it unchanged. Otherwise it prepends to it the value of
@code{Reply-Prefix} profile variable, or, if it is unset, the string
@samp{Re:}.
@@ -151,7 +151,7 @@ This expression is used in default @file{replcomps} and
This function returns true if the given element is present in the
recipient mask (as modified by @option{--cc} or @option{--nocc} options) and
-false otherwise. It is used in default formats for @command{repl} and
+false otherwise. It is used in default formats for @command{repl} and
@command{comp}, e.g.:
@smallexample
@@ -201,8 +201,8 @@ output.
@anchor{Reply-Regex variable}
@deftypevar {MH Variable} string Reply-Regex
-Keeps the regular expression used to recognize reply messages. The
-argument should be a POSIX extended regular expression. Matching
+Keeps the regular expression used to recognize reply messages. The
+argument should be a POSIX extended regular expression. Matching
is case insensitive.
For more information, please see @xref{reply_regex function}.
@@ -225,21 +225,21 @@ RAND @command{anno} displays the prompt anyway.
@item burst
The utility is able to burst both RFC 934 digest messages and MIME
-multipart messages. It provides two additional command line options:
+multipart messages. It provides two additional command line options:
@option{--recurse} and @option{--length}.
The @option{--recurse} option instructs the utility to recursively
expand the digest.
The @option{--length} option can be used to set the minimal encapsulation
-boundary length for RFC 934 digests. Default length is 1,
+boundary length for RFC 934 digests. Default length is 1,
i.e. encountering one dash immediately following a newline triggers
-digest decoding. It is OK for messages that follow RFC 934
-specification. However, many user agents do not precisely follow it,
+digest decoding. It is OK for messages that follow RFC 934
+specification. However, many user agents do not precisely follow it,
in particular, they often do not escape lines starting with a dash by
address@hidden } sequence. @command{Mailman} is one of such agents. To cope
address@hidden } sequence. @command{Mailman} is one of such agents. To cope
with such digests you can set encapsulation boundary length to a higher
-value. For example, @command{bounce --length=8} has been found to be
+value. For example, @command{bounce --length=8} has been found to be
sufficient for most Mailman-generated digests.
@item comp
@@ -248,7 +248,7 @@ Understands @option{--build} option.
@item fmtdump
-This command is not provided. Use @option{fmtcheck} instead.
+This command is not provided. Use @option{fmtcheck} instead.
@item mhl
@@ -280,8 +280,8 @@ The following format variables are silently ignored:
@samp{center},
@itemize @bullet
@item New option
-New option @option{--compose} forces @command{mhn} editing mode. This
-is also the default mode. This differs from the standard
+New option @option{--compose} forces @command{mhn} editing mode. This
+is also the default mode. This differs from the standard
@command{mhn}, which switches to the editing mode only if no other
options were given and the input file name coincides with the value of
@env{mhdraft} environment variable.
@@ -289,22 +289,22 @@ options were given and the input file name coincides with
the value of
@item Show mode (@option{--show})
If an appropriate mhn-show-type[/subtype] was not found, GNU @command{mhn}
prints the decoded message content using @code{moreproc}
-variable. Standard @command{mhn} in this case used to print @samp{don't
+variable. Standard @command{mhn} in this case used to print @samp{don't
know how to display content} diagnostic.
The default behaviour is to pipe the content to the standard input
-of the mhn-show-type[/subtype] command. This is altered to using a
+of the mhn-show-type[/subtype] command. This is altered to using a
temporary file if the command contains @code{%f} or @code{%F} escapes.
@item Store mode (@option{--store})
If the @code{Content-Disposition} header contains @samp{filename=},
and @command{mhn} is invoked with @option{--auto} switch, it
transforms the file name into the absolute notation and uses it only
-if it lies below the current mhn-storage directory. Standard
+if it lies below the current mhn-storage directory. Standard
@command{mhn} only requires that the file name do not begin with @samp{/}.
Before saving a message part, GNU @command{mhn} checks if the file already
-exists. If so, it asks whether the user wishes to rewrite it. This
+exists. If so, it asks whether the user wishes to rewrite it. This
behaviour is disabled when @option{--quiet} option was given.
@end itemize
@@ -319,7 +319,7 @@ recognized only if at least one of the following conditions
is met:
@itemize @bullet
@item The word @var{component} contains at least one capital letter.
-E.g. @option{--User-Agent Mailutils}.
+E.g. @option{--User-Agent Mailutils}.
@item The word @var{component} ends with a colon, as in
@option{user-agent: Mailutils}.
@@ -334,7 +334,7 @@ pick --component @var{field} --pattern @var{string}
@end smallexample
New command line option @option{--cflags} allows to control the type of
-regular expressions used. The option must occur right before
+regular expressions used. The option must occur right before
@option{--pattern} or @option{--component} option (or one of its
aliases, like @option{--cc}, @option{--from}, etc.)
@@ -401,11 +401,11 @@ will add it automatically.
@item
Linking messages between folders goes against the logic of Mailutils,
so @command{refile} never makes links even if called with
address@hidden option. The latter is actually a synonym for @option{--copy},
address@hidden option. The latter is actually a synonym for @option{--copy},
which preserves the original message.
@item
-The @option{--preserve} option is not implemented. It is retained for backward
+The @option{--preserve} option is not implemented. It is retained for backward
compatibility only.
@item
@@ -414,7 +414,7 @@ Message specs and folder names may be interspersed.
@item repl
-Understands @option{--use} option. Disposition shell provides
+Understands @option{--use} option. Disposition shell provides
@code{use} command.
@item rmm
@@ -423,7 +423,7 @@ Understands @option{--use} option. Disposition shell
provides
@item
Different behaviour if one of the messages in the list does not exist:
-Mailutils @command{rmm} does not delete any messages. Standard
+Mailutils @command{rmm} does not delete any messages. Standard
@command{rmm} in this case deletes all messages preceding the
non-existent one.
@@ -445,7 +445,7 @@ Any number of @option{--datefield}, @option{--textfield} and
@option{--numfield} options may be given, thus allowing to build sort
criteria of arbitrary complexity.
-The order of @option{--.*field} options sets the ordering priority. This
+The order of @option{--.*field} options sets the ordering priority. This
differs from the behaviour of the standard @command{sortm}, which
always orders datefield-major, textfield-minor.
@@ -459,7 +459,7 @@ List the ordered messages using a format string given by
@item --dry-run
Do not actually sort messages, rather print what would have been
-done. This is useful for debugging purposes.
+done. This is useful for debugging purposes.
@end table
@end table
diff --git a/doc/texinfo/programs.texi b/doc/texinfo/programs.texi
index bcac978..84d9034 100644
--- a/doc/texinfo/programs.texi
+++ b/doc/texinfo/programs.texi
@@ -5,12 +5,12 @@
@comment *******************************************************************
GNU Mailutils provides a broad set of utilities for handling
-electronic mail. These utilities address the needs of both system
+electronic mail. These utilities address the needs of both system
administrators and users.
All utilities are built around a single core subsystem and share many
-common aspects. All of them are able to work with almost any existing
-mailbox formats. They use a common configuration file syntax, and
+common aspects. All of them are able to work with almost any existing
+mailbox formats. They use a common configuration file syntax, and
their configuration files are located in a single subdirectory.
In this chapter we will discuss each utility, and give some advices on
@@ -22,6 +22,7 @@ syntax.
@menu
* command line:: Command Line Syntax.
* configuration:: Common Configuration File.
+* debugging::
* frm and from:: List Headers from a Mailbox.
* mail:: Send and Receive Mail.
@@ -42,7 +43,7 @@ syntax.
* mh:: The MH Message Handling System.
-* mailutils-config:: Get the Information about the Mailutils Build.
+* mu:: Mailutils Multi-Purpose Tool.
@end menu
@node command line
@@ -57,55 +58,55 @@ syntax.
@subsection Basic Notions About Command Line Options
Many command line options have two forms, called short and long
-forms. Both forms are absolutely identical in function; they are
+forms. Both forms are absolutely identical in function; they are
interchangeable.
The @dfn{short} form is a traditional form for UNIX utilities.
In this form, the option consists of a single dash, followed by a
-single letter, e.g. @option{-c}.
+single letter, e.g. @option{-c}.
Short options which require arguments take their arguments
immediately following the option letter, optionally separated by white
-space. For example, you might write @option{-f name}, or @option{-fname}.
+space. For example, you might write @option{-f name}, or @option{-fname}.
Here, @option{-f} is the option, and @option{name} is its argument.
Short options which allow optional arguments take their arguments
immediately following the option letter, @emph{without any intervening
-white space characters}. This is important, so that the command line
+white space characters}. This is important, so that the command line
parser might discern that the text following option is its argument,
-not the next command line parameter. For example, if option @option{-d}
+not the next command line parameter. For example, if option @option{-d}
took an optional argument, then @option{-dname} would mean the option
with its argument (@option{name} in this case), and @option{-d name} would
mean the @option{-d} option without any argument, followed by command
line argument @option{name}.
Short options' letters may be clumped together, but you are not
-required to do this. When short options are clumped as a set, use one
-(single) dash for them all, e.g. @option{-cvl} is equivalent to @option{-c
--v -l}. However, only options that do not take arguments may be
-clustered this way. If an option takes an argument, it can only be
+required to do this. When short options are clumped as a set, use one
+(single) dash for them all, e.g. @option{-cvl} is equivalent to @option{-c
+-v -l}. However, only options that do not take arguments may be
+clustered this way. If an option takes an argument, it can only be
the last option in such a cluster, otherwise it would be impossible to
-specify the argument for it. Anyway, it is much more readable to
+specify the argument for it. Anyway, it is much more readable to
specify such options separated.
The @dfn{long} option names are probably easier to memorize than
-their short counterparts. They consist of two dashes, followed by a
+their short counterparts. They consist of two dashes, followed by a
multi-letter option name, which is usually selected to be a mnemonics
-for the operation it requests. For example, @option{--verbose} is a
-long option that increases the verbosity of a utility. In addition,
+for the operation it requests. For example, @option{--verbose} is a
+long option that increases the verbosity of a utility. In addition,
long option names can abbreviated, provided that such an abbreviation
-is unique among the options understood by a given utility. For
+is unique among the options understood by a given utility. For
example, if a utility takes options @option{--foreground} and
@option{--forward}, then the shortest possible abbreviations for these
-options are @option{--fore} and @option{--forw}, correspondingly. If
+options are @option{--fore} and @option{--forw}, correspondingly. If
you try to use @option{--for}, the utility will abort and inform you
that the abbreviation you use is ambiguous, so it is not clear which
of the options you intended to use.
Long options which require arguments take those arguments following
-the option name. There are two ways of specifying a mandatory
-argument. It can be separated from the option name either by an equal
-sign, or by any amount of white space characters. For example, if the
+the option name. There are two ways of specifying a mandatory
+argument. It can be separated from the option name either by an equal
+sign, or by any amount of white space characters. For example, if the
@option{--file} option requires an argument, and you wish to supply
@file{name} as its argument, then you can do so using any of the
following notations: @option{--file=name} or @option{--file name}.
@@ -125,22 +126,22 @@ equal sign.
Display a short summary of the command line options understood by
this utilities, along with a terse description of each.
- The output of this option consists of three major parts. First, a
-usage synopsis is displayed. For example:
+ The output of this option consists of three major parts. First, a
+usage synopsis is displayed. For example:
address@hidden
address@hidden
@group
Usage: sieve [OPTION...] SCRIPT
GNU sieve -- a mail filtering tool
@end group
address@hidden smallexample
address@hidden example
The first line tells that the @command{sieve} utility takes any
number of options (brackets indicate optional part) and a single
-mandatory argument (@samp{SCRIPT}). The second lines summarizes the
+mandatory argument (@samp{SCRIPT}). The second lines summarizes the
purpose of the utility.
- Following this header is an option summary. It consists of two
+ Following this header is an option summary. It consists of two
columns:
@verbatim
@@ -151,10 +152,10 @@ columns:
The leftmost column contains a comma-separated list of option
-names. Short options are listed first. The options are ordered
-alphabetically. Arguments, if any, are specified after the last
+names. Short options are listed first. The options are ordered
+alphabetically. Arguments, if any, are specified after the last
option name in the list, so that, e.g. the option @samp{-e} in the
-example above requires an argument: @samp{-e ADDRESS}. Optional
+example above requires an argument: @samp{-e ADDRESS}. Optional
arguments are enclosed in square brackets, as in @option{--debug}
option in the example above.
@@ -166,20 +167,20 @@ notices and lists the email address for reporting bugs.
@xopindex{usage, described}
@item --usage
-Display a short summary of options. In the contrast to the
+Display a short summary of options. In the contrast to the
@option{--help} option, only option names and arguments
-are printed, without any textual description. For example:
+are printed, without any textual description. For example:
address@hidden
address@hidden
@group
Usage: sieve [-cv?V] [--compile-only] [--debug[=FLAGS]]
[--email=ADDRESS] SCRIPT
@end group
address@hidden smallexample
address@hidden example
@end table
The exact formatting of the output produced by these two options is
-configurable. @xref{Usage Vars}, for a detailed descriptions of it.
+configurable. @xref{Usage Vars}, for a detailed descriptions of it.
@table @option
@xopindex{version, described}
@@ -189,15 +190,15 @@ Print program version and exit.
@xopindex{show-config-options, described}
@item --show-config-options
-Show configuration options used when compiling the package. You can
+Show configuration options used when compiling the package. You can
use this option to verify if support for a particular mailbox format
-or other functionality is compiled in the binary. The output of this
+or other functionality is compiled in the binary. The output of this
option is intended to be both machine-readable and understandable by
humans.
@end table
The following command line options affect parsing of configuration
-files. Here we provide a short summary, the next section will
+files. Here we provide a short summary, the next section will
describe them in detail.
@table @option
@@ -224,6 +225,10 @@ Do not load site-wide configuration file.
@xopindex{no-user-config, introduced}
@item --no-user-config
Do not load user configuration file.
+
address@hidden, introduced}
address@hidden address@hidden
+Set configuration variable.
@end table
@node configuration
@@ -232,7 +237,7 @@ Do not load user configuration file.
@cindex mailutils.rc
Configuration files are the principal means of configuring any GNU
-Mailutils component. When started, each utility tries to load its
+Mailutils component. When started, each utility tries to load its
configuration from the following locations, in that order:
@enumerate 1
@@ -242,16 +247,16 @@ It is named @address@hidden/mailutils.rc}, where
@var{sysconfdir} stands
for the system configuration directory set when compiling the package.
You can obtain the value of @var{sysconfdir} by running
address@hidden
address@hidden
$ mailutils-config --info sysconfdir
address@hidden smallexample
address@hidden example
@noindent
or
address@hidden
address@hidden
$ @var{prog} --show-config-options | grep SYSCONFDIR
address@hidden smallexample
address@hidden example
@noindent
where @var{prog} stands for any GNU Mailutils utility.
@@ -264,7 +269,7 @@ command line option was given.
A per user configuration file is located in the user home directory
and is named @address@hidden, where @var{prog} is the name of the
-utility. For example, the per-user configuration file for
+utility. For example, the per-user configuration file for
@command{sieve} utility is named @file{.sieve}.
@xopindex{no-user-config, described}
@@ -277,31 +282,31 @@ command line option was given.
@end enumerate
The order in which configuration files are loaded defines the
-precedence of their settings. Thus, the settings from additional
+precedence of their settings. Thus, the settings from additional
configuration file override those set in per-user configuration file.
The latter, in their turn, take precedence over the settings from the
site-wide configuration file.
@xopindex{config-verbose, described}
Neither site-wide nor user configuration files are required to
-exist. If any or both of them are absent, GNU Mailutils does not
-complain, and the utility falls back to its default settings. To make
+exist. If any or both of them are absent, GNU Mailutils does not
+complain, and the utility falls back to its default settings. To make
configuration processing more verbose, use the
address@hidden command line option. Here is an example of
address@hidden command line option. Here is an example of
what you might get using this option:
address@hidden
address@hidden
imap4d: Info: parsing file `/etc/mailutils.rc'
imap4d: Info: finished parsing file `/etc/mailutils.rc'
address@hidden smallexample
address@hidden example
Specifying this option more than once adds more verbosity to this
-output. If this option is given two times, GNU Mailutils will print
+output. If this option is given two times, GNU Mailutils will print
any configuration file statement it parsed, along with the exact
location where it occurred (the exact meaning of each statement will
be described later in this chapter):
address@hidden
address@hidden
imap4d: Info: parsing file `/etc/mailutils.rc'
# 1 "/etc/mailutils.rc"
mailbox @{
@@ -314,30 +319,43 @@ mailbox @{
include /etc/mailutils.d;
imap4d: Info: parsing file `/etc/mailutils.d/imap4d'
...
address@hidden smallexample
address@hidden example
@xopindex{config-lint, described}
To test configuration file without actually starting the utility,
-use the @option{--config-lint} command line option. With this option,
+use the @option{--config-lint} command line option. With this option,
any Mailutils utility exits after finishing parsing of the
-configuration files. Any errors occurred during parsing are displayed
-on the standard error output. This option can be combined with
+configuration files. Any errors occurred during parsing are displayed
+on the standard error output. This option can be combined with
@option{--config-verbose} to obtain more detailed output.
@xopindex{config-help, described}
The @option{--config-help} command line option produces on the
standard output the summary of all configuration statements understood
by the utility, with detailed comments and in the form suitable for
-configuration file. For example, the simplest way to write a
+configuration file. For example, the simplest way to write a
configuration file for, say, @command{imap4d} is to run
address@hidden
address@hidden
$ imap4d --config-help > imap4d.rc
address@hidden smallexample
address@hidden example
@noindent
and to edit the @file{imap4d.rc} file with your editor of choice.
address@hidden, described}
+ It is also possible to set or override arbitrary configuration
+variables in the command line. It can be done via the @option{--set}
+option. Its argument is a @dfn{pathname} of the variable to be set.
+For example, to define the variable @samp{syslog} in section
address@hidden to @samp{no}, do the following:
+
address@hidden
+$ imap4d --set .logging.syslog=no
address@hidden example
+
+Configuration pathnames are discussed in detail in @ref{Paths}.
+
@menu
* conf-syntax:: Configuration File Syntax
* Include:: Include Statement
@@ -361,40 +379,41 @@ and to edit the @file{imap4d.rc} file with your editor of
choice.
@node conf-syntax
@subsection Configuration File Syntax
- Configuration files consist of a series of statements. Blanks,
-tabs, newlines and comments, collectively called @dfn{white space} are
-ignored except as they serve to separate tokens. Some white space is
-required to separate otherwise adjacent keywords and values.
+ The configuration file consists of statements and comments.
+
+ There are three classes of lexical tokens: keywords, values, and
+separators. Blanks, tabs, newlines and comments, collectively called
address@hidden space} are ignored except as they serve to separate
+tokens. Some white space is required to separate otherwise adjacent
+keywords and values.
@menu
* Comments::
* Statements::
-* Block Statements::
+* Paths::
@end menu
@node Comments
@subsubsection Comments
address@hidden comments, configuration file
address@hidden comments, single-line
address@hidden Comments in a configuration file
@cindex single-line comments
@dfn{Comments} may appear anywhere where white space may appear in the
-configuration file. There are two kinds of comments:
-single-line and multi-line comments. @dfn{Single-line} comments start
+configuration file. There are two kinds of comments:
+single-line and multi-line comments. @dfn{Single-line} comments start
with @samp{#} or @samp{//} and continue to the end of the line:
address@hidden
address@hidden
# This is a comment
// This too is a comment
address@hidden smallexample
address@hidden example
address@hidden comments, multi-line
@cindex multi-line comments
@dfn{Multi-line} or @dfn{C-style} comments start with the two
characters @samp{/*} (slash, star) and continue until the first
occurrence of @samp{*/} (star, slash).
- Multi-line comments cannot be nested. However, single-line comments
-are allowed to appear within a multi-line one.
+ Multi-line comments cannot be nested. However, single-line comments
+may well appear within multi-line ones.
@node Statements
@subsubsection Statements
@@ -402,21 +421,20 @@ are allowed to appear within a multi-line one.
@cindex configuration file statements
@cindex statement, simple
@cindex simple statements
- A @dfn{simple statement}, consists of a keyword and value
-separated by any amount of whitespace. Simple statement is terminated
-with a semicolon (@samp{;}), unless it contains a @dfn{here-document}
-(see below), in which case semicolon is optional.
+ A @dfn{simple statement} consists of a keyword and value
+separated by any amount of whitespace. Simple statement is terminated
+with a semicolon (@samp{;}).
- Examples of simple statements:
+ The following is a simple statement:
address@hidden
-pidfile /var/run/imap4d.pid;
-transcript yes;
address@hidden smallexample
address@hidden
+standalone yes;
+pidfile /var/run/pop3d.pid;
address@hidden example
A @dfn{keyword} begins with a letter and may contain letters,
decimal digits, underscores (@samp{_}) and dashes (@samp{-}).
-Examples of keywords are: @samp{group}, @samp{identity-check}.
+Examples of keywords are: @samp{expression}, @samp{output-file}.
A @dfn{value} can be one of the following:
@@ -424,7 +442,7 @@ Examples of keywords are: @samp{group},
@samp{identity-check}.
@item number
A number is a sequence of decimal digits.
address@hidden value}
address@hidden value}
@item boolean
@cindex boolean value
A boolean value is one of the following: @samp{yes}, @samp{true},
@@ -435,14 +453,14 @@ Examples of keywords are: @samp{group},
@samp{identity-check}.
@cindex string, unquoted
An unquoted string may contain letters, digits, and any of the
following characters: @samp{_}, @samp{-}, @samp{.}, @samp{/},
address@hidden:}.
address@hidden@@}, @samp{*}, @samp{:}.
@item quoted string
@cindex quoted string
@cindex string, quoted
@cindex escape sequence
A quoted string is any sequence of characters enclosed in
-double-quotes (@samp{"}). A backslash appearing within a quoted
+double-quotes (@samp{"}). A backslash appearing within a quoted
string introduces an @dfn{escape sequence}, which is replaced
with a single character according to the following rules:
@@ -456,142 +474,220 @@ with a single character according to the following
rules:
@item \n @tab Newline character (@acronym{ASCII} 10)
@item \r @tab Carriage return character (@acronym{ASCII} 13)
@item \t @tab Horizontal tabulation character (@acronym{ASCII} 9)
address@hidden \v @tab Vertical tabulation character (@acronym{ASCII} 11)
@item \\ @tab A single backslash (@samp{\})
@item \" @tab A double-quote.
@end multitable
@end float
In addition, the sequence @address@hidden is removed from
-the string. This allows to split long strings over several
+the string. This allows to split long strings over several
physical lines, e.g.:
address@hidden
address@hidden
@group
"a long string may be\
split over several lines"
@end group
address@hidden smallexample
address@hidden example
If the character following a backslash is not one of those specified
above, the backslash is ignored and a warning is issued.
Two or more adjacent quoted strings are concatenated, which gives
another way to split long strings over several lines to improve
-readability. The following fragment produces the same result as the
+readability. The following fragment produces the same result as the
example above:
address@hidden
address@hidden
@group
"a long string may be"
" split over several lines"
@end group
address@hidden smallexample
address@hidden example
@anchor{here-document}
@item Here-document
@cindex here-document
- @dfn{Here-document} is a special construct that allows to introduce
+ A @dfn{here-document} is a special construct that allows to introduce
strings of text containing embedded newlines.
The @code{<<@var{word}} construct instructs the parser to read all
-the lines that follow up to the line containing only @var{word}, with
-possible trailing blanks. Any lines thus read are concatenated
-together into a single string. For example:
+the following lines up to the line containing only @var{word}, with
+possible trailing blanks. Any lines thus read are concatenated
+together into a single string. For example:
address@hidden
address@hidden
@group
<<EOT
A multiline
string
EOT
@end group
address@hidden smallexample
address@hidden example
- Body of a here-document is interpreted the same way as
+ The body of a here-document is interpreted the same way as a
double-quoted string, unless @var{word} is preceded by a backslash
-(e.g. @samp{<<\EOT}) or enclosed in double-quotes, in which case
+(e.g. @samp{<<\EOT}) or enclosed in double-quotes, in which case
the text is read as is, without interpretation of escape sequences.
If @var{word} is prefixed with @code{-} (a dash), then all leading
tab characters are stripped from input lines and the line containing
address@hidden Furthermore, if @code{-} is followed by a single space,
-all leading whitespace is stripped from them. This allows to indent
-here-documents in a natural fashion. For example:
address@hidden Furthermore, if @code{-} is followed by a single space,
+all leading whitespace is stripped from them. This allows to indent
+here-documents in a natural fashion. For example:
address@hidden
address@hidden
@group
<<- TEXT
- All leading whitespace will be
+ The leading whitespace will be
ignored when reading these lines.
TEXT
@end group
address@hidden smallexample
address@hidden example
It is important that the terminating delimiter be the only token on
-its line. The only exception to this rule is allowed if a
-here-document appears as the last element of a statement. In this
+its line. The only exception to this rule is allowed if a
+here-document appears as the last element of a statement. In this
case a semicolon can be placed on the same line with its terminating
delimiter, as in:
address@hidden
address@hidden
help-text <<-EOT
A sample help text.
EOT;
address@hidden smallexample
-
- However, terminated semicolon after a here-document is optional.
address@hidden example
@anchor{list values}
@item list
@cindex list
- A @dfn{list} is a comma-separated list of values. Lists are
-enclosed in parentheses. The following example shows a statement
+ A @dfn{list} is a comma-separated list of values. Lists are
+enclosed in parentheses. The following example shows a statement
whose value is a list of strings:
address@hidden
-shared-namespace ("/home", "/var/spool/common");
address@hidden smallexample
address@hidden
+alias (test,null);
address@hidden example
In any case where a list is appropriate, a single value is allowed
without being a member of a list: it is equivalent to a list with a
-single member. This means that, e.g. @samp{shared-namespace /home;} is
-equivalent to @samp{shared-namespace (/home);}.
+single member. This means that, e.g.
+
address@hidden
+alias test;
address@hidden example
+
address@hidden
+is equivalent to
+
address@hidden
+alias (test);
address@hidden example
@end table
address@hidden Block Statements
address@hidden Block Statements
address@hidden block statement, configuration file
- A @dfn{block statement} introduces a logical group of another
-statements. It consists of a keyword, followed by an optional value,
address@hidden statement, block
address@hidden block statement
+ A @dfn{block statement} introduces a logical group of
+statements. It consists of a keyword, followed by an optional value,
and a sequence of statements enclosed in curly braces, as shown in
-example below:
+the example below:
address@hidden
address@hidden
@group
-tcp-wrappers @{
- enable yes;
- allow-syslog-priority info;
- deny-syslog-priority notice;
+server srv1 @{
+ host 10.0.0.1;
+ community "foo";
@}
@end group
address@hidden smallexample
address@hidden example
The closing curly brace may be followed by a semicolon, although
this is not required.
-
+
address@hidden Paths
address@hidden Statement Path
+
address@hidden configuration files have a distinct hierarchical
+structure. Each statement in such files can therefore be identified
+by its name and the names of block statements containing it. Such
+names form this statement @dfn{pathname}, similar to that used,
+e.g. by UNIX file system.
+
+For example, consider the following file:
+
address@hidden
+foo @{
+ bar @{
+ baz 45; # @r{A.}
+ @}
+ baz 98; # @r{B.}
address@hidden
address@hidden example
+
+The full pathname of the statement marked with @samp{A} can be written
+as:
+
address@hidden
+.foo.bar.baz
address@hidden example
+
+Similarly, the statement marked with @samp{B} has the following
+pathname:
+
address@hidden
+.foo.baz
address@hidden example
+
+The default path component separator is dot. A pathname beginning with
+a component separator is called @dfn{absolute pathname}. Absolute
+pathnames uniquely identify corresponding statements. If the leading
+dot is omitted, the resulting pathname is called
address@hidden Relative pathnames identify statements in relation to
+the current point of reference in the configuration file.
+
+Any other punctuation character can be used as a component separator,
+provided that it appears at the beginning of the pathname. In other
+words, only absolute pathnames allow for a change in component separators.
+
+A block statement that has a tag is referred to by its name, followed
+by an equals sign, followed by the tag value. For example, the
+statement @samp{A} in the file below:
+
address@hidden
+program x @{
+ bar @{
+ baz 45; # @r{A.}
+ @}
address@hidden
address@hidden example
+
+is identified by the following pathname:
+
address@hidden
+.program=x.bar.baz
address@hidden example
+
+The tag can optionally be enclosed in a pair of double quotes. Such a
+quoting becomes mandatory for tags that contain white space or path
+component separator, e.g.:
+
address@hidden
+.program="a.out".bar.baz
address@hidden example
+
@node Include
@subsection Include Statement
@cindex include statement, configuration file
@kwindex include
- An @dfn{include statement} is a special statement that causes
-inclusion of a named file. This statement has the following syntax:
+ The @dfn{include statement} is a special statement that causes
+inclusion of a named file. It has the following syntax:
address@hidden
address@hidden
include @var{file};
address@hidden smallexample
address@hidden example
If @var{file} names a regular file, the contents of this file is
-included in this point. Otherwise, if @var{file} names a directory,
+included in this point. Otherwise, if @var{file} names a directory,
Mailutils searches in that directory for a file whose name coincides
with the name of utility being executed, and includes this file, if it
exists.
@@ -599,215 +695,103 @@ exists.
It is a common approach to end the site-wide configuration file with
an include statement, e.g.:
address@hidden
address@hidden
include /etc/mailutils.d;
address@hidden smallexample
address@hidden example
This allows each particular utility to have its own configuration
-file. Thus. @command{imap4d} will read
+file. Thus. @command{imap4d} will read
@file{/etc/mailutils.d/imap4d}, etc.
@node Logging Statement
@subsection Logging Statement
@kwindex logging
@subheading Syntax
address@hidden
address@hidden
logging @{
+ # @r{Send diagnostics to syslog.}
+ syslog @var{boolean};
+ # @r{Print message severity levels.}
+ print-severity @var{boolean};
+ # @r{Output only messages with a severity equal to or}
+ # @r{greater than this one.}
+ severity @var{string};
# @r{Set syslog facility.}
facility @var{name};
# @r{Tag syslog messages with this string.}
tag @var{text};
@}
address@hidden smallexample
address@hidden example
@subheading Description
- The @code{logging} block statement provides configuration for
-programs that use @command{syslog} for diagnostics. The default
-syslog facility is determined at compile time, it can be inspected
-using the following command:
+ The @code{logging} block statement configures where the diagnostic
+output goes and how verbose it is.
+
address@hidden {Configuration} syslog bool
+If @samp{syslog} is set to @samp{yes}, the diagnostics will go to
+syslog. Otherwise, it goes to the standard error.
address@hidden deffn
address@hidden
-$ mailutils-config --info log_facility
address@hidden smallexample
+The default syslog facility is determined at compile time, it can be inspected
+using the following command (@pxref{mu info}):
+
address@hidden
+$ mu info log_facility
address@hidden example
@anchor{syslog facility}
@deffn {Configuration} facility name
-Use syslog facility @var{name}. Valid argument values are: @samp{user},
+Use syslog facility @var{name}. Valid argument values are: @samp{user},
@samp{daemon}, @samp{auth}, @samp{authpriv}, @samp{mail}, @samp{cron},
@samp{local0} through @samp{local7} (all names case-insensitive), or
a facility number.
@end deffn
@deffn {Configuration} tag text
-Tag syslog messages with @var{text}. By default, program name is used
+Tag syslog messages with @var{text}. By default, program name is used
as syslog tag.
@end deffn
address@hidden {Configuration} print-severity bool
+Print Mailutils severity name before each message.
address@hidden deffn
+
address@hidden {Configuration} severity name
+Output only messages with a severity equal to or greater than this
+one. Valid arguments are: @samp{debug}, @samp{info}, @samp{notice},
address@hidden, @samp{error}, @samp{crit}, @samp{alert}, @samp{emerg},
address@hidden deffn
+
@node Debug Statement
@subsection Debug Statement
@kwindex debug
@subheading Syntax
address@hidden
address@hidden
debug @{
# @r{Set Mailutils debugging level.}
level @var{spec};
# @r{Prefix debug messages with Mailutils source locations.}
line-info @var{bool};
@}
address@hidden smallexample
address@hidden example
@subheading Description
-The @code{debug} statement configures debugging output. Although it
-is mostly useful for Mailutils developers, it may be of interest for
-casual users as well. In particular, you may use it to obtain more
-information about Mailutils actions, which may help in configuring it,
-or in filling a bug report.
-
-Debugging output is controlled by a set of levels, each of which can be
-enabled or disabled independently of others. A @dfn{debugging
-level} consists of a module name, which defines a Mailutils module
-affected by this level, and a level number, which defines the
-verbosity of the debugging output. Valid debugging levels are:
-
address@hidden Table, debugging levels
address@hidden levels}
address@hidden @asis
address@hidden error
-Display only error messages.
-
address@hidden trace0 through trace7
-Eight levels of verbosity, @samp{trace0} producing less output,
address@hidden producing maximum possible output.
-
address@hidden prot
-Display network protocol interactions, where appropriate.
address@hidden table
address@hidden float
-
-The most important debugging modules are:
-
address@hidden @asis
address@hidden acl
-Debug access control lists. @FIXME-xref{Debugging ACLs}.
-
address@hidden config
-Debug configuration parser and/or lexical analyzer. The following
-levels are supported:
-
address@hidden @asis
address@hidden trace0
-Minimal information about configuration statements.
-
address@hidden trace2
-Trace lexical structure of the configuration files.
-
address@hidden trace7
-Trace execution of the configuration parser.
address@hidden table
-
-Due to its specific nature, this debugging module cannot be enabled
-using @code{level} statement below. The @option{--debug-level}
-command line option should be used instead
-(@FIXME-pxref{debug-level}). Alternatively, you may use the following
-hook, provided to facilitate debugging of the configuration parser: a
address@hidden comment} in form:
-
address@hidden
address@hidden
address@hidden smallexample
-
-is understood as a request to set debugging level of module
address@hidden to @var{level}.
-
address@hidden ip_server
-IP based servers, such as @command{imap4d} and @command{pop3d}. This
-module supports @samp{trace0} and @samp{error} levels. @xref{Server
-Settings}, for more information about servers.
-
address@hidden udp_server
-UDP based servers, such as @command{comsatd}. This module supports
address@hidden and @samp{error} levels. @xref{Server Settings}, for
-more information about servers.
-
address@hidden mailbox
-Operations over mailboxes. This module supports the following levels:
address@hidden, @samp{trace0}, @samp{trace1}, and @samp{proto}. The
-latter is used by remote mailbox support libraries.
-
address@hidden sieve
-Debug Sieve parser and run-time evaluator. Currently supported levels
-are @samp{error}, @samp{trace1} and @samp{trace7}.
address@hidden table
-
address@hidden {Configuration} level spec
-This statement enables debugging levels given by @var{spec}. The
-argument is an list of debugging specifications or a string with
-specifications delimited by semicolons. The syntax of a specification
-is:
-
address@hidden
- @var{module}[[:address@hidden
address@hidden smallexample
-
address@hidden
-where @var{module} is the name of a module, and @var{level} is the
-level to be set. The level may be optionally prefixed with the
-following symbols:
-
address@hidden @samp
address@hidden !
-All levels except this one. E.g. @samp{config=!trace7} means
-set all debugging levels, except @samp{trace7} for the @samp{config}
-module.
-
address@hidden <
-All levels up to and including this. The words @samp{up to} refer to
-the position of levels in @ref{debugging levels} table, so that, e.g.
address@hidden<trace2} means levels @samp{error}, @samp{trace0}, @samp{trace1}
-and @samp{trace2}.
address@hidden table
-
-Both prefixes can be used together, in this order: @samp{!<}. This
-means all levels except this one and ones listed before it in
-the table.
-
-A comma before equal sign, as in @samp{mailbox:=<trace7} means set
-this debugging levels in all modules, invoked by this one.
-
-The @var{level} in the level specification can also be a
-comma-separated list of valid levels, e.g.:
-
address@hidden
- mailbox=<trace2,!<trace4
address@hidden smallexample
-
address@hidden
-which means ``levels trace3 and trace4''.
-
-The following example illustrates two equivalent ways of setting
-debugging level in a configuration file:
-
address@hidden
- level ("mailbox=!proto", "acl=<trace7");
- level "mailbox=!proto;acl=<trace7";
address@hidden smallexample
-
-The @option{--debug-level} command line option overrides the settings
-of the @code{level} configuration statement.
address@hidden deffn
-
address@hidden {Configuration} line-info @var{bool}
-If @var{bool} is @samp{true} (@pxref{boolean value}), each debugging
-message will be preceded by a corresponding source file location,
-i.e. the file name and line number where this message was generated.
address@hidden deffn
+The @samp{debug} statement controls the amount of additional debugging
+information output by Mailutils programs. The @samp{level} statement
+enables additional debugging information. Its argument (@var{spec})
+is a Mailutils debugging specification as described in
address@hidden
+The @samp{line-info} statement, when set to @samp{true} causes
+debugging messages to be prefixed with locations in Mailutils source
+files where they appear. Normally, only Mailutils developers need
+this option.
@node Mailbox Statement
@subsection Mailbox Statement
@kwindex mailbox
@subheading Syntax
address@hidden
address@hidden
mailbox @{
# @r{Use specified @var{url} as a mailspool.}
mail-spool @var{url};
@@ -818,7 +802,7 @@ mailbox @{
# @r{Default user mail folder.}
folder @var{dir};
@}
address@hidden smallexample
address@hidden example
@subheading Description
The @code{mailbox} statement configures the location, name and type of
@@ -829,7 +813,7 @@ The mailbox location can be specified using
@code{mail-spool} or
@deffn {Configuration} mail-spool @var{path}
The @code{mail-spool} statement specifies directory that holds user
-mailboxes. Once this statement is given, the @command{libmailutils}
+mailboxes. Once this statement is given, the @command{libmailutils}
library will assume that the mailbox of user @var{login} is kept in
file @address@hidden/@var{login}}.
@@ -840,25 +824,25 @@ favor of @code{mailbox-pattern} statement.
@deffn {Configuration} mailbox-pattern @var{pattern}
The @code{mailbox-pattern} statement is a modern way of configuring
-mailbox locations. It supersedes @code{mail-spool} statement.
+mailbox locations. It supersedes @code{mail-spool} statement.
The @var{pattern} is valid @dfn{mailbox URL}, which
may contain references to @samp{user} macro-variable
-(@FIXME-pxref{macro-variables}). This macro-variable will be expanded
-to the actual user name. The full syntax for @var{pattern} is:
+(@FIXME-pxref{macro-variables}). This macro-variable will be expanded
+to the actual user name. The full syntax for @var{pattern} is:
address@hidden
address@hidden
address@hidden://address@hidden;@var{args}]
address@hidden smallexample
address@hidden example
@noindent
where:
@table @var
@item type
-Specifies the mailbox type. It must be one of mailbox types,
-supported by Mailutils. @FIXME-xref{Mailbox URLs}. By default,
address@hidden is assumed. @FIXME{Verify this}.
+Specifies the mailbox type. It must be one of mailbox types,
+supported by Mailutils. @FIXME-xref{Mailbox URLs}. By default,
address@hidden is assumed. @FIXME{Verify this}.
@item path
The path pattern.
@@ -873,9 +857,9 @@ mailboxes, which allows for faster access in case of very
large
number of users.
By default, all user mailboxes are stored in a single directory and
-are named after user login names. To find the mailbox for a given
+are named after user login names. To find the mailbox for a given
user, the system scans the directory for the corresponding
-file. This usually implies linear search, so the time needed to
+file. This usually implies linear search, so the time needed to
locate a mailbox is directly proportional to the ordinal number of
the mailbox in the directory.
@@ -885,13 +869,13 @@ GNU Mailutils supports three types of indexed directories:
@cindex direct indexing
@cindex indexing, direct
In direct indexed directory structure, @var{path} contains 26 subdirectories
-named with lower-case letters of Latin alphabet. The location of the
+named with lower-case letters of Latin alphabet. The location of the
user mailbox is determined using the following algorithm:
@enumerate 1
@item Take the first letter of the user name.
@item Map it to a lower-case letter using @dfn{index mapping}
-table. The result gives sub-directory name.
+table. The result gives sub-directory name.
@item Descend into this directory.
@end enumerate
@@ -899,7 +883,7 @@ For example, using this algorithm, the mailbox of the user
@samp{smith} is stored in file @address@hidden/s/smith}.
If each of single-letter subdirectories contains the
-indexed directory structure, we have second level of indexing. In
+indexed directory structure, we have second level of indexing. In
this case the file name of @samp{smith}'s mailbox is
@address@hidden/s/m/smith}.
@@ -907,7 +891,7 @@ this case the file name of @samp{smith}'s mailbox is
@cindex indexing, reverse
The @dfn{reverse} indexed structure uses the same principles, but the
indexing letters are taken from the @emph{end} of the user name,
-instead of from the beginning. For example, in the 2nd level reverse
+instead of from the beginning. For example, in the 2nd level reverse
indexed structure, the @samp{smith}'s mailbox is located in
@address@hidden/h/t/smith}.
@@ -915,9 +899,9 @@ indexed structure, the @samp{smith}'s mailbox is located in
@cindex indexing, hashed
Finally, the @dfn{hashed} structure consists of 256 subdirectories
under @var{path}, named by 2-letter hex codes from @samp{00} to
address@hidden Mailboxes are stored in these subdirectories. The name
address@hidden Mailboxes are stored in these subdirectories. The name
of the subdirectory is computed by hashing first @var{level} letters
-of the user name. The hashing algorithm is:
+of the user name. The hashing algorithm is:
@enumerate 1
@item Take next letter from the user name
@@ -933,7 +917,7 @@ arguments:
@table @asis
@kwindex type
@item address@hidden
-Specifies type of indexing. Valid values are @samp{index}, for direct
+Specifies type of indexing. Valid values are @samp{index}, for direct
indexed structure, @samp{rev-index} for reverse indexing, and
@samp{hash} for hashed structure.
@@ -943,7 +927,7 @@ Specifies indexing level.
@kwindex user
@item address@hidden
-Specifies indexing key. The only meaningful value, as of Mailutils
+Specifies indexing key. The only meaningful value, as of Mailutils
version @value{VERSION} is @address@hidden@}}.
@end table
@@ -951,25 +935,25 @@ Let's assume the traditional mail layout, in which user
incoming
mails are stored in UNIX mailbox format in @file{/var/mail} directory.
The @code{mailbox-pattern} for this case is:
address@hidden
address@hidden
mailbox-pattern "/var/mail/address@hidden@}";
address@hidden smallexample
address@hidden example
It is entirely equivalent to specifying @samp{mail-spool "/var/mail"}.
Now, if the layout is the same, but mailboxes are kept in
@samp{maildir} format, then the corresponding statement is:
address@hidden
address@hidden
mailbox-pattern "maildir:///var/mail/address@hidden@}";
address@hidden smallexample
address@hidden example
Finally, if the mailboxes are stored in a directly-indexed directory with
two levels of indexing, than:
address@hidden
address@hidden
mailbox-pattern "maildir:///var/mail;type=index;param=2;address@hidden@}";
address@hidden smallexample
address@hidden example
@end table
@end deffn
@@ -986,22 +970,22 @@ separator, and the user name.
The built-in mail spool directory name is determined at compile
time, using @samp{_PATH_MAILDIR} define from the include file
address@hidden If this value is not defined, @file{/var/mail} or
address@hidden If this value is not defined, @file{/var/mail} or
@file{/usr/spool/mail} is used.
@end enumerate
@deffn {Configuration} mailbox-type @var{type}
@vrindex MU_DEFAULT_SCHEME
-Specifies type of mailboxes. By default, @samp{mbox} (UNIX mailbox)
-is assumed. This can be changed while configuring the package by
-setting @code{MU_DEFAULT_SCHEME} configuration variable. The default
+Specifies type of mailboxes. By default, @samp{mbox} (UNIX mailbox)
+is assumed. This can be changed while configuring the package by
+setting @code{MU_DEFAULT_SCHEME} configuration variable. The default
value can be verified by running @command{mailutils-config --info scheme}.
@end deffn
@deffn {Configuration} folder @var{dir}
@cindex plus expansion
-Sets user mail folder directory. Its value is using when expanding
address@hidden, i.e. such mailbox names as @file{+inbox}. The
+Sets user mail folder directory. Its value is using when expanding
address@hidden, i.e. such mailbox names as @file{+inbox}. The
@samp{+} sign is replaced by @var{dir}, followed by a directory
separator (@samp{/}).
@@ -1015,7 +999,7 @@ The default folder name is @samp{Mail/}.
@subsection Locking Statement
@kwindex locking
@subheading Syntax
address@hidden
address@hidden
locking @{
# @r{Default locker flags.}
flags @var{arg};
@@ -1028,33 +1012,33 @@ locking @{
# @r{Use @var{prog} as external locker program.}
external-locker @var{prog};
@}
address@hidden smallexample
address@hidden example
@subheading Description
This block statement configures various parameters used when locking
UNIX mailboxes in order to prevent simultaneous writes.
It is important to note, that locking applies only to maildrops in
-UNIX mailbox format. All other mailbox types do not require locking.
+UNIX mailbox format. All other mailbox types do not require locking.
@deffn {Configuration} flags @var{string}
-Set locking flags. Argument is a string consisting of one or more of
+Set locking flags. Argument is a string consisting of one or more of
the following letters:
@table @asis
@item E
-Use an external program to manage locks. The program is given by
+Use an external program to manage locks. The program is given by
@code{external-locker} statement (see below).
@item R
-If the locking attempt failed, retry it. This is the default. The
+If the locking attempt failed, retry it. This is the default. The
number of retries, and time interval between the two successive
attempts is given by @code{retry-count} and @code{retry-timeout}
statements, correspondingly.
@item T
If a lock file exists, check its modification time and, if it is
-older than a predefined amount of time, remove the lock. The amount
+older than a predefined amount of time, remove the lock. The amount
of time is specified by @code{expire-timeout} statement.
@item P
@@ -1063,22 +1047,22 @@ Store the PID of the locking process in a lock file.
@end deffn
@deffn {Configuration} retry-count @var{number}
-Number of locking attempts. The @samp{P} flag must be set for this to
+Number of locking attempts. The @samp{P} flag must be set for this to
take effect.
@end deffn
@deffn {Configuration} retry-timeout @var{seconds}
Time interval, in seconds, between the two successive locking
-attempts. The @samp{P} flag must be set for this to take effect.
+attempts. The @samp{P} flag must be set for this to take effect.
@end deffn
@deffn {Configuration} expire-timeout @var{seconds}
Remove existing lock file, if it is created more than this number of
-seconds ago. The @samp{T} flag must be set for this to take effect.
+seconds ago. The @samp{T} flag must be set for this to take effect.
@end deffn
@deffn {Configuration} external-locker @var{string}
-Set command line of an external locker program. The @samp{E} flag
+Set command line of an external locker program. The @samp{E} flag
must be set for this to take effect.
@end deffn
@@ -1086,16 +1070,16 @@ must be set for this to take effect.
@subsection Mailer Statement
@kwindex mailer
@subheading Syntax
address@hidden
address@hidden
mailer @{
url @var{url};
@}
address@hidden smallexample
address@hidden example
@subheading Description
A @dfn{mailer} is a special logical entity GNU Mailutils uses for
-sending messages. Its internal representation is discussed in
address@hidden The @code{mailer} statement configures it.
+sending messages. Its internal representation is discussed in
address@hidden The @code{mailer} statement configures it.
The mailer statement contains a single sub-statement:
@@ -1104,20 +1088,20 @@ Set the mailer @acronym{URL}.
@end deffn
GNU Mailutils supports two types of mailer @acronym{URL}s, described
-in the table below. As usual, square brackets indicate optional parts:
+in the table below. As usual, square brackets indicate optional parts:
@table @asis
@item smtp://@var{host}[:@var{port}]
-Use an SMTP server @var{host} to send messages. Optional @var{port}
+Use an SMTP server @var{host} to send messages. Optional @var{port}
specifies port number or symbolic name (as defined in
address@hidden/etc/services}). It defaults to 25. The @var{host} can be
address@hidden/etc/services}). It defaults to 25. The @var{host} can be
specified as either an IP address in dotted-quad notation or as a
-symbolic host name. In the latter case, DNS system will be used to
+symbolic host name. In the latter case, DNS system will be used to
resolve it.
@item sendmail://@var{progname}
Use sendmail-compatible program
address@hidden @dfn{Sendmail-compatible} means that the program must
address@hidden @dfn{Sendmail-compatible} means that the program must
support following command line options:
@table @option
@@ -1132,21 +1116,21 @@ Get recipient addresses from the message.
@end table
@item sendmail:
-This is a special form of the @samp{sendmail} mailer. It uses the
+This is a special form of the @samp{sendmail} mailer. It uses the
@command{sendmail} binary from the @code{_PATH_SENDMAIL} macro in your
address@hidden/usr/include/paths.h}. It is the default mailer.
address@hidden/usr/include/paths.h}. It is the default mailer.
@item prog://@address@hidden
-A @dfn{prog} mailer. This is a generalization of @samp{sendmail}
+A @dfn{prog} mailer. This is a generalization of @samp{sendmail}
mailer that allows to use arbitrary external programs as mailers.
-The @var{progname} must be a full pathname of the binary file. When
+The @var{progname} must be a full pathname of the binary file. When
sending message, Mailutils will invoke this file with the arguments
specified by @var{query} and will pipe the message to be sent to its
standard input.
The @var{query} part is a list of arguments, separated by @samp{&}
-signs. Arguments may contain the following macro-substitutions:
+signs. Arguments may contain the following macro-substitutions:
@table @samp
@item address@hidden@}
@@ -1161,7 +1145,7 @@ Expands to the recipient email addresses.
@subsection ACL Statement
@kwindex acl
@subheading Syntax
address@hidden
address@hidden
acl @{
# @r{Allow connections from this IP address.}
allow [from] @var{ip};
@@ -1176,22 +1160,22 @@ acl @{
from @var{ip}. */
ifexec [from] @var{ip} @var{program};
@}
address@hidden smallexample
address@hidden example
@subheading Description
The ACL statement defines an @dfn{Access Control List}, a special
structure that controls who can access the given Mailutils resource.
-The @code{acl} block contains a list of access controls. Each control
+The @code{acl} block contains a list of access controls. Each control
can be regarded as a function that returns a tree-state value:
address@hidden, @samp{False} and @samp{Don't know}. When a
address@hidden, @samp{False} and @samp{Don't know}. When a
remote party connects to the server, each of controls is tried in
-turn. If a control returns @samp{False}, access is denied. If it
-returns @samp{True}, access is allowed. If it returns @samp{Don't
-know}, then the next control is tried. It is unclear whether to allow
-access if the last control in list returned @samp{Don't know}. GNU
+turn. If a control returns @samp{False}, access is denied. If it
+returns @samp{True}, access is allowed. If it returns @samp{Don't
+know}, then the next control is tried. It is unclear whether to allow
+access if the last control in list returned @samp{Don't know}. GNU
Mailutils @value{VERSION} issues a warning message and allows access.
-This default may change in future versions. Users are advised to
+This default may change in future versions. Users are advised to
write their ACLs so that the last control returns a definitive answer
(either @code{True} or @code{False}).
@@ -1200,12 +1184,12 @@ can be replaced by any of:
@itemize @bullet
@item An IPv4 address in dotted-quad notation.
address@hidden An IPv6 address in numeric notation
@item A CIDR in the form @address@hidden/@var{mask}}, where @var{ip} is
-an IPv4 address, and @var{mask} is a decimal number in the range
address@hidden
+an IP address (either IPv4 or IPv6), and @var{mask} is the network mask.
@item A symbolic host name.
@kwindex any
address@hidden A word @samp{any}, that stands for @samp{0.0.0.0/0}.
address@hidden A word @samp{any}, which matches any IP address.
@end itemize
The following controls are understood:
@@ -1220,17 +1204,17 @@ Deny connections from IP addresses matching this
@var{cidr} block.
@deffn {Configuration} ifexec [from] @var{cidr} @var{program}
When a connection from the @var{cidr} block is requested, execute
-the program @var{program}. If its exit code is @samp{0}, then allow
-connection. Otherwise, deny it.
+the program @var{program}. If its exit code is @samp{0}, then allow
+connection. Otherwise, deny it.
@end deffn
The following two controls are provided for logging purposes and as a
-means of extensions. They always return a @samp{Don't know} answer,
+means of extensions. They always return a @samp{Don't know} answer,
and therefore should not be used at the end of an ACL:
@deffn {Configuration} log [from] @var{cidr} address@hidden
-Log connections from addresses in this @var{cidr}. The
address@hidden channel is used. If the logging goes to syslog,
+Log connections from addresses in this @var{cidr}. The
address@hidden channel is used. If the logging goes to syslog,
it is translated to the @code{LOG_INFO} priority.
If @var{string} is not given, the format of the log entry depends on
@@ -1238,30 +1222,30 @@ the connection family, as described in the table below:
@table @asis
@item @{AF_INET @var{ip}:@address@hidden
-For inet IPv4 connections. The variables @var{ip} and @var{port} are
+For inet IPv4 connections. The variables @var{ip} and @var{port} are
replaced by the remote IP address and port number, correspondingly.
@item @address@hidden
-For connections over UNIX sockets. The socket name, if available, may
+For connections over UNIX sockets. The socket name, if available, may
be printed before the closing curly brace.
@end table
If the @var{string} is specified, it undergoes macro expansion and the
-result of it is used as the log entry. The following macro variables
+result of it is used as the log entry. The following macro variables
are expanded:
@table @code
@item aclno
-Ordinal number of the control in the ACL. Numbers begin from
+Ordinal number of the control in the ACL. Numbers begin from
@samp{0}.
@item family
-Connection family. Mailutils version @value{VERSION} supports two
+Connection family. Mailutils version @value{VERSION} supports two
families: @samp{AF_INET} and @samp{AF_UNIX}.
@item address
Remote IP address (for @samp{AF_INET}) or socket name (for
address@hidden). Notice that most Unixes return empty string instead
address@hidden). Notice that most Unixes return empty string instead
of the @samp{AF_UNIX} socket name, so do not rely on it.
@item port
@@ -1271,12 +1255,12 @@ Remote port number (for @samp{AF_INET}).
For example, the following ACL makes a Mailutils server log every
incoming connection:
address@hidden
address@hidden
acl @{
log from any "Connect from address@hidden@}";
...
@}
address@hidden smallexample
address@hidden example
This was the default behavior for the versions of Mailutils up to
@samp{1.2}, so if you got used to its logs you might wish to add the
@@ -1285,15 +1269,16 @@ above in your configuration files.
@deffn {Configuration} exec [from] @var{cidr} @var{program}
If a connection from the @var{cidr} block is requested, execute
-the given @var{program}. Do not wait for it to terminate, and ignore
+the given @var{program}. Do not wait for it to terminate, and ignore
its exit code.
@end deffn
@node Tcp-wrappers Statement
@subsection Tcp-wrappers Statement
address@hidden
@kwindex tcp-wrappers
@subheading Syntax
address@hidden
address@hidden
tcp-wrappers @{
# @r{Enable TCP wrapper access control.}
enable @var{bool};
@@ -1308,47 +1293,47 @@ tcp-wrappers @{
# @r{Log denied accesses at this syslog priority.}
deny-syslog-priority @var{prio};
@}
address@hidden smallexample
address@hidden example
@subsection Description
The @code{tcp-wrappers} statements provides an alternative way to
-control accesses to the resources served by GNU Mailutils. This
+control accesses to the resources served by GNU Mailutils. This
statement is enabled if Mailutils is compiled with TCP wrappers
library @command{libwrap}.
Access control using TCP wrappers is based on two files, called
address@hidden, containing access rules. There are two tables: the
address@hidden, containing access rules. There are two tables: the
@dfn{allow table}, usually stored in file @file{/etc/hosts.allow}, and
-the @dfn{deny table}, kept in file @file{/etc/hosts.deny}. The rules
-in each table begin with an identifier called @dfn{daemon name}. Each
+the @dfn{deny table}, kept in file @file{/etc/hosts.deny}. The rules
+in each table begin with an identifier called @dfn{daemon name}. Each
utility wishing to verify a connection, select the entries having
-its daemon name from the allow table. A connection is allowed if it
-matches any of these entries. Otherwise, the utility retrieves all
-entries with its daemon name from the deny table. If any of these
-matches the connection, then it is refused. Otherwise, if neither
+its daemon name from the allow table. A connection is allowed if it
+matches any of these entries. Otherwise, the utility retrieves all
+entries with its daemon name from the deny table. If any of these
+matches the connection, then it is refused. Otherwise, if neither
table contains matching entries, the connection is allowed.
Description of a TCP wrapper table format lies outside the scope of
-this document. Please, see @ref{ACCESS CONTROL FILES,,ACCESS CONTROL FILES,
+this document. Please, see @ref{ACCESS CONTROL FILES,,ACCESS CONTROL FILES,
hosts_access(5), hosts_access(5) man page}, for details.
@deffn {Configuration} enable @var{bool}
-Enable access control using TCP wrappers. It is on by default.
+Enable access control using TCP wrappers. It is on by default.
@end deffn
@deffn {Configuration} daemon @var{name}
-Set daemon name for TCP wrapper lookups. By default, the name of the
-utility is used. E.g. @command{imap4d} uses @samp{imap4d} as the
+Set daemon name for TCP wrapper lookups. By default, the name of the
+utility is used. E.g. @command{imap4d} uses @samp{imap4d} as the
daemon name.
@end deffn
@deffn {Configuration} allow-table @var{file}
-Use @var{file} as allow table. By default, @file{/etc/hosts.allow} is
+Use @var{file} as allow table. By default, @file{/etc/hosts.allow} is
used.
@end deffn
@deffn {Configuration} deny-table @var{file}
-Use @var{file} as negative table. By default, @file{/etc/hosts.deny}
+Use @var{file} as negative table. By default, @file{/etc/hosts.deny}
is used.
@end deffn
@@ -1362,16 +1347,17 @@ Log denied accesses using syslog priority @var{prio}.
@node Server Settings
@subsection Server Settings
address@hidden
@cindex server settings, configuration
@cindex configuring servers
GNU Mailutils offers several server applications: @command{pop3d},
address@hidden, @command{comsatd}, to name a few. Being quite
address@hidden, @command{comsatd}, to name a few. Being quite
different in their purpose, they are very similar in some aspects of
-their architecture. First of all, they all support two operating
+their architecture. First of all, they all support two operating
mode: a @dfn{daemon} mode, where a program disconnects from the controlling
terminal and works in background, and an @dfn{inetd} mode, where it
remains in foreground and communicates with the remote party via
-standard input and output streams. Secondly, when operating as
+standard input and output streams. Secondly, when operating as
daemons, they listen to a preconfigured set of IP addresses and
ports, reacting to requests that arrive.
@@ -1386,9 +1372,10 @@ subsection.
@node General Server Configuration
@subsubsection General Server Configuration
address@hidden
@cindex server configuration, general
@* Syntax:
address@hidden
address@hidden
# @r{Set daemon mode.}
mode @samp{inetd|daemon};
# @r{Run in foreground.}
@@ -1401,23 +1388,23 @@ pidfile @var{file};
port @var{portspec};
# @r{Set idle timeout.}
timeout @var{time};
address@hidden smallexample
address@hidden example
@* Description:
These statements configure general server-related issues.
@deffn {Configuration} mode @var{string};
-Set operation mode of the server. Two operation modes are supported:
+Set operation mode of the server. Two operation modes are supported:
@anchor{server mode}
@table @asis
@cindex daemon, server mode
@item daemon
Run as a standalone daemon, disconnecting from the controlling
-terminal and continuing to run in the background. In this case, it is
+terminal and continuing to run in the background. In this case, it is
the server that controls what IP addresses and ports to listen on, who
is allowed to connect and from where, how many clients are allowed to
-connect simultaneously, etc. Most remaining configuration statements
+connect simultaneously, etc. Most remaining configuration statements
are valid only in the daemon mode.
This is the preferred mode of operation for GNU Mailutils servers.
@@ -1425,14 +1412,14 @@ This is the preferred mode of operation for GNU
Mailutils servers.
@cindex inetd, server mode
@item inetd
Operate as a subprocess of UNIX internet super-server program,
address@hidden @xref{Internet super-server,,,inetd(8), inetd(8) man
address@hidden @xref{Internet super-server,,,inetd(8), inetd(8) man
page}, for a detailed description of the operation of @command{inetd}
-and its configuration. In this case it is @command{inetd} that
+and its configuration. In this case it is @command{inetd} that
controls all major connectivity aspects, the Mailutils server itself
communicates with it via standard input and output streams.
For historical reasons, this mode is the default, if no @code{mode}
-statement is specified. This will change in the future.
+statement is specified. This will change in the future.
@end table
@end deffn
@@ -1453,31 +1440,32 @@ The default is 20 clients.
@deffn {Configuration} pidfile @var{file};
After startup, store the PID of the main server process in
address@hidden When the process terminates, the file is removed. As of
address@hidden When the process terminates, the file is removed. As of
version @value{VERSION}, GNU Mailutils servers make no further use of
-this file. It is intended for use by automated startup scripts and
+this file. It is intended for use by automated startup scripts and
controlling programs (@FIXME-pxref{mention pies}).
@end deffn
@deffn {Configuration} port @var{portspec};
@*[daemon mode only]
address@hidden default port to listen to. The @var{portspec} argument is either
address@hidden default port to listen to. The @var{portspec} argument is either
a port number in decimal, or a symbolic service name, as listed in
@file{/etc/services} (@pxref{Internet network services list,,,
services(5), services(5) man page}).
@end deffn
@deffn {Configuration} timeout @var{time};
-Set maximum idle time out in seconds. If a client does not send any
+Set maximum idle time out in seconds. If a client does not send any
requests during @var{time} seconds, the child process terminates.
@end deffn
@node Server Statement
@subsubsection Server Statement
address@hidden
@cindex server statement
@kwindex server
@* Syntax:
address@hidden
address@hidden
server @var{ipaddr}[:@var{port}] @{
# @r{Run this server as a single process.}
single-process @var{bool};
@@ -1488,20 +1476,20 @@ server @var{ipaddr}[:@var{port}] @{
# @r{Set server specific ACLs.}
acl @{ /* @xref{ACL Statement}. */ @};
@}
address@hidden smallexample
address@hidden example
@* Description:
The @code{server} block statement configures a single TCP or UDP
-server. It takes effect only in daemon mode (@pxref{server mode}).
+server. It takes effect only in daemon mode (@pxref{server mode}).
The argument to this statement specifies the IP address, and,
-optionally, the port, to listen on for requests. The @var{ipaddr}
+optionally, the port, to listen on for requests. The @var{ipaddr}
part is either an IPv4 address in dotted-quad form, or a symbolic host
-name which can be resolved to such an address via DNS. Specifying
+name which can be resolved to such an address via DNS. Specifying
@samp{0.0.0.0} as the @var{ipaddr} means listen on all available
-network interfaces. The @var{port} argument is either a port number
+network interfaces. The @var{port} argument is either a port number
in decimal, or a symbolic service name, as listed in
@file{/etc/services} (@pxref{Internet network services
-list,,,services(5), services(5) man page}). If @var{port} is omitted,
+list,,,services(5), services(5) man page}). If @var{port} is omitted,
Mailutils uses the port set by @code{port} statement (@pxref{General
Server Configuration, port}), or, in its absence, the default port
number, which depends on a server being used (e.g. 110, for
@@ -1515,28 +1503,28 @@ Statements within the @code{server} block statement
configure this
particular server.
@deffn {Configuration} single-process @var{bool};
-If set to true, this server will operate in single-process mode. This
+If set to true, this server will operate in single-process mode. This
mode is intended for debugging only, do not use it on production
servers.
@end deffn
@deffn {Configuration} transcript @var{bool};
-Enable transcript of the client-server interaction. This may generate
+Enable transcript of the client-server interaction. This may generate
excessive amounts of logging, which in turn may slow down the operation
considerably.
Session transcripts are useful in fine-tuning your configurations and
-in debugging. They should be turned off on most production servers.
+in debugging. They should be turned off on most production servers.
@end deffn
@deffn {Configuration} timeout @var{time};
-Set idle timeout for this server. This overrides global timeout
+Set idle timeout for this server. This overrides global timeout
settings (@pxref{General Server Configuration, timeout}).
@end deffn
@deffn {Configuration} acl
-This statement defines a per-server Access Control List. Its syntax
-is as described in @ref{ACL Statement}. Per-server ACLs complement,
+This statement defines a per-server Access Control List. Its syntax
+is as described in @ref{ACL Statement}. Per-server ACLs complement,
but not override, global ACLs, i.e. if both global ACL and per-server
ACL are used, the connection is allowed only if both of them allow it,
and is denied if any one of them denies it.
@@ -1544,59 +1532,60 @@ and is denied if any one of them denies it.
@node Auth Statement
@subsection Auth Statement
address@hidden
@cindex authorization
@cindex authentication
@kwindex auth
@subheading Syntax
address@hidden
address@hidden
auth @{
# @r{Set a list of modules for authentication.}
authentication @var{module-list};
# @r{Set a list of modules for authorization.}
authorization @var{module-list};
@}
address@hidden smallexample
address@hidden example
@subheading Description
Some mail utilities provide access to their services only after
verifying that the user is actually the person he is claiming
-to be. Such programs are, for example, @command{pop3d} and
address@hidden The process of the verification is broken
+to be. Such programs are, for example, @command{pop3d} and
address@hidden The process of the verification is broken
down into two stages: @dfn{authorization} and @dfn{authentication}.
In @dfn{authorization} stage the program retrieves the information
-about a particular user. In @dfn{authentication} stage, this
-information is compared against the user-supplied credentials. Only if
+about a particular user. In @dfn{authentication} stage, this
+information is compared against the user-supplied credentials. Only if
both stages succeed is the user allowed to use the service.
-A set of @dfn{modules} is involved in performing each stage. For
+A set of @dfn{modules} is involved in performing each stage. For
example, the authorization stage can retrieve the user description
from various sources: system database, SQL database, virtual domain
-table, etc. Each module is responsible for retrieving the description
-from a particular source of information. The modules are arranged in
-a @dfn{module list}. The modules from the list are invoked in turn,
-until one of them succeeds or the list is exhausted. In the latter case
-the authorization fails. Otherwise, the data returned by the succeeded
+table, etc. Each module is responsible for retrieving the description
+from a particular source of information. The modules are arranged in
+a @dfn{module list}. The modules from the list are invoked in turn,
+until one of them succeeds or the list is exhausted. In the latter case
+the authorization fails. Otherwise, the data returned by the succeeded
module are used in authentication.
-Similarly, authentication may be performed in several ways. The
-authentication modules are also grouped in a list. Each module
+Similarly, authentication may be performed in several ways. The
+authentication modules are also grouped in a list. Each module
is tried in turn until either a module succeeds, in which case the
authentication succeeds, or the end of the list is reached.
For example, the authorization list
address@hidden
address@hidden
(system, sql, virtdomains)
address@hidden smallexample
address@hidden example
@noindent
means that first the system user database (@file{/etc/password}) is
-searched for a description of a user in question. If the search fails,
-the @acronym{SQL} database is searched. Finally, if it also fails, the
+searched for a description of a user in question. If the search fails,
+the @acronym{SQL} database is searched. Finally, if it also fails, the
search is performed in the virtual domain database.
@emph{Note}, that some authentication and/or authorization modules may
-be disabled when configuring the package before compilation. The names
+be disabled when configuring the package before compilation. The names
of the disabled modules are nevertheless available for use in runtime
configuration options, but they represent a ``fail-only'' functionality,
e.g. if the package was compiled without @acronym{SQL} support then
@@ -1606,7 +1595,7 @@ passing the execution on to the next module.
The @code{auth} statement configures authentication and authorization.
@deffn {Configuration} authorization @var{module-list}
-Define a sequence of modules to use for authorization. Modules will
+Define a sequence of modules to use for authorization. Modules will
be tried in the same order as listed in @var{module-list}.
The modules available for use in authorization list are:
@@ -1621,14 +1610,14 @@ A separate configuration statement, @code{sql}, is used
to configure
it (@pxref{SQL Statement}).
@item virtdomain
User credentials are retrieved from a ``virtual domain'' user
-database. Virtual domains are configured using @code{virtdomain}
+database. Virtual domains are configured using @code{virtdomain}
statement (@pxref{Virtdomain Statement}).
@item radius
-User credentials are retrieved using @acronym{RADIUS}. @xref{Radius
+User credentials are retrieved using @acronym{RADIUS}. @xref{Radius
Statement}, for a detailed description on how to configure it.
@item ldap
User credentials are retrieved from an @acronym{LDAP}
-database. @xref{LDAP Statement}, for an information on how to
+database. @xref{LDAP Statement}, for an information on how to
configure it.
@end table
@@ -1636,20 +1625,20 @@ configure it.
Unless overridden by @code{authorization} statement,
the default list of authorization modules is:
address@hidden
address@hidden
(system, sql, virtdomains)
address@hidden smallexample
address@hidden example
@end deffn
@deffn {Configuration} authentication @var{module-list}
-Define a sequence of modules to use for authentication. Modules will
+Define a sequence of modules to use for authentication. Modules will
be tried in the same order as listed in @var{module-list}.
The following table lists modules available for use in @var{module-list}:
@table @asis
@item generic
-The generic authentication type. User password is hashed and compared
+The generic authentication type. User password is hashed and compared
against the hash value returned in authorization stage.
@item system
The hashed value of the user password is retrieved from
@@ -1660,41 +1649,42 @@ The hashed value of the user password is retrieved from
a
statement (@pxref{SQL Statement, getpass}).
@item pam
The user is authenticated via pluggable authentication module
-(@acronym{PAM}). The @acronym{PAM} service name to be used is
+(@acronym{PAM}). The @acronym{PAM} service name to be used is
configured in @code{pam} statement (@pxref{PAM Statement}).
@item radius
The user is authenticated on a remote @acronym{RADIUS}
-server. @xref{Radius Statement}.
+server. @xref{Radius Statement}.
@item ldap
-The user is authenticated using @acronym{LDAP}. @xref{LDAP Statement}.
+The user is authenticated using @acronym{LDAP}. @xref{LDAP Statement}.
@end table
@FIXME{This list is inaccurate:}
Unless overridden by @code{authentication} statement,
the list of authentication modules is:
address@hidden
address@hidden
(generic, system, pam, sql)
address@hidden smallexample
address@hidden example
@end deffn
@node PAM Statement
@subsection PAM Statement
address@hidden
@kwindex pam
@subheading Syntax
address@hidden
address@hidden
pam @{
# @r{Set PAM service name.}
service @var{text};
@}
address@hidden smallexample
address@hidden example
@subheading Description
-The @code{pam} statement configures @acronym{PAM} authentication. It
+The @code{pam} statement configures @acronym{PAM} authentication. It
contains a single sub-statement:
@deffn {Configuration} service @var{text}
-Define service name to look for in @acronym{PAM} configuration. By
+Define service name to look for in @acronym{PAM} configuration. By
default, the base name of the Mailutils binary is used.
@end deffn
@@ -1703,14 +1693,15 @@ This statement takes effect only if @samp{pam} is
listed in
@node Virtdomain Statement
@subsection Virtdomain Statement
address@hidden
@kwindex virtdomain
@subheading Syntax
address@hidden
address@hidden
virtdomain @{
# @r{Name of the virtdomain password directory.}
passwd-dir @var{dir};
@}
address@hidden smallexample
address@hidden example
@subheading Description
@dfn{Virtual mail domains} make it possible to handle several
@@ -1720,9 +1711,9 @@ user name can be present in several domains and represent
different
users.
When authenticating to a server with virtual domain support enabled,
-users must supply their user names with domain parts. The server strips
+users must supply their user names with domain parts. The server strips
off the domain part and uses it as a name of UNIX-format password
-database file, located in the @dfn{domain password directory}. The
+database file, located in the @dfn{domain password directory}. The
latter is set using @code{passwd-dir} statement.
@deffn {Configuration} passwd-dir @var{dir}
@@ -1735,33 +1726,34 @@ This file must be in UNIX passwd format (@pxref{password
file,,,passwd(5), passwd(5) man page}), with encrypted passwords
stored in it (as of GNU Mailutils version @value{VERSION}, there is no
support for shadow files in virtual password directories, although
-this is planned for future versions). Here is an example record from
+this is planned for future versions). Here is an example record from
this file:
address@hidden
address@hidden
smith:Wbld/G2Q2Le2w:1000:1000:Email Account:/var/mail/domain/smith:/dev/null
address@hidden smallexample
address@hidden example
Notice, that it must contain user names without domain parts.
The @code{pw_dir} field (the 6th field) is used to determine the
-location of the maildrop for this user. It is defined as
address@hidden@var{pw_dir}/INBOX}. In our example, the maildrop for user
+location of the maildrop for this user. It is defined as
address@hidden@var{pw_dir}/INBOX}. In our example, the maildrop for user
@samp{smith} will be located in file @file{/var/mail/domain/smith}.
If user did not supply his domain name, or if no matching record was
found in the password file, or if the file matching the domain name
does not exist, then GNU Mailutils falls back to alternative method.
-First, it tries to determine the IP address of the remote party. Then
+First, it tries to determine the IP address of the remote party. Then
the domain name corresponding to that address is looked up in the DNS
-system. Finally, this domain name is used as a name of the password
+system. Finally, this domain name is used as a name of the password
file.
@node Radius Statement
@subsection Radius Statement
address@hidden
@kwindex radius
@subheading Syntax
address@hidden
address@hidden
radius @{
# Set radius configuration directory.
directory @var{dir};
@@ -1772,17 +1764,17 @@ radius @{
# Radius request for getpwuid.
getpwuid @var{request};
@}
address@hidden smallexample
address@hidden example
@subheading Description
The @code{radius} block statement configures @acronym{RADIUS
authentication} and authorization.
Mailutils uses GNU Radius library, which is configured via
@file{raddb/client.conf} file (@pxref{client.conf, Client Configuration,
-Client Configuration, radius, GNU Radius Reference Manual}). Its exact
+Client Configuration, radius, GNU Radius Reference Manual}). Its exact
location depends on configuration settings that were used while
-compiling GNU Radius. Usually it is @file{/usr/local/etc}, or
address@hidden/etc}. This default can also be changed at run time using
+compiling GNU Radius. Usually it is @file{/usr/local/etc}, or
address@hidden/etc}. This default can also be changed at run time using
@code{directory} statement:
@deffn {Configuration} directory @var{dir}
@@ -1814,31 +1806,31 @@ the following attributes:
@flindex mailutils.dict
A dictionary file with appropriate definitions is included in the
-Mailutils distribution: @file{examples/config/mailutils.dict}. This
+Mailutils distribution: @file{examples/config/mailutils.dict}. This
file is not installed by default, you will have to manually copy it to
the GNU Radius @file{raddb/dict} directory and include it in the main
dictionary file @file{raddb/dictionary} by adding the following
statement:
address@hidden
address@hidden
$INCLUDE dict/mailutils.dict
address@hidden smallexample
address@hidden example
Requests to use for authentication and authorization are
configured using three statements: @code{auth}, @code{getpwnam} and
address@hidden Each statement takes a single argument: a string,
-containing a comma-separated list of assignments. An assignment
address@hidden Each statement takes a single argument: a string,
+containing a comma-separated list of assignments. An assignment
specifies a particular @dfn{attribute-value pair} (@pxref{Overview,
RADIUS Attributes,, radius, GNU Radius Reference Manual}) to send to
-the server. The left-hand side of the assignment is a symbolic attribute
+the server. The left-hand side of the assignment is a symbolic attribute
name, as defined in one of Radius dictionaries (@pxref{dictionary
file, Dictionary of Attributes,, radius, GNU Radius Reference
-Manual}). The value is specified by the right-hand side of
-assignment. For example:
+Manual}). The value is specified by the right-hand side of
+assignment. For example:
address@hidden
address@hidden
"Service-Type = Authenticate-Only, NAS-Identifier = \"mail\""
address@hidden smallexample
address@hidden example
An assignment may contain references to the following macro-variables
(@FIXME-pxref{macro-variables}):
@@ -1846,40 +1838,40 @@ An assignment may contain references to the following
macro-variables
@table @asis
@item user
The actual user name (for @code{auth} and @code{getpwnam}), or user ID
-(for @code{getpwuid}). For example:
+(for @code{getpwuid}). For example:
address@hidden
address@hidden
User-Name = address@hidden@}
address@hidden smallexample
address@hidden example
@item passwd
-User password. For examples:
address@hidden
+User password. For examples:
address@hidden
User-Password = address@hidden@}
address@hidden smallexample
address@hidden example
@end table
@deffn {Configuration} auth @var{pairlist}
-Specifies the request to be sent to authenticate the user. For example:
+Specifies the request to be sent to authenticate the user. For example:
address@hidden
address@hidden
auth "User-Name = address@hidden@}, User-Password = address@hidden@}";
address@hidden smallexample
address@hidden example
The user is authenticated only if this request returns
@code{Access-Accept} (@pxref{Authentication Requests, Access-Accept,,
-radius, GNU Radius Reference Manual}). Any returned attribute-value
+radius, GNU Radius Reference Manual}). Any returned attribute-value
pairs are ignored.
@end deffn
@deffn {Configuration} getpwnam @var{pairlist}
Specifies the request that returns user information for the
-given user name. For example:
+given user name. For example:
address@hidden
address@hidden
getpwnam "User-Name = address@hidden@}, State = getpwnam, "
"Service-Type = Authenticate-Only";
address@hidden smallexample
address@hidden example
If the requested user account exists, the Radius server must return
@code{Access-Accept} packet with the following attributes:
@@ -1890,26 +1882,26 @@ The attributes @code{GNU-MU-Mailbox} and
@code{GNU-MU-Quota} are
optional.
If @code{GNU-MU-Mailbox} is present, it must contain a
-valid mailbox @acronym{URL} (@FIXME-pxref{urls}). If
+valid mailbox @acronym{URL} (@FIXME-pxref{urls}). If
@code{GNU-MU-Mailbox} is not present, Mailutils constructs the
mailbox name using the settings from the @code{mailbox} configuration
statement (@pxref{Mailbox Statement}), or built-in defaults, if it is
not present.
If @code{GNU-MU-Quota} is present, it specifies the maximum mailbox
-size for this user, in bytes. In the absence of this attribute,
+size for this user, in bytes. In the absence of this attribute,
mailbox size is unlimited.
@end deffn
@deffn {Configuration} getpwuid @var{pairlist}
Specifies the request that returns user information for the
-given user ID. In @var{pairlist}, the @samp{user} macro-variable is
-expanded to the numeric value of ID. For example:
+given user ID. In @var{pairlist}, the @samp{user} macro-variable is
+expanded to the numeric value of ID. For example:
address@hidden
address@hidden
getpwuid "User-Name = address@hidden@}, State = getpwuid, "
"Service-Type = Authenticate-Only";
address@hidden smallexample
address@hidden example
The reply to @code{getpwuid} request is the same as to @code{getpwnam}
request (see above).
@@ -1920,7 +1912,7 @@ request (see above).
@UNREVISED
@kwindex sql
@subheading Syntax
address@hidden
address@hidden
sql @{
# @r{Set SQL interface to use.}
interface @samp{mysql|odbc|postgres};
@@ -1945,7 +1937,7 @@ sql @{
# @r{SQL query to use for getpwuid requests.}
getpwuid @var{query};
@}
address@hidden smallexample
address@hidden example
@subsection Description
The @code{sql} statement configures access credentials to
@@ -1953,19 +1945,19 @@ The @code{sql} statement configures access credentials
to
authorization.
GNU Mailutils supports three types of @acronym{SQL} interfaces:
-MySQL, PostgreSQL and ODBC. The latter is a standard API for using
+MySQL, PostgreSQL and ODBC. The latter is a standard API for using
database management systems, which can be used to communicate with a
wide variety of DBMS.
@deffn {Configuration} interface @var{type}
-Configures type of DBMS interface. Allowed values for @var{type} are:
+Configures type of DBMS interface. Allowed values for @var{type} are:
@table @asis
@item mysql
Interface with a MySQL server (@uref{http://www.mysql.org}).
@item odbc
-Use ODBC interface. See @uref{http://www.unixodbc.org}, for a detailed
+Use ODBC interface. See @uref{http://www.unixodbc.org}, for a detailed
description of ODBC configuration.
@item postgres
@@ -1977,7 +1969,7 @@ The database and database access credentials are
configured using the
following statements:
@deffn {Configuration} host @var{arg}
-The host running the @acronym{SQL} server. The value can be either a
+The host running the @acronym{SQL} server. The value can be either a
host name or an IP address in dotted-quad notation, in which case an
@acronym{INET} connection is used, or a full pathname to a file, in
which case a connection to @acronym{UNIX} socket is used.
@@ -1985,7 +1977,7 @@ which case a connection to @acronym{UNIX} socket is used.
@deffn {Configuration} port @var{arg}
TCP port the server is listening on (for @acronym{INET}
-connections). This parameter is optional. Its default value depends on
+connections). This parameter is optional. Its default value depends on
the type of database being used.
@end deffn
@@ -2006,7 +1998,7 @@ Password to access the database.
@WRITEME
@kwindex ldap
@subheading Syntax
address@hidden
address@hidden
ldap @{
# @r{Enable LDAP lookups.}
enable @var{bool};
@@ -2029,14 +2021,14 @@ ldap @{
# @r{LDAP filter to use for getpwuid requests.}
getpwuid @var{filter};
@}
address@hidden smallexample
address@hidden example
@node TLS Statement
@subsection TLS Statement
@WRITEME
@kwindex tls
@subheading Syntax
address@hidden
address@hidden
tls @{
# @r{Enable TLS support.}
enable @var{bool};
@@ -2047,14 +2039,14 @@ tls @{
# @r{Specify trusted CAs file.}
ssl-cafile @var{file};
@}
address@hidden smallexample
address@hidden example
@node GSASL Statement
@subsection GSASL Statement
@WRITEME
@kwindex gsasl
@subheading Syntax
address@hidden
address@hidden
gsasl @{
# @r{Name of GSASL password file.}
cram-passwd @var{file};
@@ -2067,12 +2059,244 @@ gsasl @{
# @r{Anonymous user name.}
anonymous-user @var{string};
@}
address@hidden smallexample
address@hidden example
@c -------------------------------------------------------------------
address@hidden debugging
address@hidden Debugging
address@hidden debugging output is controlled by a set of levels, each of
+which can be set independently of others. Each debug level consists of
+a @dfn{category name}, which identifies the part of
address@hidden for which additional debugging is desired, and a
+level number, which tells @command{Mailutils} how verbose should its
+output be.
+
+Valid debug levels are:
+
address@hidden @asis
address@hidden error
+Displays error conditions which are normally not reported, but passed
+to the caller layers for handling.
address@hidden trace0 through trace9
+Ten levels of verbosity, @samp{trace0} producing less output,
address@hidden producing the maximum amount of output.
address@hidden prot
+Displays network protocol interaction, where applicable.
address@hidden table
+
+Implementation and applicability of each level differs between various
+categories. The full list of categories is available in
+file @file{libmailutils/diag/debcat} in the Mailutils source tree.
+Most useful categories and levels implemented for them are discussed
+later in this article.
+
address@hidden
+* Level Syntax::
+* Level BNF::
+* Debugging Categories::
address@hidden menu
+
address@hidden Level Syntax
address@hidden Level Syntax
+
+Debug levels can be set either from the command line, by using the
address@hidden command line option, or from the configuration
+file, using the @samp{.debug.level} statement. In both cases, the
+level is specified as a list of individual levels, delimited with
+semicolons. Each individual level can be specified as:
+
address@hidden @asis
address@hidden address@hidden
+Disables all levels for the specified @var{category}.
address@hidden @var{category}
+Enables all levels for the specified @var{category}.
address@hidden @address@hidden
+For the given @var{category}, enables all levels from @samp{error} to
address@hidden, inclusive.
address@hidden @address@hidden
+Enables only the given @var{level} for this @var{category}.
address@hidden @address@hidden
+Disables all levels from @samp{error} to @var{level}, inclusive, for
+this @var{category}.
address@hidden @address@hidden
+Disables only the given @var{level} in this @var{category}.
address@hidden @address@hidden@var{levelB}
+Enables all levels in the range from @var{levelA} to @var{levelB}, inclusive.
address@hidden @address@hidden@var{levelB}
+Disables all levels in the range from @var{levelA} to @var{levelB}, inclusive.
address@hidden table
+
+Additionally, a comma-separated list of level specifications is
+allowed after the dot. For example, the following specification:
+
address@hidden
+acl.prot,!=trace9,!trace2
address@hidden example
+
+enables in category @samp{acl} all levels, except @samp{trace9},
address@hidden, @samp{trace1}, and @samp{trace2}.
+
address@hidden Level BNF
address@hidden BNF
+
+The following specification in Backus-Naur form describes formally the
+Mailutils debug level:
+
address@hidden
+<debug-spec> ::= <level-spec> | <debug-level-list>
+<debug-level-list> ::= <debug-level> |
+ <debug-level-list> ";" <debug-level>
+<debug-level> ::= <category> | "!" <category> |
+ <category> "." <level-list>
+<level-list> ::= <level-spec> | <level-list> "," <level-spec>
+<level-spec> ::= <level> | <negate-level>
+<negate-level> ::= "!" <level>
+<level> ::= <level-number> | "=" <level-number> |
+ <level-number> "-" <level-number>
+<level-number> ::= "error" | "trace0" | "trace1" | "trace2" | "trace3" |
+ "trace4" | "trace5" | "trace6" | "trace7" |
+ "trace8" | "trace9" | "prot"
address@hidden example
+
address@hidden Debugging Categories
address@hidden Debugging Categories
+
address@hidden @asis
address@hidden acl
+This category enables debugging of Access Control Lists. Available
+levels are:
+
address@hidden @asis
address@hidden error
+As usual, displays errors, not directly reported otherwise.
address@hidden trace0
+Basic tracing of ACL processing.
address@hidden trace9
+Traces the process of matching the ACL conditions.
address@hidden table
+
address@hidden config
+This category affects configuration parser and/or lexical
+analyzer. The following levels are supported:
+
address@hidden @asis
address@hidden trace0
+Minimal information about configuration statements.
address@hidden trace2
+Trace lexical structure of the configuration files.
address@hidden trace7
+Trace execution of the configuration parser.
address@hidden table
+
+Due to its specific nature, this category cannot be enabled from the
+configuration file. A special hook is provided to facilitate
+debugging the configuration parser, namely, a pragmatic comment in
+form:
+
address@hidden
address@hidden
address@hidden example
+
+causes @var{debug-level-list} to be parsed as described above. Thus, to
+force debugging of the configuration parser, one would add the following
+line at the very beginning of the configuration file:
+
address@hidden
+#debug=config.trace7
address@hidden example
+
address@hidden mailbox
+Operations over mailboxes. This module supports the following levels:
address@hidden, @samp{trace0}, @samp{trace1}, and @samp{prot}. The
+latter is used by remote mailbox support libraries.
+
address@hidden auth
+Enables debugging information about authentication and authorization.
+This category supports the following levels: @samp{error},
address@hidden, @samp{trace1}, and @samp{trace2}.
+
+In level @samp{trace0}, user data are reported along with the
address@hidden source} they were obtained from. The output may look like this:
+
address@hidden
+pop3d: source=system, name=gray, passwd=x, uid=120, gid=100,
+gecos=Sergey Poznyakoff, dir=/home/gray, shell=/bin/bash,
+mailbox=/var/mail/gray, quota=0, change_uid=1
address@hidden example
+
+In the @samp{trace1} level, additional flow traces are displayed.
+
+In the level @samp{trace2}, a detailed flow trace is displayed, which
+looks like the following:
+
address@hidden
+pop3d: Trying generic...
+pop3d: generic yields 38=Function not implemented
+pop3d: Trying system...
+pop3d: system yields 0=Success
+pop3d: Trying generic...
+pop3d: generic yields 4135=Authentication failed
+pop3d: Trying system...
+pop3d: system yields 0=Success
address@hidden example
+
address@hidden mailer
+Debugs mailer operations. The following levels are supported:
+
address@hidden @asis
address@hidden error
+Displays mild error conditions.
address@hidden trace0
+Traces mailer operations in general: displays what part of the message
+is being sent, etc.
address@hidden trace6
+When used together with @samp{prot}, displays security-sensitive
+information (such as passwords, user keys, etc). in plaintext. By
+default, such information is replaced with asteriscs to reduce the
+possibility of security compromise.
address@hidden trace7
+When used together with @samp{prot}, displays the @dfn{payload}
+information as it is being sent. The @dfn{payload} is the actual
+message contents, i.e. the part of SMTP transaction that goes after
+the @samp{DATA} command and which ends with a terminating dot line.
+Setting this level can generate huge amounts of information.
address@hidden prot
+For SMTP mailer: outputs transcripts of SMTP sessions.
address@hidden table
+
address@hidden:} Unless in a very secure environment, it is advised to
+avoid using level settings such as mailer.prot or mailer (without
+explicit level part), because the resulting output tends to be
+extremely copious and reveals sender private and security-sensitive
+data. If you wish to trace SMTP session flow, use @samp{mailer.=prot}
+or at least @samp{mailer.prot,!trace6}.
+
address@hidden serve
+This category provides debugging information for Mailutils IP
+server objects. It supports the @samp{error} and @samp{trace0} levels.
+
address@hidden folder
+This category controls debugging information shown for operations
+related to Mailutils folders.
+
address@hidden remote
+The remote category is used by @command{imap4d} and @command{pop3d}
+servers to request showing additional information in the session
+transcripts. This category takes effect only when the @code{transcript}
+configuration variable is set. Valid levels are:
+
address@hidden @asis
address@hidden trace6
+Show security-sensitive information (user passwords, etc.)
address@hidden trace7
+Show payload information
address@hidden table
address@hidden table
+
@node frm and from
@section @command{frm} and @command{from} --- List Headers from a Mailbox
address@hidden
GNU mailutils provides two commands for listing messages in a mailbox.
These are @command{from} and @command{frm}.
@@ -2092,9 +2316,9 @@ configuration file statements:
@pindex frm
The @command{frm} utility outputs a header information of
-the selected messages in a mailbox. By default, @command{frm} reads
+the selected messages in a mailbox. By default, @command{frm} reads
user's system mailbox and outputs the contents of @code{From} and
address@hidden headers for each message. If a folder is specified in
address@hidden headers for each message. If a folder is specified in
the command line, the program reads that folder rather than the default
mailbox.
@@ -2110,14 +2334,14 @@ Display the header named by @var{string} instead of
@code{From}
@code{Subject} pair.
@item -l
@itemx --to
-Include the contents of @code{To} header to the output. The output field
+Include the contents of @code{To} header to the output. The output field
order is then: @code{To} @code{From} @code{Subject}.
@item -n
@itemx --number
Prefix each line with corresponding message number.
@item -Q
@itemx --Quiet
-Be very quiet. Nothing is output except error messages. This is useful
+Be very quiet. Nothing is output except error messages. This is useful
in shell scripts where only the return status of the program is
important.
@item -q
@@ -2130,12 +2354,12 @@ Print a summary line.
@itemx --status @var{attr}
Only display headers from messages with the given status.
@var{Attr} may be one of the following: @samp{new}, @samp{read},
address@hidden It is sufficient to specify only first letter of
-an @var{attr}. Multiple @option{-s} options are allowed.
address@hidden It is sufficient to specify only first letter of
+an @var{attr}. Multiple @option{-s} options are allowed.
@item -t
@itemx --align
-Tidy mode. In this mode @command{frm} tries to preserve the alignment of
-the output fields. It also enables the use of BIDI algorithm for
+Tidy mode. In this mode @command{frm} tries to preserve the alignment of
+the output fields. It also enables the use of BIDI algorithm for
displaying subject lines that contain text in right-to-left
orientation (such as Arabic or Hebrew).
@end table
@@ -2144,9 +2368,9 @@ orientation (such as Arabic or Hebrew).
@pindex from
The @command{from} utility displays sender and subject of each message
-in a mailbox. By default, it reads the user's system mailbox. If the
+in a mailbox. By default, it reads the user's system mailbox. If the
program is given a single argument, it is interpreted as a name of the
-user whose mailbox is to be read. Obviously, permissions are required
+user whose mailbox is to be read. Obviously, permissions are required
to access that user's mailbox, so such invocations may be used only
by superuser.
@@ -2178,24 +2402,25 @@ Examine mailbox from the given @var{url}.
@node mail
@section @command{mail} --- Send and Receive Mail
@pindex mail
address@hidden
@command{Mail} is an enhanced version of standard @command{/bin/mail} program.
As well as its predecessor, it can be used either in sending mode or
-in reading mode. @command{Mail} enters sending mode when one or more
-email addresses were specified in this command line. In this mode the
+in reading mode. @command{Mail} enters sending mode when one or more
+email addresses were specified in this command line. In this mode the
program waits until user finishes composing the message, then attempts
to send it to the specified addresses and exits.
See @ref{Composing Mail}, for a detailed description of this behavior.
If the command line contained no email addresses, @command{mail} switches
-to reading mode. In this mode it allows to read and manipulate the
-contents of the user system mailbox. The @option{--file} (@option{-f})
-command line option allows to specify another mailbox name. For more
+to reading mode. In this mode it allows to read and manipulate the
+contents of the user system mailbox. The @option{--file} (@option{-f})
+command line option allows to specify another mailbox name. For more
detail, see @ref{Reading Mail}.
In contrast to other GNU Mailutils programs, @command{mail} does not
-use the Mailutils configuration file. Instead, it uses the traditional
address@hidden configuration. @xref{Mail Configuration Files},
+use the Mailutils configuration file. Instead, it uses the traditional
address@hidden configuration. @xref{Mail Configuration Files},
for a detailed description of its format.
@menu
@@ -2213,9 +2438,9 @@ for a detailed description of its format.
General usage of @command{mail} program is:
address@hidden
address@hidden
mail address@hidden address@hidden
address@hidden smallexample
address@hidden example
@noindent
If address@hidden part is present, @command{mail} switches to
mail sending mode, otherwise it operates in mail reading mode.
@@ -2227,26 +2452,26 @@ The program uses following option groups:
@FIXME-xref{mailbox}.
@table @option
@item -e
@itemx --exist
-Return true if the mailbox contains some messages. Return false
+Return true if the mailbox contains some messages. Return false
otherwise.
This is useful for writing shell scripts.
@item -E @var{command}
@itemx address@hidden
-Execute @var{command} before opening the mailbox. Any number of
address@hidden options can be given. The commands will be executed
+Execute @var{command} before opening the mailbox. Any number of
address@hidden options can be given. The commands will be executed
after sourcing configuration files (@pxref{Mail Configuration Files}),
but before opening the mailbox.
@item -f
@itemx --file
Operate on the mailbox given by the first non-optional command line
-argument. If there is no such argument, read messages from the
-user's @file{mbox} file. @xref{Reading Mail}, for more details about
+argument. If there is no such argument, read messages from the
+user's @file{mbox} file. @xref{Reading Mail}, for more details about
using this option.
@item -F
@itemx --byname
Record outgoing messages in a file named after the first recipient.
The name is the login-name portion of the address found first on the
address@hidden:} line in the mail header. This option sets the @samp{byname}
address@hidden:} line in the mail header. This option sets the @samp{byname}
variable, which see (@pxref{byname}).
@item -H
@itemx --headers
@@ -2259,7 +2484,7 @@ Ignore interrupts.
Set path to the mailspool directory
@item -n
@itemx --norc
-Do not read the system-wide mailrc file. @xref{Mail Configuration Files}.
+Do not read the system-wide mailrc file. @xref{Mail Configuration Files}.
@item -N
@itemx --nosum
Do not display initial header summary.
@@ -2267,30 +2492,30 @@ Do not display initial header summary.
@itemx --print
@itemx -r
@itemx --read
-Print all mail to standard output. It is equivalent to issuing following
+Print all mail to standard output. It is equivalent to issuing following
commands after starting @samp{mail -N}:
address@hidden
address@hidden
@group
print *
quit
@end group
address@hidden smallexample
address@hidden example
@item -q
@itemx --quit
Cause interrupts to terminate program.
@item -s @var{subj}
@itemx address@hidden
-Send a message with a Subject of @var{subj}. Valid only in sending mode.
+Send a message with a Subject of @var{subj}. Valid only in sending mode.
@item -t
@itemx --to
Switch to sending mode.
@item -u @var{user}
@itemx address@hidden
-Operate on @var{user}'s mailbox. This is equivalent to:
+Operate on @var{user}'s mailbox. This is equivalent to:
address@hidden
address@hidden
mail -f/@var{spool_path}/@var{user}
address@hidden smallexample
address@hidden example
@noindent
with @var{spool_path} being the full path to your mailspool directory
@@ -2309,14 +2534,14 @@ Print program version and exit.
@subsection How to Specify Message Sets
Many mail commands such as print and delete can be given a @dfn{message list}
-to operate upon. Wherever the message list is omitted, the command
+to operate upon. Wherever the message list is omitted, the command
operates on the current message.
The @dfn{message list} in its simplest form is one of:
@table @asis
@item .
-Selects current message. It is equivalent to empty message list.
+Selects current message. It is equivalent to empty message list.
@item *
Selects all messages in the mailbox.
@item ^
@@ -2326,7 +2551,7 @@ Selects last non-deleted message.
@end table
In its complex form, the @dfn{message list} is a comma or whitespace-separated
-list of @dfn{message specifiers}. A @dfn{message specifier} is one
+list of @dfn{message specifiers}. A @dfn{message specifier} is one
of
@table @asis
@@ -2335,11 +2560,11 @@ This specifier addresses the message with the given
ordinal number
in the mailbox.
@item Message range
@dfn{Message range} is specified as two message numbers separated by
-a dash. It selects all messages with the number lying within that range.
+a dash. It selects all messages with the number lying within that range.
@item Attribute specifier
An @dfn{Attribute specifier} is a colon followed by a single
-letter. The @dfn{Attribute specifier} addresses all messages in the
-mailbox that have the given attribute. These are the valid attribute
+letter. The @dfn{Attribute specifier} addresses all messages in the
+mailbox that have the given attribute. These are the valid attribute
specifiers:
@table @samp
@@ -2362,14 +2587,14 @@ Selects all untagged messages.
@item Header match
The @dfn{header match} is a string in the form:
address@hidden
address@hidden
address@hidden:]/@var{string}/
address@hidden smallexample
address@hidden example
@noindent
It selects all messages that contain header field @var{header}
-matching given @var{regexp}. If the variable @code{regexp} is set,
-the @var{string} is assumed to be a POSIX regexp. Otherwise, a
+matching given @var{regexp}. If the variable @code{regexp} is set,
+the @var{string} is assumed to be a POSIX regexp. Otherwise, a
header is considered to match @var{string} if the latter constitutes
a substring of the former (comparison is case-insensitive).
@@ -2377,21 +2602,21 @@ If @var{header}: part is omitted, it is assumed to be
@samp{Subject:}.
@item Message body match
The @dfn{message body match} is a string in the form:
address@hidden
address@hidden
:/@var{string}/
address@hidden smallexample
address@hidden example
@noindent
-It selects all messages whose body matches the string. The matching
+It selects all messages whose body matches the string. The matching
rules are the same as described under ``Header match''.
@end table
A @dfn{message specifier} can be followed by @dfn{message part
-specifier}, enclosed in a pair of brackets. A @dfn{message part
+specifier}, enclosed in a pair of brackets. A @dfn{message part
specifier} controls which part of a message should be operated upon.
-It is meaningful only for multipart messages. A @dfn{message part
+It is meaningful only for multipart messages. A @dfn{message part
specifier} is a comma or whitespace - separated list of part numbers
-or ranges. Each part number can in turn be @dfn{message part specifier},
+or ranges. Each part number can in turn be @dfn{message part specifier},
thus allowing for operating upon multiply-encoded messages.
The following are the examples of valid message lists:
@@ -2400,13 +2625,13 @@ The following are the examples of valid message lists:
@subsection Composing Mail
You can compose the message by simply typing the contents of it, line
-by line. But usually this is not enough, you would need to edit
-your text, to quote some messages, etc. @command{Mail} provides these
-capabilities through @dfn{compose escapes}. The @dfn{compose escapes}
+by line. But usually this is not enough, you would need to edit
+your text, to quote some messages, etc. @command{Mail} provides these
+capabilities through @dfn{compose escapes}. The @dfn{compose escapes}
are single-character commands, preceded by special @dfn{escape character},
-which defaults to @samp{~}. The combination @code{escape character + command}
+which defaults to @samp{~}. The combination @code{escape character + command}
is recognized as a compose escape only if it occurs at the beginning of
-a line. If the escape character must appear at the beginning of a
+a line. If the escape character must appear at the beginning of a
line, enter it twice.
The actual escape character may be changed by setting the value of
@code{escape} mail variable (@pxref{Mail Variables}).
@@ -2434,7 +2659,7 @@ The actual escape character may be changed by setting the
value of
There are several commands allowing you to quit the compose mode.
Typing the end-of-file character (@samp{C-D}) on a line alone finishes
-compose mode and sends the message to its destination. The @samp{C-D}
+compose mode and sends the message to its destination. The @samp{C-D}
character looses its special meaning if @code{ignoreeof} mail variable
is set.
@@ -2445,8 +2670,8 @@ Finally, using @samp{~.} escape always quits compose mode
and sends
out the composed message.
To abort composing of a message without sending it, type interrupt
-character (by default, @samp{C-C}) twice. This behavior is disabled
-when mail variable @code{ignore} is set. In this case, you can use
+character (by default, @samp{C-C}) twice. This behavior is disabled
+when mail variable @code{ignore} is set. In this case, you can use
@samp{~x} escape to achieve the same effect.
@node Getting Help on Compose Escapes
@@ -2454,7 +2679,7 @@ when mail variable @code{ignore} is set. In this case,
you can use
@kyindex ~?, mail escape
The @samp{~?} escape prints on screen a brief summary of the available
-compose escapes. @emph{Please note}, that @samp{~h} escape prompts
+compose escapes. @emph{Please note}, that @samp{~h} escape prompts
for changing the header values, and does @emph{not} give help.
@node Editing the Message
@@ -2464,11 +2689,11 @@ for changing the header values, and does @emph{not}
give help.
If you are not satisfied with the message as it is, you can edit it
using a text editor specified either by @code{EDITOR} or by
address@hidden environment variables. The @samp{~e} uses the former,
address@hidden environment variables. The @samp{~e} uses the former,
and @samp{~v} uses the latter.
By default both escapes allow you to edit only the body of the
-message. However, if the @code{editheaders} variable is set,
+message. However, if the @code{editheaders} variable is set,
@command{mail} will load into the editor the complete text of
the message with headers included, thus allowing you to change
the headers as well.
@@ -2479,20 +2704,20 @@ the headers as well.
To add new addresses to the list of message recipients, use @samp{~t}
command, e.g.:
address@hidden
address@hidden
~t name1@@domain.net name2
address@hidden smallexample
address@hidden example
To add addresses to @code{Cc} or @code{Bcc}, use @samp{~c} or @samp{~b}
escapes respectively.
To change the @code{Subject} header, use @samp{~s} escape, e.g.:
address@hidden
address@hidden
~s "Re: your message"
address@hidden smallexample
address@hidden example
-Finally, to edit all headers, type @samp{~h} escape. This will present
+Finally, to edit all headers, type @samp{~h} escape. This will present
you with the values of @code{To}, @code{Cc}, @code{Bcc}, and
@code{Subject} headers allowing to edit them with normal text editing
commands.
@@ -2504,7 +2729,7 @@ commands.
If you are sending mail from within mail command mode, you can enclose
the contents of any message sent to you by using @samp{~m} or @samp{~M}
-commands. Typing @samp{~m} alone will enclose the contents of the
+commands. Typing @samp{~m} alone will enclose the contents of the
current message, typing @samp{~m 12} will enclose the contents of
message #12 and so on.
@@ -2519,22 +2744,22 @@ prepended to each line enclosed.
To append the contents of file @var{filename} to the message, type
address@hidden
address@hidden
~r @var{filename}
address@hidden smallexample
address@hidden example
@noindent
or
address@hidden
address@hidden
~< @var{filename}
address@hidden smallexample
address@hidden example
@noindent
The @samp{~d} escape is a shorthand for
address@hidden
address@hidden
~r dead.letter
address@hidden smallexample
address@hidden example
@node Printing And Saving the Message
@subsubsection Printing And Saving the Message
@@ -2542,8 +2767,8 @@ The @samp{~d} escape is a shorthand for
@kyindex ~w, mail escape
The @samp{~p} escape types the contents of the message entered so far,
-including headers, on your terminal. You can save the message to
-an arbitrary file using @samp{~w} escape. It takes the filename as its
+including headers, on your terminal. You can save the message to
+an arbitrary file using @samp{~w} escape. It takes the filename as its
argument.
@node Signing the Message
@@ -2552,9 +2777,9 @@ argument.
@kyindex ~A, mail escape
To save you the effort of typing your signature at the end of each
-message, you can use @samp{~a} or @samp{~A} escapes. If your signature
+message, you can use @samp{~a} or @samp{~A} escapes. If your signature
occupies one line only, save it to the variable @code{sign} and use
address@hidden escape to insert it. Otherwise, if it is longer than one
address@hidden escape to insert it. Otherwise, if it is longer than one
line, save it to a file, store the name of this file in the
variable @code{Sign}, and use @samp{~A} escape to insert it into
the message.
@@ -2565,9 +2790,9 @@ the message.
@kyindex ~F, mail escape
Sometimes it is necessary to view the contents of another message,
-while composing. These two escapes allow it. Both take the message
-list as their argument. If they are used without argument, the
-contents of the current message is printed. The difference between
+while composing. These two escapes allow it. Both take the message
+list as their argument. If they are used without argument, the
+contents of the current message is printed. The difference between
@samp{~f} and @samp{~F} is that the former uses ignored and retained
lists to select headers to be displayed, whereas the latter prints
all headers.
@@ -2585,20 +2810,20 @@ the body of the message being composed.
@kyindex ~-, mail escape
You can execute a mail command from within compose mode using @samp{~:}
-or @samp{~-} escapes. For example, typing
+or @samp{~-} escapes. For example, typing
address@hidden
address@hidden
~: from :t
address@hidden smallexample
address@hidden example
@noindent
-will display the from lines of all tagged messages. Note, that executing
+will display the from lines of all tagged messages. Note, that executing
mail-sending commands from within the compose mode is not allowed.
An attempt to execute such a command will result in diagnostic message
``Command not allowed in an escape sequence'' being displayed.
Also, when starting compose mode immediately from the shell
(e.g. running @samp{mail address@@domain}), most mail commands are
-meaningless, since there is no mailbox to operate upon. In this case,
+meaningless, since there is no mailbox to operate upon. In this case,
the only commands that can reasonably be used are: @code{alias},
@code{unalias}, @code{alternate}, @code{set}, and @code{unset}.
@@ -2608,10 +2833,10 @@ the only commands that can reasonably be used are:
@code{alias},
@kyindex ~|, mail escape
The @samp{~!} escape executes specified command and returns you to
address@hidden compose mode without altering your message. When used without
-arguments, it starts your login shell. The @samp{~|} escape pipes the
address@hidden compose mode without altering your message. When used without
+arguments, it starts your login shell. The @samp{~|} escape pipes the
message composed so far through the given shell command and replaces the
-message with the output the command produced. If the command produced
+message with the output the command produced. If the command produced
no output, @command{mail} assumes that something went wrong and retains
the old contents of your message.
@@ -2646,29 +2871,29 @@ permissions the target mailbox has.
Notice that @var{path_to_mailbox} is not an argument to
@option{--file} (@option{-f}) option, but rather the first
-non-optional argument on the command line. Therefore, the
+non-optional argument on the command line. Therefore, the
following three invocations are equivalent:
address@hidden
address@hidden
$ mail -fin mymbox
$ mail -f mymbox -in
$ mail --file -in mymbox
$ mail --file -i mymbox -n
address@hidden smallexample
address@hidden example
Additionally, for conformance to the GNU standards, the
following form is also accepted:
address@hidden
address@hidden
$ mail --file=mymbox -i -n
address@hidden smallexample
address@hidden example
Unless you have started mail with @option{--norc} command line option,
it will read the contents of the system-wide configuration file.
Then it reads the contents of user configuration file, if any.
For detailed description of these files, see @ref{Mail Configuration Files}.
After this initial setup, @command{mail} displays the first page of header
-lines and enters interactive mode. In interactive mode, @command{mail}
+lines and enters interactive mode. In interactive mode, @command{mail}
displays its prompt (@samp{?}, if not set otherwise) and executes the
commands the user enters.
@@ -2699,10 +2924,10 @@ Following commands quit the program:
@table @samp
@item quit
-Terminates the session. If @command{mail} was operating upon user's system
+Terminates the session. If @command{mail} was operating upon user's system
mailbox, then all undeleted and unsaved messages that have been read and
are not marked with hold flag are saved to the user's mbox file
-(@file{$HOME/mbox}). The messages, marked with @code{delete} are removed.
+(@file{$HOME/mbox}). The messages, marked with @code{delete} are removed.
The program exits to the Shell, unless saving the mailbox fails, in
which case user can escape with the exit command.
@@ -2730,7 +2955,7 @@ help:
@item help address@hidden
@itemx hel address@hidden
@itemx ? address@hidden
-Display detailed command synopsis. If no @var{command} is given, help for
+Display detailed command synopsis. If no @var{command} is given, help for
all available commands is displayed.
@item list
@itemx *
@@ -2771,23 +2996,23 @@ Move to the previous message.
@item cd address@hidden
@itemx chdir address@hidden
@itemx ch address@hidden
-Change to the specified directory. If @var{dir} is omitted, @env{$HOME} is
+Change to the specified directory. If @var{dir} is omitted, @env{$HOME} is
assumed.
@item file address@hidden
@itemx fi address@hidden
@itemx folder address@hidden
@itemx fold address@hidden
-Read in the contents of the specified @var{mailbox}. The current mailbox
+Read in the contents of the specified @var{mailbox}. The current mailbox
is updated as if @code{quit} command has been issued.
If @var{mailbox} is omitted, the command prints the current mailbox
name followed by the summary information regarding it, e.g.:
address@hidden
address@hidden
@cartouche
& fold
"/var/spool/mail/gray": 23 messages 22 unread
@end cartouche
address@hidden smallexample
address@hidden example
@end table
@node Controlling Header Display
@@ -2798,10 +3023,10 @@ name followed by the summary information regarding it,
e.g.:
To control which headers in the message should be displayed, @command{mail}
keeps two lists: a @dfn{retained} header list and an @dfn{ignored}
-header list. If @dfn{retained} header list is not empty, only the
+header list. If @dfn{retained} header list is not empty, only the
header fields listed in it are displayed when printing the message.
Otherwise, if @dfn{ignored} header list is not empty, only the headers
address@hidden listed} in this list are displayed. The uppercase variants
address@hidden listed} in this list are displayed. The uppercase variants
of message-displaying commands can be used to print all the headers.
The following commands modify and display the contents of both lists.
@@ -2811,11 +3036,11 @@ The following commands modify and display the contents
of both lists.
@itemx di address@hidden
@itemx ignore address@hidden
@itemx ig address@hidden
-Add @var{header-field-list} to the ignored list. When used without
+Add @var{header-field-list} to the ignored list. When used without
arguments, this command prints the contents of ignored list.
@item retain address@hidden
@itemx ret address@hidden
-Add @var{header-field-list} to the retained list. When used without
+Add @var{header-field-list} to the retained list. When used without
arguments, this command prints the contents of retained list.
@end table
@@ -2840,17 +3065,17 @@ Lists the current pageful of headers.
Lists the contents of @samp{From} headers for a given set of messages.
@item z address@hidden
Presents message headers in pagefuls as described for @code{headers}
-command. When @var{arg} is @samp{.}, it is generally equivalent to
address@hidden When @var{arg} is omitted or is @samp{+}, the next
-pageful of headers is displayed. If @var{arg} is @samp{-}, the
-previous pageful of headers is displayed. The latter two forms
+command. When @var{arg} is @samp{.}, it is generally equivalent to
address@hidden When @var{arg} is omitted or is @samp{+}, the next
+pageful of headers is displayed. If @var{arg} is @samp{-}, the
+previous pageful of headers is displayed. The latter two forms
of @code{z} command may also take a numerical argument meaning the
-number of pages to skip before displaying the headers. For
+number of pages to skip before displaying the headers. For
example:
address@hidden
address@hidden
& z +2
address@hidden smallexample
address@hidden example
@noindent
will skip two pages of messages before displaying the header summary.
@item size address@hidden
@@ -2861,14 +3086,14 @@ Lists the message number and message size in bytes for
each message in
Displays the value of @code{folder} variable.
@item summary
@itemx su
-Displays current mailbox summary. E.g.:
+Displays current mailbox summary. E.g.:
address@hidden
address@hidden
@cartouche
& summary
"/var/spool/mail/gray": 23 messages 22 unread
@end cartouche
address@hidden smallexample
address@hidden example
@end table
@node Displaying Messages
@@ -2888,13 +3113,13 @@ Displays current mailbox summary. E.g.:
@itemx p address@hidden
@item type address@hidden
@itemx t address@hidden
-Prints out the messages from @var{msglist}. The variable @code{crt}
+Prints out the messages from @var{msglist}. The variable @code{crt}
determines the minimum number of lines the body of the message must
contain in order to be piped through pager command specified
-by environment variable @code{PAGER}. If @code{crt} is set to a numeric
-value, this value is taken as the minimum number of lines. Otherwise,
+by environment variable @code{PAGER}. If @code{crt} is set to a numeric
+value, this value is taken as the minimum number of lines. Otherwise,
if @code{crt} is set without a value then the height of the terminal
- screen is used to compute the threshold. The number of lines on
+ screen is used to compute the threshold. The number of lines on
screen is controlled by @code{screen} variable.
@item Print address@hidden
@itemx P address@hidden
@@ -2903,9 +3128,9 @@ screen is controlled by @code{screen} variable.
Like print but also prints out ignored header fields.
@item decode address@hidden
@itemx dec address@hidden
-Print a multipart message. The @code{decode} command decodes and prints
-out specified message parts. E.g.
address@hidden
+Print a multipart message. The @code{decode} command decodes and prints
+out specified message parts. E.g.
address@hidden
@cartouche
& decode 15[2]
+---------------------------------------
@@ -2916,24 +3141,24 @@ out specified message parts. E.g.
Content-Type: message/delivery-status
...
@end cartouche
address@hidden smallexample
address@hidden example
@item top address@hidden
@itemx to address@hidden
-Prints the top few lines of each message in @var{msglist}. The number
+Prints the top few lines of each message in @var{msglist}. The number
of lines printed is controlled by the variable @code{toplines} and
defaults to five.
@item pipe address@hidden address@hidden
@itemx | address@hidden address@hidden
-Pipe the contents of specified messages through @var{shell-command}. If
+Pipe the contents of specified messages through @var{shell-command}. If
@var{shell-command} is empty but the string variable @code{cmd} is set,
the value of this variable is used as a command name.
@item struct address@hidden
Prints the @acronym{MIME} structure of each message from
address@hidden Empty @var{msglist} means current message.
address@hidden Empty @var{msglist} means current message.
Example:
address@hidden
address@hidden
@cartouche
& struct 2
2 multipart/mixed 14k
@@ -2941,7 +3166,7 @@ Example:
2[2] application/octet-stream 5k
2[3] text/x-diff 31k
@end cartouche
address@hidden smallexample
address@hidden example
@end table
@node Marking Messages
@@ -2953,20 +3178,20 @@ Example:
@table @samp
@item tag address@hidden
@itemx ta address@hidden
-Tag messages. The tagged messages can be referred to in message list
+Tag messages. The tagged messages can be referred to in message list
using @samp{:t} notation.
@item untag address@hidden
@itemx unt address@hidden
-Clear tags from specified messages. To untag all messages tagged so far
+Clear tags from specified messages. To untag all messages tagged so far
type
address@hidden
address@hidden
& untag :t
address@hidden smallexample
address@hidden example
@item hold address@hidden
@itemx ho address@hidden
@itemx preserve address@hidden
@itemx pre address@hidden
-Marks each message to be held in user's system mailbox. This command
+Marks each message to be held in user's system mailbox. This command
does not override the effect of @code{delete} command.
@end table
@@ -2980,8 +3205,8 @@ does not override the effect of @code{delete} command.
@table @samp
@item delete address@hidden
@itemx d address@hidden
-Mark messages as deleted. Upon exiting with @code{quit} command these
-messages will be deleted from the mailbox. Until the end of current
+Mark messages as deleted. Upon exiting with @code{quit} command these
+messages will be deleted from the mailbox. Until the end of current
session the deleted messages can be referred to in message lists using
:d notation.
@item undelete address@hidden
@@ -2989,7 +3214,7 @@ session the deleted messages can be referred to in
message lists using
Clear delete mark from the specified messages.
@item dp address@hidden
@itemx dt address@hidden
-Deletes the current message and prints the next message. If
+Deletes the current message and prints the next message. If
@var{msglist} is specified, deletes all messages from the list and
prints the message, immediately following last deleted one.
@end table
@@ -3009,16 +3234,16 @@ prints the message, immediately following last deleted
one.
@item save address@hidden @var{file}]
@itemx s address@hidden @var{file}]
Takes a message list and a file name and appends each message in turn to
-the end of the file. The name of file and number of characters appended
-to it is echoed on the terminal. Each saved message is marked for
+the end of the file. The name of file and number of characters appended
+to it is echoed on the terminal. Each saved message is marked for
deletion as if with @code{delete} command, unless the variable
@code{keepsave} is set.
@item Save address@hidden
@itemx S address@hidden
Like @code{save}, but the file to append messages to is named after the
-sender of the first message in @var{msglist}. For example:
+sender of the first message in @var{msglist}. For example:
address@hidden
address@hidden
@cartouche
@group
& from 14 15
@@ -3028,7 +3253,7 @@ sender of the first message in @var{msglist}. For example:
"smith" 22/603
@end group
@end cartouche
address@hidden smallexample
address@hidden example
@noindent
i.e., 22 lines (603 characters) have been appended to the file ``smith''.
@@ -3047,7 +3272,7 @@ header) is saved.
@itemx touch address@hidden
@itemx tou address@hidden
Mark list of messages to be saved in the user's mailbox (@file{$HOME/mbox})
-upon exiting via @code{quit} command. This is the default action for
+upon exiting via @code{quit} command. This is the default action for
all read messages, unless you have variable @code{hold} set.
@item copy address@hidden @var{file}]
@itemx c address@hidden @var{file}]
@@ -3064,7 +3289,7 @@ deletion.
@kyindex edit, mail command
@kyindex visual, mail command
-These command allow to edit messages in a mailbox. @emph{Please note},
+These command allow to edit messages in a mailbox. @emph{Please note},
that modified messages currently do not replace original ones. i.e.
you have to save them explicitly using your editor's @code{save}
command if you do not want the effects of your editing to be lost.
@@ -3098,13 +3323,13 @@ With more than one argument, creates a new alias or
changes an old one.
@item unalias address@hidden
@itemx una address@hidden
Takes a list of names defined by alias commands and discards the
-remembered groups of users. The alias names no longer have any
+remembered groups of users. The alias names no longer have any
significance.
@item alternates @var{name}...
@itemx alt @var{name}...
The alternates command is useful if you have accounts on several
-machines. It can be used to inform mail that the listed addresses are
-really you. When you reply to messages, mail will not send a copy of
+machines. It can be used to inform mail that the listed addresses are
+really you. When you reply to messages, mail will not send a copy of
the message to any of the addresses listed on the alternates list.
If the alternates command is given with no argument, the current set of
alternate names is displayed.
@@ -3123,7 +3348,7 @@ alternate names is displayed.
@table @samp
@item mail address@hidden
@itemx m address@hidden
-Switches to compose mode. After composing the message, sends messages to
+Switches to compose mode. After composing the message, sends messages to
the specified addresses.
@item reply address@hidden
@@ -3149,7 +3374,7 @@ originators only.
@item followup address@hidden
@itemx fo address@hidden
-Switches to compose mode. After composing, sends the message to the
+Switches to compose mode. After composing, sends the message to the
originators and recipients of all messages in @var{msglist}.
@item Followup address@hidden
@@ -3160,20 +3385,20 @@ originators of messages in @var{msglist}.
@end table
To determine the sender of the message @command{mail} uses the
-list of sender fields (@pxref{Controlling Sender Fields}). The first field
-from this list is looked up in message headers. If it is found
+list of sender fields (@pxref{Controlling Sender Fields}). The first field
+from this list is looked up in message headers. If it is found
and contains a valid email address, this address is used as
-the sender address. If not, the second field is searched and
-so on. This process continues until a field is found in the
+the sender address. If not, the second field is searched and
+so on. This process continues until a field is found in the
headers, or the sender field list is exhausted, whichever happens
first.
If the previous step did not determine the sender address, the
address from SMTP envelope is used.
-Let's illustrate this. Suppose your mailbox contains the following:
+Let's illustrate this. Suppose your mailbox contains the following:
address@hidden
address@hidden
@cartouche
U 1 block@@helsingor.org Fri Jun 30 18:30 8/245 Re: The Sa
& Print 1
@@ -3185,12 +3410,12 @@ Subject: News
Hi
@end cartouche
address@hidden smallexample
address@hidden example
@noindent
Now, you issue the following commands:
address@hidden
address@hidden
@cartouche
& sender mail-followup-to reply-to from
& reply
@@ -3198,7 +3423,7 @@ To: <root@@helsingor.org>
Subject: Re: News
@end cartouche
address@hidden smallexample
address@hidden example
@noindent
As you see, the value of @code{Reply-To} field was taken as the
@@ -3206,24 +3431,24 @@ sender address.
Now, let's try the following command sequence:
address@hidden
address@hidden
# Clear the sender list
& nosender
# Set new sender list
& sender From
address@hidden smallexample
address@hidden example
@noindent
Now, the @code{From} address will be taken:
address@hidden
address@hidden
@cartouche
& reply
To: Antonius Block <block@@helsingor.org>
Subject: Re: News
@end cartouche
address@hidden smallexample
address@hidden example
@node Controlling Sender Fields
@subsubsection Controlling Sender Fields
@@ -3234,10 +3459,10 @@ Commands @code{sender} and @code{nosender} are used to
manipulate
the contents of the sender field list.
If the command @code{sender} is used without arguments, it displays
-the contents of the sender field list. If arguments are given,
-each argument is appended to the sender field list. For example:
+the contents of the sender field list. If arguments are given,
+each argument is appended to the sender field list. For example:
address@hidden
address@hidden
@cartouche
& sender
Sender address is obtained from the envelope
@@ -3251,12 +3476,12 @@ mail-followup-to
reply-to
from
@end cartouche
address@hidden smallexample
address@hidden example
Command @code{nosender} is used to remove items from the sender
field list:
address@hidden
address@hidden
@cartouche
& sender
mail-followup-to
@@ -3267,23 +3492,23 @@ from
mail-followup-to
from
@end cartouche
address@hidden smallexample
address@hidden example
When used without arguments, this command clears the list:
address@hidden
address@hidden
@cartouche
& nosender
Sender address is obtained from the envelope
@end cartouche
address@hidden smallexample
address@hidden example
@node Incorporating New Mail
@subsubsection Incorporating New Mail
@kyindex incorporate, mail command
The @code{incorporate} (@code{inc}) command incorporates newly arrived
-messages to the displayed list of messages. This is done automatically
+messages to the displayed list of messages. This is done automatically
before returning to @command{mail} command prompt if the variable
@code{autoinc} is set.
@@ -3293,10 +3518,10 @@ before returning to @command{mail} command prompt if
the variable
@kyindex !, mail command
To run arbitrary shell command from @command{mail} command prompt, use
address@hidden (@code{sh}) command. If no arguments are specified, the
-command starts the user login shell. Otherwise, it uses its first
address@hidden (@code{sh}) command. If no arguments are specified, the
+command starts the user login shell. Otherwise, it uses its first
argument as a file name to execute and all subsequent arguments are
-passed as positional parameters to this command. The @code{shell}
+passed as positional parameters to this command. The @code{shell}
command can also be spelled as @code{!}.
@c **********************************
@@ -3306,7 +3531,7 @@ command can also be spelled as @code{!}.
@subsubheading Comments
-The @samp{#} character introduces an end-of-line comment. All characters
+The @samp{#} character introduces an end-of-line comment. All characters
until and including the end of line are ignored.
@subsubheading Displaying Arbitrary Text
@@ -3318,19 +3543,19 @@ The @samp{echo} (@samp{ec}) command prints its
arguments to stdout.
@kyindex source, mail command
The command @samp{source @var{filename}} reads commands from the named
-file. Its minimal abbreviation is @samp{so}.
+file. Its minimal abbreviation is @samp{so}.
@anchor{Setting and Unsetting the Variables}
@subsubheading Setting and Unsetting the Variables
@kyindex set, mail command
@kyindex unset, mail command
-The mail variables are set using @samp{set} (@samp{se}) command. The
-command takes a list of assignments. The syntax of an assignment is
+The mail variables are set using @samp{set} (@samp{se}) command. The
+command takes a list of assignments. The syntax of an assignment is
@table @samp
@item @address@hidden
-Assign a string value to the variable. If @var{string} contains
+Assign a string value to the variable. If @var{string} contains
whitespace characters it must be enclosed in a pair of
double-quote characters (@samp{"})
@item @address@hidden
@@ -3343,30 +3568,30 @@ Assign boolean @code{False} value.
Example:
address@hidden
address@hidden
& set askcc nocrt indentprefix="> "
address@hidden smallexample
address@hidden example
@noindent
This statement sets @code{askcc} to @code{True}, @code{crt} to
@code{False}, and @code{indentprefix} to ``> ''.
-To unset mail variables use @samp{unset}(@samp{uns}) command. The
+To unset mail variables use @samp{unset}(@samp{uns}) command. The
command takes a list of variable names to unset.
Example:
To undo the effect of the previous example, do:
address@hidden
address@hidden
& unset askcc crt indentprefix
address@hidden smallexample
address@hidden example
When used without arguments, both @command{set} or @command{unset}
-list all currently defined variables. The form of this listing is
-controlled by @code{variable-pretty-print} (@code{varpp}) variable. If
+list all currently defined variables. The form of this listing is
+controlled by @code{variable-pretty-print} (@code{varpp}) variable. If
it is set, a description precedes each variable, e.g.:
address@hidden
address@hidden
# prompt user for subject before composing the message
ask
# prompt user for cc before composing the message
@@ -3375,32 +3600,32 @@ askcc
charset="auto"
# number of columns on terminal screen
columns=80
address@hidden smallexample
address@hidden example
If @code{variable-pretty-print} is not set, only the settings are
shown, e.g.:
address@hidden
address@hidden
ask
askcc
charset="auto"
columns=80
address@hidden smallexample
address@hidden example
@kyindex variable, mail command
A special command is provided to list all internal @command{mail}
variables:
address@hidden
address@hidden
variable address@hidden
address@hidden smallexample
address@hidden example
-If used without arguments, it prints all known internal variables. If
+If used without arguments, it prints all known internal variables. If
arguments are given, it displays only those internal variables that
-are listed in command line. For each variable, this command prints its
-name, data type, current value and a short description. For example:
+are listed in command line. For each variable, this command prints its
+name, data type, current value and a short description. For example:
address@hidden
address@hidden
& variable ask datefield
ask, asksub
Type: boolean
@@ -3411,12 +3636,12 @@ datefield
Type: boolean
Current value: [not set]
get date from the `Date:' header, instead of the envelope
address@hidden smallexample
address@hidden example
@subsubheading Setting and Unsetting Shell Environment Variables
Shell environment may be modified using @samp{setenv} (@samp{sete})
-command. The command takes a list of assignments. The syntax of an
+command. The command takes a list of assignments. The syntax of an
assignment is:
@table @samp
@@ -3435,20 +3660,20 @@ Delete the variable @var{name} from the environment
(``unset'' it).
@kyindex endif, mail command
The conditional statement allows to execute a set of mail commands
-depending on the mode the @command{mail} program is in. The conditional
+depending on the mode the @command{mail} program is in. The conditional
statement is:
address@hidden
address@hidden
if @var{cond}
...
else
...
endif
address@hidden smallexample
address@hidden example
@noindent
where @samp{...} represents the set of commands to be executed in each
-branch of the statement. @var{cond} can be one of the following:
+branch of the statement. @var{cond} can be one of the following:
@table @samp
@item s
@@ -3459,13 +3684,13 @@ True if @command{mail} is operating in mail reading
mode.
True if stdout is a terminal device (as opposed to a regular file).
@end table
-The conditional statements can be nested to arbitrary depth. The minimal
+The conditional statements can be nested to arbitrary depth. The minimal
abbreviations for @samp{if}, @samp{else} and @samp{endif} commands are
@samp{i}, @samp{el} and @samp{en}.
Example:
address@hidden
address@hidden
if t
set crt prompt="& "
else
@@ -3474,7 +3699,7 @@ endif
if s
alt gray@@farlep.net gray@@mirddin.farlep.net
set
address@hidden smallexample
address@hidden example
@node Mail Variables
@subsection How to Alter the Behavior of @command{mail}
@@ -3489,7 +3714,7 @@ Following variables control the behavior of GNU
@command{mail}:
@vrindex append, mail variable
Messages saved in mbox are appended to the end rather than prepended.
-This is the default and cannot be changed. This variable exists only
+This is the default and cannot be changed. This variable exists only
for compatibility with other @command{mailx} implementations.
@kwindex appenddeadletter
@@ -3499,7 +3724,7 @@ for compatibility with other @command{mailx}
implementations.
@vrindex appenddeadletter, mail variable
If this variable is @code{True}, the contents of canceled letter is
-appended to the user's @file{dead.letter} file. Otherwise it overwrites
+appended to the user's @file{dead.letter} file. Otherwise it overwrites
its contents.
@kwindex askbcc
@@ -3564,7 +3789,7 @@ command is replaced with the last executed command.
Record outgoing messages in a file named after the first recipient.
The name is the login-name portion of the address found first on the
address@hidden:} line in the mail header. This variable overrides the
address@hidden:} line in the mail header. This variable overrides the
@samp{record} variable.
It is set by the @option{--byname} (@option{-F}) command line option.
@@ -3577,9 +3802,9 @@ It is set by the @option{--byname} (@option{-F}) command
line option.
@vrindex datefield, mail variable
By default the date in a header summary is taken from the @acronym{SMTP}
-envelope of the message. Setting this variable tells @command{mail}
+envelope of the message. Setting this variable tells @command{mail}
to use the date from @code{Date:} header field, converted to
-local time. Notice, that for messages lacking this field @command{mail}
+local time. Notice, that for messages lacking this field @command{mail}
will fall back to using @acronym{SMTP} envelope.
@xref{fromfield}.
@@ -3591,11 +3816,11 @@ will fall back to using @acronym{SMTP} envelope.
@vrindex charset, mail variable
The value of this variable controls the output character set for the
-header fields encoding using RFC 2047. If the variable is unset, no
-decoding is performed and the fields are printed as they are. If the
+header fields encoding using RFC 2047. If the variable is unset, no
+decoding is performed and the fields are printed as they are. If the
variable is set to @samp{auto}, @command{mail} tries to deduce the
name of the character set from the value of @code{LC_ALL} environment
-variable. Otherwise, its value is taken as the name of the charset.
+variable. Otherwise, its value is taken as the name of the charset.
@kwindex cmd
@item cmd
@@ -3608,7 +3833,7 @@ Contains default shell command for @code{pipe}.
@kwindex columns
@item columns
@*Type: Numeric.
address@hidden: Detected at startup by querying the terminal device. If this
address@hidden: Detected at startup by querying the terminal device. If this
fails, the value of environment variable @code{COLUMNS} is used.
@vrindex columns, mail variable
@@ -3622,10 +3847,10 @@ This variable contains the number of columns on
terminal screen.
The variable @code{crt} determines the minimum number of lines the body
of the message must contain in order to be piped through pager command
-specified by environment variable @code{PAGER}. If @code{crt} is set
-to a numeric value, this value is taken as the threshold. Otherwise,
+specified by environment variable @code{PAGER}. If @code{crt} is set
+to a numeric value, this value is taken as the threshold. Otherwise,
if @code{crt} is set without a value, then the height of the terminal
-screen is used to compute the threshold. The number of lines on
+screen is used to compute the threshold. The number of lines on
screen is controlled by @code{screen} variable.
@kwindex debug
@@ -3638,8 +3863,8 @@ Sets mailutils debug level. If set to string, the value
must be a
valid Mailutils debugging specification. @xref{Debug Statement}, for
a description.
-If unset (i.e. @code{set nodebug}), clears and disables all debugging
-information. If set to @samp{true} (i.e. @code{set debug}), sets
+If unset (i.e. @code{set nodebug}), clears and disables all debugging
+information. If set to @samp{true} (i.e. @code{set debug}), sets
maximum debugging (@samp{<trace7}) on mailbox and its underlying
objects.
@@ -3650,19 +3875,19 @@ objects.
@vrindex decode-fallback, mail variable
This variable controls the way to represent characters that cannot
-be rendered using current character set. It can have three values:
+be rendered using current character set. It can have three values:
@table @samp
@item none
-Such characters are not printed at all. The conversion process stops
+Such characters are not printed at all. The conversion process stops
at the first character that cannot be rendered.
@item copy-pass
-The characters are displayed @samp{as is}. Notice, that depending on
+The characters are displayed @samp{as is}. Notice, that depending on
your setup, this may screw-up your terminal settings.
@item copy-octal
-Unprintable characters are represented by their octal codes. Printable
+Unprintable characters are represented by their octal codes. Printable
ones are printed @samp{as is}.
@end table
@@ -3691,7 +3916,7 @@ terminator of a message you are sending.
@vrindex emptystart, mail variable
If the mailbox is empty, @command{mail} normally prints @samp{No mail for
user} and
-exits immediately. If this option is set, @command{mail} will start no matter
is
+exits immediately. If this option is set, @command{mail} will start no matter
is
the mailbox empty or not.
@kwindex editheaders
@@ -3728,7 +3953,7 @@ and @code{Reply} commands (@pxref{Replying}).
@*Default: Unset.
@vrindex folder, mail variable
-The name of the directory to use for storing folders of messages. If
+The name of the directory to use for storing folders of messages. If
unset, @env{$HOME} is assumed.
@anchor{fromfield}
@@ -3776,26 +4001,26 @@ introduces a @dfn{format specifier}. Valid format
specifiers are:
@end multitable
Some additional symbols are allowed between @samp{%} and the specifier
-letter. The @samp{-} character immediately following @samp{%}
-indicates that this field should be left aligned. Similarly, the
address@hidden character indicates right alignment. Default alignment
+letter. The @samp{-} character immediately following @samp{%}
+indicates that this field should be left aligned. Similarly, the
address@hidden character indicates right alignment. Default alignment
depends on the type of the specifier: the specifiers that produce
numeric values (@samp{%l}, @samp{%m}, and @samp{%o}) are aligned to
the right, whereas the ones producing string values are aligned to the
left.
A number following @samp{%} or the alignment flag, indicates the
-field width. Consider, for example, the following specifiers:
+field width. Consider, for example, the following specifiers:
@table @asis
@item %m
-Print current message number. Take as much screen columns as necessary
+Print current message number. Take as much screen columns as necessary
to output it.
@item %4m
@itemx %+4m
-Print current message number. Occupy 4 screen columns, truncate the
-output if it does not fit that width. Align the output to the right.
+Print current message number. Occupy 4 screen columns, truncate the
+output if it does not fit that width. Align the output to the right.
@item %-4m
Same as above, but align to the left.
@@ -3808,8 +4033,8 @@ Same as above, but align to the left.
@vrindex hold, mail variable
When set to @code{True}, the read or saved messages will be stored in
-user's mailbox (@file{$HOME/mbox}). Otherwise, they will be held in
-system mailbox also. This option is in effect only when operating
+user's mailbox (@file{$HOME/mbox}). Otherwise, they will be held in
+system mailbox also. This option is in effect only when operating
upon user's system mailbox.
@kwindex ignore
@@ -3819,7 +4044,7 @@ upon user's system mailbox.
@vrindex ignore, mail variable
When set to @code{True}, @command{mail} will ignore keyboard interrupts
-when composing messages. Otherwise an interrupt will be taken as a
+when composing messages. Otherwise an interrupt will be taken as a
signal to abort composing.
@kwindex ignoreeof
@@ -3845,7 +4070,7 @@ String used by the @code{~m} tilde escape for indenting
quoted messages.
@*Default: False
If set, @command{mail} will expand aliases in the address header field
-before entering send mode (@pxref{Composing Mail}). By default, the
+before entering send mode (@pxref{Composing Mail}). By default, the
address header fields are left intact while composing, the alias
expansion takes place immediately before sending message.
@@ -3856,7 +4081,7 @@ expansion takes place immediately before sending message.
@vrindex append, mail variable
Truncate the user's system mailbox when it is empty, instead of
-removing it. This is the default and cannot be changed. This variable
+removing it. This is the default and cannot be changed. This variable
exists only for compatibility with other @command{mailx} implementations.
@kwindex keepsave
@@ -3875,7 +4100,7 @@ mailbox.
@*Default: False.
@vrindex mailx, mail variable
-When set, enables @dfn{mailx compatibility mode}. This mode
+When set, enables @dfn{mailx compatibility mode}. This mode
has the following effects:
@itemize @bullet
@@ -3885,7 +4110,7 @@ The default behavior is to ask for these values before
composing
the body.
@item In send mode, if the composition was interrupted, @command{mail}
-will exit with zero status. By default it exits with zero status only
+will exit with zero status. By default it exits with zero status only
if the message was sent successfully.
@end itemize
@@ -3895,23 +4120,23 @@ if the message was sent successfully.
@*Default: True.
@vrindex metamail, mail variable
-This variable controls operation of @code{decode} command. If
+This variable controls operation of @code{decode} command. If
it is unset, @code{decode} will not attempt any interpretation
-of the content of message parts. Otherwise, if @code{metamail}
+of the content of message parts. Otherwise, if @code{metamail}
is set to @code{true}, @code{decode} will use internal metamail
-support to interpret message parts. Finally, if @code{metamail}
+support to interpret message parts. Finally, if @code{metamail}
is assigned a string, this string is treated as command line of
the external @command{metamail} command which will be used to
-display parts of a multipart message. For example:
+display parts of a multipart message. For example:
address@hidden
address@hidden
# Disable MIME interpretation:
set nometamail
# Enable built-in MIME support:
set metamail
# Use external program to display MIME parts:
set metamail="metamail -m mail -p"
address@hidden smallexample
address@hidden example
@kwindex mimenoask
@item mimenoask
@@ -3920,14 +4145,14 @@ set metamail="metamail -m mail -p"
@vrindex mimenoask, mail variable
By default @command{mail} asks for confirmation before running
-interpreter to view a part of the multi-part message. If this variable
+interpreter to view a part of the multi-part message. If this variable
is set, its value is treated as a comma-separated list of MIME types
-for which no confirmation is needed. Elements of this list may include
+for which no confirmation is needed. Elements of this list may include
shell-style globbing patterns, e.g. setting
address@hidden
address@hidden
set mimenoask=text/*,image/jpeg
address@hidden smallexample
address@hidden example
@noindent
will disable prompting before displaying any textual files, no
@@ -3941,7 +4166,7 @@ type @samp{image/jpeg}.
@vrindex metoo, mail variable
Usually, when an alias is expanded that contains the sender, the sender
-is removed from the expansion. Setting this option causes the sender to
+is removed from the expansion. Setting this option causes the sender to
be included in the group.
@kwindex mode
@@ -3950,7 +4175,7 @@ be included in the group.
@*Default: The name of current operation mode.
@vrindex mode, mail variable
-This variable keeps the name of the current operation mode. Its
+This variable keeps the name of the current operation mode. Its
possible values are:
@table @asis
@@ -3967,10 +4192,10 @@ The program is started with the @option{--print}
(@option{-p}) command
line option (@pxref{Invoking Mail}).
@item read
-The progran operates in read mode. This is the default.
+The progran operates in read mode. This is the default.
@item send
-The program operates in send mode. This means it was given one or more
+The program operates in send mode. This means it was given one or more
recipient addresses in the command line.
@end table
@@ -3981,23 +4206,23 @@ recipient addresses in the command line.
@vrindex nullbody, mail variable
Controls whether @command{mail} accepts messages with an empty
-body. The default value, @code{true}, means such messages are sent,
+body. The default value, @code{true}, means such messages are sent,
and a warning (traditionally saying @samp{Null message body; hope
-that's ok}) is displayed. The text of the warning can be set using
+that's ok}) is displayed. The text of the warning can be set using
@code{nullbodymsg} variable (see below).
If @code{nullbody} is unset, @command{mail} will silently ignore such
-messages. This can be useful in @file{crontab} files, to avoid sending
-mails when nothing important happens. For example, the @file{crontab}
+messages. This can be useful in @file{crontab} files, to avoid sending
+mails when nothing important happens. For example, the @file{crontab}
entry below will send mail only if the utility @command{some-prog}
outputs something on its standard output or error:
address@hidden
address@hidden
@group
*/5 * * * * some-prog 2>&1 | \
/bin/mail -E'set nonullbody' -s 'Periodic synchronization'
@end group
address@hidden smallexample
address@hidden example
@kwindex showenvelope
@item showenvelope
@@ -4014,7 +4239,7 @@ If this variable is set, the @code{print} command will
include the
@vrindex nullbodymsg
Keeps the text of the warning, displayed by @command{mail} before
-sending an empty message. When available, the translation of
+sending an empty message. When available, the translation of
this text, in accordance with the current locale, is displayed.
Unsetting this variable disables the warning.
@@ -4035,7 +4260,7 @@ This variable is not used. It exists for compatibility
with other
@vrindex outfolder, mail variable
Contains the directory in which files created by @code{save},
address@hidden, etc. commands will be stored. When unset, current
address@hidden, etc. commands will be stored. When unset, current
directory is assumed.
@kwindex page
@@ -4079,7 +4304,7 @@ When set, causes keyboard interrupts to terminate the
program.
@vrindex rc, mail variable
When this variable is set, @command{mail} will read the system-wide
-configuration file upon startup. See @ref{Mail Configuration Files}.
+configuration file upon startup. See @ref{Mail Configuration Files}.
@kwindex readonly
@item readonly
@@ -4132,17 +4357,17 @@ of a reply message.
@vrindex replyregex, mail variable
Sets the regular expression used to recognize subjects of reply
-messages. If the @code{Subject} header of the message matches this
+messages. If the @code{Subject} header of the message matches this
expression, the value of @code{replyprefix} will not be prepended to
-it before replying. The expression should be a POSIX extended regular
-expression. The comparison is case-insensitive.
+it before replying. The expression should be a POSIX extended regular
+expression. The comparison is case-insensitive.
For example, to recognize usual English, Polish, Norwegian and German
reply subject styles, use:
address@hidden
address@hidden
set replyregex="^(re|odp|aw|ang)(\\[[0-9]+\\])?:[[:blank:]]"
address@hidden smallexample
address@hidden example
@noindent
(Notice the quoting of backslash characters).
@@ -4154,12 +4379,12 @@ set
replyregex="^(re|odp|aw|ang)(\\[[0-9]+\\])?:[[:blank:]]"
@vrindex save, mail variable
When set, the aborted messages will be stored in the user's
address@hidden See also @code{appenddeadletter}.
address@hidden See also @code{appenddeadletter}.
@kwindex screen
@item screen
@*Type: Numeric.
address@hidden: Detected at startup by querying the terminal device. If this
address@hidden: Detected at startup by querying the terminal device. If this
fails, the value of environment variable @code{LINES} is used.
@vrindex screen, mail variable
@@ -4197,7 +4422,7 @@ the header summary.
@*Default: Unset.
@vrindex Sign, mail variable
-Contains the filename holding users signature. The contents of this
+Contains the filename holding users signature. The contents of this
file is appended to the end of a message being composed by @code{~A}
escape.
@@ -4207,8 +4432,8 @@ escape.
@*Default: Unset.
@vrindex sign, mail variable
-Contains the user's signature. The contents of this variable is appended
-to the end of a message being composed by @code{~a} escape. Use
+Contains the user's signature. The contents of this variable is appended
+to the end of a message being composed by @code{~a} escape. Use
@code{Sign} variable, if your signature occupies more than one line.
@kwindex showto
@@ -4227,7 +4452,7 @@ invoked the program.
@*Default: Unset.
@vrindex subject, mail variable
-Contains default subject line. This will be used when @code{asksub} is
+Contains default subject line. This will be used when @code{asksub} is
off.
@kwindex toplines
@@ -4245,8 +4470,8 @@ Number of lines to be displayed by @code{top} and
@code{Top} commands.
@*Default: False.
Setting this variable enables strict control over variable
-settings. In this mode, @command{mail} refuses to set read-only
-variables. Also, if the user is trying to set an unknown variable,
+settings. In this mode, @command{mail} refuses to set read-only
+variables. Also, if the user is trying to set an unknown variable,
@command{mail} prints a warning.
@xref{Setting and Unsetting the Variables}.
@@ -4258,7 +4483,7 @@ variables. Also, if the user is trying to set an unknown
variable,
@*Default: False.
If this variable is set, the listing ouput by @command{set} contains short
-descriptions before each variable. @xref{Setting and Unsetting the Variables}.
+descriptions before each variable. @xref{Setting and Unsetting the
Variables}.
@kwindex verbose
@item verbose
@@ -4275,11 +4500,11 @@ When set, the actual delivery of messages is displayed
on the user's terminal.
@vrindex xmailer, mail variable
Controls whether the header @samp{X-Mailer} should be added to
-outgoing messages. The default value of this header is
+outgoing messages. The default value of this header is
address@hidden
address@hidden
X-Mailer: mail (GNU Mailutils @value{VERSION})
address@hidden smallexample
address@hidden example
@end table
@@ -4288,32 +4513,33 @@ X-Mailer: mail (GNU Mailutils @value{VERSION})
Upon startup, @command{mail} reads the contents of the two command files:
the system-wide configuration file, and the user's configuration
-file. Each line read from these files is processed like a usual
+file. Each line read from these files is processed like a usual
@command{mail} command.
When run with @option{--norc} (@option{-N}) option, @command{mail} does
-not read the contents of system-wide configuration file. The user's
+not read the contents of system-wide configuration file. The user's
file, if it exists, is always processed.
The user's configuration file is located in the user's home
-directory and is named @file{.mailrc}. The location and name of
+directory and is named @file{.mailrc}. The location and name of
the system-wide configuration file is determined when configuring the
-package via @option{--with-mail-rc} option. It defaults to
+package via @option{--with-mail-rc} option. It defaults to
@address@hidden/mail.rc}.
@page
@node messages
@section @command{messages} --- Count the Number of Messages in a Mailbox
@pindex messages
address@hidden
@command{Messages} prints on standard output the number of messages
-contained in each folder specified in command line. If no folders
-are specified, it operates upon user's system mailbox. For each
+contained in each folder specified in command line. If no folders
+are specified, it operates upon user's system mailbox. For each
folder, the following output line is produced:
address@hidden
address@hidden
Number of messages in @var{folder}: @var{number}
address@hidden smallexample
address@hidden example
@noindent
where @var{folder} represents the folder name, @var{number} represents
@@ -4337,7 +4563,7 @@ The program accepts following command line options:
@itemx --quiet
@itemx -s
@itemx --silent
-Be quiet. Display only number of messages per mailbox, without leading text.
+Be quiet. Display only number of messages per mailbox, without leading text.
@item -?
@itemx --help
Output help message and exit.
@@ -4352,26 +4578,27 @@ Output program version and exit.
@node movemail
@section @command{movemail} --- Moves Mail from the User Maildrop to the Local
File
@pindex movemail
address@hidden
The purpose of @command{movemail}, as its name implies, is to move mail
-from one location to another. For example, the following invocation:
+from one location to another. For example, the following invocation:
address@hidden
address@hidden
movemail /var/mail/smith INBOX
address@hidden smallexample
address@hidden example
@noindent
moves messages from file @file{/var/mail/smith} to file @file{INBOX}.
-You will probably never have to run this program manually. It is
-intended as a replacement for @command{movemail} from GNU Emacs. The
+You will probably never have to run this program manually. It is
+intended as a replacement for @command{movemail} from GNU Emacs. The
@command{movemail} program is run by Emacs @code{Rmail}
-module. @xref{Rmail,,,emacs,Reading Mail with Rmail}, for detailed
+module. @xref{Rmail,,,emacs,Reading Mail with Rmail}, for detailed
description of @code{Rmail} interface.
Mailutils version of @command{movemail} is fully
backward-compatible with its Emacs predecessor, so it should run
-flawlessly with older versions of Emacs. Emacs versions
+flawlessly with older versions of Emacs. Emacs versions
starting from 22.1 contain improved @code{Rmail} interface and
are able to take advantage of all new features mailutils
@command{movemail} provides.
@@ -4385,6 +4612,7 @@ are able to take advantage of all new features mailutils
@node Movemail Configuration
@subsection Movemail Configuration
address@hidden
Following configuration file statements affect the behavior of
@command{movemail}:
@@ -4447,9 +4675,9 @@ Setting @code{program-id} may be necessary if several
@code{movemail}
instances are run simultaneously (e.g. invoked from a script) to
discern between the instances. For example:
address@hidden
address@hidden
program-id "address@hidden@}: address@hidden@} => address@hidden@}"
address@hidden smallexample
address@hidden example
@end deffn
@deffn {Movemail Config} uidl @var{bool}
@@ -4469,7 +4697,7 @@ elements:
@anchor{mailbox-ownership-methods}
@table @asis
@item copy-id
-Copy owner UID and GID from the source mailbox. This method works only
+Copy owner UID and GID from the source mailbox. This method works only
with local mailboxes, i.e.: @samp{mbox} (UNIX mailbox), @samp{maildir}
and @samp{mh}.
@@ -4478,7 +4706,7 @@ Get owner name from the source mailbox URL and obtain UID
and GID for
this user using mailutils authorization methods.
@item address@hidden:@var{gid}]
-Set supplied @var{uid} and @var{gid}. If @var{gid} is not supplied,
+Set supplied @var{uid} and @var{gid}. If @var{gid} is not supplied,
it is read from the @file{/etc/passwd} record for this UID.
@item address@hidden
@@ -4502,6 +4730,7 @@ Make destination mailbox owned by @var{user}.
@node Movemail Options
@subsection Movemail Options
address@hidden
This subsection discusses @command{movemail} options from the point of
view of an Emacs @code{Rmail} user.
@@ -4510,7 +4739,7 @@ To set various options to @command{movemail} from
@code{Rmail}, use
@code{rmail-movemail-flags} variable, or @samp{Rmail Movemail Flags}
section from the menu.
-Some POP servers return messages in reversed order. To fix the
+Some POP servers return messages in reversed order. To fix the
order, use @option{-p} option or its synonym @option{--reverse}.
If the remote server supports @acronym{TLS} encryption, use
@@ -4525,17 +4754,17 @@ connection.
@node Summary
@subsection Movemail Usage Summary
address@hidden
address@hidden
movemail address@hidden @var{inbox} @var{destfile} address@hidden
address@hidden smallexample
address@hidden example
-The first argument, @var{inbox}, is the @acronym{url} (@pxref{URL}) of
-the source mailbox. The second argument, @var{destfile}, traditionally
+The first argument, @var{inbox}, is the @acronym{url} (@FIXME-pxref{URL}) of
+the source mailbox. The second argument, @var{destfile}, traditionally
means destination file, i.e. the UNIX mailbox to copy messages
-to. However, mailutils @command{movemail} extends the meaning of this
-parameter. You may actually specify any valid @acronym{URL} as
+to. However, mailutils @command{movemail} extends the meaning of this
+parameter. You may actually specify any valid @acronym{URL} as
@var{destfile} address@hidden does not use this
-feature}. Finally, optional third argument is a traditional way of
+feature}. Finally, optional third argument is a traditional way of
specifying user passwords for remote (@acronym{POP} or @acronym{IMAP})
mailboxes.
@@ -4571,8 +4800,8 @@ Use UIDLs to avoid downloading the same message twice.
@item -P @var{method-list}
@itemx address@hidden
Define list of methods for setting ownership of the destination
-mailbox. @xref{mailbox-ownership-methods}, for a description of
address@hidden This option is useful only when running
+mailbox. @xref{mailbox-ownership-methods}, for a description of
address@hidden This option is useful only when running
@command{movemail} as root.
@item -v
@@ -4586,30 +4815,30 @@ Increase verbosity level.
@pindex readmsg
The @command{readmsg} utility extracts messages from a mailbox
-according to the criteria specified in the command line. These
+according to the criteria specified in the command line. These
criteria are:
@enumerate
@item A lone @samp{*} means ``select all messages in the mailbox''.
@item
-A list of message numbers may be specified. Values
+A list of message numbers may be specified. Values
of @samp{0} and @samp{$} in the list both mean the last
-message in the mailbox. For example:
address@hidden
+message in the mailbox. For example:
address@hidden
readmsg 1 3 0
address@hidden smallexample
address@hidden example
extracts three messages from the folder: the first, the third, and the last.
@item
-Finally, the selection may be some text to match. This will select a mail
-message which exactly matches the specified text. For example,
address@hidden
+Finally, the selection may be some text to match. This will select a mail
+message which exactly matches the specified text. For example,
address@hidden
readmsg staff meeting
address@hidden smallexample
address@hidden example
extracts the message which contains the words @samp{staff meeting}.
Note that it will not match a message containing @samp{Staff Meeting}
--- the matching is case sensitive. Normally only the first message
+-- the matching is case sensitive. Normally only the first message
which matches the pattern is printed.
@end enumerate
@@ -4665,9 +4894,9 @@ If @var{bool} is @samp{true}, display entire headers.
@end deffn
@deffn {Readmsg Conf} weedlist @var{str}
-Set the weedlist. The @var{str} argument is
+Set the weedlist. The @var{str} argument is
a string, containing a list of header names, separated by whitespace,
-commands or colons. This corresponds to the @option{--weedlist} command
+commands or colons. This corresponds to the @option{--weedlist} command
line option (@pxref{Opt-readmsg, --weedlist}).
@end deffn
@@ -4700,11 +4929,12 @@ only the first.
@node sieve
@section @command{sieve}
@pindex sieve
address@hidden
Sieve is a language for filtering e-mail messages at time of final
-delivery, described in RFC 3028. GNU Mailutils provides two
+delivery, described in RFC 3028. GNU Mailutils provides two
implementations of this language: a stand-alone @dfn{sieve interpreter}
-and a @dfn{sieve translator and filter}. The following sections describe these
+and a @dfn{sieve translator and filter}. The following sections describe these
utilities in detail.
@menu
@@ -4716,9 +4946,9 @@ utilities in detail.
@subsection A Sieve Interpreter
Sieve interpreter @command{sieve} allows to apply Sieve scripts to an
-arbitrary number of mailboxes. GNU @command{sieve} implements a superset
-of the Sieve language as described in RFC 3028. @xref{Sieve Language},
-for a description of the Sieve language. @xref{GNU Extensions}, for a
+arbitrary number of mailboxes. GNU @command{sieve} implements a superset
+of the Sieve language as described in RFC 3028. @xref{Sieve Language},
+for a description of the Sieve language. @xref{GNU Extensions}, for a
discussion of differences between the GNU implementation of Sieve and
its standard.
@@ -4734,9 +4964,9 @@ its standard.
The @command{sieve} invocation syntax is:
address@hidden
address@hidden
sieve address@hidden @var{script}
address@hidden smallexample
address@hidden example
@noindent
where @var{script} denotes the filename of the sieve program to parse,
@@ -4749,16 +4979,16 @@ Compile script and exit.
@item --clear-library-path
@itemx --clearpath
-Clear Sieve library path. See also @ref{Sieve Configuration,
+Clear Sieve library path. See also @ref{Sieve Configuration,
clear-library-path}.
@item --clear-include-path
-Clear Sieve include path. See also @ref{Sieve Configuration,
+Clear Sieve include path. See also @ref{Sieve Configuration,
clear-include-path}.
@item address@hidden
@itemx address@hidden
-Specify debug flags. The @var{flags} argument is a sequence of one or
+Specify debug flags. The @var{flags} argument is a sequence of one or
more of the following letters:
@multitable @columnfractions .40 .45
@@ -4775,31 +5005,31 @@ Compile the script, dump disassembled code on standard
output and exit.
@item -e @var{address}
@itemx --email @var{address}
-Override the user email address. This is useful for @code{reject} and
address@hidden actions. By default, the user email address is deduced
+Override the user email address. This is useful for @code{reject} and
address@hidden actions. By default, the user email address is deduced
from the user name and the full name of the machine where
address@hidden is executed. See also @ref{Sieve Configuration,
address@hidden is executed. See also @ref{Sieve Configuration,
email}.
@item -I @var{dir}
@itemx address@hidden
Append directory @var{dir} to the list of directories searched for
-include files. See also @ref{Sieve Configuration, include-path}.
+include files. See also @ref{Sieve Configuration, include-path}.
@item -f
@itemx address@hidden
-Mailbox to sieve (defaults to user's system mailbox). See also
+Mailbox to sieve (defaults to user's system mailbox). See also
@ref{Sieve Configuration, mbox-url}.
@item -k
@itemx --keep-going
-Keep on going if execution fails on a message. See also
+Keep on going if execution fails on a message. See also
@ref{Sieve Configuration, keep-going}.
@item -L @var{dir}
@item address@hidden
Append directory @var{dir} to the list of directories searched for
-library files. See also @ref{Sieve Configuration, library-path}.
+library files. See also @ref{Sieve Configuration, library-path}.
@item -n
@itemx --no-actions
@@ -4807,12 +5037,12 @@ Dry run: do not execute any actions, just print what
would be done.
@item -t @var{ticket}
@itemx address@hidden
-Ticket file for mailbox authentication. See also
+Ticket file for mailbox authentication. See also
@ref{Sieve Configuration, ticket}.
@item -v
@itemx --verbose
-Log all actions executed. See also @ref{Sieve Configuration, verbose}.
+Log all actions executed. See also @ref{Sieve Configuration, verbose}.
@end table
@node Sieve Configuration
@@ -4833,9 +5063,9 @@ configuration statements:
The following statements configure sieve-specific features:
address@hidden {Sieve Conf} sieve @{ ... @}
address@hidden {Sieve Conf} sieve @{ ... @}
This block statement configures search paths @command{sieve} uses to
-locate its loadable modules. @xref{Require Statement}, for a detailed
+locate its loadable modules. @xref{Require Statement}, for a detailed
information of this feature.
This statement may contain the following sub-statements:
@@ -4858,14 +5088,14 @@ If @var{bool} is @samp{true}, clear include search path.
@deffn {Sieve Conf} library-path @var{path}
Used within the @code{sieve} block statement.
-Add directories to @command{sieve} library search path. Argument is a
+Add directories to @command{sieve} library search path. Argument is a
string containing a colon-separated list of directories.
@end deffn
@deffn {Sieve Conf} include-path @var{path}
Used within the @code{sieve} block statement.
-Add directories to the include search path. Argument is a
+Add directories to the include search path. Argument is a
string containing a colon-separated list of directories.
@end deffn
@@ -4883,7 +5113,7 @@ Sets the name of the ticket file for user authentication.
@end deffn
@deffn {Sieve Conf} debug @var{flags}
-Sets Sieve debug flags. @xref{Logging and Debugging}, for a detailed
+Sets Sieve debug flags. @xref{Logging and Debugging}, for a detailed
description.
@end deffn
@@ -4893,13 +5123,13 @@ If @var{bool} is @samp{true}, log all executed actions.
@deffn {Sieve Conf} line-info @var{bool}
If @var{bool} is @samp{true}, print source locations along with action
-logs. This statement takes effect only if @code{verbose true} is also
+logs. This statement takes effect only if @code{verbose true} is also
set.
@end deffn
@deffn {Sieve Conf} email @var{addr}
-Set user e-mail address. This is useful for @code{reject} and
address@hidden actions. By default, the user email address is deduced
+Set user e-mail address. This is useful for @code{reject} and
address@hidden actions. By default, the user email address is deduced
from the user name and the full name of the machine where @command{sieve} is
executed.
@end deffn
@@ -4908,19 +5138,19 @@ executed.
@subsubsection Logging and debugging
The default behavior of @command{sieve} is to remain silent about
-anything except errors. However, it is sometimes necessary to see
-which actions are executed and on which messages. This is particularly
-useful when debugging the sieve scripts. The @option{--verbose}
+anything except errors. However, it is sometimes necessary to see
+which actions are executed and on which messages. This is particularly
+useful when debugging the sieve scripts. The @option{--verbose}
(@option{-v}) option outputs log of every action executed.
Option @option{--debug} allows to produce even more detailed debugging
-information. This option takes an argument specifying the
-debugging level to be enabled. The argument can consist of the
+information. This option takes an argument specifying the
+debugging level to be enabled. The argument can consist of the
following letters:
@table @samp
@item @samp{t}
-This flag enables sieve tracing. It means that every test will be logged
+This flag enables sieve tracing. It means that every test will be logged
when executed.
@item @samp{T}
@@ -4931,18 +5161,18 @@ Trace network protocols: produces log of network
transactions executed
while running the script.
@item @samp{g}
-Enable main parser traces. This is useful for debugging the sieve grammar.
+Enable main parser traces. This is useful for debugging the sieve grammar.
@item @samp{i}
-Trace the program instructions. It is the most extensive debugging
-level. It produces the full execution log of a sieve program, showing
-each instruction and states of the sieve machine. It is only useful
+Trace the program instructions. It is the most extensive debugging
+level. It produces the full execution log of a sieve program, showing
+each instruction and states of the sieve machine. It is only useful
for debugging the code generator.
@end table
@emph{Note}, that there should be no whitespace
between the short variant of the option (@option{-d}), and its
-argument. Similarly, when using long option (@option{--debug}),
+argument. Similarly, when using long option (@option{--debug}),
its argument must be preceded by equal sign.
If the argument to @option{--debug} is omitted, it defaults to
@@ -4952,7 +5182,7 @@ Option @option{--dump} produces the disassembled dump of
the compiled
sieve program.
By default @command{sieve} output all diagnostics on standard error and verbose
-logs on standard output. This behaviour is changed when
+logs on standard output. This behaviour is changed when
@option{--log-facility} is given in the command line (@FIXME-pxref{logging}).
This option causes @command{sieve} to output its diagnostics to
the given syslog facility.
@@ -4961,31 +5191,31 @@ the given syslog facility.
@subsubsection Extending @command{sieve}
The basic set of sieve actions, tests and comparators may be extended
-using loadable extensions. Usual @code{require} mechanism is used for
+using loadable extensions. Usual @code{require} mechanism is used for
that.
When processing arguments for @code{require} statement, @command{sieve}
uses the following algorithm:
@enumerate 1
address@hidden Look up the name in a symbol table. If the name begins with
address@hidden it is looked up in the comparator table. If it
-begins with @samp{test-}, the test table is used instead. Otherwise
address@hidden Look up the name in a symbol table. If the name begins with
address@hidden it is looked up in the comparator table. If it
+begins with @samp{test-}, the test table is used instead. Otherwise
the name is looked up in the action table.
@item If the name is found, the search is terminated.
address@hidden Otherwise, transform the name. First, any @samp{comparator-} or
address@hidden prefix is stripped. Then, any character other than
address@hidden Otherwise, transform the name. First, any @samp{comparator-} or
address@hidden prefix is stripped. Then, any character other than
alphanumeric characters, @samp{.} and @samp{,} is replaced with
-dash (@samp{-}). The name thus obtained is used as a file name
+dash (@samp{-}). The name thus obtained is used as a file name
of an external loadable module.
address@hidden Try to load the module. The module is searched in the
address@hidden Try to load the module. The module is searched in the
following search paths (in the order given):
@enumerate 1
address@hidden Mailutils module directory. By default it is
address@hidden Mailutils module directory. By default it is
@file{$prefix/lib/mailutils}.
@item The value of the environment variable @env{LTDL_LIBRARY_PATH}.
@@ -5011,7 +5241,7 @@ a colon-separated list of absolute directories, for
example,
@samp{"/usr/lib/mypkg:/lib/foo"}.
In any of these directories, @command{sieve} first attempts to find
-and load the given filename. If this fails, it tries to append the
+and load the given filename. If this fails, it tries to append the
following suffixes to the file name:
@enumerate 1
@@ -5023,16 +5253,16 @@ platform, e.g., @samp{.so}, @samp{.sl}, etc.
@item If the module is found, @command{sieve} executes its
initialization function (see below) and again looks up the name
-in the symbol table. If found, search terminates successfully.
+in the symbol table. If found, search terminates successfully.
@item If either the module is not found, or the symbol wasn't
found after execution of the module initialization function,
-search is terminated with an error status. @command{sieve} then displays
+search is terminated with an error status. @command{sieve} then displays
the following diagnostic message:
address@hidden
address@hidden
source for the required action NAME is not available
address@hidden smallexample
address@hidden example
@end enumerate
@c ***********************************************************************
@@ -5040,11 +5270,12 @@ source for the required action NAME is not available
@page
@node sieve.scm
@subsection A Sieve to Scheme Translator and Filter
address@hidden
A Sieve to Scheme Translator @command{sieve.scm} translates a given
Sieve script into an equivalent Scheme program and optionally executes
-it. The program itself is written in Scheme and requires presence of
-Guile version 1.8 or newer on the system. For more information on
+it. The program itself is written in Scheme and requires presence of
+Guile version 1.8 or newer on the system. For more information on
Guile refer to @ref{Top,,Overview,guile,The Guile Reference Manual}.
@table @option
@@ -5074,6 +5305,7 @@ The Scheme programs produced by @command{sieve.scm} can
be used with
@node guimb
@section @command{guimb} --- A Mailbox Scanning and Processing Language
@pindex guimb
address@hidden
@command{Guimb} is for mailboxes what @command{awk} is for text files.
It processes mailboxes, applying the user-supplied scheme procedures
@@ -5127,8 +5359,8 @@ Execute scheme expression.
Load Scheme source code from @var{file}.
@end table
-You can specify both of them. In this case, the @var{file} is read
-first, then @var{expr} is executed. You may still pass any additional
+You can specify both of them. In this case, the @var{file} is read
+first, then @var{expr} is executed. You may still pass any additional
arguments to the script using @option{--guile-arg} option.
@node Specifying Mailboxes to Operate Upon
@@ -5142,13 +5374,13 @@ The resulting mailbox is not saved, unless the
user-supplied
scheme program saves it.
@item guimb address@hidden --mailbox @var{defmbox}
The contents of @var{defmbox} is processed and is replaced with the resulting
-mailbox contents. Useful for applying filters to user's mailbox.
+mailbox contents. Useful for applying filters to user's mailbox.
@item guimb address@hidden --mailbox @var{defmbox} @var{mailbox} address@hidden
The contents of specified mailboxes is processed, and the resulting
mailbox contents is appended to @var{defmbox}.
@item guimb address@hidden --user @var{username} address@hidden
The contents of specified mailboxes is processed, and the resulting
-mailbox contents is appended to the user's system mailbox. This allows
+mailbox contents is appended to the user's system mailbox. This allows
to use @command{guimb} as a mail delivery agent.
@end table
@@ -5159,43 +5391,43 @@ and processes the system mailbox of the current user.
@subheading Passing Options to Scheme
Sometimes it is necessary to pass some command line options to the
-scheme procedure. There are three ways of doing so.
+scheme procedure. There are three ways of doing so.
When using @option{--source} (@option{-s}) or @option{--code}
(@option{-c}) options, all the rest of the command line following
-the option's argument is passed to Scheme program verbatim. This
-allows for making guimb scripts executable by the shell. If your system
+the option's argument is passed to Scheme program verbatim. This
+allows for making guimb scripts executable by the shell. If your system
supports @samp{#!} magic at the start of scripts, add the following two
lines to the beginning of your script to allow for its immediate execution:
address@hidden
address@hidden
#! /usr/local/bin/guimb -s
!#
address@hidden smallexample
address@hidden example
@noindent
(replace @samp{/usr/local/bin/} with the actual path to the @command{guimb}).
Otherwise, if you use @option{--file} or @option{--expression} options,
the additional arguments may be passed to the Scheme program @option{-g}
-(@option{--guile-arg}) command line option. For example:
+(@option{--guile-arg}) command line option. For example:
address@hidden
address@hidden
guimb --guile-arg -opt --guile-arg 24 --file @var{progfile}
address@hidden smallexample
address@hidden example
In this example, the scheme procedure will see the following command line:
address@hidden
address@hidden
@var{progfile} -opt 24
address@hidden smallexample
address@hidden example
Finally, if there are many arguments to be passed to Scheme, it is more
convenient to enclose them in @address@hidden and @address@hidden escapes:
address@hidden
address@hidden
guimb address@hidden -opt 24 address@hidden --file @var{progfile}
address@hidden smallexample
address@hidden example
@node Command Line Option Summary
@subheading Command Line Option Summary
@@ -5240,23 +5472,24 @@ Display program version.
@node maidag
@section maidag
@pindex maidag
address@hidden
-The name @samp{maidag} stands for @i{Mai}l @i{d}elivery @i{ag}ent. It
+The name @samp{maidag} stands for @i{Mai}l @i{d}elivery @i{ag}ent. It
is a general-purpose @acronym{MDA} offering a rich set of
-features. It can operate both in traditional mode, reading the message
-from its standard input, and in @acronym{LMTP} mode. @command{Maidag}
+features. It can operate both in traditional mode, reading the message
+from its standard input, and in @acronym{LMTP} mode. @command{Maidag}
is able to deliver mail to any mailbox format, supported by GNU
-Mailutils. These formats, among others, include @samp{remote+smtp},
+Mailutils. These formats, among others, include @samp{remote+smtp},
@samp{remote+prog} and @samp{remote+sendmail} which are
equivalent to forwarding a message over @acronym{SMTP} to a remote
-node. Thus, @command{maidag} supersedes both @command{mail.local} and
+node. Thus, @command{maidag} supersedes both @command{mail.local} and
@command{mail.remote} utilities from GNU Mailutils versions prior to
2.0.
@command{Maidag} is also able to process incoming messages using
Sieve, Scheme or Python scripts and, based on results of this
processing, to take a decision on whether to actually deliver and
-where to deliver them. Due to its extensive scripting facilities,
+where to deliver them. Due to its extensive scripting facilities,
@command{maidag} offers much more flexibility than other popular
@acronym{MDA}s, such as @command{procmail}.
@@ -5277,11 +5510,11 @@ where to deliver them. Due to its extensive scripting
facilities,
@cindex Sendmail
When used as a @acronym{MDA} with Sendmail, @command{maidag} must be
invoked from the local mailer definition in the @file{sendmail.cf}
-file. It must have the following flags set: @samp{lswS}. These mean:
+file. It must have the following flags set: @samp{lswS}. These mean:
the mailer is local, quote characters should be stripped off the
address before invoking the mailer, the user must have a valid account
on this machine and the userid should not be reset before calling the
-mailer. Additionally, the flags @samp{fn} may be specified to allow
+mailer. Additionally, the flags @samp{fn} may be specified to allow
@command{maidag} to generate the usual @samp{From } envelope instead
of the one supplied by @command{sendmail}.
@@ -5292,31 +5525,31 @@ valid account on the machine that runs
@command{sendmail}.
Here is an example of mailer definition in @file{sendmail.cf}
address@hidden
address@hidden
Mlocal, P=/usr/local/sbin/maidag,
F=lsDFMAw5:/|@@qSPfhn9,
S=EnvFromL/HdrFromL, R=EnvToL/HdrToL,
T=DNS/RFC822/X-Unix,
A=mail $u
address@hidden smallexample
address@hidden example
To define local mailer in @samp{mc} source file, it will suffice to
set:
address@hidden
address@hidden
define(`LOCAL_MAILER_PATH', `/usr/local/sbin/maidag')
define(`LOCAL_MAILER_ARGS', `mail $u')
address@hidden smallexample
address@hidden example
@node Exim-maidag
@subsection Using @command{maidag} with Exim.
@cindex Exim
-Using @command{maidag} with Exim is quite straightforward. The
+Using @command{maidag} with Exim is quite straightforward. The
following example illustrates the definition of the appropriate transport
and director in @file{exim.conf}:
address@hidden
address@hidden
# transport
maidag_pipe:
driver = pipe
@@ -5329,7 +5562,7 @@ maidag_pipe:
maidag:
driver = localuser
transport = maidag_pipe
address@hidden smallexample
address@hidden example
@node MeTA1-maidag
@subsection Using @command{maidag} with MeTA1.
@@ -5339,13 +5572,13 @@ MeTA1 (@uref{http://meta1.org}) communicates with the
delivery agent
using @acronym{LMTP}.
LMTP mode is enabled in @command{maidag} by the @samp{lmpt yes}
-statement. The socket to listen on must be specified using
address@hidden statement (@pxref{Server Settings}). For the purposes of
+statement. The socket to listen on must be specified using
address@hidden statement (@pxref{Server Settings}). For the purposes of
this section, let's suppose @command{maidag} will listen on a
address@hidden socket @file{/var/spool/meta1/lmtpsock}. Then, the
address@hidden socket @file{/var/spool/meta1/lmtpsock}. Then, the
following (minimal) @command{maidag} configuration will do the job:
address@hidden
address@hidden
# @r{Start in LMTP mode.}
lmtp yes;
# @r{Run as daemon.}
@@ -5356,43 +5589,43 @@ group meta1c;
server unix:///var/spool/meta1/lmtpsock @{
transcript no;
@};
address@hidden smallexample
address@hidden example
To configure MeTA1 to use this socket, add the following statement to
the @samp{smtpc} section in @file{/etc/meta1/meta1.conf}:
address@hidden
address@hidden
LMTP_socket="lmtpsock";
address@hidden smallexample
address@hidden example
@node Mailbox Quotas
@subsection Mailbox Quotas
address@hidden quota} is a limit on the size of the mailbox. When a
address@hidden quota} is a limit on the size of the mailbox. When a
mailbox size reaches this limit, @command{maidag} stops accepting
messages for this recipient and returns an error condition to the
-sender. The error code is accompanied by the following error message:
+sender. The error code is accompanied by the following error message:
address@hidden
address@hidden
@var{user}: mailbox quota exceeded for this recipient
address@hidden smallexample
address@hidden example
Furthermore, if accepting the incoming message would make the
mailbox size exceed the quota, such a message will be rejected as
-well. In this case, the error message is:
+well. In this case, the error message is:
address@hidden
address@hidden
@var{user}: message would exceed maximum mailbox size for this recipient
address@hidden smallexample
address@hidden example
In both cases, the default return code will be @samp{service
unavailable} (corresponding to the @acronym{SMTP} return code
@samp{550}), unless the following statement is present in the
@command{maidag} configuration file:
address@hidden
address@hidden
exit-quota-tempfail yes;
address@hidden smallexample
address@hidden example
@noindent
in which case a temporary error will be returned.
@@ -5416,20 +5649,20 @@ The mailbox quota can be retrieved from the following
sources:
To use @acronym{DBM} quota database, GNU Mailutils must
be compiled with one of the following command line options:
@option{--with-gdbm}, @option{--with-berkeley-db}, or
address@hidden Examine the output of @command{maidag
address@hidden Examine the output of @command{maidag
--show-config-options}, if not sure.
The quota database should have the following structure:
@table @asis
@item Key
-Key represents the user name. Special key @samp{DEFAULT} means default
+Key represents the user name. Special key @samp{DEFAULT} means default
quota value, i.e. the one to be used if the user is not explicitly
listed in the database.
@item Value
-Mailbox quota for this user. If it is a number, it represents the
-maximum mailbox size in bytes. A number may optionally be followed by
+Mailbox quota for this user. If it is a number, it represents the
+maximum mailbox size in bytes. A number may optionally be followed by
@samp{kb} or @samp{mb}, meaning kilobytes and megabytes, respectively.
A special value @samp{NONE} means no mailbox size limit for this user.
@@ -5437,7 +5670,7 @@ A special value @samp{NONE} means no mailbox size limit
for this user.
Here is an example of a valid quota database
address@hidden
address@hidden
# Default quota value:
DEFAULT 5mb
@@ -5448,81 +5681,81 @@ smith NONE
# Rest of users
plog 26214400
karin 10mB
address@hidden smallexample
address@hidden example
To use the @acronym{DBM} quota database, specify its absolute name using
@code{quota-db} configuration statement, e.g.:
address@hidden
address@hidden
quota-db /etc/mail/quota.db;
address@hidden smallexample
address@hidden example
@node SQL Quotas
@subsubsection Keeping Quotas in SQL Database
Configuration statement @code{quota-query} allows to specify a special
-query to retrieve the quota from the database. Currently (as of mailutils
+query to retrieve the quota from the database. Currently (as of mailutils
version @value{VERSION}) it is assumed that this table can be accessed
using the credentials set in @samp{sql} configuration statement
(@pxref{SQL Statement}).
For example, suppose you have the following quota table:
address@hidden
address@hidden
create table mailbox_quota (
user_name varchar(32) binary not null,
quota int,
unique (user_name)
);
address@hidden smallexample
address@hidden example
@noindent
To retrieve user quota the following query can be used:
address@hidden
address@hidden
SELECT quota FROM mailbox_quota WHERE user_name='address@hidden@}'
address@hidden smallexample
address@hidden example
There are no special provisions for specifying group quotas, similar to
address@hidden in @acronym{DBM} databases. This is because group quotas can
-easily be implemented using @acronym{SQL} language. @command{Maidag}
address@hidden in @acronym{DBM} databases. This is because group quotas can
+easily be implemented using @acronym{SQL} language. @command{Maidag}
always uses the first tuple from the set returned by mailbox quota
-query. So, you may add a special entry to the @code{mailbox_quota}
-table that would keep the group quota. In the discussion below we assume
+query. So, you may add a special entry to the @code{mailbox_quota}
+table that would keep the group quota. In the discussion below we assume
that the @code{user_name} column for this entry is lexicographically
-less than any other user name in the table. Let's suppose the group
-quota name is @samp{00DEFAULT}. Then the following query:
+less than any other user name in the table. Let's suppose the group
+quota name is @samp{00DEFAULT}. Then the following query:
address@hidden
address@hidden
SELECT quota
FROM mailbox_quota
WHERE user_name IN ('address@hidden@}','00DEFAULT')
ORDER BY user_name DESC
address@hidden smallexample
address@hidden example
@noindent
will return two tuples if the user is found in
address@hidden Due to @code{ORDER} statement, the first tuple
address@hidden Due to @code{ORDER} statement, the first tuple
will contain the quota for the user, which will be used by
address@hidden On the other hand, if the requested user name is not
address@hidden On the other hand, if the requested user name is not
present in the table, the above query will return a single tuple
containing the group quota.
The following configuration statement instructs @command{maidag} to
use this query for retrieving the user quota:
address@hidden
address@hidden
quota-query "SELECT quota "
"FROM mailbox_quota "
"WHERE user_name IN ('address@hidden@}','00DEFAULT') "
"ORDER BY user_name DESC";
address@hidden smallexample
address@hidden example
@node Maidag Scripting
@subsection Maidag Scripting
@command{Maidag} can use global or per-user @dfn{mail filters} to
-decide whether to deliver the message, and where to deliver it. As of
+decide whether to deliver the message, and where to deliver it. As of
Mailutils version @value{VERSION}, such mail filters may be written in
the following languages:
@@ -5535,7 +5768,7 @@ the following languages:
@end itemize
Mail filters to use are specified using @samp{script} configuration
-statement. The following meta-symbols can be used in its argument:
+statement. The following meta-symbols can be used in its argument:
@table @asis
@item ~
@@ -5547,13 +5780,13 @@ Expands to the recipient user name.
@end table
By default, a filename extension decide which scripting language will
-be used. User can alter the choice using @samp{language} configuration
+be used. User can alter the choice using @samp{language} configuration
statement. For example:
address@hidden
address@hidden
language "python"
script "~/.maidag-py-filter"
address@hidden smallexample
address@hidden example
@menu
* Sieve Maidag Filters::
@@ -5568,9 +5801,9 @@ The file name of the Sieve filter to use is specified
using
@samp{script} configuration statement. For example, the following
configuration statement:
address@hidden
address@hidden
script "~/.maidag.sv"
address@hidden smallexample
address@hidden example
@noindent
instructs @command{maidag} to use file @file{.maidag.sv} in the
@@ -5579,7 +5812,7 @@ recipient home directory as a Sieve filter.
Normal message delivery is attempted if execution of the Sieve code
ended with @code{keep} action (either implicit or explicit).
-Other Sieve actions are executed as described in @ref{Actions}. For
+Other Sieve actions are executed as described in @ref{Actions}. For
example, to deliver message to another mailbox, use the
@code{fileinto} action.
@@ -5593,9 +5826,9 @@ The file name of the Scheme mail filter is specified using
@samp{script} configuration statement. For example, the following
configuration statement:
address@hidden
address@hidden
script "~/.maidag.scm"
address@hidden smallexample
address@hidden example
@noindent
instructs `maidag' to use file `.maidag.scm' in the recipient home
@@ -5609,9 +5842,9 @@ The file name of the Python mail filter is specified using
@samp{script} configuration statement. For example, the following
configuration statement:
address@hidden
address@hidden
script "~/.maidag.py"
address@hidden smallexample
address@hidden example
@noindent
instructs `maidag' to use file `.maidag.py' in the recipient home
@@ -5620,7 +5853,7 @@ directory as a Python filter.
@noindent
A simple example of a mail filter written in Python:
address@hidden
address@hidden
from mailutils import *
import maidag
import re
@@ -5647,34 +5880,34 @@ try:
msg.attribute.set_deleted ()
except Exception:
pass
address@hidden smallexample
address@hidden example
@node Forwarding
@subsection Forwarding
@cindex forward
@dfn{Forward file} is a special file in the user's home directory that
contains the email address of the mailbox where the user wants to
-forward his mail. Normally, forward files are processed by
address@hidden However, there are some @acronym{MTA} that lack this
-feature. One of them is MeTA1.
+forward his mail. Normally, forward files are processed by
address@hidden However, there are some @acronym{MTA} that lack this
+feature. One of them is MeTA1.
@command{Maidag} provides a forwarding feature that is useful to
compensate the lack of it.
@kwindex forward-file
Name of the forward file is given using @code{forward-file}
-configuration statement. A common usage is:
+configuration statement. A common usage is:
address@hidden
address@hidden
forward-file .forward;
address@hidden smallexample
address@hidden example
The forward file is always searched in the recipient home directory.
@kwindex forward-file-checks
Before actually using the file, a number of safety checks are
-performed on it. If the file fails to pass one of these checks, no
-forwarding is performed and the message is delivered as usual. These
+performed on it. If the file fails to pass one of these checks, no
+forwarding is performed and the message is delivered as usual. These
checks can be configured using @code{forward-file-checks} statement.
Its argument is a list of the following keywords:
@@ -5706,11 +5939,11 @@ All of the above checks.
The default is @samp{forward-file-checks all}.
Each of these keywords may be prefixed by @samp{no} to disable this
-particular check. For example:
+particular check. For example:
address@hidden
address@hidden
forward-file-checks (nodir_iwoth, nodir_iwgrp);
address@hidden smallexample
address@hidden example
@node Url-mode
@subsection Delivering Messages to a URL.
@@ -5720,28 +5953,28 @@ When invoked with the @option{--url} command line
option,
For example:
address@hidden
address@hidden
$ maidag --url maildir:///home/smith/Mail
address@hidden smallexample
address@hidden example
@node Remote Mailbox Delivery
@subsection Remote Mailbox Delivery
@command{Maidag} can be used to deliver mail to remote mailboxes, such
-as @samp{imap} or @samp{remote+smtp}. If the mailbox @acronym{URL}
+as @samp{imap} or @samp{remote+smtp}. If the mailbox @acronym{URL}
is @samp{remote+smtp} or @samp{remote+sendmail}, the message is
actually forwarded over @acronym{SMTP} to the remote node, so
address@hidden acts as a message transfer agent. For example:
address@hidden acts as a message transfer agent. For example:
address@hidden
address@hidden
$ maidag --url remote+smtp://10.10.1.100:24
address@hidden smallexample
address@hidden example
This command line will send the message to the machine
@samp{10.10.1.100} using port @samp{24} (private mail system).
-The @samp{remote+prog} mailbox may be of special use. Delivering to
+The @samp{remote+prog} mailbox may be of special use. Delivering to
this mailbox results in invoking the specified command with the given
-arguments and passing the message to its standard input. There are two
+arguments and passing the message to its standard input. There are two
ways to specify a @samp{remote+prog} mailbox:
@table @asis
@@ -5761,7 +5994,7 @@ mailing lists with MeTA1.
For example, suppose that the @command{maidag} configuration contains:
address@hidden
address@hidden
auth @{
authorization sql:system;
authentication generic:system;
@@ -5776,12 +6009,12 @@ sql @{
"FROM userdb "
"WHERE user='address@hidden@}'";
@}
address@hidden smallexample
address@hidden example
Then, the following entries in the @samp{userdb} table implement
@email{mailman@@yourdomain} mailing list:
address@hidden
address@hidden
mysql> select * from userdb;
+---------------------+---------------------------------------+
| user | mailbox |
@@ -5797,7 +6030,7 @@ mysql> select * from userdb;
| mailman-subscribe | |/usr/bin/mailman subscribe mailman |
| mailman-unsubscribe | |/usr/bin/mailman unsubscribe mailman |
+---------------------+---------------------------------------+
address@hidden smallexample
address@hidden example
@node Conf-maidag
@subsection Maidag Configuration File Summary
@@ -5817,7 +6050,7 @@ statements:
@item ldap @tab @xref{LDAP Statement}.
@item auth @tab @xref{Auth Statement}.
@item mailer @tab @xref{Mailer Statement}.
address@hidden server @tab @xref{Server Settings}. Used only in
address@hidden server @tab @xref{Server Settings}. Used only in
@acronym{LMTP} mode.
@item acl @tab @xref{ACL Statement}.
@item tcp-wrappers @tab @xref{Tcp-wrappers Statement}.
@@ -5830,11 +6063,11 @@ delivery has succeeded.
@deffn {Maidag Config} ex-quota-tempfail @var{bool}
Indicate temporary failure if the recipient is over his mail quota.
-By default, permanent failure is returned. @xref{Mailbox Quotas}.
+By default, permanent failure is returned. @xref{Mailbox Quotas}.
@end deffn
@deffn {Maidag Config} quota-db @var{file}
-Set the name of DBM quota database file. @xref{DBM Quotas}.
+Set the name of DBM quota database file. @xref{DBM Quotas}.
@end deffn
@deffn {Maidag Config} sieve-filter @var{pattern}
@@ -5853,7 +6086,7 @@ File name or name pattern for Guile filter file.
@end deffn
@deffn {Maidag Config} debug @var{flags}
-Set additional debugging flags. Valid flags are:
+Set additional debugging flags. Valid flags are:
@table @asis
@item g
@@ -5876,7 +6109,7 @@ Log to stderr instead of syslog.
@end deffn
@deffn {Maidag Config} forward-file @var{file}
-Process forward file @var{file}. @xref{Forwarding}.
+Process forward file @var{file}. @xref{Forwarding}.
@end deffn
@deffn {Maidag Config} forward-file-checks @var{list}
@@ -5893,14 +6126,14 @@ In @acronym{LMTP} mode, retain supplementary groups
from @var{list}.
@end deffn
@deffn {Maidag Config} listen @var{url}
-In @acronym{LMTP} mode, listen on @var{url}. Valid @acronym{URL}s are:
+In @acronym{LMTP} mode, listen on @var{url}. Valid @acronym{URL}s are:
@samp{tcp://@var{host}:@var{port}} (note that port is mandatory),
@samp{file://@var{socket-file-name}} or
@samp{socket://@var{socket-file-name}}.
@end deffn
@deffn {Maidag Config} reuse-address @var{bool}
-Reuse existing address (@acronym{LMTP} mode). Default is @samp{yes}.
+Reuse existing address (@acronym{LMTP} mode). Default is @samp{yes}.
@end deffn
@page
@@ -5912,16 +6145,16 @@ Reuse existing address (@acronym{LMTP} mode). Default
is @samp{yes}.
to autodetect its type and invoke an appropriate file viewer.
To detect the file type, @command{mimeview} uses @file{mime.types}
-file. This file is a part of Common UNIX Printing System,
address@hidden,,,mime.types(5), mime.types man page}. By default
+file. This file is a part of Common UNIX Printing System,
address@hidden,,,mime.types(5), mime.types man page}. By default
@command{mimeview} searches for @file{mime.types} in
@file{$prefix/etc/cups/address@hidden exact location is determined at
configuration time by setting environment variable
address@hidden On most sites running
address@hidden On most sites running
address@hidden
address@hidden
./configure DEFAULT_CUPS_CONFDIR=/etc/cups
address@hidden smallexample
address@hidden example
@noindent
should be recommended.}, however its exact location can be specified
@@ -5929,18 +6162,18 @@ at runtime as well (see @option{--mimetypes} below).
Once file MIME type is successfully determined, @command{mimeview}
consults @file{mailcap} files in order to determine how to display
-the file. It does so essentially in the same manner as
+the file. It does so essentially in the same manner as
@command{metamail} utility, i.e., it scans all files specified
in @code{METAMAIL} environment variable until it finds an entry
describing the desired file format or until the list of files is
-exhausted. If @code{METAMAIL} variable is not set, @command{mimeview}
+exhausted. If @code{METAMAIL} variable is not set, @command{mimeview}
uses the following default path instead:
address@hidden
address@hidden
$HOME/.mailcap:/usr/local/etc/mailcap:\
/usr/etc/mailcap:/etc/mailcap:\
/etc/mail/mailcap:/usr/public/lib/mailcap
address@hidden smallexample
address@hidden example
@menu
* Mimeview Invocation::
@@ -5956,16 +6189,16 @@ $HOME/.mailcap:/usr/local/etc/mailcap:\
@item address@hidden
@itemx address@hidden
By default @command{mimeview} asks for confirmation before running
-interpreter to view a message. If this option is used without
+interpreter to view a message. If this option is used without
argument, it disables the default behavior for all message
-types. Otherwise, if argument @var{type-list} is given, it specifies
+types. Otherwise, if argument @var{type-list} is given, it specifies
a comma-separated list of MIME types for which no questions should be
-asked. Elements of this list may include shell-style globbing
+asked. Elements of this list may include shell-style globbing
patterns, e.g. setting
address@hidden
address@hidden
--no-ask='text/*,image/jpeg'
address@hidden smallexample
address@hidden example
@noindent
will disable prompting before displaying any textual files, no
@@ -5974,14 +6207,14 @@ type @samp{image/jpeg}.
Notice, that when the long form is used, its argument
must be separated from the option by a single equal sign, as shown
-in the example above. When the short form (@option{-a}) is used, its argument
+in the example above. When the short form (@option{-a}) is used, its argument
must follow the option immediately, without any intervening whitespace,
-e.g. @option{-a'text/*'}).
+e.g. @option{-a'text/*'}).
@item address@hidden
@itemx address@hidden
-Enables debugging output. @var{Flags} is a sequence of characters
-specifying the desired debugging level. Following characters are
+Enables debugging output. @var{Flags} is a sequence of characters
+specifying the desired debugging level. Following characters are
meaningful in @var{flags}:
@table @asis
@@ -6011,17 +6244,17 @@ If @var{flags} are not given, the default @samp{9} is
assumed.
@item address@hidden
Run @command{metamail} to display files, instead of using the internal
-mechanisms. If @var{file} is specified, it is taken as
+mechanisms. If @var{file} is specified, it is taken as
@command{metamail} command line.
@item -h
@itemx --no-interactive
@itemx --print
This options tells @command{mimeview} that it should run in
-non-interactive mode. In this mode prompting is disabled, and
-the normal mailcap @code{command} field is not executed. Instead
+non-interactive mode. In this mode prompting is disabled, and
+the normal mailcap @code{command} field is not executed. Instead
@command{mimeview} will execute the command specified in
-the @code{print} field. If there is nothing in the print field,
+the @code{print} field. If there is nothing in the print field,
the mailcap entry is ignored and the search continues for a matching
mailcap entry that does have a @code{print} field.
@@ -6038,12 +6271,12 @@ a @asis{tty} device.
@item -n
@itemx --dry-run
-Do not do anything, just print what would be done. Implies
+Do not do anything, just print what would be done. Implies
@option{--debug=1}, unless the debugging level is set up explicitly.
@item -t @var{file}
@itemx --mimetypes @var{file}
-Use @var{file} as @file{mime.types} file. If @var{file} is a
+Use @var{file} as @file{mime.types} file. If @var{file} is a
directory, use @address@hidden/mime.types}
@end table
@@ -6059,7 +6292,7 @@ The following configuration statements affect the
behavior of
@end multitable
@deffn {Mimeview Config} debug @var{number}
-Set @command{mimeview} debug level. @xref{Mimeview Invocation,
+Set @command{mimeview} debug level. @xref{Mimeview Invocation,
--debug}, for a description of debug levels.
@end deffn
@@ -6075,6 +6308,7 @@ Use @var{program} to display files.
@node pop3d
@section POP3 Daemon
@pindex pop3d
address@hidden
The @command{pop3d} daemon implements the Post Office Protocol
Version 3 server.
@@ -6085,9 +6319,9 @@ Version 3 server.
@item Inetd
The server is started from @file{/etc/inetd.conf} file:
address@hidden
address@hidden
pop3 stream tcp nowait root /usr/local/sbin/pop3d pop3d
address@hidden smallexample
address@hidden example
This is the default operation mode.
@@ -6109,60 +6343,57 @@ The server operation mode is configured using
@code{mode} statement
@node Login delay
@subsection Login delay
- POP3 clients often login frequently to check for new mail. Each new
+ POP3 clients often login frequently to check for new mail. Each new
connection implies authenticating the user and opening his maildrop
-and can be very resource consuming. To reduce server load, it is
+and can be very resource consuming. To reduce server load, it is
possible to impose a minimum delay between any two consecutive logins.
This is called @samp{LOGIN-DELAY} capability and is described in RFC
2449.
As of version @value{VERSION}, GNU Mailutils @command{pop3d} allows
to set global login delay, i.e. such enforcement will affect all POP3
-users. If a user attempts to log in before the specified login delay
+users. If a user attempts to log in before the specified login delay
expires, he will get the following error message:
address@hidden
address@hidden
-ERR [LOGIN-DELAY] Attempt to log in within the minimum login delay interval
address@hidden smallexample
address@hidden example
-The message will be issued after a valid password is entered. This prevents
+The message will be issued after a valid password is entered. This prevents
this feature from being used by malicious clients for account
harvesting.
To enable the login delay capability, specify the minimum delay
using @code{login-delay} configuration statement, e.g.:
address@hidden
address@hidden
login-delay 60;
address@hidden smallexample
address@hidden example
The @command{pop3d} utility keeps each user's last login time in a
special DBM file, called @dfn{login statistics database}, so to be
able to use this feature, Mailutils must be compiled with DBM support.
By default, the login statistics database is called
address@hidden/var/run/pop3-login.db}. You can change its name using
address@hidden/var/run/pop3-login.db}. You can change its name using
@code{stat-file} configuration statement:
address@hidden
address@hidden
login-delay 60;
-stat-file /tmp/pop.login;
address@hidden smallexample
-
- Notice, that there is no need to include the @samp{.db} suffix in the
-file name.
+stat-file /tmp/pop.login.db;
address@hidden example
The login delay facility will be enabled only if @command{pop3d} is
able to access the statistics database for both reading and
-writing. If it is not, it will report this using @command{syslog} and
-start up without login delay restrictions. A common error message
+writing. If it is not, it will report this using @command{syslog} and
+start up without login delay restrictions. A common error message
looks like:
address@hidden
address@hidden
Unable to open statistics db: Operation not permitted
address@hidden smallexample
address@hidden example
You can check whether your @command{pop3d} uses login delays by
-connecting to it and issuing the @samp{CAPA} command. If login delays
+connecting to it and issuing the @samp{CAPA} command. If login delays
are in use, there response will contain the string @samp{LOGIN-DELAY
@var{n}}, where @var{n} is the actual login delay value.
@@ -6170,7 +6401,7 @@ are in use, there response will contain the string
@samp{LOGIN-DELAY
@subsection Auto-expire
Automatic expiration of messages allows you to limit the period of
-time users are permitted to keep their messages on the server. It is
+time users are permitted to keep their messages on the server. It is
enabled by @code{expire} configuration statement:
@table @code
@@ -6178,16 +6409,16 @@ enabled by @code{expire} configuration statement:
Enable automatic expiration of messages after @var{n} days.
@end table
- The current implementation works as follows. When a message is
+ The current implementation works as follows. When a message is
downloaded by @code{RETR} or @code{TOP} command, it is marked with
@samp{X-Expire-Timestamp: @var{n}} header, where @var{n} is current
-value of UNIX timestamp. The exact expiration mechanism
-depends on you. Mailutils allows you two options:
+value of UNIX timestamp. The exact expiration mechanism
+depends on you. Mailutils allows you two options:
@enumerate
@item
Expired messages are deleted by @command{pop3d} upon closing the
-mailbox. You specify this mechanism using @code{delete-expired}
+mailbox. You specify this mechanism using @code{delete-expired}
configuration statement:
@table @command
@@ -6197,12 +6428,12 @@ the @code{QUIT} command.
@end table
@item
-Expired messages remain in the mailbox after closing it. The system
+Expired messages remain in the mailbox after closing it. The system
administrator is supposed to run a cron job that purges the mailboxes.
Such a cron job can be easily implemented using @command{sieve} from
GNU Mailutils and the following script:
address@hidden
address@hidden
@group
require "timestamp";
# @r{Replace "5" with the desired expiration period}
@@ -6211,33 +6442,33 @@ if timestamp :before "X-Expire-Timestamp" "now - 5 days"
discard;
@}
@end group
address@hidden smallexample
address@hidden example
This script will remove expired messages 5 days after the
-retrieval. Replace @samp{5} with the desired expiration period and
+retrieval. Replace @samp{5} with the desired expiration period and
make sure it equals the argument to @command{expire} configuration keyword.
@end enumerate
The statement @code{expire 0} means the client is not permitted to
-leave mail on the server. It always implies @code{delete-expired true}.
+leave mail on the server. It always implies @code{delete-expired true}.
@node Bulletins
@subsection Bulletins
The bulletin feature allows you to send important announcements to
-all POP3 users without mailing them. It works by creating a
+all POP3 users without mailing them. It works by creating a
@dfn{bulletin source mailbox} and sending the announcements to it.
After a user successfully authenticates, @command{pop3d} checks the
-last @dfn{bulletin number} the user receives. The bulletin number
+last @dfn{bulletin number} the user receives. The bulletin number
refers to the number of the bulletin message in the bulletin source
-mailbox. If the latter contains more messages, these are appended to
+mailbox. If the latter contains more messages, these are appended to
the user mailbox.
- The user last bulletin number can be kept in two places. First, it
-can be stored in file @file{.popbull} in his home directory. Secondly,
+ The user last bulletin number can be kept in two places. First, it
+can be stored in file @file{.popbull} in his home directory. Secondly,
if Mailutils is compiled with DBM support, the numbers can be kept in
-a DBM file, supplied via @code{bulletin-db} configuration statement. If
+a DBM file, supplied via @code{bulletin-db} configuration statement. If
both the database and the @file{.popbull} file are present, the data
from the database take precedence.
@@ -6249,7 +6480,6 @@ Set the @acronym{URL} of the bulletin source mailbox.
@item bulletin-db @var{file}
Set the name of the database file to keep last bulletin numbers in.
-Be sure not to specify @samp{.db} extension.
@end table
The following example instructs @command{pop3d} to look for the
@@ -6257,12 +6487,12 @@ bulletin messages in @acronym{MH} folder
@file{/var/spool/bull/mbox}
and to keep the database of last delivered bulletin numbers in
@file{/var/spool/bull/numbers.db}:
address@hidden
address@hidden
@group
bulletin-source mh:/var/spool/bull/mbox;
-bulletin-db /var/spool/bull/numbers;
+bulletin-db /var/spool/bull/numbers.db;
@end group
address@hidden smallexample
address@hidden example
@node Conf-pop3d
@subsection Pop3d Configuration
@@ -6294,11 +6524,11 @@ On startup, clear deletion marks from all the messages.
@deffn {Pop3d Conf} expire @var{n}
Automatically expire read messages after @var{n}
-days. @xref{Auto-expire}, for a detailed description.
+days. @xref{Auto-expire}, for a detailed description.
@end deffn
@deffn {Pop3d Conf} delete-expired @var{bool}
-Delete expired messages upon closing the mailbox. @xref{Auto-expire},
+Delete expired messages upon closing the mailbox. @xref{Auto-expire},
for a detailed description.
@end deffn
@@ -6314,16 +6544,16 @@ Set the minimal allowed delay between two successive
logins.
@deffn {Pop3d Conf} stat-file @var{file}
Set the name of login statistics file for the @code{login-delay}
-facility. @xref{Login delay}, for more information.
+facility. @xref{Login delay}, for more information.
@end deffn
@deffn {Pop3d Conf} bulletin-source @var{file}
-Get bulletins from the specified mailbox. @xref{Bulletins}, for a
+Get bulletins from the specified mailbox. @xref{Bulletins}, for a
detailed description.
@end deffn
@deffn {Pop3d Conf} bulletin-db @var{file}
-Set bulletin database file name. @xref{Bulletins}, for a
+Set bulletin database file name. @xref{Bulletins}, for a
detailed description.
@end deffn
@@ -6335,8 +6565,8 @@ The following table summarizes all @command{pop3d}
command line options.
@table @option
@item address@hidden
@itemx address@hidden
-Run in standalone mode. An optional @var{number} specifies the maximum number
-of child processes allowed to run simultaneously. When it is omitted,
+Run in standalone mode. An optional @var{number} specifies the maximum number
+of child processes allowed to run simultaneously. When it is omitted,
it defaults to 10 processes.
@emph{Please note}, that there should be no whitespace between the
@option{-d} and its parameter.
@@ -6353,7 +6583,7 @@ Display short help message and exit.
Remain in foreground.
@item address@hidden
-Enable TLS. If optional argument is supplied and is @samp{false}, then
+Enable TLS. If optional argument is supplied and is @samp{false}, then
disable it.
@item --debug-auth
@@ -6364,9 +6594,10 @@ Enable debugging of authentication functions.
@node imap4d
@section IMAP4 Daemon
@pindex imap4d
address@hidden
GNU @command{imap4d} is a daemon implementing @sc{imap4} rev1 protocol
-for accessing and handling electronic mail messages on a server. It can
+for accessing and handling electronic mail messages on a server. It can
be run either as a standalone program or from @file{inetd.conf} file.
@menu
@@ -6381,8 +6612,8 @@ be run either as a standalone program or from
@file{inetd.conf} file.
@cindex IMAP4 namespace
GNU @command{imap4d} supports a notion of @dfn{namespaces} defined
-in RFC 2342. A namespace is a set of directories upon which the user
-has certain permissions. It should be understood that these permissions
+in RFC 2342. A namespace is a set of directories upon which the user
+has certain permissions. It should be understood that these permissions
apply only if the underlying filesystem allows them.
The three namespaces supported by @command{imap4d} are:
@@ -6390,12 +6621,12 @@ The three namespaces supported by @command{imap4d} are:
@table @asis
@item Personal Namespace
A namespace that is within the personal scope of the authenticated user
-on a particular connection. The user has all permissions on this namespace.
+on a particular connection. The user has all permissions on this namespace.
@item Other Users' Namespace
A namespace that consists of mailboxes from the ``Personal Namespaces''
-of other users. The user can read and list mailboxes from this
-namespace. However, he is not allowed to use @samp{%} and @samp{*}
+of other users. The user can read and list mailboxes from this
+namespace. However, he is not allowed to use @samp{%} and @samp{*}
wildcards with @command{LIST} command, that is he can access a
mailbox only if he knows exactly its location.
@@ -6437,9 +6668,9 @@ Set other users' namespace.
For both statements, the argument is a list of directories that belong
to this namespace, e.g.:
address@hidden
address@hidden
shared-namespace (/var/spool/mail,/var/mail);
address@hidden smallexample
address@hidden example
If during the session the user creates a mailbox within either of
these namespaces, the mode of the mailbox is determined by the
@@ -6454,21 +6685,21 @@ Set file mode for mailboxes created in other users'
namespace.
@end table
In both cases, the argument, @var{mode} is a list of symbolic mode
-settings, similar to that used by @command{chmod}. It is a list of
-comma-separated mode change commands. Each command begins with a
+settings, similar to that used by @command{chmod}. It is a list of
+comma-separated mode change commands. Each command begins with a
letter @samp{g}, which means set mode bits for file group, or
@samp{o}, which means set mode bits for other users (note, that there
is no @samp{u} specifier, since user ownership of his mailbox cannot
-be changed). This letter is followed by an @samp{=} (or @samp{+}), and
-a list of modes to be set. This list can contain only two letters:
+be changed). This letter is followed by an @samp{=} (or @samp{+}), and
+a list of modes to be set. This list can contain only two letters:
@samp{r} to set read permission, and @samp{w} to set write permission.
For example, the following statement sets read and write permissions
for the group:
address@hidden
address@hidden
shared-namespace-mode g=rw;
address@hidden smallexample
address@hidden example
@node Conf-imap4d
@subsection Configuration of @command{imap4d}.
@@ -6495,13 +6726,13 @@ configuration statements:
@end multitable
@deffn {Imap4d Conf} shared-namespace @var{list}
-Set shared namespace. @var{List} is a list of
-strings. @xref{Namespace}, for a detailed description.
+Set shared namespace. @var{List} is a list of
+strings. @xref{Namespace}, for a detailed description.
@end deffn
@deffn {Imap4d Conf} other-namespace @var{list}
-Set other users' namespace. @var{List} is a list of
-strings. @xref{Namespace}, for a detailed description.
+Set other users' namespace. @var{List} is a list of
+strings. @xref{Namespace}, for a detailed description.
@end deffn
@deffn {Imap4d Conf} shared-mailbox-mode @var{str}
@@ -6519,11 +6750,11 @@ Disable @code{LOGIN} command, if @var{bool} is
@samp{true}.
@end deffn
@deffn {Imap4d Conf} create-home-dir @var{bool}
-Create nonexistent user home directories. See also home-dir-mode, below.
+Create nonexistent user home directories. See also home-dir-mode, below.
@end deffn
@deffn {Imap4d Conf} home-dir-mode @var{mode}
-Set file mode for created user home directories. Mode is specified in
+Set file mode for created user home directories. Mode is specified in
octal.
The default value for @var{mode} is @samp{700} (@samp{drwx------} in
@@ -6536,12 +6767,12 @@ authentication phase.
@end deffn
@deffn {Imap4d Conf} preauth @var{mode}
-Configure PREAUTH mode. Valid arguments are:
+Configure PREAUTH mode. Valid arguments are:
@table @asis
@item prog:///@var{program-name}
@command{Imap4d} invokes an external program to authenticate the
-connection. The command line is obtained from the supplied string,
+connection. The command line is obtained from the supplied string,
by expanding the following meta-variables:
@table @code
@@ -6566,26 +6797,26 @@ Otherwise, it should exit with a non-zero exit code.
@item ident[://:@var{port}]
The remote machine is asked about the requester identity
-using the identification protocol (RFC 1413). Both plaintext and
-DES encrypted replies are understood. Optional @var{port} specifies
-the port to use, if it differs from the default @samp{113}. It can be
+using the identification protocol (RFC 1413). Both plaintext and
+DES encrypted replies are understood. Optional @var{port} specifies
+the port to use, if it differs from the default @samp{113}. It can be
either a decimal port number or a symbolic name of a service, listed
in @file{/etc/services}.
@item stdio
PREAUTH mode is enabled automatically if imap4d is started
from command line in interactive mode (@option{-i} command line
-option). The current login name is used as the user name.
+option). The current login name is used as the user name.
@end table
@end deffn
@deffn {Imap4d Conf} preauth-only @var{bool}
-If @var{bool} is @samp{true}, use only preauth mode. If unable to
+If @var{bool} is @samp{true}, use only preauth mode. If unable to
setup it, disconnect immediately.
@end deffn
@deffn {Imap4d Conf} ident-keyfile @var{file}
-Set DES keyfile for decoding encrypted ident responses. Used with
+Set DES keyfile for decoding encrypted ident responses. Used with
@samp{ident://} preauth mode.
@end deffn
@@ -6636,24 +6867,24 @@ List of environment variables with their values.
@subsection Starting @command{imap4d}
@command{imap4d} may run either in @dfn{standalone} or in @dfn{inetd}
-operation modes. When run in ``standalone'' mode, the server disconnects
+operation modes. When run in ``standalone'' mode, the server disconnects
from the terminal and runs as a daemon, forking a child for each new
connection.
The ``inetd'' mode allows to start the server from
address@hidden/etc/inetd.conf} file. This is the default operation mode.
address@hidden/etc/inetd.conf} file. This is the default operation mode.
address@hidden
address@hidden
imap4 stream tcp nowait root /usr/local/sbin/imap4d imap4d
address@hidden smallexample
address@hidden example
@subheading Command Line Options
@table @option
@item address@hidden
@itemx address@hidden
-Run in standalone mode. An optional @var{number} specifies the maximum number
-of child processes the daemon is allowed to fork. When it is omitted,
+Run in standalone mode. An optional @var{number} specifies the maximum number
+of child processes the daemon is allowed to fork. When it is omitted,
it defaults to 20 processes.
@emph{Please note}, that there should be no whitespace between the
@option{-d} and its parameter.
@@ -6686,9 +6917,10 @@ Display program version and exit.
@node comsatd
@section Comsat Daemon
@pindex comsatd
address@hidden
Comsatd is the server which receives reports of incoming mail and
-notifies users, wishing to get this service. It can be started
+notifies users, wishing to get this service. It can be started
either from @file{inetd.conf} or as a standalone daemon.
@menu
@@ -6707,14 +6939,14 @@ either from @file{inetd.conf} or as a standalone daemon.
@item -C @var{file}
@itemx address@hidden
Convert the configuration file @var{file} to the new
-format. @var{File} must be a @command{comsatd} configuration file in
-Mailutils v. 1.x format. The converted file is printed on the standard
-output. For example, the following command can be used to convert old
+format. @var{File} must be a @command{comsatd} configuration file in
+Mailutils v. 1.x format. The converted file is printed on the standard
+output. For example, the following command can be used to convert old
@command{comsatd} configuration file to new format:
address@hidden
address@hidden
$ comsatd --convert-config=/etc/comsatd.conf > /etc/mailutils.d/comsatd
address@hidden smallexample
address@hidden example
@item -d
@itemx --daemon
@@ -6724,22 +6956,22 @@ Run as a standalone daemon.
@itemx --inetd
The server is started from @file{/etc/inetd.conf} file:
address@hidden
address@hidden
comsat dgram udp wait root /usr/sbin/comsatd \
comsatd -c /etc/comsat.conf
address@hidden smallexample
address@hidden example
This is the default operation mode.
@item -t
@itemx --test
-Test mode. In this mode, @command{comsatd} takes two arguments:
+Test mode. In this mode, @command{comsatd} takes two arguments:
@acronym{URL} of a mailbox and @acronym{QID} of the message from that
mailbox, e.g.:
address@hidden
address@hidden
$ comsatd --test /var/mail/root 34589
address@hidden smallexample
address@hidden example
@end table
@@ -6773,7 +7005,7 @@ Set maximum number of message body lines to be output.
@end deffn
@deffn {Comsatd Conf} allow-biffrc @var{bool}
-Enable or disable processing of user's @file{.biffrc} file. By default,
+Enable or disable processing of user's @file{.biffrc} file. By default,
it is enabled.
@end deffn
@@ -6797,7 +7029,7 @@ Set initial amount of time to sleep, after the first
overflow occurs.
@end deffn
@deffn {Comsatd Conf} overflow-control-interval @var{duration}
-Set overflow control interval. If two consecutive overflows happen
+Set overflow control interval. If two consecutive overflows happen
within that interval, the overflow-delay-time is doubled.
@end deffn
@@ -6806,18 +7038,18 @@ within that interval, the overflow-delay-time is
doubled.
By default, when a notification arrives, @command{comsatd} prints subject,
from headers and the first five lines from the new message to the user's
-tty. The user is allowed to change this behavior by using his own
-configuration file. This file should be located in the user's home
-directory and should be named @file{.biffrc}. It must be owned by the
+tty. The user is allowed to change this behavior by using his own
+configuration file. This file should be located in the user's home
+directory and should be named @file{.biffrc}. It must be owned by the
user and have its permissions bits set to 0600. (@emph{Please note},
that the use of per-user configuration files may be disabled, by
specifying @samp{allow-biffrc no} in the main configuration file, see
@pxref{Configuring comsatd}).
-The @file{.biffrc} file consists of a series of statements. Each
+The @file{.biffrc} file consists of a series of statements. Each
statement occupies one line and defines an action to be taken upon
-arrival of a new mail. Very long lines may be split using @samp{\} as
-the last character on the line. As usual, comments may be introduced with
+arrival of a new mail. Very long lines may be split using @samp{\} as
+the last character on the line. As usual, comments may be introduced with
@samp{#} character.
The actions specified in @file{.biffrc} file are executed in turn.
@@ -6827,20 +7059,20 @@ The following actions are defined:
@item beep
Produce an audible signal.
@item echo [-n] @var{string} address@hidden
-Output the arguments to the user's terminal device. If several
+Output the arguments to the user's terminal device. If several
arguments are given they will be output separated by single
-spaces. The newline character will be printed at the end of the
+spaces. The newline character will be printed at the end of the
output, unless the @option{-n} option is used.
@item exec @var{prog} @var{arglist}
-Execute program @var{prog} with arguments from @var{arglist}. @var{prog}
-must be specified with absolute pathname. It may not be a setuid or
+Execute program @var{prog} with arguments from @var{arglist}. @var{prog}
+must be specified with absolute pathname. It may not be a setuid or
setgid program.
@end table
In the description above, @var{string} denotes any sequence of
-characters. This sequence must be enclosed in a pair of double-quotes,
-if it contains whitespace characters. The @samp{\} character inside a
-string starts a C escape sequence. Following meta-characters may be
+characters. This sequence must be enclosed in a pair of double-quotes,
+if it contains whitespace characters. The @samp{\} character inside a
+string starts a C escape sequence. Following meta-characters may be
used in strings:
@table @asis
@@ -6851,15 +7083,15 @@ Expands to hostname
@item address@hidden@}
Expands to value of message header @samp{name}.
@item $B(@var{c},@var{l})
-Expands to message body. @var{c} and @var{l} give maximum number of
-characters and lines in the expansion. When omitted, they default to 400, 5.
+Expands to message body. @var{c} and @var{l} give maximum number of
+characters and lines in the expansion. When omitted, they default to 400, 5.
@end table
@subsubheading Example I
Dump to the user's terminal the contents of @samp{From} and
@samp{Subject} headers followed by at most 5 lines of message body.
address@hidden
address@hidden
@group
echo "Mail to \a$u@@$h\a\n---\n\
From: address@hidden@}\n\
@@ -6868,11 +7100,11 @@ Subject: address@hidden@}\n\
$B(,5)\
---\n"
@end group
address@hidden smallexample
address@hidden example
@noindent
The above example can also be written as:
address@hidden
address@hidden
@group
echo Mail to \a$u@@$h\a
echo ---
@@ -6882,14 +7114,14 @@ echo ---
echo $B(,5)
echo ---
@end group
address@hidden smallexample
address@hidden example
@subsubheading Example II
Produce a bell, then pop up the xmessage window on display :0.0 with
the text formatted in the same manner as in the previous example.
address@hidden
address@hidden
@group
beep
exec /usr/X11R6/bin/xmessage \
@@ -6900,274 +7132,1085 @@ Subject: address@hidden@}\n\
$B(,5)\
---\n"
@end group
address@hidden smallexample
address@hidden example
@page
@node mh
address@hidden @acronym{MH} --- The MH Message Handling System
address@hidden MH --- The MH Message Handling System
address@hidden
@include mu-mh.texi
@page
address@hidden mailutils-config
address@hidden @command{mailutils-config} --- Get the Information about the
Mailutils Build
address@hidden mailutils-config
-
-This program is designed for developers wishing to link their programs
-against libmailutils. It allows to examine the particulars of the
-current build of Mailutils and to get the command line parameters
-necessary for compiling and linking an application with Mailutils
-libraries.
address@hidden mu
address@hidden MU
address@hidden mu
+The @command{mu} utility is a multi-purpose tool shipped with
+Mailutils. It can be used for various mail- and database-related
+tasks, as well as an auxiliary tool for compiling and linking programs
+with Mailutils.
@menu
-* Compiler Flags:: Getting Compiler Flags.
-* Loader Flags:: Getting Loader Flags.
-* General Information:: Obtaining General Build Information.
+* mu invocation syntax::
+* mu help::
+* mu info::
+* mu cflags::
+* mu ldflags::
+* mu query::
+* mu 2047::
+* mu filter::
+* mu acl::
+* mu wicket::
+* mu dbm::
+* mu logger::
+* mu pop::
+* mu imap::
@end menu
address@hidden Compiler Flags
address@hidden Getting Compiler Flags
address@hidden mu invocation syntax
address@hidden Invocation Syntax
address@hidden is a command line tool. Its invocation syntax is:
-When invoked with the option @option{--compile}, or its short form
address@hidden, @command{mailutils-config} prints the flags
-that must be given to the compiler for compiling the program using
-Mailutils functions. An example usage:
address@hidden
+mu address@hidden @var{command} address@hidden
address@hidden example
address@hidden
-cc -omyprog.o `mailutils-config --compile` myprog.c
address@hidden smallexample
-
address@hidden Loader Flags
address@hidden Getting Loader Flags
+where @var{options} are options that affect the behavior of
address@hidden as a whole, @var{command} instructs it what it is to do
+and @var{args} are any arguments the @var{command} needs in order to be
+executed.
-The @option{--link}, or its short form @option{-l} prints to the
-standard output the loader flags necessary to link a program against
-Mailutils libraries.
+The commands are:
-When invoked without arguments, it produces the flags necessary to
-link against the basic library of Mailutils: @file{libmailutils}.
-Arguments may be given that alter this behavior. These are:
address@hidden @asis
address@hidden 2047
+Decodes or encodes email message headers.
address@hidden acl
+Tests Mailutils access control lists.
address@hidden cflags
+Shows compiler options needed to compile with Mailutils.
address@hidden dbm
+Invokes a DBM management tool.
address@hidden ;filter
+Applies a chain of filters to the input.
address@hidden help
+Displays a terse help summary.
address@hidden imap
+Invokes an IMAP4 client shell (in development).
address@hidden info
+Displays information about Mailutils compile-time configuration.
address@hidden ldflags
+Constructs a @command{ld}(1) command line for linking a program with Mailutils.
address@hidden logger
+Logs information using Mailutils log facility.
address@hidden pop
+Invokes a POP3 client shell.
address@hidden query
+Queries configuration values.
address@hidden wicket
+Scans wicket for matching URLs
address@hidden table
address@hidden @samp
address@hidden mu help
address@hidden mu help
+The @command{mu help} command lists all available options and command
+names along with short descriptions of what each of them does. It is
+similar to the @command{mu --help} option.
+
+A command name can be supplied as an argument to
address@hidden, in which case it will display a help page for that
+particular command, e.g.:
+
address@hidden
+mu help ldflags
address@hidden example
+
+will output help for the @command{ldflags} command. It is synonymous
+to the @option{--help} option used with that particular command, e.g.:
address@hidden ldflags --help}.
+
address@hidden mu info
address@hidden mu info
+The @command{mu info} command displays information about Mailutils
+compile-time configuration. In normal form its output lists a single
+configuration flag per line, e.g.:
+
address@hidden
+$ mu info
+VERSION=2.99.93
+SYSCONFDIR=/etc
+MAILSPOOLDIR=/var/mail/
+SCHEME=mbox
+LOG_FACILITY=mail
+IPV6
+USE_LIBPAM
+HAVE_LIBLTDL
+WITH_GDBM
+WITH_GNUTLS
+WITH_GSASL
address@hidden example
+
+A configuration flag can consist either of a single word, indicating
+that a particular capability has been enabled at compile time, or of a
+keyword/value pair delimited by an equal sign, which indicates a
+particular value used by default for that feature. For example,
address@hidden means that Mailutils was compiled with support for IPv6,
+whereas @samp{SYSCONFDIR=/etc} means that the default place for
+configuration files is in @file{/etc} directory.
+
+Such short output is convenient for using @command{mu info} in scripts
+to decide whether it is possible to use a given feature. To assist
+human users, the @option{--verbose} (@option{-v}) option is provided.
+It prints a short description next to each flag:
+
address@hidden
+$ mu info --verbose
+VERSION=2.99.93 - Version of this package
+SYSCONFDIR=/etc - System configuration directory
+MAILSPOOLDIR=/var/mail/ - Default mail spool directory
+SCHEME=mbox - Default mailbox type
+LOG_FACILITY=mail - Default syslog facility
+IPV6 - IPv6 support
+USE_LIBPAM - PAM support
+HAVE_LIBLTDL - a portable `dlopen' wrapper library
+WITH_GDBM - GNU DBM
+WITH_GNUTLS - TLS support using GNU TLS
+WITH_GSASL - SASL support using GNU SASL
address@hidden example
+
address@hidden mu cflags
address@hidden mu cflags
+The @command{mu cflags} command shows compiler options needed to
+compile a C source with Mailutils. It is intended for use in
+configuration scripts and Makefiles, e.g.:
+
address@hidden
+CFLAGS=-g -O2 `mu cflags`
address@hidden example
+
address@hidden mu ldflags
address@hidden mu ldflags
+The @command{mu ldflags} command is a counterpart of @command{cflags}
+which is used for linking. It constructs a @command{ld} command line
+for linking a program with Mailutils.
+
+When used without arguments, it outputs @command{ld} arguments which
+would link only with the core Mailutils library @file{libmailutils}, e.g.:
+
address@hidden
+$ mu ldflags
+-L/usr/local/lib -lmailutils
address@hidden example
+
+This command accepts a number of keywords which allow to select a
+particular subset of Mailutils libraries to link with. In particular,
+the argument @samp{all} instructs it to link in all available libraries:
+
address@hidden
+$ mu ldflags all
+-L/usr/local/lib -lmu_mbox -lmu_mh -lmu_maildir -lmu_imap -lmu_pop \
+-lmu_mailer -lmu_compat -lmailutils -lmu_auth -lgsasl -lgnutls -lgcrypt \
+-lldap -lgnuradius -lpam -ldl
address@hidden example
+
+Other available keywords are:
address@hidden @asis
address@hidden mbox
+Link in the UNIX mbox format support.
address@hidden mh
+Link in the MH format support.
address@hidden maildir
+Link in the Maildir format support.
address@hidden imap
+Link in the IMAP protocol support.
address@hidden pop
+Link in the POP protocol support.
address@hidden nntp
+Link in the NNTP protocol support.
address@hidden mailer
+Enable support for mailers.
address@hidden sieve
+Link in the support for Sieve mail filtering language.
address@hidden dbm
+Link in the support for DBM databases (libmu_dbm library).
address@hidden compat
+Provide a compatibility layer for Mailutils 2.x.
@item auth
-Print flags to link against @file{libmu_auth}, the library adding new
-authentication methods to @file{libmailutils}.
-
+Link in the Mailutils authentication library.
@item guile
-Print flags to link against @file{libmu_scm}, the Guile interface
-library.
+Provide Guile language bindings.
address@hidden python
+Provide Python language bindings.
address@hidden cfg
+Link in the Mailutils configuration library.
address@hidden argp
+Link in the library for command line parsing.
address@hidden table
address@hidden mbox
-Link against @code{mbox} format library.
address@hidden mu query
address@hidden mu query
+The @command{mu query} command queries values from Mailutils
+configuration files. It takes one or more configuration paths
+(@pxref{Paths}) as its arguments. On output, it displays the values
+it found, each value on a separate line. If the requested value is a
+block statement it is displayed in full. For example, if main
+configuration file contained:
address@hidden mh
-Link against @code{mh} format library.
address@hidden
+logging @{
+ syslog yes;
+ facility mail;
address@hidden
address@hidden example
address@hidden maildir
-Link against @code{maildir} format library.
+Then:
address@hidden mailer
-Link against @code{mailer} library.
address@hidden
+$ mu query .logging.syslog
+syslog yes;
+$ mu query .logging.syslog .logging.facility
+syslog yes;
+facility mail;
+$ mu query .logging
+logging @{
+ syslog yes;
+ facility mail;
address@hidden;
address@hidden example
address@hidden imap
-Link against @code{imap} format library.
+Several command line options allow to modify output format. The
address@hidden option instructs the command to output only values:
address@hidden pop
-Link against @code{pop} format library.
address@hidden
+$ mu query --value .logging.syslog
+yes
address@hidden example
address@hidden all
-Link against all Mailutils format libraries.
address@hidden table
+The @option{--path} option instructs it to print full pathnames for
+each value:
-The order of arguments does not matter.
address@hidden
+$ mu query --path .logging.syslog
+logging.syslog: yes
address@hidden example
-For example, if you wrote a program @file{myprog.c} that uses
-standard @sc{unix} mailbox format, @sc{mh} format and the
-Guile interface, then you would link it with the following
+The @option{--program} option instructs @command{mu} to behave as if
+it was called under another program name. For example, the following
command:
address@hidden
-cc -omyprog myprog.o `mailutils-config --link mbox mh guile`
address@hidden smallexample
address@hidden
+$ mu query --program=pop3d .server.transcript
address@hidden example
address@hidden General Information
address@hidden Obtaining General Build Information
+will return the value of the @samp{.server.transcript} statement which
+the @command{pop3d} utility would see.
-The @option{--info}, or @option{-i} retrieves the options (flags) used
-when building Mailutils. It may be used with or without
-arguments.
+By default, @command{mu query} operates on the main configuration
+file. Another configuration file can be supplied using the
address@hidden (@option{-f}) option:
-When used without arguments, it prints the list of all
-build flags, e.g.:
address@hidden
+$ mu query --file /usr/local/etc/file.conf .pidfile
address@hidden example
address@hidden
-$ mailutils-config --info
address@hidden
-SYSCONFDIR=/usr/local/etc
-MAILSPOOLDIR=/var/mail/
-SCHEME=mbox
-LOG_FACILITY=mail
-USE_LIBPAM
-HAVE_LIBLTDL
-WITH_GDBM
-WITH_GNUTLS
-WITH_GSASL
-WITH_GUILE
-WITH_PTHREAD
-WITH_READLINE
-HAVE_MYSQL
-ENABLE_VIRTUAL_DOMAINS
-ENABLE_IMAP
-ENABLE_POP
-ENABLE_MH
-ENABLE_MAILDIR
-ENABLE_SMTP
-ENABLE_SENDMAIL
address@hidden smallexample
-
-When this option is used in conjunction with the @option{--verbose}
-option, a short description is printed to the right of each keyword,
-e.g.:
-
address@hidden
-$ mailutils-config --info --verbose
-VERSION=1.9.93 - Version of this package
-SYSCONFDIR=/usr/local/etc - System configuration directory
-MAILSPOOLDIR=/var/mail/ - Default mail spool directory
-SCHEME=mbox - Default mailbox type
-LOG_FACILITY=mail - Default syslog facility
-USE_LIBPAM - PAM support
-HAVE_LIBLTDL - a portable `dlopen' wrapper library
-WITH_GDBM - GNU DBM
address@hidden
address@hidden smallexample
-
-This option also accepts any number of arguments. When these are
-given, each argument is treated as a name of a build flag.
address@hidden checks if such a flag was defined and
-prints its full name if so. It exits with zero code if all the
-flags given on the command line are defined. Otherwise, it
-exits with code of 1.
-
-The comparison of the flag names is case-insensitive. The arguments
-given need not include the leading prefix (i.e. the characters up
-to and including the first underscore character).
-
-Given the previous example, the invocation
-
address@hidden
-$ mailutils --info readline use_libpam pop
address@hidden smallexample
address@hidden mu 2047
address@hidden mu 2047
+The @command{mu 2047} command is a filter for decoding or encoding
+email message headers formatted in accordance with RFC 2047 (see
address@hidden://www.faqs.org/rfcs/rfc2047.html}. By default, it operates
+in encode mode and assumes the @samp{iso-8859-1} encoding. If
+arguments are supplied in the command line, they are treated as the
+text to operate upon. Otherwise the command acts as a UNIX filter,
+reading lines from the standard input and printing results on the
+standard output.
+
+For example:
+
address@hidden
+$ mu 2047 'Keld address@hidden Simonsen <keld@@dkuug.dk>'
+=?ISO-8859-1?Q?Keld_J=F8rn_Simonsen?= <keld@@dkuug.dk>
address@hidden example
+
+The decode mode can be requested via the @option{--decode}
+(@option{-d}) option:
+
address@hidden
+$ mu 2047 --decode '=?ISO-8859-1?Q?Keld_J=F8rn_Simonsen?= \
+ <keld@@dkuug.dk>'
+Keld address@hidden Simonsen <keld@@dkuug.dk>
address@hidden example
+
+The @option{--charset} (@option{-c}) option changes the default
+character set. It is meaningful both in decode and in encode modes.
+In decode mode it instructs the utility to convert the output to the
+given character set. In encode mode it indicates the encoding of the
+input data, which will be reflected in the resulting string:
+
address@hidden
+$ mu 2047 --charset=utf-8 'Keld address@hidden Simonsen <keld@@dkuug.dk>'
+=?utf-8?Q?Keld J=C3=B8rn Simonsen <keld@@dkuug.dk>?=
address@hidden example
+
+The @option{--encoding} (@option{-E}) option can be used in encode
+mode to change the output encoding. Valid arguments for this option
+are: @samp{quoted-printable} (the default) or @samp{base64}.
+
+The @option{--newline} (@option{-n}) option prints an additional
+newline character after each line of output.
+
address@hidden mu filter
address@hidden mu filter
+The @command{mu filter} command applies a chain of filters to the
+input. The filters to apply and their arguments are given
+in the command line. The full invocation syntax is:
+
address@hidden
+ mu filter address@hidden @var{filter-chain}
address@hidden example
+
+The syntax for @var{filter-chain} in Backus-Naur form follows:
+
address@hidden
+<filter-chain> ::= <filter> | <filter-chain> "+" <filter>
+<filter> ::= <filter-spec> <@var{ARG}>*
+<filter-spec> ::= <@var{WORD}> | "~" <@var{WORD}>
address@hidden example
@noindent
-will produce the following output:
+where @var{<WORD>} stands for the filter name and @var{<ARG>}
+represents filter arguments. To obtain a list of known filter names,
+run:
address@hidden
-WITH_READLINE
-USE_LIBPAM
-ENABLE_POP
address@hidden smallexample
address@hidden
+mu filter --list
address@hidden example
+
+Filters are applied in the order of their appearence, from left to
+right and operate in encode mode. The plus sign has the same meaning
+as pipe in shell. The default mode can be changed using the
address@hidden (@option{-d}) and @option{--encode} (@option{-e}) options.
+Whatever the default mode is, a @samp{~} character before filter
+name reverts the mode for that filter alone.
+
+For example, to encode the contents of file @file{file.txt} in Base64
+run:
+
address@hidden
+mu filter base64 < file.txt
address@hidden example
+
+To convert it to base64 and use CRLF as line delimiters, run:
+
address@hidden
+mu filter base64 + crlf < file.txt
address@hidden example
+
+The following command will decode the produced output:
+
address@hidden
+mu filter --decode crlf + base64
address@hidden example
+
+It can also be written as
+
address@hidden
+mu filter ~crlf + ~base64
address@hidden example
+
+The following example converts the input from ISO-8859-2 to UTF-8,
+quotes eventual @samp{From} occurring at the beginning of a line,
+encodes the result in Base64 and changes line delimiters to CRLF:
+
address@hidden
+mu filter iconv iso-8859-2 utf-8 + from + base64 + crlf
address@hidden example
+
+This final example removes UNIX-style comments from the input and
+joins continuation lines:
+
address@hidden
+mu filter --decode inline-comment -S '#' + linecon
address@hidden example
+
+Such invocation can be useful in shell scripts to facilitate
+configuration file processing.
+
address@hidden mu acl
address@hidden mu acl
+The @command{mu acl} command tests Mailutils Access Control Lists. By
+default it reads ACL from the Mailutils configiration file section
address@hidden The command takes a list of IP addresses as its
+arguments, applies the ACL to each of them in turn and prints the result.
+
+To select the ACL to test, two options are provided. The
address@hidden (@option{-f}) option supplies the name of
+configuration file to read instead of the default one. The
address@hidden (@option{-p} option supplies the pathname
+(@pxref{Paths}) of the ACL section to use instead of the default @samp{.acl}.
For example, to test ACL in section @samp{server 213.130.1.232} of file
@file{/etc/pop3d.conf} use:
+
address@hidden
+mu acl --file=/etc/pop3d.conf \
+ --path=/server="213.130.1.232"/acl @var{address}
address@hidden example
+
+As an example of its use, consider file @file{test.conf} with the
+following contents:
+
address@hidden
+acl @{
+ deny from 10.10.10.1;
+ deny from 10.10.1.0/24;
+ log from any "Connect from address@hidden@}";
+ allow from 10.0.0.0/8;
+ allow from 192.168.1.0/24;
+ deny from any;
address@hidden
address@hidden example
+
+Then, running @command{mu acl --file=test.conf 127.0.0.1} you will get:
+
address@hidden
+Testing 127.0.0.1:
+mu: Connect from 127.0.0.1
+127.0.0.1: deny
address@hidden example
+
+More examples:
+
address@hidden
+$ mu acl --file=test.conf 127.0.0.1 10.10.10.1 \
+ 10.10.1.3 10.5.3.1 192.168.1.0 192.168.2.0
+Testing 127.0.0.1:
+mu: Connect from 127.0.0.1
+127.0.0.1: deny
+Testing 10.10.10.1:
+10.10.10.1: deny
+Testing 10.10.1.3:
+10.10.1.3: deny
+Testing 10.5.3.1:
+mu: Connect from 10.5.3.1
+10.5.3.1: accept
+Testing 192.168.1.0:
+mu: Connect from 192.168.1.0
+192.168.1.0: accept
+Testing 192.168.2.0:
+mu: Connect from 192.168.2.0
+192.168.2.0: accept
address@hidden example
+
+The @command{mu} option @option{--debug-level} will give you a deeper
+insight into the address matching algorithm:
+
address@hidden
+$ mu --debug-level=acl.trace9 acl --file test.conf 127.0.0.1
+Testing 127.0.0.1:
+mu: Checking sockaddr 127.0.0.1
+mu: 1:deny: Does 10.10.10.1/255.255.255.255 match 127.0.0.1? no;
+mu: 2:deny: Does 10.10.1.0/255.255.255.0 match 127.0.0.1? no;
+mu: 3:log: Does any match 127.0.0.1? yes;
+mu: Expanding "Connect from address@hidden@}";
+mu: Expansion: "Connect from 127.0.0.1";.
+mu: Connect from 127.0.0.1
+mu: 4:accept: Does 10.0.0.0/255.0.0.0 match 127.0.0.1? no;
+mu: 5:accept: Does 192.168.0.0/255.255.0.0 match 127.0.0.1? no;
+mu: 6:deny: Does any match 127.0.0.1? yes;
+127.0.0.1: deny
address@hidden example
+
address@hidden Categories,acl}.
+
address@hidden mu wicket
address@hidden mu wicket
+The @command{mu wicket} command looks up matching URLs in the
+Mailutils ticket file (by default, @file{~/.mu-tickets}) and prints
+them. The URLs to look for are supplied in the command line.
+
+Consider the following ticket file as an example:
+
address@hidden
+smtp://foo:bar@@*
+smtp://bar:baz@@gnu.org
+*://baz:qux@@*
+*://quux:bar@@gnu.org
address@hidden example
+
+Now, running @command{mu wicket smtp://bar@@gnu.org} will show:
+
address@hidden
+smtp://bar@@gnu.org: /home/@var{user}/.mu-tickets:2
address@hidden example
+
address@hidden
+(where @var{user} is your login name). This means that this URL
+matches the line 2 in your @file{.mu-tickets} file. The
address@hidden command does not show the actual matching line to
+avoid revealing eventual security-sensitive information. You can
+instruct it to do so using the @option{--verbose} (@option{-v})
+option:
+
address@hidden
+$ mu wicket -v smtp://bar@@gnu.org
+smtp://bar@@gnu.org: /home/@var{user}/.mu-tickets:2: smtp://bar:***@@gnu.org
address@hidden example
+
+As you see, even in that case the tool hides the actual password part
+by replacing it with three asteriscs. If you are working in a secure
+environment, you can tell @command{mu wicket} to show passwords as
+well, by supplying the @option{-v} option twice.
+
+A counterpart of @option{--verbose} is the @option{--quite}
+(@option{-q}) option, which instructs @command{wicket} to suppress any
+output, excepting error messages. This can be used in scripts, which
+analyze the @command{mu wicket} exit code to alter the control flow.
+
+The @command{mu wicket} tool exits with code 0 if all URLs were
+matched and with code 1 if some of them were not matched in the ticket
+file. If an error occurred, the code 2 is returned.
+
address@hidden mu dbm
address@hidden mu dbm
+The @command{mu dbm} tool manages DBM files using @file{libmu_dbm}
+The invocation syntax is:
+
address@hidden
+mu dbm @var{subcommand} address@hidden @var{file} address@hidden
address@hidden example
address@hidden
+or
address@hidden
+mu dbm address@hidden @var{subcommand} @var{file} address@hidden
address@hidden example
@noindent
-and will exit with a zero status.
+where @var{subcommand} selects the operation mode, @var{options}
+modify the tool behavior and @var{file} specifies the DBM file to
+operate upon. Some @var{command}s allow for optional @var{keys} to be
+specified.
+
+The @var{file} argument can be either a DBM file name or a Database URL.
+
address@hidden
+* Create a Database::
+* Add Records to a Database::
+* Delete Records::
+* List the Database::
+* Dump the Database::
+* Dump Formats::
+* Dbm Exit Codes::
address@hidden menu
+
address@hidden Create a Database
address@hidden Create a Database
+The @option{create} subcommand and its synonym @option{load} instruct
+the tool to create a new database:
+
address@hidden
+mu dbm create file.db
address@hidden example
+
+If the argument file already exists, it will be truncated prior to
+adding new records to it.
+
+The data to populate the database with are read from the standard
+input. The @command{mu dbm} command supports several formats for
+these data, which are discussed later. In the simplest case (a so
+called @samp{format 0.0}) each input line must consist of two fields
+separated by any amount of whitespace. The first field is treated as
+a key and the second one as the corresponding value.
+
+The usual way to read data from a file is, of course, by redirecting
+the file to the standard input as in:
+
address@hidden
+mu dbm create file.db < input.txt
address@hidden example
+
+There is also a special option for that purpose: @option{--file}
+(@option{-f}). Thus, the following command is equivalent to the one
+above:
+
address@hidden
+mu dbm create --file input.txt file.db
address@hidden example
+
+The @option{--file} option has the advantage that it allows, in
+conjunction with another options, for copying input file metadata
+(owner UID, GID and file mode) to the created database. For example,
+the following command ensures that the created database file will have
+the same metadata as the input file:
+
address@hidden
+mu dbm create --file input.txt --copy-permissions file.db
address@hidden example
+
+The @option{--copy-permissions} (@option{-P}) option is the one that
+does the job.
+
+There are also other ways to control mode and ownership of the created
+database, which are described below.
+
+More advanced dump formats (e.g. @samp{version 1.0} format) carry
+additional information about the file, including its original name,
+ownership and mode. If input is in one of these formats, the file
+name argument becomes optional. If it is not supplied, the name
+stored in the input stream will be used. For example, supposing that
+the file @file{users.dump} is in format 1.0, the following command
+suffices to restore the original filename, ownership, mode and, of
+course, data:
+
address@hidden
+mu dbm create --file users.dump
address@hidden example
+
address@hidden Add Records to a Database
address@hidden Add Records to a Database
+The @option{add} subcommand adds records to a database. Records are
+read from the standard input and must be formatted as for
address@hidden:
+
address@hidden
+mu dbm add file.db
address@hidden example
+
+If the argument file does not exist, it will be created.
+
+Adding a record with a key which is already present in the database
+produces an error. To replace existing records, use the
address@hidden subcommand instead.
+
+The same options that affect the behavior of @option{create} apply to
address@hidden and @samp{replace} as well, e.g.:
+
address@hidden
+mu dbm replace --file input.txt --copy-permissions file.db
address@hidden example
+
address@hidden Delete Records
address@hidden Delete Records
+To delete records, use the @option{delete} subcommand. It reads a
+list of keys to delete to be specified as arguments in the command
+line:
-The following command:
address@hidden
+mu dbm delete file.db foo bar
address@hidden example
address@hidden
-$ mailutils --info readline gssapi pop
address@hidden smallexample
+The command above will delete from @file{file.db} records with keys
address@hidden and @samp{bar}.
+
+It is not an error to attempt to delete a key that does not exist in
+the database, although such use will produce a warning message.
+
+By default, keys are matched literally. It is also possible to use
+various pattern matching techniques, depending on the option
+specified.
+
+The @option{--glob} (@option{-G}) option instructs the tool to use UNIX
globbing pattern matching. For example, the command below will delete all keys
starting with @samp{foo} and ending with a decimal digit:
+
address@hidden
+mu dbm delete file.db 'foo*[0-9]'
address@hidden example
@noindent
-will exit with status 1, and will print:
+(note the quoting necessary to prevent shell from interpreting the
+metacharacters itself).
+
+Another option, @option{--regex} (@option{-R}) instructs @command{mu}
+to treat supplied keys as extended regular expressions:
+
address@hidden
+mu dbm delete --regex file.db 'address@hidden,address@hidden'
address@hidden example
+
+Both options are affected by the @option{--ignore-case} (@option{-i})
+option, which turns on case-insensitive matching.
+
+Using pattern matching to delete records can be a risky operation as
+selecting a wrong pattern will lead to removing wrong records. It is
+recommended to first use the list mode described below to verify that
+the patterns match the right keys.
+
address@hidden List the Database
address@hidden List the Database
+The @option{list} command lists the content of the database:
+
address@hidden
+mu dbm list file.db
address@hidden example
+
+By default, entire content is listed on the standard output.
+
+If supplied more than one command line argument, this mode treats the
+rest of arguments after the database file name as the keys to look for
+and lists only records with these keys:
+
address@hidden
+$ mu dbm list file.db foo bar
+foo 1
+bar 56
address@hidden example
+
+The @option{--glob} and @option{--regex} options instruct the tool to
+use UNIX globbing or extended regular expression matching,
+correspondingly. These were described in detail above.
+
address@hidden Dump the Database
address@hidden
+
+The @option{dump} subcommand dumps the database to the standard output
+in a format suitable for backup or sending over the network (a
+version 1.0 format).
+
address@hidden
+mu dbm dump file.db < file.dump
address@hidden example
+
+The produced file is suitable for input to the @option{create} (@option{load})
command. Among other uses, it provides an easy way to convert databases
between various formats supported by Mailutils. For example this is how to
convert the database file @file{file.db} to the GDBM database @file{new.db}:
+
address@hidden
+mu dbm dump file.db | mu dbm create gdbm://new.db
address@hidden example
+
+Both @option{list} and @option{dump} subcommands share the same set of
+options. In fact, they are pretty similar, except that use different
+defaults. The @option{list} subcommand is designed to produce a
+human-readable output, whereas the dump subcommand is oriented towards
+backup purposes.
+
address@hidden Dump Formats
address@hidden Dump Formats
+As of version @value{VERSION}, @command{mu dbm} supports two formats
+for dumping DBM databases. Both formats are line-oriented. Comments
+are introduced with a sharp (@samp{#}) sign in the column 0 of a line,
+followed by at least one white space character (space or tab). Sharp
+sign followed by a colon (@samp{#:}) introduces a @dfn{paragmatic
+comment}, which carries some additional information to the loader.
+
address@hidden version 0.0}
+The @dfn{version 0.0} format is suitable for databases whose records
+contain only ASCII data. In this format, each record occupies a
+separate line, which consists of the key and value separated by a
+single @sc{tab} character. Empty lines are ignored. For example:
+
address@hidden
+$ mu list /etc/mail/users.db
+root guessme
+smith pAssword
+qed fooBar
address@hidden example
+
+The output in version 0.0 format is human readable and can be used as
+input to the popauth utility (@FIXME-pxref{popauth}. However, version 0.0
+has serious drawbacks. First of all, it is not suitable for databases
+that contain binary data. Secondly, it cannot properly handle keys
+beginning with a sharp sign or containing @sc{tab}. The version 1.0
+format is free from these drawbacks.
+
address@hidden version 1.0}
+The @dfn{version 1.0} dump format begins with a @dfn{header}
+containing important information about the file, such as its file
+name, ownership and file mode. This information is stored in
+pragmatic comments and allows @command{mu dbm load} to easily recreate
+an exact copy of the file. The following comments are defined:
+
address@hidden @asis
address@hidden #:version=1.0
+Indicates that the data that follow are in version 1.0 format.
address@hidden #:address@hidden
+Original database file name, without directory parts.
address@hidden #:address@hidden
+Owner UID.
address@hidden #:address@hidden
+Owner name.
address@hidden #:address@hidden
+Owner GID
address@hidden #:address@hidden
+Owner group name.
address@hidden #:address@hidden
+File mode in octal
address@hidden table
+
+Following this header are actual data. Each record is output in two
+parts: key and value. Each part begins with a @samp{#:address@hidden
+construct on a line by itself, where @var{n} is the length of the data
+in decimal. This line is followed by one or more lines of the actual
+data, encoded in base64. The data are formatted so that each line
+does not exceed 76 bytes in length (not counting the terminating
+newline). An example of this format follows:
+
address@hidden
+# Database dump file created by GNU Mailutils 2.99.93 on
+# Tue Nov 1 13:28:03 2011
+#:version=1.0
+#:file=users.db
+#:uid=0,user=root,gid=25,group=mail,mode=640
+#:len=6
+c21pdGgA
+#:len=9
+cEFzc3dvcmQA
+#:len=5
+cm9vdAA=
+#:len=8
+Z3Vlc3NtZQA=
+#:len=4
+cWVkAA==
+#:len=7
+Zm9vQmFyAA==
address@hidden example
+
address@hidden Dbm Exit Codes
address@hidden Dbm Exit Codes
+The table below summarizes exit codes used by @command{mu dbm}:
+
address@hidden @columnfractions 0.2 0.3 0.5
address@hidden Code @tab Symbolic name @tab Meaning
address@hidden 0 @tab EX_OK @tab Successful termination
address@hidden 64 @tab EX_USAGE @tab Command line usage error
address@hidden 65 @tab EX_DATAERR @tab Error in user-supplied data: the input
+file is badly formatted, or some of the data supplied in the command
+line are invalid (e.g. user name, uid or the like), etc.
address@hidden 66 @tab EX_NOINPUT @tab Cannot open input file
address@hidden 67 @tab EX_NOUSER @tab No such user or UID when trying to set
+output file ownership
address@hidden 69 @tab EX_UNAVAILABLE @tab Operation cannot be performed due to
+some kind of problem (e.g. access to the file denied, etc.)
address@hidden 70 @tab EX_SOFTWARE @tab Internal software error
address@hidden 74 @tab EX_IOERR @tab Input/output error
address@hidden multitable
+
address@hidden mu logger
address@hidden mu logger
+The @command{mu logger} tool logs information using Mailutils log facility.
+
+Syntax:
+
address@hidden
+mu logger address@hidden address@hidden
address@hidden example
address@hidden
-WITH_READLINE
-ENABLE_POP
address@hidden smallexample
+The @var{message} argument, if supplied, gives the text to log. If not
supplied, the utility reads lines of text from standard input or a file (if the
@option{--file} option is given) and sends them to log:
+
address@hidden
+# Send text to log
+$ mu logger I am here
+# Log each line from file.txt
+$ mu logger --file file.txt
+# Read stdin and log it:
+$ mu logger
address@hidden example
+
+The default logging channel is bound to standard error. To bind it to
+syslog, use the @option{--syslog} command line option. In that case
address@hidden uses facility @samp{user} and priority @samp{err}. You
+can change this by using the @option{--priority} (@option{-p}) option.
+Its argument is either a syslog facility name or facility and severity
+names separated by a dot. For example, the following invocation will use
+facility @samp{auth}, severity @samp{info}:
+
address@hidden
+mu logger --priority auth.info
address@hidden example
+
+The syslog tag can be set using the @option{--tag} (@option{-t}) option:
+
address@hidden
+mu logger --tag myprog
address@hidden example
+
+The default tag is @samp{mu-logger}.
+
+The @option{--severity} (@option{-s}) option sets the Mailutils
+severity level. Its argument can be any of the following:
address@hidden, @samp{info}, @samp{notice}, @samp{warning},
address@hidden, @samp{crit}, @samp{alert}, @samp{emerg}.
+
+Finally, the @option{--locus} (@option{-l}) option binds log messages
+to a location in a file. Its argument has the following syntax:
+
address@hidden
address@hidden:@var{line}[:@var{col}]
address@hidden example
@noindent
-since @code{WITH_GSSAPI} flag is not defined.
+where @var{file} is the file name, @var{line} is the line number and
+optional @var{col} is the column number in that file.
+
+For example, the following invocation:
-The flags and their meanings are:
address@hidden
+mu logger --locus mailutils.rc:34 Suspicious statement
address@hidden example
+will send the following to the log:
+
address@hidden
+mu-logger: mailutils.rc:34: Suspicious statement
address@hidden example
+
address@hidden mu pop
address@hidden mu pop
+The @command{mu pop} command invokes an interactive POP3 client shell.
+It reads commands from the standard input, executes them and displays
+the results on the standard output. If the standard input is
+connected to a terminal, the readline and history facilities are
+enabled (provided that Mailutils is configured with GNU Readline).
+
+The @command{mu pop} commands form two major groups. POP3 protocol
+commands interact with the remote POP3 server and display responses
+obtained from it. These commands are named after their POP3
+equivalents. Another group, @dfn{internal commands}, are used to
+configure the shell itself.
+
address@hidden POP protocol commands
@table @asis
address@hidden @item VERSION=" VERSION,
address@hidden USE_LIBPAM
-The Mailutils uses @sc{pam} libraries.
address@hidden connect [-tls] @var{hostname} address@hidden
+Open connection to @var{hostname}. If the @option{-tls} option is
+given, TLS encryption (also known as POPS protocol) will be used. If
address@hidden argument is not given, the command uses port 110 for a
+plain POP connection or 995 for POPS (if @option{-tls} is given).
+
address@hidden stls
+Start TLS negotiation. This command is valid only after successful
+unencrypted connection has been initiated (using @command{connect}
+without @option{-tls} argument).
address@hidden HAVE_LIBLTDL
-The GNU wrapper library @file{libltdl} is present and is used
-by Mailutils. @xref{Using libltdl,,,libtool,Using libltdl}, for
-more information on @file{libltdl} library.
address@hidden user @var{name}
+Send user name to the server. The @command{pass} command must follow.
address@hidden WITH_BDB2
-Support for Berkeley DB is compiled in (the package was configured with
address@hidden option).
address@hidden pass address@hidden
+Send password. This command is valid only after @command{user}. If
+the @var{password} argument is omitted, the shell will ask you to
+enter it. While entering, both echoing and history recording will be
+disabled. Use this to avoid compromising your password.
address@hidden WITH_NDBM
-Support for NDBM is compiled in (the package was configured with
address@hidden option).
address@hidden apop @var{user} address@hidden
+Authenticate with APOP. If the @var{password} argument is omitted,
+you will be asked to supply it. While entering, both echoing and
+history recording will be disabled.
address@hidden WITH_OLD_DBM
-Support for old style DBM is compiled in (the package was configured with
address@hidden option).
address@hidden capa [-reread] address@hidden
+List server capabilities. Any number of arguments is accepted. If given, the
shell will display only the named capabilities, otherwise it displays entire
list. By default @command{capa} reuses the response of its previous invocation
(if there was any), instead of resending the @samp{CAPA} command to the server.
To force it do so, use the @option{-reread} option.
address@hidden WITH_GDBM
-Support for GNU DBM is compiled in (the package was configured with
address@hidden option). @xref{Top,,Introduction,gdbm,The GNU DBM Manual},
-for more information about this library.
address@hidden noop
+Send a @samp{NOOP} (@dfn{no operation}) command to the server.
address@hidden WITH_GNUTLS
-Support for GnuTLS (a Transport Layer Security Library) is compiled in
-(the package was configured with @option{--with-gnutls} option).
address@hidden stat
+Get the mailbox size and number of messages in it.
address@hidden WITH_GSASL
-Support for GNU SASL is compiled in (the package was configured with
address@hidden option). @xref{Top,,Introduction,gsasl,The GNU SASL Manual},
-for more information about this library.
address@hidden uidl address@hidden
+Shows unique message identifiers. Without arguments, shows
+identifiers for each message in the mailbox. If @var{number} is
+given, the command returns the UIDL of that particular message only.
address@hidden WITH_GSSAPI
-Support for @sc{gssapi} is compiled in (the package was configured with
address@hidden option).
address@hidden list address@hidden
+Lists messages. See above for the meaning of @var{number}. Each line
+of the produced listing contains describes a single message and
+contains at least the message number and size in bytes. Depending on
+the POP3 server implementation, additional fields may be present. For
+example, Mailutils @command{pop3d} can also output number of lines in
+the message in the additional third field.
address@hidden WITH_GUILE
-Support for Guile extension language is built (the package was
-configured with @option{--with-guile} option).
address@hidden,,Overview,guile,The Guile Reference Manual},
-for more information about Guile.
address@hidden retr @var{number}
+Retrieve a message.
+
address@hidden top @var{msgno} address@hidden
+Display message headers and first @var{number} (default 5) of lines of its
body.
+
address@hidden dele @var{number}
+Mark message for deletion.
+
address@hidden rset
+Remove deletion marks.
+
address@hidden quit
+Quit pop3 session.
address@hidden WITH_PTHREAD
-The @sc{posix} thread support is compiled in.
address@hidden disconnect
+Close existing connection.
address@hidden table
address@hidden WITH_READLINE
-The readline support is enabled (the package was
-configured with @option{--with-readline} option).
address@hidden,,,readline,The GNU Readline Library}, for more information.
address@hidden Internal commands
address@hidden @asis
address@hidden verbose [on|off|mask|unmask] [secure [payload]]
+Control output verbosity. Without arguments the @command{verbose}
+command shows current settings.
+
+The argument @samp{off} (the default) turns off all additional output.
+The @samp{verbose on} command enables POP3 protocol tracing output.
+Additional arguments can be used to provide more verbosity. The
address@hidden argument enables display of user passwords in the trace
+output and the @samp{payload} argument enables showing payload data
+(e.g. response body sent in the reply to @samp{RETR} command, etc.)
+Thus, the full diagnostics output is obtained by
+
address@hidden
+verbose on secure payload
address@hidden example
+
+The @samp{mask} and @samp{unmask} arguments allow to disable and
+enable such additional verbosity. For example, supposing the command
+above is in action, the following command will suppress the display of
+user passwords in the traces:
+
address@hidden
+verbose mask secure
address@hidden example
+
+Similarly, @command{verbose unmask secure} will turn it back again.
+
address@hidden prompt @var{string}
+Set command prompt. The argument can contain @dfn{variable
+references} in any of the following forms:
+
address@hidden
address@hidden
address@hidden@address@hidden
address@hidden example
address@hidden HAVE_MYSQL
-Authentication via MySQL is supported (the package was
-configured with @option{--enable-mysql} option).
address@hidden
+where @var{name} is the variable name. Such references are expanded
+to the actual value of the variable at the time of expansion. The
+following variables are defined:
+
address@hidden @columnfractions 0.4 0.6
address@hidden Variable @tab Expansion
address@hidden user @tab Login name of the authenticated POP3 user. If the
session is not authenticated yet, expands to @samp{[nouser]}.
address@hidden host @tab Name of the remote host, or @samp{[nohost]} if no
+connection is established.
address@hidden program-name @tab Name of the program, as typed on the command
+line to invoke it.
address@hidden canonical-program-name @tab @samp{mu}
address@hidden package @tab @samp{Mailutils}
address@hidden version @tab Mailutils version number (@value{VERSION})
address@hidden status @tab Session status. One of: @samp{disconnected},
address@hidden or @samp{logged in}.
address@hidden multitable
address@hidden ENABLE_VIRTUAL_DOMAINS
-Support for mail virtual domains is enabled (the package was
-configured with @option{--enable-virtual-domains} option).
+For example:
address@hidden ENABLE_IMAP
-Support for @sc{imap4} protocol is enabled.
address@hidden
+prompt "address@hidden@}@@$host "
address@hidden example
address@hidden ENABLE_POP
-Support for @sc{pop3} protocol is enabled.
+Notice the use of quotes to include the space character in the prompt.
address@hidden ENABLE_MH
-Support for mailboxes in @sc{mh} format is enabled.
address@hidden exit
+Exit the program.
address@hidden ENABLE_MAILDIR
-Support for mailboxes in @sc{Maildir} format is enabled.
address@hidden help address@hidden
address@hidden ? address@hidden
+Without arguments displays a list of commands with possible arguments
+and short descriptions.
address@hidden ENABLE_SMTP
-Support for @sc{smtp} mailer is enabled.
+With one argument, displays a terse description for the given @var{command}.
address@hidden ENABLE_SENDMAIL
-Support for Sendmail mailer is enabled.
address@hidden history
+Shows command history.
@end table
+
address@hidden mu imap
address@hidden mu imap
+The @command{mu imap} command is reserved for an interactive IMAP4
+client shell. It does not do much now (as of version @value{VERSION}.
+
diff --git a/doc/texinfo/sieve.texi b/doc/texinfo/sieve.texi
index e8d0d51..d8308a0 100644
--- a/doc/texinfo/sieve.texi
+++ b/doc/texinfo/sieve.texi
@@ -30,8 +30,8 @@ as described below).
There are two kinds of comments: hash comments, that begin with a
@samp{#} character that is not contained within a string and continue
until the next newline, and C-style or bracketed comments, that are
-delimited by @samp{/*} and @samp{*/} tokens. The bracketed comments
-may span multiple lines. E.g.:
+delimited by @samp{/*} and @samp{*/} tokens. The bracketed comments
+may span multiple lines. E.g.:
@smallexample
if size :over 100K
@@ -53,20 +53,20 @@ Like in C, bracketed comments do not nest.
The basic lexical entities are @dfn{identifiers} and @dfn{literals}.
An @dfn{identifier} is a sequence of letters, digits and underscores,
-that begins with a letter or underscore. For example, @code{header} and
+that begins with a letter or underscore. For example, @code{header} and
@code{check_822_again} are valid identifiers, whereas @code{1st} is not.
A special form of identifier is @dfn{tag}: it is an identifier prefixed
with a colon (@samp{:}), e.g.: @code{:comparator}.
A @dfn{literal} is a data that is not executed, merely evaluated ``as
-is'', to be used as arguments to commands. There are four kinds of
+is'', to be used as arguments to commands. There are four kinds of
literals:
@itemize
@item Number
@cindex numbers, sieve
address@hidden are given as ordinary unsigned decimal numbers. An
address@hidden are given as ordinary unsigned decimal numbers. An
optional suffix may be used to indicate a multiple of a power of two.
The suffixes are: @samp{K} specifying ``kibi-'', or 1,024 (2^10) times
the value of the number; @samp{M} specifying ``mebi-'', or 1,048,576
@@ -78,24 +78,24 @@ The numbers have 32 bits of magnitude.
@item String
@cindex strings, sieve
A @dfn{string} is any sequence of characters enclosed in double quotes
-(@samp{"}). A string cannot contain newlines and double quote
-characters. This limitation will disappear in future releases.
+(@samp{"}). A string cannot contain newlines and double quote
+characters. This limitation will disappear in future releases.
@item Multiline Strings
@cindex multiline strings, sieve
@kwindex text:
A @dfn{multiline string} is used to represent large blocks of text
-with embedded newlines and special characters. It starts with the
+with embedded newlines and special characters. It starts with the
keyword @code{text:} followed by a newline and ends with a dot
-(@samp{.}) on a newline by itself. Any characters between these two
-markers are taken verbatim. For example:
+(@samp{.}) on a newline by itself. Any characters between these two
+markers are taken verbatim. For example:
@smallexample
text:
** This is an automatic response from my message **
** filtering program. **
-I can not attend your message right now. However it
+I can not attend your message right now. However it
will be saved, and I will read it as soon as I am back.
Regards,
@@ -104,10 +104,10 @@ Fred
@end smallexample
Notice that a hashed comment or whitespace may occur between
address@hidden:} and the newline. However, when used inside the multiline
address@hidden:} and the newline. However, when used inside the multiline
string a hash sign looses its special meaning (except in one case, see
below) and is taken as is, as well as bracketed comment delimiters.
-In other words, no comments are allowed within a multiline string. E.g.:
+In other words, no comments are allowed within a multiline string. E.g.:
@smallexample
text: # This is a comment
@@ -131,15 +131,15 @@ text:
This results in the contents of file @file{myresponse.txt} being read
and interpreted as the contents of the multiline string.
-GNU libmu_sieve extends the described syntax as follows. If the keyword
+GNU libmu_sieve extends the described syntax as follows. If the keyword
@code{text:} is immediately followed by a dash (@samp{-}), then all
leading tab characters are stripped from input lines and the line
-containing delimiter (@samp{.}). This allows multiline strings within
+containing delimiter (@samp{.}). This allows multiline strings within
scripts to be indented in a natural fashion.
Furthermore, if the @code{text:} (optionally followed by @samp{-}) is
immediately followed by a word, this word will be used as ending
-delimiter of multiline string instead of the default dot. For
+delimiter of multiline string instead of the default dot. For
example:
@smallexample
@@ -172,7 +172,7 @@ in a pair of square brackets, e.g.:
For convenience, in any context where a list of strings is appropriate,
a single string is allowed without being a member of a list: it is
-equivalent to a list with a single member. For example, the following
+equivalent to a list with a single member. For example, the following
two statements are equivalent:
@smallexample
@@ -198,7 +198,7 @@ simple syntax.
@node Commands
@subsection Commands
-The basic syntax element is a @dfn{command}. It is defined as follows:
+The basic syntax element is a @dfn{command}. It is defined as follows:
@smallexample
@var{command-name} address@hidden @var{args}
@@ -209,18 +209,18 @@ command, @var{tags} is an optional list of @dfn{optional}
or
@dfn{tagged arguments} and @var{args} is a list of @dfn{required} or
@dfn{positional arguments}.
-Positional arguments are literals delimited with whitespace. They
+Positional arguments are literals delimited with whitespace. They
provide the command with the information necessary to its proper
-functioning. Each command has a fixed number of positional arguments. It
+functioning. Each command has a fixed number of positional arguments. It
is an error to supply more arguments to the command or to give it fewer
arguments than it accepts.
Optional arguments allow to modify the behaviour of the command, like
-command line options in UNIX do. They are a list of @dfn{tags}
-(@pxref{Lexical Structure}) separated by whitespace. An optional
+command line options in UNIX do. They are a list of @dfn{tags}
+(@pxref{Lexical Structure}) separated by whitespace. An optional
argument may have at most one parameter.
-Each command understands a set of optional arguments. Supplying it tags
+Each command understands a set of optional arguments. Supplying it tags
that it does not understand results in an error.
For example, consider the following command
@@ -233,8 +233,8 @@ header :mime :comparator "i;octet" ["to", "from"]
"bug-mailutils@@gnu.org"
Here, given that @code{header} takes two positional arguments:
@code{header} is command name, the list @code{["to", "from"]} is first
positional argument and the string @code{"bug-mailutils@@gnu.org"} is second
-positional argument. There are two optional arguments: @code{:mime} and
address@hidden:comparator}. The latter has a string @code{"i;octet"} as its
+positional argument. There are two optional arguments: @code{:mime} and
address@hidden:comparator}. The latter has a string @code{"i;octet"} as its
parameter.
@node Actions Described
@@ -242,8 +242,8 @@ parameter.
@cindex action, sieve
An @dfn{action} is a Sieve command that performs some operation over
-a message. Actions do the main job in any Sieve
-program. Syntactically, an action is a command terminated with
+a message. Actions do the main job in any Sieve
+program. Syntactically, an action is a command terminated with
semicolon, e.g.:
@smallexample
@@ -254,13 +254,13 @@ fileinto "mbox";
GNU Sieve provides the full set of actions described in RFC 3028.
It also allows to extend this set using loadable
-actions. @xref{Actions}, for detailed discussion of actions.
+actions. @xref{Actions}, for detailed discussion of actions.
@node Control Flow
@subsection Control Flow
@kwindex if, sieve
-The only control flow statement Sieve has is @code{if} statement. In its
+The only control flow statement Sieve has is @code{if} statement. In its
simplest form it is:
@smallexample
@@ -287,13 +287,13 @@ if @code{cond1} @{ @dots{} @} elsif @code{cond2} @{
@dots{} @} else @{ @dots{} @
@end smallexample
There may be any number of ``elsif'' branches in an ``if''
-statement. However it may have at most one ``else'' branch.
+statement. However it may have at most one ``else'' branch.
Notes for C programmers:
@enumerate
@item The braces surrounding each branch of an ``if'' statement are
required.
address@hidden The ``else if'' construct is disallowed. Use ``elsif'' keyword
address@hidden The ``else if'' construct is disallowed. Use ``elsif'' keyword
instead.
@end enumerate
@@ -321,7 +321,7 @@ statements.
@subsection Tests and Conditions
@cindex test, sieve
address@hidden are Sieve commands that return boolean value. E.g. the
address@hidden are Sieve commands that return boolean value. E.g. the
test
@smallexample
@@ -336,7 +336,7 @@ The tests shipped with the GNU Sieve are described in
@ref{Tests}.
@cindex condition, sieve
@dfn{Condition} is a Sieve expression that evaluates to @code{true} or
address@hidden In its simplest form, condition is just a Sieve test.
address@hidden In its simplest form, condition is just a Sieve test.
@kwindex not, sieve
To reverse the sense of a condition use keyword @code{not}, e.g.:
@@ -350,10 +350,10 @@ not header :contains "from" "coyote"
@kwindex allof
@kwindex anyof
The results of several conditions may be joined together by logical
address@hidden and @code{or} operations. The special form @code{allof}
address@hidden and @code{or} operations. The special form @code{allof}
takes several tests as its arguments and computes the logical @code{and}
-of their results. Similarly, the form @code{anyof} performs logical
address@hidden over the results of its arguments. E.g.:
+of their results. Similarly, the form @code{anyof} performs logical
address@hidden over the results of its arguments. E.g.:
@smallexample
if anyof (not exists ["From", "Date"],
@@ -371,7 +371,7 @@ if anyof (not exists ["From", "Date"],
Preprocessor statements are a GNU extension to the Sieve language.
The syntax for a preprocessor statement is similar to that used in
@code{C} programming language, i.e. a pound character (@samp{#})
-followed by a preprocessor directive and its arguments. Any amount of
+followed by a preprocessor directive and its arguments. Any amount of
whitespace can be inserted between the @samp{#} and the directive.
Currently implemented directives are @code{include} and @code{searchpath}.
@@ -386,7 +386,7 @@ Currently implemented directives are @code{include} and
@code{searchpath}.
The @code{#include} directive reads in the contents of the given file.
The contents is ``inserted'' into the text being parsed starting at the
-line where the directive appears. The directive takes two forms:
+line where the directive appears. The directive takes two forms:
@table @code
@item #include "@var{filename}"
@@ -405,7 +405,7 @@ If @var{filename} starts with a directory separator
character
@kwindex #searchpath, sieve
The @code{#searchpath} directive adds its argument to the list of
-directories searched for loadable modules. It has the same effect
+directories searched for loadable modules. It has the same effect
as @command{library-path} Sieve configuration statement
(@pxref{Sieve Configuration, library-path}).
@@ -419,23 +419,23 @@ Syntax: require @var{string};
@end smallexample
The require statement informs the parser that a script makes use of a certain
-extension. Multiple capabilities can be declared using the second form
-of the statement. The actual handling of a capability name depends on
+extension. Multiple capabilities can be declared using the second form
+of the statement. The actual handling of a capability name depends on
its suffix.
If the name starts with @samp{comparator-}, it is understood
-as a request to use the specified comparator. The comparator name
+as a request to use the specified comparator. The comparator name
consists of the characters following the suffix.
If the name starts with @samp{test-}, it means a request to use
-the given test. The test name consists of the characters following
+the given test. The test name consists of the characters following
the suffix.
Otherwise, the capability is understood as a name of an action to be
used.
The @code{require} statement, if present, must be used before any other
-statement that is using the required capability. As an extension, the GNU
+statement that is using the required capability. As an extension, the GNU
sieve allows the @code{require} and any other statements to be
interspersed.
@@ -464,24 +464,24 @@ When processing arguments for @code{require} statement,
GNU libmu_sieve
uses the following algorithm:
@enumerate 1
address@hidden Look up the name in a symbol table. If the name begins with
address@hidden it is looked up in the comparator table. If it
-begins with @samp{test-}, the test table is used instead. Otherwise
address@hidden Look up the name in a symbol table. If the name begins with
address@hidden it is looked up in the comparator table. If it
+begins with @samp{test-}, the test table is used instead. Otherwise
the name is looked up in the action table.
@item If the name is found, the search is terminated.
address@hidden Otherwise, transform the name. First, any @samp{comparator-} or
address@hidden prefix is stripped. Then, any character other than
address@hidden Otherwise, transform the name. First, any @samp{comparator-} or
address@hidden prefix is stripped. Then, any character other than
alphanumeric characters, @samp{.} and @samp{,} is replaced with
-dash (@samp{-}). The name thus obtained is used as a file name
+dash (@samp{-}). The name thus obtained is used as a file name
of an external loadable module.
address@hidden Try to load the module. The module is searched in the
address@hidden Try to load the module. The module is searched in the
following search paths (in the order given):
@enumerate 1
address@hidden Mailutils module directory. By default it is
address@hidden Mailutils module directory. By default it is
@file{$prefix/lib/mailutils}.
@item Sieve library path as given with the @option{-L} options in
@@ -505,7 +505,7 @@ colon-separated list of absolute directories, for example,
@samp{"/usr/lib/mypkg:/lib/foo"}.
In any of these directories, @command{libmu_sieve} first attempts to find
-and load the given filename. If this fails, it tries to append the
+and load the given filename. If this fails, it tries to append the
following suffixes to the file name:
@enumerate 1
@@ -517,11 +517,11 @@ platform, e.g., @samp{.so}, @samp{.sl}, etc.
@item If the module is found, @command{libmu_sieve} executes its
initialization function (see below) and again looks up the name
-in the symbol table. If found, search terminates successfully.
+in the symbol table. If found, search terminates successfully.
@item If either the module is not found, or the symbol wasn't
found after execution of the module initialization function,
-search is terminated with an error status. @command{libmu_sieve} then
+search is terminated with an error status. @command{libmu_sieve} then
issues the following diagnostic message:
@smallexample
@@ -541,11 +541,11 @@ This comparator simply compares the two arguments octet
by octet
@item i;ascii-casemap
It treats uppercase and lowercase characters in the @sc{ascii} subset of
address@hidden as the same. This is the default comparator.
address@hidden as the same. This is the default comparator.
@item i;ascii-numeric
Treats the two arguments as @sc{ascii} representation of decimal
-numbers and compares their numeric values. This comparator must
+numbers and compares their numeric values. This comparator must
be explicitly required prior to use.
@end table
@@ -558,7 +558,7 @@ In the discussion below the following macro-notations are
used:
@table @var
@item match-type
-This tag specifies the matching type to be used with the test. It can
+This tag specifies the matching type to be used with the test. It can
be one of the following:
@table @code
@@ -567,26 +567,26 @@ be one of the following:
@item :is
The @code{:is} match type describes an absolute match; if the contents of
the first string are absolutely the same as the contents of the
-second string, they match. Only the string ``frobnitzm'' is the string
-``frobnitzm''. The null key ``:is'' and only ``:is'' the null value.
+second string, they match. Only the string ``frobnitzm'' is the string
+``frobnitzm''. The null key ``:is'' and only ``:is'' the null value.
This is the default match-type.
@kwindex :contains, sieve
@kwindex contains, sieve
@item :contains
-The @code{:contains} match type describes a substring match. If the value
+The @code{:contains} match type describes a substring match. If the value
argument contains the key argument as a substring, the match is true.
For instance, the string ``frobnitzm'' contains ``frob'' and ``nit'', but
-not ``fbm''. The null key ``'' is contained in all values.
+not ``fbm''. The null key ``'' is contained in all values.
@kwindex :matches, sieve
@kwindex matches, sieve
@item :matches
The @code{:matches} version specifies a wildcard match using the
-characters @samp{*} and @samp{?}. @samp{*} matches zero or more
-characters, and @samp{?} matches a single character. @samp{?} and
+characters @samp{*} and @samp{?}. @samp{*} matches zero or more
+characters, and @samp{?} matches a single character. @samp{?} and
@samp{*} may be escaped as @samp{\\?} and @samp{\\*} in strings to match
-against themselves. The first backslash escapes the second backslash;
+against themselves. The first backslash escapes the second backslash;
together, they escape the @samp{*}.
@kwindex :regex, sieve
@@ -599,7 +599,7 @@ Expressions.
@kwindex value, sieve
@item :value @var{relation}
The @code{:value} match type does a relational comparison between
-strings. Valid values for @var{relation} are:
+strings. Valid values for @var{relation} are:
@table @asis
@item "eq"
@@ -627,7 +627,7 @@ Less than or Equal
This match type first determines the number of the specified entities
(headers, addresses, etc.) in the message and does a relational
comparison of the number of entities to the values specified in the
-test expression. The test expression must be a list of one element.
+test expression. The test expression must be a list of one element.
@end table
@kwindex :comparator, sieve
@@ -653,7 +653,7 @@ if header :comparator "i;ascii-numeric" :is "X-Num" "10"
@end smallexample
@item address-part
-This syntax item is used when testing structured Internet addresses. It
+This syntax item is used when testing structured Internet addresses. It
specifies which part of an address must be used in comparisons.
Exactly one of the following tags may be used:
@@ -661,7 +661,7 @@ Exactly one of the following tags may be used:
@kwindex :all, sieve
@kwindex all, sieve
@item :all
-Use the whole address. This is the default.
+Use the whole address. This is the default.
@kwindex :localpart, sieve
@kwindex localpart, sieve
@@ -677,9 +677,9 @@ Use domain part of the address.
@end table
@emph{Notice}, that @var{match-type} modifiers interact with
-comparators. Some comparators are not suitable for matching with
address@hidden:contains} or @code{:matches}. If this occurs, sieve issues
-an appropriate error message. For example, the statement:
+comparators. Some comparators are not suitable for matching with
address@hidden:contains} or @code{:matches}. If this occurs, sieve issues
+an appropriate error message. For example, the statement:
@smallexample
if header :matches :comparator "i;ascii-numeric"
@@ -692,7 +692,7 @@ comparator `i;ascii-numeric' is incompatible with match
type `:matches'
in call to `header'
@end smallexample
-GNU Sieve supports two kinds of tests. @dfn{Built-in tests} are
+GNU Sieve supports two kinds of tests. @dfn{Built-in tests} are
defined within the library and do not require any external files.
@dfn{External tests} are loadable modules that can be linked in at run
time using the @code{require} statement (@pxref{Require Statement}).
@@ -725,7 +725,7 @@ Tagged arguments:
@table @var
@item address-part
-Selects the address part to compare. Default is the whole email address
+Selects the address part to compare. Default is the whole email address
(@code{:all}).
@item comparator
@@ -748,7 +748,7 @@ A list of address values.
@noindent
The @code{address} test matches Internet addresses in structured headers
-that contain addresses. It returns @code{true} if any header contains any
+that contain addresses. It returns @code{true} if any header contains any
key in the specified part of the address, as modified by
@var{comparator} and @var{match-type} optional arguments.
@@ -756,8 +756,8 @@ This test returns @code{true} if any combination of the
@var{header-names} and @var{key-list} arguments match.
The @code{address} primitive never acts on the phrase part of an email
-address, nor on comments within that address. Use the @code{header} test
-instead. It also never acts on group names, although it does act on the
+address, nor on comments within that address. Use the @code{header} test
+instead. It also never acts on group names, although it does act on the
addresses within the group construct.
Example:
@@ -771,8 +771,8 @@ if address :is :all "from" "tim@@example.com"
@end deftypefn
@deftypefn Test {} size [:over | :under] @var{limit}(number)
-The @code{size} test deals with the size of a message. The required
-argument @var{limit} represents the size of the message in bytes. It
+The @code{size} test deals with the size of a message. The required
+argument @var{limit} represents the size of the message in bytes. It
may be suffixed with the following quantifiers:
@table @samp
@@ -796,7 +796,7 @@ If the argument is @samp{:under}, and the size of the
message is less than
the @var{number}, the test is true; otherwise, it is false.
Otherwise, the test is true only if the size of the message equals
-exactly @var{number}. This is a GNU extension.
+exactly @var{number}. This is a GNU extension.
The size of a message is defined to be the number of octets from the
initial header until the last character in the message body.
@@ -813,7 +813,7 @@ Tagged arguments:
@table @var
@item address-part
-Selects the address part to compare. Default is the whole email address
+Selects the address part to compare. Default is the whole email address
(@code{:all}).
@item comparator
@@ -859,7 +859,7 @@ List of message header names.
@sp 1
@noindent
The @code{exists} test is @code{true} if the headers listed in
address@hidden argument exist within the message. All of the headers
address@hidden argument exist within the message. All of the headers
must exist or the test is false.
The following example throws out mail that doesn't have a From header
@@ -909,15 +909,15 @@ A list of header values.
@sp 1
@noindent
The @code{header} test evaluates to true if any header name matches any
-key. The type of match is specified by the optional match argument,
+key. The type of match is specified by the optional match argument,
which defaults to ":is" if not explicitly given.
The test returns @code{true} if any combination of the @var{header-names}
and @var{key-list} arguments match.
If a header listed in @var{header-names} exists, it contains the null
-key (@samp{""}). However, if the named header is not present, it
-does not contain the null key. So if a message contained the header
+key (@samp{""}). However, if the named header is not present, it
+does not contain the null key. So if a message contained the header
@smallexample
X-Caffeine: C8H10N4O2
@@ -949,12 +949,12 @@ if numaddr @var{args}
@}
@end smallexample
@*Description:
-This test is provided as an example of loadable extension tests. You
+This test is provided as an example of loadable extension tests. You
must use @samp{require "test-numaddr"} statement before actually using
it.
The @code{numaddr} test counts Internet addresses in structured headers
-that contain addresses. It returns true if the total number of
+that contain addresses. It returns true if the total number of
addresses satisfies the requested relation.
@kwindex :over
@@ -985,17 +985,17 @@ if spamd @var{args}
@end smallexample
@*Description:
-This test is an interface to SpamAssassin filter. It connects to the
+This test is an interface to SpamAssassin filter. It connects to the
@command{spamd} daemon using connection parameters specified by tagged
arguments @code{:host} and @code{:port} (if the daemon is listening on
an INET socket), or @code{:socket} (if the daemon is listening on a
UNIX socket) and returns true, if SpamAssassin qualifies the message
-as spam. Tagged argument @var{limit} alters the default behavior. Its
-value is a string representation of a floating point number. If
+as spam. Tagged argument @var{limit} alters the default behavior. Its
+value is a string representation of a floating point number. If
the tag @code{:over} is used, then the test returns true if the spam
score returned from SpamAssassin is greater than @var{limit}.
Otherwise, if @code{:under} is used, the test returns true if the spam
-score is less than @var{limit}. The comparison takes into account
+score is less than @var{limit}. The comparison takes into account
three decimal digits.
Tagged argument @code{:user} allows to select a specific user profile.
@@ -1046,8 +1046,8 @@ if list @var{args}
@end smallexample
@*Description:
The @code{list} test evaluates to true if any of @var{headers} match any
-key from @var{keys}. Each header is regarded as containing a list of
-keywords. By default, comma is assumed as list separator. This can be
+key from @var{keys}. Each header is regarded as containing a list of
+keywords. By default, comma is assumed as list separator. This can be
overridden by specifying the @code{:delim} tag, whose value is a
string consisting of valid list delimiter characters.
@@ -1098,7 +1098,7 @@ date is after the given date, the result is false.
If no tagged argument is supplied, @code{:after} is assumed.
-Almost any date format is understood. @xref{Date Input Formats}, for
+Almost any date format is understood. @xref{Date Input Formats}, for
a detailed information on date formats.
@*Example:
@@ -1148,19 +1148,19 @@ These actions are described in detail below.
@deffn Action stop
-The @code{stop} action ends all processing. If no actions have been
+The @code{stop} action ends all processing. If no actions have been
executed, then the @code{keep} action is taken.
@end deffn
@deffn Action keep
The effect of this action is to preserve the current message in the
-mailbox. This action is executed if no other action has been executed.
+mailbox. This action is executed if no other action has been executed.
@end deffn
@deffn Action discard
address@hidden silently throws away the current message. No notification
address@hidden silently throws away the current message. No notification
is returned to the sender, the message is deleted from the mailbox.
Example:
@@ -1192,12 +1192,12 @@ Specifies the permissions to use, if the mailbox is
created.
@end table
The @code{fileinto} action delivers the message into the specified
-folder. If the folder is local, it is created using permissions
address@hidden, for regular files, and @samp{0700} for directories. This
-default can be changed by using the @code{:permissions} tag. Its
+folder. If the folder is local, it is created using permissions
address@hidden, for regular files, and @samp{0700} for directories. This
+default can be changed by using the @code{:permissions} tag. Its
argument is a mode specification, similar to that used by
address@hidden shell utility. It is a list of permissions settings
-separated by commas. Each setting begins with one of the following
address@hidden shell utility. It is a list of permissions settings
+separated by commas. Each setting begins with one of the following
letters:
@table @asis
@@ -1209,7 +1209,7 @@ Set permissions for users not in the file's group.
@end table
This letter must be followed by either @samp{+} or @samp{=} and the
-list of permissions to be set. This latter list is a string
+list of permissions to be set. This latter list is a string
containing any one or both of the following characters:
@table @asis
@@ -1237,17 +1237,17 @@ value.
@item
Only @code{r} and @code{w} permissions can be set, since other
-permissions do not seem to be useful for mailboxes. However, for
+permissions do not seem to be useful for mailboxes. However, for
mailboxes that have a directory structure (such as maildir and MH),
any settings in @samp{g} and @samp{o} sets imply setting the
executable bit.
@item
-Owner's permissions cannot be set. The owner always has all
+Owner's permissions cannot be set. The owner always has all
permissions on the mailbox he created.
@item
-The @code{:permissions} settings apply only to local mailboxes. They
+The @code{:permissions} settings apply only to local mailboxes. They
are ignored for remote mailboxes.
@end enumerate
@@ -1256,9 +1256,9 @@ are ignored for remote mailboxes.
@deffn Action reject @var{reason}
The optional @code{reject} action refuses delivery of a message by sending
-back a message delivery notification to the sender. It resends the
+back a message delivery notification to the sender. It resends the
message to the sender, wrapping it in a ``reject'' form, noting that it
-was rejected by the recipient. The required argument @var{reason} is
+was rejected by the recipient. The required argument @var{reason} is
a string specifying the reason for rejecting the message.
Example:
@@ -1344,15 +1344,15 @@ if header :mime :matches "Content-Type"
@deffn Action redirect @var{address}
The @code{redirect} action is used to send the message to another user at
-a supplied @var{address}, as a mail forwarding feature does. This action
+a supplied @var{address}, as a mail forwarding feature does. This action
makes no changes to the message body or existing headers, but it may add
-new headers. It also modifies the envelope recipient.
+new headers. It also modifies the envelope recipient.
The @code{redirect} command performs an MTA-style ``forward'' --- that
is, what you get from a @file{.forward} file using @code{sendmail} under
address@hidden The address on the SMTP envelope is replaced with the one on
address@hidden The address on the SMTP envelope is replaced with the one on
the @code{redirect} command and the message is sent back
-out. @emph{Notice}, that it differs from the MUA-style forward, which
+out. @emph{Notice}, that it differs from the MUA-style forward, which
creates a new message with a different sender and message ID, wrapping
the old message in a new one.
@end deffn
@@ -1361,7 +1361,7 @@ the old message in a new one.
@subsection External Actions
@UNREVISED
GNU Mailutils is shipped with a set of external Sieve
-actions. These actions are compiled as loadable modules and must be
+actions. These actions are compiled as loadable modules and must be
required prior to use (@pxref{Require Statement}).
@deftypefn Action {} moderator [:keep] [:address @var{address}(string)] @
@@ -1391,20 +1391,20 @@ Replying to part 3 while adding an `Approved:' header
with the list
password in it approves the submission.
The @code{moderator} action spawns an inferior Sieve machine and
-filters the original submission (part 2) through it. If the inferior
+filters the original submission (part 2) through it. If the inferior
machine marks the message as deleted, the action replies to the
-control message, thereby causing the submission to be discarded. The
+control message, thereby causing the submission to be discarded. The
@samp{From:} address of the reply can be modified using
address@hidden:address} tag. After discarding the message, @code{moderator}
address@hidden:address} tag. After discarding the message, @code{moderator}
marks it as deleted, unless it is given @code{:keep} tag.
The argument of @code{:source} tag, if given, specifies the Sieve
-source file to be used on the message. If @code{:tag} is not present,
+source file to be used on the message. If @code{:tag} is not present,
@code{moderator} will create and use a copy of the existing Sieve machine.
The action checks the message structure: it will bail out if the message
does not have exactly 3 MIME parts, or if parts 2 and 3 are not of
address@hidden/rfc822} type. It is the responsibility of the caller to
address@hidden/rfc822} type. It is the responsibility of the caller to
make sure the message is actually a valid Mailman moderation request
(see the example below).
@@ -1429,7 +1429,7 @@ if pipe @var{args}
@end smallexample
@*Description:
The @code{pipe} action sends executes a command specified by its
-argument and sends the entire message to its standard input. The
+argument and sends the entire message to its standard input. The
@var{command} argument supplies the command line.
The envelope of the message is included, if the @code{:envelope} tag
@@ -1461,15 +1461,15 @@ vacation @var{args};
@end smallexample
@*Description:
The @code{vacation} action returns a message with @var{reply-text} to
-the sender. It is intended to inform the sender that the recipient is
+the sender. It is intended to inform the sender that the recipient is
not currently reading his mail.
If the @code{:subject} tag is given, its argument sets the subject of
-the message. Otherwise, the subject is formed by prefixing original
+the message. Otherwise, the subject is formed by prefixing original
subject with @samp{Re:}, or @var{prefix}, given with the
address@hidden:reply_prefix} tag. Before prefixing, any original prefixes
address@hidden:reply_prefix} tag. Before prefixing, any original prefixes
matching extended regular expression @var{expr} (@code{:reply_regex}
-tag) are stripped from the subject line. If @code{:reply_regex} is not
+tag) are stripped from the subject line. If @code{:reply_regex} is not
specified, the default regexp is @samp{^re: *}.
The @code{:aliases} tag instructs @code{vacation} to handle messages
@@ -1477,9 +1477,9 @@ for any address in @var{addrlist} in the same manner as
those received
for the user's principal email.
Before processing, @code{vacation} compares the sender address with
-its @dfn{address exclusion list}. Elements of this list are extended
-case-insensitive regular expressions. If the sender address matches
-any of these expressions, the message will not be replied. The default
+its @dfn{address exclusion list}. Elements of this list are extended
+case-insensitive regular expressions. If the sender address matches
+any of these expressions, the message will not be replied. The default
exclusion list is:
@smallexample
@@ -1495,10 +1495,10 @@ exclusion list is:
New entries can be added to this list using @code{:addresses} tag.
-The @code{:days} tag sets the @dfn{reply interval}. A reply is sent to
-each sender once in @var{ndays} days. GNU Sieve keeps track of
+The @code{:days} tag sets the @dfn{reply interval}. A reply is sent to
+each sender once in @var{ndays} days. GNU Sieve keeps track of
sender addresses and dates in a DBM file @file{.vacation} stored in
-the user's home directory. This tag is available only if Mailutils is
+the user's home directory. This tag is available only if Mailutils is
compiled with DBM support.
@end deftypefn
@@ -1524,15 +1524,15 @@ The meaning of optional flags is the same as in shell
``here document''
construct: the dash strips all leading tab characters from the string body,
thus allowing it to be indented in a natural fashion; @var{delimiter}
introduces the new end-of-text delimiter instead of the default
-dot. If @var{delimiter} starts with a backslash, no preprocessing will
+dot. If @var{delimiter} starts with a backslash, no preprocessing will
be performed within a string.
@item Handling of the @code{require} statement.
@itemize
@item According to the RFC an error must occur if a @code{require} appears
-after a command other than @code{require}. The GNU sieve library allows
-interspersing the @code{require} and other statements. The only
+after a command other than @code{require}. The GNU sieve library allows
+interspersing the @code{require} and other statements. The only
requirement is that @code{require} must occur before a statement that is
using the required capability (@pxref{Require Statement}).
@@ -1548,12 +1548,12 @@ scan the headers from each part of a multipart message.
@item @code{size} test
The @code{size} test allows to omit the optional argument
-(:over|:under). In this case exact equality is assumed.
+(:over|:under). In this case exact equality is assumed.
@item @code{envelope} test
The only value that can be meaningfully used as the first required
-argument of an @code{envelope} test is @samp{from}. This limitation
+argument of an @code{envelope} test is @samp{from}. This limitation
may disappear from the subsequent releases.
@item @code{fileinto} action
@@ -1564,7 +1564,7 @@ in case it is created (@pxref{fileinto}).
@item Match type optional argument.
Along with the usual @code{:is}, @code{:matches} and @code{contains}
-matching type, GNU sieve library understands @code{:regex} type. This
+matching type, GNU sieve library understands @code{:regex} type. This
matching type toggles POSIX Extended Regular Expression matching.
@end enumerate
diff --git a/doc/texinfo/usage.texi b/doc/texinfo/usage.texi
index ee2e2ec..fe79375 100644
--- a/doc/texinfo/usage.texi
+++ b/doc/texinfo/usage.texi
@@ -3,15 +3,13 @@
@c 2008, 2010, 2011 Free Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************
address@hidden Usage Vars
address@hidden Configuring Help Summary
Running @address@hidden --help} displays the short usage summary
-for @var{prog} utility (@pxref{Common Options}). This summary is
-organized by @dfn{groups} of semantically close options. The options
+for @var{prog} utility (@pxref{Common Options}). This summary is
+organized by @dfn{groups} of semantically close options. The options
within each group are printed in the following order: a short option,
eventually followed by a list of corresponding long option names,
-followed by a short description of the option. For example, here is an
+followed by a short description of the option. For example, here is an
excerpt from the actual @kbd{sieve --help} output:
@verbatim
@@ -22,12 +20,12 @@ excerpt from the actual @kbd{sieve --help} output:
@vrindex ARGP_HELP_FMT, environment variable
The exact visual representation of the help output is configurable via
address@hidden environment variable. The value of this variable
-is a comma-separated list of @dfn{format variable} assignments. There
-are two kinds of format variables. An @dfn{offset variable} keeps the
address@hidden environment variable. The value of this variable
+is a comma-separated list of @dfn{format variable} assignments. There
+are two kinds of format variables. An @dfn{offset variable} keeps the
offset of some part of help output text from the leftmost column on
-the screen. A @dfn{boolean} variable is a flag that toggles some
-output feature on or off. Depending on the type of the corresponding
+the screen. A @dfn{boolean} variable is a flag that toggles some
+output feature on or off. Depending on the type of the corresponding
variable, there are two kinds of assignments:
@table @asis
@@ -45,8 +43,8 @@ numeric value to be assigned to the variable.
@item Boolean assignment
-To assign @code{true} value to a variable, simply put this variable name. To
-assign @code{false} value, prefix the variable name with @samp{no-}. For
+To assign @code{true} value to a variable, simply put this variable name. To
+assign @code{false} value, prefix the variable name with @samp{no-}. For
example:
@smallexample
@@ -78,7 +76,7 @@ argument is only shown with the long one, for example:
@noindent
and a message indicating that the argument is applicable to both
-forms is printed below the options. This message can be disabled
+forms is printed below the options. This message can be disabled
using @code{dup-args-note} (see below).
The default is false.
@@ -93,12 +91,12 @@ Mandatory or optional arguments to long options are also
mandatory or
optional for any corresponding short options.
@end quotation
-Setting @code{no-dup-args-note} inhibits this message. Normally, only
+Setting @code{no-dup-args-note} inhibits this message. Normally, only
one of variables @code{dup-args} or @code{dup-args-note} should be set.
@end deftypevr
@deftypevr {Help Output} offset short-opt-col
-Column in which short options start. Default is 2.
+Column in which short options start. Default is 2.
@smallexample
@group
@@ -111,7 +109,7 @@ $ @kbd{ARGP_HELP_FMT=short-opt-col=6 sieve --help|grep
ARCHIVE}
@end deftypevr
@deftypevr {Help Output} offset long-opt-col
-Column in which long options start. Default is 6. For example:
+Column in which long options start. Default is 6. For example:
@smallexample
@group
@@ -124,9 +122,9 @@ $ @kbd{ARGP_HELP_FMT=long-opt-col=16 sieve --help|grep
ADDRESS}
@end deftypevr
@deftypevr {Help Output} offset doc-opt-col
-Column in which @dfn{doc options} start. A doc option isn't actually
+Column in which @dfn{doc options} start. A doc option isn't actually
an option, but rather an arbitrary piece of documentation that is
-displayed in much the same manner as the options. For example, in
+displayed in much the same manner as the options. For example, in
the output of @command{folder --help}:
@verbatim
@@ -138,7 +136,7 @@ GNU MH folder
@end verbatim
@noindent
-the string @samp{Actions are:} is a doc option. Thus, if you set
+the string @samp{Actions are:} is a doc option. Thus, if you set
@kbd{ARGP_HELP_FMT=doc-opt-col=6} the above part of the help output
will look as follows:
@@ -152,7 +150,7 @@ GNU MH folder
@end deftypevr
@deftypevr {Help Output} offset opt-doc-col
-Column in which option description starts. Default is 29.
+Column in which option description starts. Default is 29.
@smallexample
@group
@@ -172,8 +170,8 @@ Notice, that the description starts on a separate line if
@end deftypevr
@deftypevr {Help Output} offset header-col
-Column in which @dfn{group headers} are printed. A group header is a
-descriptive text preceding an option group. For example, in the
+Column in which @dfn{group headers} are printed. A group header is a
+descriptive text preceding an option group. For example, in the
following text:
@verbatim
@@ -188,10 +186,10 @@ The default value is 1.
@end deftypevr
@deftypevr {Help Output} offset usage-indent
-Indentation of wrapped usage lines. Affects @option{--usage}
-output. Default is 12.
+Indentation of wrapped usage lines. Affects @option{--usage}
+output. Default is 12.
@end deftypevr
@deftypevr {Help Output} offset rmargin
-Right margin of the text output. Used for wrapping.
+Right margin of the text output. Used for wrapping.
@end deftypevr
diff --git a/libmailutils/cfg/lexer.l b/libmailutils/cfg/lexer.l
index 3762d5d..fcf6fdd 100644
--- a/libmailutils/cfg/lexer.l
+++ b/libmailutils/cfg/lexer.l
@@ -100,7 +100,7 @@ P [1-9][0-9]*
yylval.string = _mu_line_finish ();
return MU_TOK_IDENT; }
/* Strings */
-[a-zA-Z0-9_\./:\*=-]+ { _mu_line_begin ();
+[a-zA-Z0-9_\./:address@hidden { _mu_line_begin ();
_mu_line_add (yytext, yyleng);
yylval.string = _mu_line_finish ();
return MU_TOK_STRING; }
diff --git a/pop3d/bulletin.c b/pop3d/bulletin.c
index 7bfd052..47efe61 100644
--- a/pop3d/bulletin.c
+++ b/pop3d/bulletin.c
@@ -133,6 +133,8 @@ read_bulletin_db (size_t *pnum)
return rc;
}
+ mu_dbm_safety_set_flags (db, DEFAULT_GROUP_DB_SAFETY);
+
rc = mu_dbm_safety_check (db);
if (rc)
{
@@ -225,6 +227,8 @@ write_bulletin_db (size_t num)
return rc;
}
+ mu_dbm_safety_set_flags (db, DEFAULT_GROUP_DB_SAFETY);
+
rc = mu_dbm_safety_check (db);
if (rc && rc != ENOENT)
{
diff --git a/pop3d/logindelay.c b/pop3d/logindelay.c
index 21794ca..f61d6d2 100644
--- a/pop3d/logindelay.c
+++ b/pop3d/logindelay.c
@@ -32,8 +32,10 @@ open_stat_db (int mode)
return NULL;
}
+ mu_dbm_safety_set_flags (db, DEFAULT_GROUP_DB_SAFETY);
+
rc = mu_dbm_safety_check (db);
- if (rc)
+ if (rc && rc != ENOENT)
{
mu_diag_output (MU_DIAG_ERROR,
_("statistics db fails safety check: %s"),
diff --git a/pop3d/pop3d.h b/pop3d/pop3d.h
index 2ae6286..d61f248 100644
--- a/pop3d/pop3d.h
+++ b/pop3d/pop3d.h
@@ -201,6 +201,17 @@ extern char *apop_database_name;
extern int apop_database_safety;
extern int apop_database_safety_set;
+/* Safety checks for group-rw database files, such as stat and bulletin
+ databases */
+
+#define DEFAULT_GROUP_DB_SAFETY \
+ (MU_FILE_SAFETY_WORLD_WRITABLE| \
+ MU_FILE_SAFETY_WORLD_READABLE| \
+ MU_FILE_SAFETY_LINKED_WRDIR| \
+ MU_FILE_SAFETY_DIR_IWGRP| \
+ MU_FILE_SAFETY_DIR_IWOTH)
+
+
extern pop3d_command_handler_t pop3d_find_command (const char *name);
extern int pop3d_stat (char *);
hooks/post-receive
--
GNU Mailutils
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [SCM] GNU Mailutils branch, master, updated. release-2.2-426-g3ec5d07,
Sergey Poznyakoff <=