X-Git-Url: http://cgit.sxemacs.org/?a=blobdiff_plain;f=texi%2Fsieve.texi;h=44f17ebdaa15cc33c9180976bbac6731c9e27047;hb=db5eb793e0a61a938a6d537604924c04e43fcb65;hp=99be2da9567c13b77a22f11378c73f00cbe7a215;hpb=ba87321f56214ad2902cf2c2ef2ffa2339f78c90;p=gnus diff --git a/texi/sieve.texi b/texi/sieve.texi index 99be2da95..44f17ebda 100644 --- a/texi/sieve.texi +++ b/texi/sieve.texi @@ -1,11 +1,33 @@ \input texinfo @c -*-texinfo-*- +@include gnus-overrides.texi + @setfilename sieve @settitle Emacs Sieve Manual +@documentencoding UTF-8 @synindex fn cp @synindex vr cp @synindex pg cp -@dircategory Emacs + +@copying +This file documents the Emacs Sieve package, for server-side mail filtering. + +Copyright @copyright{} 2001--2014 Free Software Foundation, Inc. + +@quotation +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 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 the freedom to copy and +modify this GNU manual.'' +@end quotation +@end copying + +@dircategory Emacs network features @direntry * Sieve: (sieve). Managing Sieve scripts in Emacs. @end direntry @@ -14,68 +36,27 @@ @end iftex @setchapternewpage odd -@ifnottex - -This file documents the Emacs Sieve package. - -Copyright (C) 2001 Free Software Foundation, Inc. - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.1 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'' in the Emacs manual. - -(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.'' - -This document is part of a collection distributed under the GNU Free -Documentation License. If you want to distribute this document -separately from the collection, you can do so by adding a copy of the -license to the document, as described in section 6 of the license. -@end ifnottex - -@tex - @titlepage +@ifset WEBHACKDEVEL +@title Emacs Sieve Manual (DEVELOPMENT VERSION) +@end ifset +@ifclear WEBHACKDEVEL @title Emacs Sieve Manual +@end ifclear @author by Simon Josefsson @page - @vskip 0pt plus 1filll -Copyright @copyright{} 2001 Free Software Foundation, Inc. - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.1 or -any later version published by the Free Software Foundation; with the -Invariant Sections being none, 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'' in the Emacs manual. - -(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.'' - -This document is part of a collection distributed under the GNU Free -Documentation License. If you want to distribute this document -separately from the collection, you can do so by adding a copy of the -license to the document, as described in section 6 of the license. +@insertcopying @end titlepage -@page -@end tex +@summarycontents +@contents @node Top @top Sieve Support for Emacs -This manual documents the Emacs Sieve package. - -It is intended as a users manual for Sieve Mode and Manage Sieve, and +This is intended as a users manual for Sieve Mode and Manage Sieve, and as a reference manual for the @samp{sieve-manage} protocol Emacs Lisp API. @@ -83,7 +64,9 @@ Sieve is a language for server-side filtering of mail. The language is documented in RFC 3028. This manual does not attempt to document the language, so keep RFC 3028 around. -A good online Sieve resources is @uref{http://www.cyrusoft.com/sieve/}. +@ifnottex +@insertcopying +@end ifnottex @menu * Installation:: Getting ready to use the package. @@ -92,6 +75,7 @@ A good online Sieve resources is @uref{http://www.cyrusoft.com/sieve/}. * Examples :: A few Sieve code snippets. * Manage Sieve API :: Interfacing to the Manage Sieve Protocol API. * Standards:: A summary of RFCs and working documents used. +* GNU Free Documentation License:: The license for this documentation. * Index:: Function and variable index. @end menu @@ -111,7 +95,7 @@ commands in your @code{~/.emacs}: (autoload 'sieve-mode "sieve-mode") @end lisp @lisp -(setq auto-mode-alist (cons '("\\.si\\(v\\|eve\\)\\'" . sieve-mode) +(setq auto-mode-alist (cons '("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode) auto-mode-alist)) @end lisp @@ -135,7 +119,7 @@ indentation. Sieve mode has its own abbrev table (@code{sieve-mode-syntax-table}). In addition to the editing utility functions, Sieve mode also contains -bindings to manage Sieve scripts remotely. @pxref{Managing Sieve}. +bindings to manage Sieve scripts remotely. @xref{Managing Sieve}. @table @kbd @@ -162,11 +146,11 @@ on a remote server. It can be invoked with @kbd{M-x sieve-manage RET}, which queries the user for a server and if necessary, user credentials to use. -When a server has been succesfully contacted, the Manage Sieve buffer +When a server has been successfully contacted, the Manage Sieve buffer looks something like: @example -Server : mailserver:2000 +Server : mailserver:sieve 2 scripts on server, press RET on a script name edits it, or press RET on to create a new script. @@ -176,7 +160,7 @@ press RET on to create a new script. @end example One of the scripts are highlighted, and standard point navigation -commands (@kbd{}, @kbd{} etc) can be used to navigate the +commands (@kbd{}, @kbd{} etc.)@: can be used to navigate the list. The following commands are available in the Manage Sieve buffer: @@ -229,7 +213,12 @@ Bury the Manage Sieve buffer without closing the connection. @kindex ? @kindex h @findex sieve-help -Displays help in the minibuffer. +Displays help in the minibuffer. + +@item Q +@kindex Q +@findex sieve-manage-quit +Quit Manage Sieve and close the connection. @end table @@ -250,18 +239,18 @@ the @code{fileinto} command. require "fileinto"; if address "sender" "owner-w3-beta@@xemacs.org" @{ - fileinto "INBOX.w3-beta"; + fileinto "INBOX.w3-beta"; @} @end example -A few mailing lists do not use the @samp{Sender:} header, but does -contain some unique identifier in some other header. The following is -not a complete script, it assumes that @code{fileinto} has already been +A few mailing lists do not use the @samp{Sender:} header, but has a +unique identifier in some other header. The following is not a +complete script, it assumes that @code{fileinto} has already been required. @example if header :contains "Delivered-To" "auc-tex@@sunsite.dk" @{ - fileinto "INBOX.auc-tex"; + fileinto "INBOX.auc-tex"; @} @end example @@ -272,7 +261,7 @@ has been required. @example if address ["to", "cc"] "kerberos@@mit.edu" @{ - fileinto "INBOX.kerberos"; + fileinto "INBOX.kerberos"; @} @end example @@ -287,17 +276,13 @@ in the @code{sieve} group (@kbd{M-x customize-group RET sieve RET}): @table @code -@item sieve-manage-default-user -@vindex sieve-manage-default-user -Sets the default username. - @item sieve-manage-default-port @vindex sieve-manage-default-port Sets the default port to use, the suggested port number is @code{2000}. @item sieve-manage-log @vindex sieve-manage-log -If non-nil, should be a string naming a buffer where a protocol trace +If non-@code{nil}, should be a string naming a buffer where a protocol trace is dumped (for debugging purposes). @end table @@ -325,7 +310,7 @@ Authenticate to the server. @item sieve-manage-capability @findex sieve-manage-capability -Return a list of capabilities the server support. +Return a list of capabilities the server supports. @item sieve-manage-listscripts @findex sieve-manage-listscripts @@ -333,7 +318,8 @@ List scripts on the server. @item sieve-manage-havespace @findex sieve-manage-havespace -Returns non-nil iff server have roam for a script of given size. +Return non-@code{nil} if the server has room for a script of given +size. @item sieve-manage-getscript @findex sieve-manage-getscript @@ -362,18 +348,19 @@ lists the relevant ones. They can all be fetched from @item RFC3028 Sieve: A Mail Filtering Language. -@item draft-martin-managesieve-03 +@item RFC5804 A Protocol for Remotely Managing Sieve Scripts @end table +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include doclicense.texi @node Index -@chapter Index +@unnumbered Index @printindex cp -@summarycontents -@contents @bye @c End: