# HG changeset patch # User Reiner Steib # Date 1091453930 0 # Node ID fd8097053f040fcfb40c863d131204578add7d03 # Parent b6e48fab7ff32be7f6e18b02e950e84265a876cc * Makefile.in, makefile.w32-in: Added PGG and Sieve files. * emacs-mime.texi, gnus-faq.texi, gnus.texi, message.texi: Import from the v5_10 branch of the Gnus repository. Change setfilename. diff -r b6e48fab7ff3 -r fd8097053f04 man/ChangeLog --- a/man/ChangeLog Mon Aug 02 13:28:45 2004 +0000 +++ b/man/ChangeLog Mon Aug 02 13:38:50 2004 +0000 @@ -1,7 +1,11 @@ 2004-08-02 Reiner Steib + * Makefile.in, makefile.w32-in: Added PGG and Sieve files. + * pgg.texi, sieve.texi: Import from the v5_10 branch of the Gnus - repository. + repository. Change setfilename. + + * emacs-mime.texi, gnus-faq.texi, gnus.texi, message.texi: Ditto. 2004-07-18 Luc Teirlinck diff -r b6e48fab7ff3 -r fd8097053f04 man/Makefile.in --- a/man/Makefile.in Mon Aug 02 13:28:45 2004 +0000 +++ b/man/Makefile.in Mon Aug 02 13:38:50 2004 +0000 @@ -35,18 +35,20 @@ MAKEINFO = makeinfo INFO_TARGETS = ../info/emacs ../info/emacs-xtra ../info/ccmode ../info/cl \ ../info/dired-x ../info/ediff ../info/forms ../info/gnus \ - ../info/info ../info/message ../info/mh-e ../info/reftex \ + ../info/message ../info/sieve ../info/pgg ../info/emacs-mime \ + ../info/info ../info/mh-e ../info/reftex \ ../info/sc ../info/vip ../info/viper ../info/widget \ ../info/efaq ../info/ada-mode ../info/autotype ../info/calc \ ../info/idlwave ../info/eudc ../info/ebrowse ../info/pcl-cvs \ - ../info/woman ../info/emacs-mime ../info/eshell \ + ../info/woman ../info/eshell \ ../info/speedbar ../info/tramp ../info/ses ../info/smtpmail \ ../info/flymake DVI_TARGETS = emacs.dvi calc.dvi cc-mode.dvi cl.dvi dired-x.dvi \ - ediff.dvi forms.dvi gnus.dvi message.dvi mh-e.dvi \ + ediff.dvi forms.dvi gnus.dvi message.dvi emacs-mime.dvi \ + gnus.dvi message.dvi sieve.dvi pgg.dvi mh-e.dvi \ reftex.dvi sc.dvi vip.dvi viper.dvi widget.dvi faq.dvi \ ada-mode.dvi autotype.dvi idlwave.dvi eudc.dvi ebrowse.dvi \ - pcl-cvs.dvi woman.dvi emacs-mime.dvi eshell.dvi \ + pcl-cvs.dvi woman.dvi eshell.dvi \ speedbar.dvi tramp.dvi ses.dvi smtpmail.dvi flymake.dvi \ emacs-xtra.dvi INFOSOURCES = info.texi @@ -185,6 +187,7 @@ forms.dvi: forms.texi $(ENVADD) $(TEXI2DVI) ${srcdir}/forms.texi +# gnus/message/emacs-mime/sieve/pgg are part of Gnus: ../info/gnus: gnus.texi cd $(srcdir); $(MAKEINFO) gnus.texi gnus.dvi: gnus.texi @@ -192,11 +195,22 @@ $(ENVADD) $(TEXI2DVI) gnustmp.texi cp gnustmp.dvi $*.dvi rm gnustmp.* - ../info/message: message.texi cd $(srcdir); $(MAKEINFO) message.texi message.dvi: message.texi $(ENVADD) $(TEXI2DVI) ${srcdir}/message.texi +../info/sieve: sieve.texi + cd $(srcdir); $(MAKEINFO) sieve.texi +sieve.dvi: sieve.texi + $(ENVADD) $(TEXI2DVI) ${srcdir}/sieve.texi +../info/emacs-mime: emacs-mime.texi + cd $(srcdir); $(MAKEINFO) emacs-mime.texi +emacs-mime.dvi: emacs-mime.texi + $(ENVADD) $(TEXI2DVI) ${srcdir}/emacs-mime.texi +../info/pgg: pgg.texi + cd $(srcdir); $(MAKEINFO) pgg.texi +pgg.dvi: pgg.texi + $(ENVADD) $(TEXI2DVI) ${srcdir}/pgg.texi ../info/mh-e: mh-e.texi cd $(srcdir); $(MAKEINFO) mh-e.texi @@ -274,11 +288,6 @@ speedbar.dvi: speedbar.texi $(ENVADD) $(TEXI2DVI) ${srcdir}/speedbar.texi -../info/emacs-mime: emacs-mime.texi - cd $(srcdir); $(MAKEINFO) emacs-mime.texi -emacs-mime.dvi: emacs-mime.texi - $(ENVADD) $(TEXI2DVI) ${srcdir}/emacs-mime.texi - ../info/tramp: tramp.texi cd $(srcdir); $(MAKEINFO) -D emacs tramp.texi tramp.dvi: tramp.texi diff -r b6e48fab7ff3 -r fd8097053f04 man/emacs-mime.texi --- a/man/emacs-mime.texi Mon Aug 02 13:28:45 2004 +0000 +++ b/man/emacs-mime.texi Mon Aug 02 13:38:50 2004 +0000 @@ -1,22 +1,61 @@ -\input texinfo @c -*-mode: texinfo; coding: latin-1 -*- +\input texinfo @setfilename ../info/emacs-mime @settitle Emacs MIME Manual @synindex fn cp @synindex vr cp @synindex pg cp +@dircategory Emacs +@direntry +* Emacs MIME: (emacs-mime). The MIME de/composition library. +@end direntry +@iftex +@finalout +@end iftex +@setchapternewpage odd -@copying +@ifnottex + This file documents the Emacs MIME interface functionality. -Copyright (C) 1998, 1999, 2000, 2002 Free Software Foundation, Inc. +Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003 + 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.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 +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 +@title Emacs MIME Manual + +@author by Lars Magne Ingebrigtsen +@page + +@vskip 0pt plus 1filll +Copyright @copyright{} 1998, 1999, 2000, 2001, 2002, 2003 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. @@ -28,766 +67,58 @@ 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 quotation -@end copying +@end titlepage +@page -@dircategory Emacs -@direntry -* MIME: (emacs-mime). Emacs MIME de/composition library. -@end direntry -@iftex -@finalout -@end iftex -@setchapternewpage odd - -@titlepage -@title Emacs MIME Manual - -@author by Lars Magne Ingebrigtsen -@page -@vskip 0pt plus 1filll -@insertcopying -@end titlepage - +@end tex @node Top @top Emacs MIME This manual documents the libraries used to compose and display -@sc{mime} messages. +@acronym{MIME} messages. -This is not a manual meant for users; it's a manual directed at people -who want to write functions and commands that manipulate @sc{mime} -elements. +This manual is directed at users who want to modify the behaviour of +the @acronym{MIME} encoding/decoding process or want a more detailed +picture of how the Emacs @acronym{MIME} library works, and people who want +to write functions and commands that manipulate @acronym{MIME} elements. -@sc{mime} is short for @dfn{Multipurpose Internet Mail Extensions}. +@acronym{MIME} is short for @dfn{Multipurpose Internet Mail Extensions}. This standard is documented in a number of RFCs; mainly RFC2045 (Format of Internet Message Bodies), RFC2046 (Media Types), RFC2047 (Message -Header Extensions for Non-ASCII Text), RFC2048 (Registration +Header Extensions for Non-@acronym{ASCII} Text), RFC2048 (Registration Procedures), RFC2049 (Conformance Criteria and Examples). It is highly -recommended that anyone who intends writing @sc{mime}-compliant software +recommended that anyone who intends writing @acronym{MIME}-compliant software read at least RFC2045 and RFC2047. @menu +* Decoding and Viewing:: A framework for decoding and viewing. +* Composing:: @acronym{MML}; a language for describing @acronym{MIME} parts. * Interface Functions:: An abstraction over the basic functions. * Basic Functions:: Utility and basic parsing functions. -* Decoding and Viewing:: A framework for decoding and viewing. -* Composing:: MML; a language for describing MIME parts. * Standards:: A summary of RFCs and working documents used. * Index:: Function and variable index. @end menu -@node Interface Functions -@chapter Interface Functions -@cindex interface functions -@cindex mail-parse - -The @code{mail-parse} library is an abstraction over the actual -low-level libraries that are described in the next chapter. - -Standards change, and so programs have to change to fit in the new -mold. For instance, RFC2045 describes a syntax for the -@code{Content-Type} header that only allows @sc{ascii} characters in the -parameter list. RFC2231 expands on RFC2045 syntax to provide a scheme -for continuation headers and non-@sc{ascii} characters. - -The traditional way to deal with this is just to update the library -functions to parse the new syntax. However, this is sometimes the wrong -thing to do. In some instances it may be vital to be able to understand -both the old syntax as well as the new syntax, and if there is only one -library, one must choose between the old version of the library and the -new version of the library. - -The Emacs MIME library takes a different tack. It defines a series of -low-level libraries (@file{rfc2047.el}, @file{rfc2231.el} and so on) -that parses strictly according to the corresponding standard. However, -normal programs would not use the functions provided by these libraries -directly, but instead use the functions provided by the -@code{mail-parse} library. The functions in this library are just -aliases to the corresponding functions in the latest low-level -libraries. Using this scheme, programs get a consistent interface they -can use, and library developers are free to create write code that -handles new standards. - -The following functions are defined by this library: - -@defun mail-header-parse-content-type string -Parse @var{string}, a @code{Content-Type} header, and return a -content-type list in the following format: - -@lisp -("type/subtype" - (attribute1 . value1) - (attribute2 . value2) - @dots{}) -@end lisp - -Here's an example: - -@example -(mail-header-parse-content-type - "image/gif; name=\"b980912.gif\"") -@result{} ("image/gif" (name . "b980912.gif")) -@end example -@end defun - -@defun mail-header-parse-content-disposition string -Parse @var{string}, a @code{Content-Disposition} header, and return a -content-type list in the format above. -@end defun - -@defun mail-content-type-get ct attribute -@findex mail-content-type-get -Returns the value of the given @var{attribute} from the content-type -list @var{ct}. - -@example -(mail-content-type-get - '("image/gif" (name . "b980912.gif")) 'name) -@result{} "b980912.gif" -@end example -@end defun - -@defun mail-header-encode-parameter param value -Takes a parameter string @samp{@var{param}=@var{value}} and returns an -encoded version of it. This is used for parameters in headers like -@samp{Content-Type} and @samp{Content-Disposition}. -@end defun - -@defun mail-header-remove-comments string -Return a comment-free version of @var{string}. - -@example -(mail-header-remove-comments - "Gnus/5.070027 (Pterodactyl Gnus v0.27) (Finnish Landrace)") -@result{} "Gnus/5.070027 " -@end example -@end defun - -@defun mail-header-remove-whitespace string -Remove linear white space from @var{string}. Space inside quoted -strings and comments is preserved. - -@example -(mail-header-remove-whitespace - "image/gif; name=\"Name with spaces\"") -@result{} "image/gif;name=\"Name with spaces\"" -@end example -@end defun - -@defun mail-header-get-comment string -Return the last comment in @var{string}. - -@example -(mail-header-get-comment - "Gnus/5.070027 (Pterodactyl Gnus v0.27) (Finnish Landrace)") -@result{} "Finnish Landrace" -@end example -@end defun - - -@defun mail-header-parse-address string -Parse an address string @var{string} and return a list containing the -mailbox and the plaintext name. - -@example -(mail-header-parse-address - "Hrvoje Niksic ") -@result{} ("hniksic@@srce.hr" . "Hrvoje Niksic") -@end example -@end defun - -@defun mail-header-parse-addresses string -Parse @var{string} as a list of addresses and return a list of elements -like the one described above. - -@example -(mail-header-parse-addresses - "Hrvoje Niksic , Steinar Bang ") -@result{} (("hniksic@@srce.hr" . "Hrvoje Niksic") - ("sb@@metis.no" . "Steinar Bang")) -@end example -@end defun - -@defun mail-header-parse-date string -Parse a date @var{string} and return an Emacs time structure. -@end defun - -@defun mail-narrow-to-head -Narrow the buffer to the header section of the buffer. Point is placed -at the beginning of the narrowed buffer. -@end defun - -@defun mail-header-narrow-to-field -Narrow the buffer to the header under point. -@end defun - -@defun mail-encode-encoded-word-region start end -Encode the non-@sc{ascii} words in the region @var{start}to @var{end}. For -instance, @samp{Naïve} is encoded as @samp{=?iso-8859-1?q?Na=EFve?=}. -@end defun - -@defun mail-encode-encoded-word-buffer -Encode the non-@sc{ascii} words in the current buffer. This function is -meant to be called with the buffer narrowed to the headers of a message. -@end defun - -@defun mail-encode-encoded-word-string string -Encode the words that need encoding in @var{string}, and return the -result. - -@example -(mail-encode-encoded-word-string - "This is naïve, baby") -@result{} "This is =?iso-8859-1?q?na=EFve,?= baby" -@end example -@end defun - -@defun mail-decode-encoded-word-region start end -Decode the encoded words in the region @var{start}to @var{end}. -@end defun - -@defun mail-decode-encoded-word-string string -Decode the encoded words in @var{string} and return the result. - -@example -(mail-decode-encoded-word-string - "This is =?iso-8859-1?q?na=EFve,?= baby") -@result{} "This is naïve, baby" -@end example -@end defun - -Currently, @code{mail-parse} is an abstraction over @code{ietf-drums}, -@code{rfc2047}, @code{rfc2045} and @code{rfc2231}. These are documented -in the subsequent sections. - - - -@node Basic Functions -@chapter Basic Functions - -This chapter describes the basic, ground-level functions for parsing and -handling. Covered here is parsing @code{From} lines, removing comments -from header lines, decoding encoded words, parsing date headers and so -on. High-level functionality is dealt with in the next chapter -(@pxref{Decoding and Viewing}). - -@menu -* rfc2045:: Encoding @code{Content-Type} headers. -* rfc2231:: Parsing @code{Content-Type} headers. -* ietf-drums:: Handling mail headers defined by RFC822bis. -* rfc2047:: En/decoding encoded words in headers. -* time-date:: Functions for parsing dates and manipulating time. -* qp:: Quoted-Printable en/decoding. -* base64:: Base64 en/decoding. -* binhex:: Binhex decoding. -* uudecode:: Uuencode decoding. -* rfc1843:: Decoding HZ-encoded text. -* mailcap:: How parts are displayed is specified by mailcap files -@end menu - - -@node rfc2045 -@section rfc2045 - -RFC2045 is the ``main'' @sc{mime} document, and as such, one would -imagine that there would be a lot to implement. But there isn't, since -most of the implementation details are delegated to the subsequent -RFCs. - -So @file{rfc2045.el} has only a single function: - -@defun rfc2045-encode-string parameter value -@findex rfc2045-encode-string -Takes a @var{parameter} and a @var{value} and returns a -@samp{@var{param}=@var{value}} string. @var{value} will be quoted if -there are non-safe characters in it. -@end defun - - -@node rfc2231 -@section rfc2231 - -RFC2231 defines a syntax for the @samp{Content-Type} and -@samp{Content-Disposition} headers. Its snappy name is @dfn{MIME -Parameter Value and Encoded Word Extensions: Character Sets, Languages, -and Continuations}. - -In short, these headers look something like this: - -@example -Content-Type: application/x-stuff; - title*0*=us-ascii'en'This%20is%20even%20more%20; - title*1*=%2A%2A%2Afun%2A%2A%2A%20; - title*2="isn't it!" -@end example - -They usually aren't this bad, though. - -The following functions are defined by this library: - -@defun rfc2231-parse-string string -Parse a @samp{Content-Type} header @var{string} and return a list -describing its elements. - -@example -(rfc2231-parse-string - "application/x-stuff; - title*0*=us-ascii'en'This%20is%20even%20more%20; - title*1*=%2A%2A%2Afun%2A%2A%2A%20; - title*2=\"isn't it!\"") -@result{} ("application/x-stuff" - (title . "This is even more ***fun*** isn't it!")) -@end example -@end defun - -@defun rfc2231-get-value ct attribute -Takes a list @var{ct} of the format above and returns the value of the -specified @var{attribute}. -@end defun - -@defun rfc2231-encode-string parameter value -Encode the string @samp{@var{parameter}=@var{value}} for inclusion in -headers likes @samp{Content-Type} and @samp{Content-Disposition}. -@end defun - -@node ietf-drums -@section ietf-drums - -@dfn{drums} is an IETF working group that is working on the replacement -for RFC822. - -The functions provided by this library include: - -@defun ietf-drums-remove-comments string -Remove the comments from @var{string} and return the result. -@end defun - -@defun ietf-drums-remove-whitespace string -Remove linear white space from @var{string} and return the result. -Spaces inside quoted strings and comments are left untouched. -@end defun - -@defun ietf-drums-get-comment string -Return the last most comment from @var{string}. -@end defun - -@defun ietf-drums-parse-address string -Parse an address @var{string} and return a list of the mailbox and the -plain text name. -@end defun - -@defun ietf-drums-parse-addresses string -Parse @var{string}, containing any number of comma-separated addresses, -and return a list of mailbox/plain text pairs. -@end defun - -@defun ietf-drums-parse-date string -Parse the date @var{string} and return an Emacs time structure. -@end defun - -@defun ietf-drums-narrow-to-header -Narrow the buffer to the header section of the current buffer. -@end defun - - -@node rfc2047 -@section rfc2047 - -RFC2047 (Message Header Extensions for Non-ASCII Text) specifies how -non-@sc{ascii} text in headers are to be encoded. This is actually rather -complicated, so a number of variables are necessary to tweak what this -library does. - -The following variables are tweakable: - -@defvar rfc2047-default-charset -Characters in this charset should not be decoded by this library. -This defaults to @samp{iso-8859-1}. -@end defvar - -@defvar rfc2047-header-encoding-list -This is an alist of header / encoding-type pairs. Its main purpose is -to prevent encoding of certain headers. -@end defvar - -The keys can either be header regexps, or @code{t}. - -The values can be either @code{nil}, in which case the header(s) in -question won't be encoded, or @code{mime}, which means that they will be -encoded. - -@defvar rfc2047-charset-encoding-alist -RFC2047 specifies two forms of encoding---@code{Q} (a -Quoted-Printable-like encoding) and @code{B} (base64). This alist -specifies which charset should use which encoding. -@end defvar - -@defvar rfc2047-encoding-function-alist -This is an alist of encoding / function pairs. The encodings are -@code{Q}, @code{B} and @code{nil}. -@end defvar - -@defvar rfc2047-q-encoding-alist -The @code{Q} encoding isn't quite the same for all headers. Some -headers allow a narrower range of characters, and that is what this -variable is for. It's an alist of header regexps and allowable character -ranges. -@end defvar - -@defvar rfc2047-encoded-word-regexp -When decoding words, this library looks for matches to this regexp. -@end defvar - -Those were the variables, and these are the functions: - -@defun rfc2047-narrow-to-field -Narrow the buffer to the header on the current line. -@end defun - -@defun rfc2047-encode-message-header -Should be called narrowed to the header of a message. Encodes according -to @code{rfc2047-header-encoding-alist}. -@end defun - -@defun rfc2047-encode-region start end -Encodes all encodable words in the region @var{start} to @var{end}. -@end defun - -@defun rfc2047-encode-string string -Encode @var{string} and return the result. -@end defun - -@defun rfc2047-decode-region start end -Decode the encoded words in the region @var{start} to @var{end}. -@end defun - -@defun rfc2047-decode-string string -Decode @var{string} and return the result. -@end defun - - - -@node time-date -@section time-date - -While not really a part of the @sc{mime} library, it is convenient to -document this library here. It deals with parsing @samp{Date} headers -and manipulating time. (Not by using tesseracts, though, I'm sorry to -say.) - -These functions convert between five formats: a date string, an Emacs -time structure, a decoded time list, a number of seconds, and a day number. - -The functions have quite self-explanatory names, so the following just -gives an overview of which functions are available. - -@findex parse-time-string -@findex date-to-time -@findex time-to-seconds -@findex seconds-to-time -@findex time-to-day -@findex days-to-time -@findex time-since -@findex time-less-p -@findex subtract-time -@findex days-between -@findex date-leap-year-p -@findex time-to-day-in-year -@example -(parse-time-string "Sat Sep 12 12:21:54 1998 +0200") -@result{} (54 21 12 12 9 1998 6 nil 7200) - -(date-to-time "Sat Sep 12 12:21:54 1998 +0200") -@result{} (13818 19266) - -(time-to-seconds '(13818 19266)) -@result{} 905595714.0 - -(seconds-to-time 905595714.0) -@result{} (13818 19266 0) - -(time-to-day '(13818 19266)) -@result{} 729644 - -(days-to-time 729644) -@result{} (961933 65536) - -(time-since '(13818 19266)) -@result{} (0 430) - -(time-less-p '(13818 19266) '(13818 19145)) -@result{} nil - -(subtract-time '(13818 19266) '(13818 19145)) -@result{} (0 121) - -(days-between "Sat Sep 12 12:21:54 1998 +0200" - "Sat Sep 07 12:21:54 1998 +0200") -@result{} 5 - -(date-leap-year-p 2000) -@result{} t - -(time-to-day-in-year '(13818 19266)) -@result{} 255 -@end example - -@findex safe-date-to-time -And finally, we have @code{safe-date-to-time}, which does the same as -@code{date-to-time}, but returns a zero time if the date is -syntactically malformed. - - - -@node qp -@section qp - -This library deals with decoding and encoding Quoted-Printable text. - -Very briefly explained, QP encoding means translating all 8-bit -characters (and lots of control characters) into things that look like -@samp{=EF}; that is, an equal sign followed by the byte encoded as a hex -string. It is defined in RFC 2045. - -The following functions are defined by the library: - -@deffn Command quoted-printable-decode-region @var{from} @var{to} &optional @var{coding-system} -QP-decode all the encoded text in the region. If @var{coding-system} -is non-nil, decode bytes into characters with that coding-system. It -is probably better not to use @var{coding-system}; instead decode into -a unibyte buffer, decode that appropriately and then interpret it as -multibyte. -@end deffn - -@defun quoted-printable-decode-string @var{string} &optional @var{coding-system} -Return a QP-encoded copy of @var{string}. If @var{coding-system} is -non-nil, decode bytes into characters with that coding-system. -@end defun - -@deffn Command quoted-printable-encode-region @var{from} @var{to} &optional @var{fold} @var{class} -QP-encode all the region. If @var{fold} is non-@var{nil}, fold lines -at 76 characters, as required by the RFC. If @var{class} is -non-@code{nil}, translate the characters not matched by that regexp -class, which should be in the form expected by -@var{skip-chars-forward} and should probably not contain literal -eight-bit characters. Specifying @var{class} makes sense to do extra -encoding in header fields. - -If variable @var{mm-use-ultra-safe-encoding} is defined and -non-@code{nil}, fold lines unconditionally and encode @samp{From } and -@samp{-} at the start of lines.. -@end deffn - -@defun quoted-printable-encode-string string -Return a QP-encoded copy of @var{string}. -@end defun - -@node base64 -@section base64 -@cindex base64 - -Base64 is an encoding that encodes three bytes into four characters, -thereby increasing the size by about 33%. The alphabet used for -encoding is very resistant to mangling during transit. @xref{Base -64,,Base 64 Encoding, elisp, The Emacs Lisp Reference Manual}. - -@node binhex -@section binhex -@cindex binhex -@cindex Apple -@cindex Macintosh - -Binhex is an encoding that originated in Macintosh environments. -The following function is supplied to deal with these: - -@defun binhex-decode-region start end &optional header-only -Decode the encoded text in the region @var{start} to @var{end}. If -@var{header-only} is non-@code{nil}, only decode the @samp{binhex} -header and return the file name. -@end defun - - -@node uudecode -@section uudecode -@cindex uuencode -@cindex uudecode - -Uuencoding is probably still the most popular encoding of binaries -used on Usenet, although Base64 rules the mail world. - -The following function is supplied by this package: - -@defun uudecode-decode-region start end &optional file-name -Decode the text in the region @var{start} to @var{end}. If -@var{file-name} is non-@code{nil}, save the result to @var{file-name}. -@end defun - - -@node rfc1843 -@section rfc1843 -@cindex rfc1843 -@cindex HZ -@cindex Chinese - -RFC1843 deals with mixing Chinese and @sc{ascii} characters in messages. In -essence, RFC1843 switches between @sc{ascii} and Chinese by doing this: - -@example -This sentence is in ASCII. -The next sentence is in GB.~@{<:Ky2;S@{#,NpJ)l6HK!#~@}Bye. -@end example - -Simple enough, and widely used in China. - -The following functions are available to handle this encoding: - -@defun rfc1843-decode-region start end -Decode HZ-encoded text in the region @var{start} to @var{end}. -@end defun - -@defun rfc1843-decode-string string -Decode the HZ-encoded @var{string} and return the result. -@end defun - - -@node mailcap -@section mailcap - -As specified by RFC 1524, @sc{mime}-aware message handlers parse -@dfn{mailcap} files from a default list, which can be overridden by the -@code{MAILCAP} environment variable. These describe how elements are -supposed to be displayed. Here's an example file: - -@example -image/*; gimp -8 %s -audio/wav; wavplayer %s -@end example - -This says that all image files should be displayed with @command{gimp}, -and that WAVE audio files should be played by @code{wavplayer}. - -The @code{mailcap} library parses such files, and provides functions for -matching types. - -@defvar mailcap-mime-data -This variable is an alist of alists containing backup viewing rules for -@sc{mime} types. These are overridden by rules for a type found in -mailcap files. The outer alist is keyed on the major content-type and -the inner alists are keyed on the minor content-type (which can be a -regular expression). - -@c Fixme: document this properly! -For example: -@example -(("application" - ("octet-stream" - (viewer . mailcap-save-binary-file) - (non-viewer . t) - (type . "application/octet-stream")) - ("plain" - (viewer . view-mode) - (test fboundp 'view-mode) - (type . "text/plain"))) -@end example -@end defvar - -@defopt mailcap-default-mime-data -This variable is the default value of @code{mailcap-mime-data}. It -exists to allow setting the value using Custom. It is merged with -values from mailcap files by @code{mailcap-parse-mailcaps}. -@end defopt - -Although it is not specified by the RFC, @sc{mime} tools normally use a -common means of associating file extensions with defualt @sc{mime} types -in the absence of other information about the type of a file. The -information is found in per-user files @file{~/.mime.types} and system -@file{mime.types} files found in quasi-standard places. Here is an -example: - -@example -application/x-dvi dvi -audio/mpeg mpga mpega mp2 mp3 -image/jpeg jpeg jpg jpe -@end example - - -@defvar mailcap-mime-extensions -This variable is an alist @sc{mime} types keyed by file extensions. -This is overridden by entries found in @file{mime.types} files. -@end defvar - -@defopt mailcap-default-mime-extensions -This variable is the default value of @code{mailcap-mime-extensions}. -It exists to allow setting the value using Custom. It is merged with -values from mailcap files by @code{mailcap-parse-mimetypes}. -@end defopt - -Interface functions: - -@defun mailcap-parse-mailcaps &optional path force -Parse all the mailcap files specified in a path string @var{path} and -merge them with the values from @code{mailcap-mime-data}. Components of -@var{path} are separated by the @code{path-separator} character -appropriate for the system. If @var{force} is non-@code{nil}, the files -are re-parsed even if they have been parsed already. If @var{path} is -omitted, use the value of environment variable @code{MAILCAPS} if it is -set; otherwise (on GNU and Unix) use the path defined in RFC 1524, plus -@file{/usr/local/etc/mailcap}. -@end defun - -@defun mailcap-parse-mimetypes &optional path force -Parse all the mimetypes specified in a path string @var{path} -and merge them with the values from @code{mailcap-mime-extensions}. -Components of @var{path} are separated by the @code{path-separator} -character appropriate for the system. If @var{path} is omitted, use the -value of environment variable @code{MIMETYPES} if set; otherwise use a -default path consistent with that used by @code{mailcap-parse-mailcaps}. -If @var{force} is non-@code{nil}, the files are re-parsed even if they -have been parsed already. -@end defun - -@defun mailcap-mime-info string &optional request -Gets the viewer command for content-type @var{string}. @code{nil} is -returned if none is found. Expects @var{string} to be a complete -content-type header line. - -If @var{request} is non-@code{nil} it specifies what information to -return. If it is nil or the empty string, the viewer (second field of -the mailcap entry) will be returned. If it is a string, then the -mailcap field corresponding to that string will be returned -(@samp{print}, @samp{description}, whatever). If it is a number, all -the information for this viewer is returned. If it is @code{all}, then -all possible viewers for this type is returned. -@end defun - -@defun mailcap-mime-types -This function returns a list of all the defined media types. -@end defun - -@defun mailcap-extension-to-mime extension -This function returns the content type defined for a file with the given -@var{extension}. -@end defun - - @node Decoding and Viewing @chapter Decoding and Viewing -This chapter deals with decoding and viewing @sc{mime} messages on a +This chapter deals with decoding and viewing @acronym{MIME} messages on a higher level. -The main idea is to first analyze a @sc{mime} article, and then allow +The main idea is to first analyze a @acronym{MIME} article, and then allow other programs to do things based on the list of @dfn{handles} that are returned as a result of this analysis. @menu -* Dissection:: Analyzing a @sc{mime} message. -* Handles:: Handle manipulations. -* Display:: Displaying handles. -* Customization:: Variables that affect display. -* New Viewers:: How to write your own viewers. +* Dissection:: Analyzing a @acronym{MIME} message. +* Non-MIME:: Analyzing a non-@acronym{MIME} message. +* Handles:: Handle manipulations. +* Display:: Displaying handles. +* Display Customization:: Variables that affect display. +* Files and Directories:: Saving and naming attachments. +* New Viewers:: How to write your own viewers. @end menu @@ -795,111 +126,174 @@ @section Dissection The @code{mm-dissect-buffer} is the function responsible for dissecting -a @sc{mime} article. If given a multipart message, it will recursively +a @acronym{MIME} article. If given a multipart message, it will recursively descend the message, following the structure, and return a tree of -@sc{mime} handles that describes the structure of the message. +@acronym{MIME} handles that describes the structure of the message. + +@node Non-MIME +@section Non-MIME +@vindex mm-uu-configure-list + +Gnus also understands some non-@acronym{MIME} attachments, such as +postscript, uuencode, binhex, yenc, shar, forward, gnatsweb, pgp, +diff. Each of these features can be disabled by add an item into +@code{mm-uu-configure-list}. For example, + +@lisp +(require 'mm-uu) +(add-to-list 'mm-uu-configure-list '(pgp-signed . disabled)) +@end lisp + +@table @code +@item postscript +@findex postscript +Postscript file. + +@item uu +@findex uu +Uuencoded file. + +@item binhex +@findex binhex +Binhex encoded file. + +@item yenc +@findex yenc +Yenc encoded file. +@item shar +@findex shar +Shar archive file. + +@item forward +@findex forward +Non-@acronym{MIME} forwarded message. + +@item gnatsweb +@findex gnatsweb +Gnatsweb attachment. + +@item pgp-signed +@findex pgp-signed +@acronym{PGP} signed clear text. + +@item pgp-encrypted +@findex pgp-encrypted +@acronym{PGP} encrypted clear text. + +@item pgp-key +@findex pgp-key +@acronym{PGP} public keys. + +@item emacs-sources +@findex emacs-sources +@vindex mm-uu-emacs-sources-regexp +Emacs source code. This item works only in the groups matching +@code{mm-uu-emacs-sources-regexp}. + +@item diff +@vindex diff +@vindex mm-uu-diff-groups-regexp +Patches. This is intended for groups where diffs of committed files +are automatically sent to. It only works in groups matching +@code{mm-uu-diff-groups-regexp}. + +@end table @node Handles @section Handles -A @sc{mime} handle is a list that fully describes a @sc{mime} component. +A @acronym{MIME} handle is a list that fully describes a @acronym{MIME} +component. + +The following macros can be used to access elements in a handle: -The following macros can be used to access elements from the -@var{handle} argument: - -@defmac mm-handle-buffer handle -Return the buffer that holds the contents of the undecoded @sc{mime} +@table @code +@item mm-handle-buffer +@findex mm-handle-buffer +Return the buffer that holds the contents of the undecoded @acronym{MIME} part. -@end defmac -@defmac mm-handle-type handle -Return the parsed @samp{Content-Type} of the part. -@end defmac +@item mm-handle-type +@findex mm-handle-type +Return the parsed @code{Content-Type} of the part. -@defmac mm-handle-encoding handle -Return the @samp{Content-Transfer-Encoding} of the part. -@end defmac +@item mm-handle-encoding +@findex mm-handle-encoding +Return the @code{Content-Transfer-Encoding} of the part. -@defmac mm-handle-undisplayer handle -Return the function that can be used to remove the displayed part (if it +@item mm-handle-undisplayer +@findex mm-handle-undisplayer +Return the object that can be used to remove the displayed part (if it has been displayed). -@end defmac -@defmac mm-handle-set-undisplayer handle function -Set the undisplayer function for the part to function. -@end defmac +@item mm-handle-set-undisplayer +@findex mm-handle-set-undisplayer +Set the undisplayer object. -@defmac mm-handle-disposition -Return the parsed @samp{Content-Disposition} of the part. -@end defmac +@item mm-handle-disposition +@findex mm-handle-disposition +Return the parsed @code{Content-Disposition} of the part. -@defmac mm-handle-disposition +@item mm-handle-disposition +@findex mm-handle-disposition Return the description of the part. -@end defmac -@defmac mm-get-content-id id -Returns the handle(s) referred to by @var{id}, the @samp{Content-ID} of -the part. -@end defmac +@item mm-get-content-id +Returns the handle(s) referred to by @code{Content-ID}. + +@end table @node Display @section Display -Functions for displaying, removing and saving. In the descriptions -below, `the part' means the @sc{mime} part represented by the -@var{handle} argument. +Functions for displaying, removing and saving. + +@table @code +@item mm-display-part +@findex mm-display-part +Display the part. -@defun mm-display-part handle &optional no-default -Display the part. Return @code{nil} if the part is removed, -@code{inline} if it is displayed inline or @code{external} if it is -displayed externally. If @var{no-default} is non-@code{nil}, the part -is not displayed unless the @sc{mime} type of @var{handle} is defined to -be displayed inline or there is an display method defined for it; i.e.@: -no default external method will be used. -@end defun +@item mm-remove-part +@findex mm-remove-part +Remove the part (if it has been displayed). -@defun mm-remove-part handle -Remove the part if it has been displayed. -@end defun - -@defun mm-inlinable-p handle -Return non-@code{nil} if the part can be displayed inline. -@end defun +@item mm-inlinable-p +@findex mm-inlinable-p +Say whether a @acronym{MIME} type can be displayed inline. -@defun mm-automatic-display-p handle -Return non-@code{nil} if the user has requested automatic display of the -@sc{mime} type of the part. -@end defun +@item mm-automatic-display-p +@findex mm-automatic-display-p +Say whether a @acronym{MIME} type should be displayed automatically. -@defun mm-destroy-part handle -Free all the resources used by the part. -@end defun +@item mm-destroy-part +@findex mm-destroy-part +Free all resources occupied by a part. -@defun mm-save-part handle -Save the part to a file. The user is prompted for a file name to use. -@end defun +@item mm-save-part +@findex mm-save-part +Offer to save the part in a file. -@defun mm-pipe-part handle -Pipe the part through a shell command. The user is prompted for the -command to use. -@end defun +@item mm-pipe-part +@findex mm-pipe-part +Offer to pipe the part to some process. -@defun mm-interactively-view-part handle -Prompt for a mailcap method to use to view the part and display it -externally using that method. -@end defun +@item mm-interactively-view-part +@findex mm-interactively-view-part +Prompt for a mailcap method to use to view the part. + +@end table -@node Customization -@section Customization +@node Display Customization +@section Display Customization -The display of @sc{mime} types may be customized with the following -options. +@table @code -@defopt mm-inline-media-tests -This is an alist where the key is a @sc{mime} type, the second element +@item mm-inline-media-tests +@vindex mm-inline-media-tests +This is an alist where the key is a @acronym{MIME} type, the second element is a function to display the part @dfn{inline} (i.e., inside Emacs), and the third element is a form to be @code{eval}ed to say whether the part can be displayed inline. @@ -907,42 +301,55 @@ This variable specifies whether a part @emph{can} be displayed inline, and, if so, how to do it. It does not say whether parts are @emph{actually} displayed inline. -@end defopt -@defopt mm-inlined-types +@item mm-inlined-types +@vindex mm-inlined-types This, on the other hand, says what types are to be displayed inline, if they satisfy the conditions set by the variable above. It's a list of -@sc{mime} media types. -@end defopt +@acronym{MIME} media types. -@defopt mm-automatic-display +@item mm-automatic-display +@vindex mm-automatic-display This is a list of types that are to be displayed ``automatically'', but only if the above variable allows it. That is, only inlinable parts can be displayed automatically. -@end defopt + +@item mm-automatic-external-display +@vindex mm-automatic-external-display +This is a list of types that will be displayed automatically in an +external viewer. -@defopt mm-attachment-override-types -Some @sc{mime} agents create parts that have a content-disposition of +@item mm-keep-viewer-alive-types +@vindex mm-keep-viewer-alive-types +This is a list of media types for which the external viewer will not +be killed when selecting a different article. + +@item mm-attachment-override-types +@vindex mm-attachment-override-types +Some @acronym{MIME} agents create parts that have a content-disposition of @samp{attachment}. This variable allows overriding that disposition and displaying the part inline. (Note that the disposition is only overridden if we are able to, and want to, display the part inline.) -@end defopt -@defopt mm-discouraged-alternatives -List of @sc{mime} types that are discouraged when viewing +@item mm-discouraged-alternatives +@vindex mm-discouraged-alternatives +List of @acronym{MIME} types that are discouraged when viewing @samp{multipart/alternative}. Viewing agents are supposed to view the last possible part of a message, as that is supposed to be the richest. However, users may prefer other types instead, and this list says what types are most unwanted. If, for instance, @samp{text/html} parts are -very unwanted, and @samp{text/richtech} parts are somewhat unwanted, -then the value of this variable should be set to: +very unwanted, and @samp{text/richtext} parts are somewhat unwanted, +you could say something like: @lisp -("text/html" "text/richtext") +(setq mm-discouraged-alternatives + '("text/html" "text/richtext") + mm-automatic-display + (remove "text/html" mm-automatic-display)) @end lisp -@end defopt -@defopt mm-inline-large-images-p +@item mm-inline-large-images +@vindex mm-inline-large-images When displaying inline images that are larger than the window, XEmacs does not enable scrolling, which means that you cannot see the whole image. To prevent this, the library tries to determine the image size @@ -951,9 +358,9 @@ @samp{xv}). Setting this variable to @code{t} disables this check and makes the library display all inline images as inline, regardless of their size. -@end defopt -@defopt mm-inline-override-p +@item mm-inline-override-types +@vindex mm-inline-override-types @code{mm-inlined-types} may include regular expressions, for example to specify that all @samp{text/.*} parts be displayed inline. If a user prefers to have a type that matches such a regular expression be treated @@ -961,13 +368,130 @@ list containing that type. For example assuming @code{mm-inlined-types} includes @samp{text/.*}, then including @samp{text/html} in this variable will cause @samp{text/html} parts to be treated as attachments. -@end defopt + +@item mm-text-html-renderer +@vindex mm-text-html-renderer +This selects the function used to render @acronym{HTML}. The predefined +renderers are selected by the symbols @code{w3}, +@code{w3m}@footnote{See @uref{http://emacs-w3m.namazu.org/} for more +information about emacs-w3m}, @code{links}, @code{lynx}, +@code{w3m-standalone} or @code{html2text}. If @code{nil} use an +external viewer. You can also specify a function, which will be +called with a @acronym{MIME} handle as the argument. + +@item mm-inline-text-html-with-images +@vindex mm-inline-text-html-with-images +Some @acronym{HTML} mails might have the trick of spammers using +@samp{} tags. It is likely to be intended to verify whether you +have read the mail. You can prevent your personal informations from +leaking by setting this option to @code{nil} (which is the default). +It is currently ignored by Emacs/w3. For emacs-w3m, you may use the +command @kbd{t} on the image anchor to show an image even if it is +@code{nil}.@footnote{The command @kbd{T} will load all images. If you +have set the option @code{w3m-key-binding} to @code{info}, use @kbd{i} +or @kbd{I} instead.} + +@item mm-w3m-safe-url-regexp +@vindex mm-w3m-safe-url-regexp +A regular expression that matches safe URL names, i.e. URLs that are +unlikely to leak personal information when rendering @acronym{HTML} +email (the default value is @samp{\\`cid:}). If @code{nil} consider +all URLs safe. + +@item mm-inline-text-html-with-w3m-keymap +@vindex mm-inline-text-html-with-w3m-keymap +You can use emacs-w3m command keys in the inlined text/html part by +setting this option to non-@code{nil}. The default value is @code{t}. + +@item mm-external-terminal-program +@vindex mm-external-terminal-program +The program used to start an external terminal. + +@item mm-enable-external +@vindex mm-enable-external +Indicate whether external MIME handlers should be used. + +If @code{t}, all defined external MIME handlers are used. If +@code{nil}, files are saved to disk (@code{mailcap-save-binary-file}). +If it is the symbol @code{ask}, you are prompted before the external +@acronym{MIME} handler is invoked. + +When you launch an attachment through mailcap (@pxref{mailcap}) an +attempt is made to use a safe viewer with the safest options--this isn't +the case if you save it to disk and launch it in a different way +(command line or double-clicking). Anyhow, if you want to be sure not +to launch any external programs, set this variable to @code{nil} or +@code{ask}. + +@end table + +@node Files and Directories +@section Files and Directories +@table @code + +@item mm-default-directory +@vindex mm-default-directory +The default directory for saving attachments. If @code{nil} use +@code{default-directory}. + +@item mm-tmp-directory +@vindex mm-tmp-directory +Directory for storing temporary files. + +@item mm-file-name-rewrite-functions +@vindex mm-file-name-rewrite-functions +A list of functions used for rewriting file names of @acronym{MIME} +parts. Each function is applied successively to the file name. +Ready-made functions include + +@table @code +@item mm-file-name-delete-control +@findex mm-file-name-delete-control +Delete all control characters. + +@item mm-file-name-delete-gotchas +@findex mm-file-name-delete-gotchas +Delete characters that could have unintended consequences when used +with flawed shell scripts, i.e. @samp{|}, @samp{>} and @samp{<}; and +@samp{-}, @samp{.} as the first character. + +@item mm-file-name-delete-whitespace +@findex mm-file-name-delete-whitespace +Remove all whitespace. + +@item mm-file-name-trim-whitespace +@findex mm-file-name-trim-whitespace +Remove leading and trailing whitespace. + +@item mm-file-name-collapse-whitespace +@findex mm-file-name-collapse-whitespace +Collapse multiple whitespace characters. + +@item mm-file-name-replace-whitespace +@findex mm-file-name-replace-whitespace +@vindex mm-file-name-replace-whitespace +Replace whitespace with underscores. Set the variable +@code{mm-file-name-replace-whitespace} to any other string if you do +not like underscores. +@end table + +The standard Emacs functions @code{capitalize}, @code{downcase}, +@code{upcase} and @code{upcase-initials} might also prove useful. + +@item mm-path-name-rewrite-functions +@vindex mm-path-name-rewrite-functions +List of functions used for rewriting the full file names of @acronym{MIME} +parts. This is used when viewing parts externally, and is meant for +transforming the absolute name so that non-compliant programs can find +the file where it's saved. + +@end table @node New Viewers @section New Viewers -Here's an example viewer for displaying @samp{text/enriched} inline: +Here's an example viewer for displaying @code{text/enriched} inline: @lisp (defun mm-display-enriched-inline (handle) @@ -980,7 +504,7 @@ (mm-insert-inline handle text))) @end lisp -We see that the function takes a @sc{mime} handle as its parameter. It +We see that the function takes a @acronym{MIME} handle as its parameter. It then goes to a temporary buffer, inserts the text of the part, does some work on the text, stores the result, goes back to the buffer it was called from and inserts the result. @@ -990,7 +514,7 @@ handle in the current buffer. It handles charset and/or content transfer decoding. The second function just inserts whatever text you tell it to insert, but it also sets things up so that the text can be -``undisplayed' in a convenient manner. +``undisplayed'' in a convenient manner. @node Composing @@ -1000,21 +524,24 @@ @cindex MML @cindex MIME Meta Language -Creating a @sc{mime} message is boring and non-trivial. Therefore, a -library called @code{mml} has been defined that parses a language called -MML (@sc{mime} Meta Language) and generates @sc{mime} messages. +Creating a @acronym{MIME} message is boring and non-trivial. Therefore, +a library called @code{mml} has been defined that parses a language +called @acronym{MML} (@acronym{MIME} Meta Language) and generates +@acronym{MIME} messages. @findex mml-generate-mime The main interface function is @code{mml-generate-mime}. It will examine the contents of the current (narrowed-to) buffer and return a -string containing the @sc{mime} message. +string containing the @acronym{MIME} message. @menu -* Simple MML Example:: An example MML document. -* MML Definition:: All valid MML elements. -* Advanced MML Example:: Another example MML document. -* Charset Translation:: How charsets are mapped from Mule to MIME. -* Conversion:: Going from @sc{mime} to MML and vice versa. +* Simple MML Example:: An example @acronym{MML} document. +* MML Definition:: All valid @acronym{MML} elements. +* Advanced MML Example:: Another example @acronym{MML} document. +* Encoding Customization:: Variables that affect encoding. +* Charset Translation:: How charsets are mapped from @sc{mule} to @acronym{MIME}. +* Conversion:: Going from @acronym{MIME} to @acronym{MML} and vice versa. +* Flowed text:: Soft and hard newlines. @end menu @@ -1055,10 +582,10 @@ @node MML Definition @section MML Definition -The MML language is very simple. It looks a bit like an SGML +The @acronym{MML} language is very simple. It looks a bit like an SGML application, but it's not. -The main concept of MML is the @dfn{part}. Each part can be of a +The main concept of @acronym{MML} is the @dfn{part}. Each part can be of a different type or use a different charset. The way to delineate a part is with a @samp{<#part ...>} tag. Multipart parts can be introduced with the @samp{<#multipart ...>} tag. Parts are ended by the @@ -1073,58 +600,85 @@ but that's not necessary unless the value contains white space. So @samp{filename=/home/user/#hello$^yes} is perfectly valid. -The following parameters have meaning in MML; parameters that have no -meaning are ignored. The MML parameter names are the same as the -@sc{mime} parameter names; the things in the parentheses say which +The following parameters have meaning in @acronym{MML}; parameters that have no +meaning are ignored. The @acronym{MML} parameter names are the same as the +@acronym{MIME} parameter names; the things in the parentheses say which header it will be used in. @table @samp @item type -The @sc{mime} type of the part (@samp{Content-Type}). +The @acronym{MIME} type of the part (@code{Content-Type}). @item filename Use the contents of the file in the body of the part -(@samp{Content-Disposition}). +(@code{Content-Disposition}). @item charset The contents of the body of the part are to be encoded in the character -set specified (@samp{Content-Type}). +set specified (@code{Content-Type}). @xref{Charset Translation}. @item name Might be used to suggest a file name if the part is to be saved -to a file (@samp{Content-Type}). +to a file (@code{Content-Type}). @item disposition Valid values are @samp{inline} and @samp{attachment} -(@samp{Content-Disposition}). +(@code{Content-Disposition}). @item encoding Valid values are @samp{7bit}, @samp{8bit}, @samp{quoted-printable} and -@samp{base64} (@samp{Content-Transfer-Encoding}). +@samp{base64} (@code{Content-Transfer-Encoding}). @xref{Charset +Translation}. @item description -A description of the part (@samp{Content-Description}). +A description of the part (@code{Content-Description}). @item creation-date -RFC822 date when the part was created (@samp{Content-Disposition}). +RFC822 date when the part was created (@code{Content-Disposition}). @item modification-date -RFC822 date when the part was modified (@samp{Content-Disposition}). +RFC822 date when the part was modified (@code{Content-Disposition}). @item read-date -RFC822 date when the part was read (@samp{Content-Disposition}). +RFC822 date when the part was read (@code{Content-Disposition}). + +@item recipients +Who to encrypt/sign the part to. This field is used to override any +auto-detection based on the To/CC headers. + +@item sender +Identity used to sign the part. This field is used to override the +default key used. @item size -The size (in octets) of the part (@samp{Content-Disposition}). +The size (in octets) of the part (@code{Content-Disposition}). + +@item sign +What technology to sign this @acronym{MML} part with (@code{smime}, @code{pgp} +or @code{pgpmime}) + +@item encrypt +What technology to encrypt this @acronym{MML} part with (@code{smime}, +@code{pgp} or @code{pgpmime}) @end table +Parameters for @samp{text/plain}: + +@table @samp +@item format +Formatting parameter for the text, valid values include @samp{fixed} +(the default) and @samp{flowed}. Normally you do not specify this +manually, since it requires the textual body to be formatted in a +special way described in RFC 2646. @xref{Flowed text}. +@end table + Parameters for @samp{application/octet-stream}: @table @samp @item type Type of the part; informal---meant for human readers -(@samp{Content-Type}). +(@code{Content-Type}). @end table Parameters for @samp{message/external-body}: @@ -1133,18 +687,36 @@ @item access-type A word indicating the supported access mechanism by which the file may be obtained. Values include @samp{ftp}, @samp{anon-ftp}, @samp{tftp}, -@samp{localfile}, and @samp{mailserver}. (@samp{Content-Type}.) +@samp{localfile}, and @samp{mailserver}. (@code{Content-Type}.) @item expiration The RFC822 date after which the file may no longer be fetched. -(@samp{Content-Type}.) +(@code{Content-Type}.) @item size -The size (in octets) of the file. (@samp{Content-Type}.) +The size (in octets) of the file. (@code{Content-Type}.) @item permission Valid values are @samp{read} and @samp{read-write} -(@samp{Content-Type}). +(@code{Content-Type}). + +@end table + +Parameters for @samp{sign=smime}: + +@table @samp + +@item keyfile +File containing key and certificate for signer. + +@end table + +Parameters for @samp{encrypt=smime}: + +@table @samp + +@item certfile +File containing certificate for recipient. @end table @@ -1169,7 +741,7 @@ <#/multipart> @end example -And this is the resulting @sc{mime} message: +And this is the resulting @acronym{MIME} message: @example Content-Type: multipart/mixed; boundary="=-=-=" @@ -1235,74 +807,141 @@ --=-=-=-- @end example +@node Encoding Customization +@section Encoding Customization + +@table @code + +@item mm-body-charset-encoding-alist +@vindex mm-body-charset-encoding-alist +Mapping from @acronym{MIME} charset to encoding to use. This variable is +usually used except, e.g., when other requirements force a specific +encoding (digitally signed messages require 7bit encodings). The +default is + +@lisp +((iso-2022-jp . 7bit) + (iso-2022-jp-2 . 7bit) + (utf-16 . base64) + (utf-16be . base64) + (utf-16le . base64)) +@end lisp + +As an example, if you do not want to have ISO-8859-1 characters +quoted-printable encoded, you may add @code{(iso-8859-1 . 8bit)} to +this variable. You can override this setting on a per-message basis +by using the @code{encoding} @acronym{MML} tag (@pxref{MML Definition}). + +@item mm-coding-system-priorities +@vindex mm-coding-system-priorities +Prioritize coding systems to use for outgoing messages. The default +is @code{nil}, which means to use the defaults in Emacs. It is a list of +coding system symbols (aliases of coding systems does not work, use +@kbd{M-x describe-coding-system} to make sure you are not specifying +an alias in this variable). For example, if you have configured Emacs +to prefer UTF-8, but wish that outgoing messages should be sent in +ISO-8859-1 if possible, you can set this variable to +@code{(iso-latin-1)}. You can override this setting on a per-message +basis by using the @code{charset} @acronym{MML} tag (@pxref{MML Definition}). + +@item mm-content-transfer-encoding-defaults +@vindex mm-content-transfer-encoding-defaults +Mapping from @acronym{MIME} types to encoding to use. This variable is usually +used except, e.g., when other requirements force a safer encoding +(digitally signed messages require 7bit encoding). Besides the normal +@acronym{MIME} encodings, @code{qp-or-base64} may be used to indicate that for +each case the most efficient of quoted-printable and base64 should be +used. You can override this setting on a per-message basis by using +the @code{encoding} @acronym{MML} tag (@pxref{MML Definition}). + +@item mm-use-ultra-safe-encoding +@vindex mm-use-ultra-safe-encoding +When this is non-@code{nil}, it means that textual parts are encoded as +quoted-printable if they contain lines longer than 76 characters or +starting with "From " in the body. Non-7bit encodings (8bit, binary) +are generally disallowed. This reduce the probability that a non-8bit +clean MTA or MDA changes the message. This should never be set +directly, but bound by other functions when necessary (e.g., when +encoding messages that are to be digitally signed). + +@end table + @node Charset Translation @section Charset Translation @cindex charsets -During translation from MML to @sc{mime}, for each @sc{mime} part which -has been composed inside Emacs, an appropriate @sc{mime} charset has to -be chosen. +During translation from @acronym{MML} to @acronym{MIME}, for each +@acronym{MIME} part which has been composed inside Emacs, an appropriate +charset has to be chosen. @vindex mail-parse-charset -@cindex unibyte Emacs -If you are running a non-Mule XEmacs, or Emacs in unibyte -mode@footnote{Deprecated!}, this process is simple: if the part -contains any non-@sc{ascii} (8-bit) characters, the @sc{mime} charset +If you are running a non-@sc{mule} Emacs, this process is simple: If the +part contains any non-@acronym{ASCII} (8-bit) characters, the @acronym{MIME} charset given by @code{mail-parse-charset} (a symbol) is used. (Never set this variable directly, though. If you want to change the default charset, please consult the documentation of the package which you use to process -@sc{mime} messages. @xref{Various Message Variables, , Various Message -Variables, message, Message Manual}, for example.) If there are only -@sc{ascii} characters, the @sc{mime} charset @samp{US-ASCII} is used, of -course. +@acronym{MIME} messages. +@xref{Various Message Variables, , Various Message Variables, message, + Message Manual}, for example.) +If there are only @acronym{ASCII} characters, the @acronym{MIME} charset US-ASCII is +used, of course. -@cindex multibyte Emacs -@cindex @code{mime-charset} property -In a normal (multibyte) Emacs session, a list of coding systems is -derived that can encode the message part's content and correspond to -MIME charsets (according to their @code{mime-charset} property). This -list is according to the normal priority rules and the highest priority -one is chosen to encode the part. If no such coding system can encode -the part's contents, they are split into several parts such that each -can be encoded with an appropriate coding system/@sc{mime} -charset.@footnote{The part can only be split at line boundaries, -though---if more than one @sc{mime} charset is required to encode a -single line, it is not possible to encode the part.} Note that this -procedure works with any correctly-defined coding systems, not just -built-in ones. Given a suitably-defined UTF-8 coding system---one -capable of encoding the Emacs charsets you use---it is not normally -necessary to split a part by charset. +@cindex MULE +@cindex UTF-8 +@cindex Unicode +@vindex mm-mime-mule-charset-alist +Things are slightly more complicated when running Emacs with @sc{mule} +support. In this case, a list of the @sc{mule} charsets used in the +part is obtained, and the @sc{mule} charsets are translated to @acronym{MIME} +charsets by consulting the variable @code{mm-mime-mule-charset-alist}. +If this results in a single @acronym{MIME} charset, this is used to encode +the part. But if the resulting list of @acronym{MIME} charsets contains more +than one element, two things can happen: If it is possible to encode the +part via UTF-8, this charset is used. (For this, Emacs must support +the @code{utf-8} coding system, and the part must consist entirely of +characters which have Unicode counterparts.) If UTF-8 is not available +for some reason, the part is split into several ones, so that each one +can be encoded with a single @acronym{MIME} charset. The part can only be +split at line boundaries, though---if more than one @acronym{MIME} charset is +required to encode a single line, it is not possible to encode the part. -@vindex mm-mime-mule-charset-alist -@cindex XEmacs/Mule -It isn't possible to do this properly in XEmacs/Mule. Instead, a list -of the Mule charsets used in the part is obtained, and the -corresponding @sc{mime} charsets are determined by lookup in -@code{mm-mime-mule-charset-alist}. If the list elements all -correspond to a single @sc{mime} charset, that is used to encode the -part. Otherwise, the part is split as above. +When running Emacs with @sc{mule} support, the preferences for which +coding system to use is inherited from Emacs itself. This means that +if Emacs is set up to prefer UTF-8, it will be used when encoding +messages. You can modify this by altering the +@code{mm-coding-system-priorities} variable though (@pxref{Encoding +Customization}). + +The charset to be used can be overridden by setting the @code{charset} +@acronym{MML} tag (@pxref{MML Definition}) when composing the message. + +The encoding of characters (quoted-printable, 8bit etc) is orthogonal +to the discussion here, and is controlled by the variables +@code{mm-body-charset-encoding-alist} and +@code{mm-content-transfer-encoding-defaults} (@pxref{Encoding +Customization}). @node Conversion @section Conversion @findex mime-to-mml -A (multipart) @sc{mime} message can be converted to MML with the -@code{mime-to-mml} function. It works on the message in the current -buffer, and substitutes MML markup for @sc{mime} boundaries. -Non-textual parts do not have their contents in the buffer, but instead -have the contents in separate buffers that are referred to from the MML -tags. +A (multipart) @acronym{MIME} message can be converted to @acronym{MML} +with the @code{mime-to-mml} function. It works on the message in the +current buffer, and substitutes @acronym{MML} markup for @acronym{MIME} +boundaries. Non-textual parts do not have their contents in the buffer, +but instead have the contents in separate buffers that are referred to +from the @acronym{MML} tags. @findex mml-to-mime -An MML message can be converted back to @sc{mime} by the +An @acronym{MML} message can be converted back to @acronym{MIME} by the @code{mml-to-mime} function. These functions are in certain senses ``lossy''---you will not get back -an identical message if you run @sc{mime-to-mml} and then -@sc{mml-to-mime}. Not only will trivial things like the order of the +an identical message if you run @code{mime-to-mml} and then +@code{mml-to-mime}. Not only will trivial things like the order of the headers differ, but the contents of the headers may also be different. For instance, the original message may use base64 encoding on text, -while @sc{mml-to-mime} may decide to use quoted-printable encoding, and +while @code{mml-to-mime} may decide to use quoted-printable encoding, and so on. In essence, however, these two functions should be the inverse of each @@ -1310,13 +949,783 @@ if not identical. +@node Flowed text +@section Flowed text +@cindex format=flowed + +The Emacs @acronym{MIME} library will respect the @code{use-hard-newlines} +variable (@pxref{Hard and Soft Newlines, ,Hard and Soft Newlines, +emacs, Emacs Manual}) when encoding a message, and the +``format=flowed'' Content-Type parameter when decoding a message. + +On encoding text, regardless of @code{use-hard-newlines}, lines +terminated by soft newline characters are filled together and wrapped +after the column decided by @code{fill-flowed-encode-column}. +Quotation marks (matching @samp{^>* ?}) are respected. The variable +controls how the text will look in a client that does not support +flowed text, the default is to wrap after 66 characters. If hard +newline characters are not present in the buffer, no flow encoding +occurs. + +On decoding flowed text, lines with soft newline characters are filled +together and wrapped after the column decided by +@code{fill-flowed-display-column}. The default is to wrap after +@code{fill-column}. + + + + +@node Interface Functions +@chapter Interface Functions +@cindex interface functions +@cindex mail-parse + +The @code{mail-parse} library is an abstraction over the actual +low-level libraries that are described in the next chapter. + +Standards change, and so programs have to change to fit in the new +mold. For instance, RFC2045 describes a syntax for the +@code{Content-Type} header that only allows @acronym{ASCII} characters in the +parameter list. RFC2231 expands on RFC2045 syntax to provide a scheme +for continuation headers and non-@acronym{ASCII} characters. + +The traditional way to deal with this is just to update the library +functions to parse the new syntax. However, this is sometimes the wrong +thing to do. In some instances it may be vital to be able to understand +both the old syntax as well as the new syntax, and if there is only one +library, one must choose between the old version of the library and the +new version of the library. + +The Emacs @acronym{MIME} library takes a different tack. It defines a +series of low-level libraries (@file{rfc2047.el}, @file{rfc2231.el} +and so on) that parses strictly according to the corresponding +standard. However, normal programs would not use the functions +provided by these libraries directly, but instead use the functions +provided by the @code{mail-parse} library. The functions in this +library are just aliases to the corresponding functions in the latest +low-level libraries. Using this scheme, programs get a consistent +interface they can use, and library developers are free to create +write code that handles new standards. + +The following functions are defined by this library: + +@table @code +@item mail-header-parse-content-type +@findex mail-header-parse-content-type +Parse a @code{Content-Type} header and return a list on the following +format: + +@lisp +("type/subtype" + (attribute1 . value1) + (attribute2 . value2) + ...) +@end lisp + +Here's an example: + +@example +(mail-header-parse-content-type + "image/gif; name=\"b980912.gif\"") +@result{} ("image/gif" (name . "b980912.gif")) +@end example + +@item mail-header-parse-content-disposition +@findex mail-header-parse-content-disposition +Parse a @code{Content-Disposition} header and return a list on the same +format as the function above. + +@item mail-content-type-get +@findex mail-content-type-get +Takes two parameters---a list on the format above, and an attribute. +Returns the value of the attribute. + +@example +(mail-content-type-get + '("image/gif" (name . "b980912.gif")) 'name) +@result{} "b980912.gif" +@end example + +@item mail-header-encode-parameter +@findex mail-header-encode-parameter +Takes a parameter string and returns an encoded version of the string. +This is used for parameters in headers like @code{Content-Type} and +@code{Content-Disposition}. + +@item mail-header-remove-comments +@findex mail-header-remove-comments +Return a comment-free version of a header. + +@example +(mail-header-remove-comments + "Gnus/5.070027 (Pterodactyl Gnus v0.27) (Finnish Landrace)") +@result{} "Gnus/5.070027 " +@end example + +@item mail-header-remove-whitespace +@findex mail-header-remove-whitespace +Remove linear white space from a header. Space inside quoted strings +and comments is preserved. + +@example +(mail-header-remove-whitespace + "image/gif; name=\"Name with spaces\"") +@result{} "image/gif;name=\"Name with spaces\"" +@end example + +@item mail-header-get-comment +@findex mail-header-get-comment +Return the last comment in a header. + +@example +(mail-header-get-comment + "Gnus/5.070027 (Pterodactyl Gnus v0.27) (Finnish Landrace)") +@result{} "Finnish Landrace" +@end example + +@item mail-header-parse-address +@findex mail-header-parse-address +Parse an address and return a list containing the mailbox and the +plaintext name. + +@example +(mail-header-parse-address + "Hrvoje Niksic ") +@result{} ("hniksic@@srce.hr" . "Hrvoje Niksic") +@end example + +@item mail-header-parse-addresses +@findex mail-header-parse-addresses +Parse a string with list of addresses and return a list of elements like +the one described above. + +@example +(mail-header-parse-addresses + "Hrvoje Niksic , Steinar Bang ") +@result{} (("hniksic@@srce.hr" . "Hrvoje Niksic") + ("sb@@metis.no" . "Steinar Bang")) +@end example + +@item mail-header-parse-date +@findex mail-header-parse-date +Parse a date string and return an Emacs time structure. + +@item mail-narrow-to-head +@findex mail-narrow-to-head +Narrow the buffer to the header section of the buffer. Point is placed +at the beginning of the narrowed buffer. + +@item mail-header-narrow-to-field +@findex mail-header-narrow-to-field +Narrow the buffer to the header under point. Understands continuation +headers. + +@item mail-header-fold-field +@findex mail-header-fold-field +Fold the header under point. + +@item mail-header-unfold-field +@findex mail-header-unfold-field +Unfold the header under point. + +@item mail-header-field-value +@findex mail-header-field-value +Return the value of the field under point. + +@item mail-encode-encoded-word-region +@findex mail-encode-encoded-word-region +Encode the non-@acronym{ASCII} words in the region. For instance, +@samp{Naïve} is encoded as @samp{=?iso-8859-1?q?Na=EFve?=}. + +@item mail-encode-encoded-word-buffer +@findex mail-encode-encoded-word-buffer +Encode the non-@acronym{ASCII} words in the current buffer. This function is +meant to be called narrowed to the headers of a message. + +@item mail-encode-encoded-word-string +@findex mail-encode-encoded-word-string +Encode the words that need encoding in a string, and return the result. + +@example +(mail-encode-encoded-word-string + "This is naïve, baby") +@result{} "This is =?iso-8859-1?q?na=EFve,?= baby" +@end example + +@item mail-decode-encoded-word-region +@findex mail-decode-encoded-word-region +Decode the encoded words in the region. + +@item mail-decode-encoded-word-string +@findex mail-decode-encoded-word-string +Decode the encoded words in the string and return the result. + +@example +(mail-decode-encoded-word-string + "This is =?iso-8859-1?q?na=EFve,?= baby") +@result{} "This is naïve, baby" +@end example + +@end table + +Currently, @code{mail-parse} is an abstraction over @code{ietf-drums}, +@code{rfc2047}, @code{rfc2045} and @code{rfc2231}. These are documented +in the subsequent sections. + + + +@node Basic Functions +@chapter Basic Functions + +This chapter describes the basic, ground-level functions for parsing and +handling. Covered here is parsing @code{From} lines, removing comments +from header lines, decoding encoded words, parsing date headers and so +on. High-level functionality is dealt with in the next chapter +(@pxref{Decoding and Viewing}). + +@menu +* rfc2045:: Encoding @code{Content-Type} headers. +* rfc2231:: Parsing @code{Content-Type} headers. +* ietf-drums:: Handling mail headers defined by RFC822bis. +* rfc2047:: En/decoding encoded words in headers. +* time-date:: Functions for parsing dates and manipulating time. +* qp:: Quoted-Printable en/decoding. +* base64:: Base64 en/decoding. +* binhex:: Binhex decoding. +* uudecode:: Uuencode decoding. +* yenc:: Yenc decoding. +* rfc1843:: Decoding HZ-encoded text. +* mailcap:: How parts are displayed is specified by the @file{.mailcap} file +@end menu + + +@node rfc2045 +@section rfc2045 + +RFC2045 is the ``main'' @acronym{MIME} document, and as such, one would +imagine that there would be a lot to implement. But there isn't, since +most of the implementation details are delegated to the subsequent +RFCs. + +So @file{rfc2045.el} has only a single function: + +@table @code +@item rfc2045-encode-string +@findex rfc2045-encode-string +Takes a parameter and a value and returns a @samp{PARAM=VALUE} string. +@var{value} will be quoted if there are non-safe characters in it. +@end table + + +@node rfc2231 +@section rfc2231 + +RFC2231 defines a syntax for the @code{Content-Type} and +@code{Content-Disposition} headers. Its snappy name is @dfn{MIME +Parameter Value and Encoded Word Extensions: Character Sets, Languages, +and Continuations}. + +In short, these headers look something like this: + +@example +Content-Type: application/x-stuff; + title*0*=us-ascii'en'This%20is%20even%20more%20; + title*1*=%2A%2A%2Afun%2A%2A%2A%20; + title*2="isn't it!" +@end example + +They usually aren't this bad, though. + +The following functions are defined by this library: + +@table @code +@item rfc2231-parse-string +@findex rfc2231-parse-string +Parse a @code{Content-Type} header and return a list describing its +elements. + +@example +(rfc2231-parse-string + "application/x-stuff; + title*0*=us-ascii'en'This%20is%20even%20more%20; + title*1*=%2A%2A%2Afun%2A%2A%2A%20; + title*2=\"isn't it!\"") +@result{} ("application/x-stuff" + (title . "This is even more ***fun*** isn't it!")) +@end example + +@item rfc2231-get-value +@findex rfc2231-get-value +Takes one of the lists on the format above and returns +the value of the specified attribute. + +@item rfc2231-encode-string +@findex rfc2231-encode-string +Encode a parameter in headers likes @code{Content-Type} and +@code{Content-Disposition}. + +@end table + + +@node ietf-drums +@section ietf-drums + +@dfn{drums} is an IETF working group that is working on the replacement +for RFC822. + +The functions provided by this library include: + +@table @code +@item ietf-drums-remove-comments +@findex ietf-drums-remove-comments +Remove the comments from the argument and return the results. + +@item ietf-drums-remove-whitespace +@findex ietf-drums-remove-whitespace +Remove linear white space from the string and return the results. +Spaces inside quoted strings and comments are left untouched. + +@item ietf-drums-get-comment +@findex ietf-drums-get-comment +Return the last most comment from the string. + +@item ietf-drums-parse-address +@findex ietf-drums-parse-address +Parse an address string and return a list that contains the mailbox and +the plain text name. + +@item ietf-drums-parse-addresses +@findex ietf-drums-parse-addresses +Parse a string that contains any number of comma-separated addresses and +return a list that contains mailbox/plain text pairs. + +@item ietf-drums-parse-date +@findex ietf-drums-parse-date +Parse a date string and return an Emacs time structure. + +@item ietf-drums-narrow-to-header +@findex ietf-drums-narrow-to-header +Narrow the buffer to the header section of the current buffer. + +@end table + + +@node rfc2047 +@section rfc2047 + +RFC2047 (Message Header Extensions for Non-@acronym{ASCII} Text) specifies how +non-@acronym{ASCII} text in headers are to be encoded. This is actually rather +complicated, so a number of variables are necessary to tweak what this +library does. + +The following variables are tweakable: + +@table @code +@item rfc2047-default-charset +@vindex rfc2047-default-charset +Characters in this charset should not be decoded by this library. +This defaults to @code{iso-8859-1}. + +@item rfc2047-header-encoding-alist +@vindex rfc2047-header-encoding-alist +This is an alist of header / encoding-type pairs. Its main purpose is +to prevent encoding of certain headers. + +The keys can either be header regexps, or @code{t}. + +The values can be either @code{nil}, in which case the header(s) in +question won't be encoded, or @code{mime}, which means that they will be +encoded. + +@item rfc2047-charset-encoding-alist +@vindex rfc2047-charset-encoding-alist +RFC2047 specifies two forms of encoding---@code{Q} (a +Quoted-Printable-like encoding) and @code{B} (base64). This alist +specifies which charset should use which encoding. + +@item rfc2047-encoding-function-alist +@vindex rfc2047-encoding-function-alist +This is an alist of encoding / function pairs. The encodings are +@code{Q}, @code{B} and @code{nil}. + +@item rfc2047-q-encoding-alist +@vindex rfc2047-q-encoding-alist +The @code{Q} encoding isn't quite the same for all headers. Some +headers allow a narrower range of characters, and that is what this +variable is for. It's an alist of header regexps / allowable character +ranges. + +@item rfc2047-encoded-word-regexp +@vindex rfc2047-encoded-word-regexp +When decoding words, this library looks for matches to this regexp. + +@end table + +Those were the variables, and these are this functions: + +@table @code +@item rfc2047-narrow-to-field +@findex rfc2047-narrow-to-field +Narrow the buffer to the header on the current line. + +@item rfc2047-encode-message-header +@findex rfc2047-encode-message-header +Should be called narrowed to the header of a message. Encodes according +to @code{rfc2047-header-encoding-alist}. + +@item rfc2047-encode-region +@findex rfc2047-encode-region +Encodes all encodable words in the region specified. + +@item rfc2047-encode-string +@findex rfc2047-encode-string +Encode a string and return the results. + +@item rfc2047-decode-region +@findex rfc2047-decode-region +Decode the encoded words in the region. + +@item rfc2047-decode-string +@findex rfc2047-decode-string +Decode a string and return the results. + +@end table + + +@node time-date +@section time-date + +While not really a part of the @acronym{MIME} library, it is convenient to +document this library here. It deals with parsing @code{Date} headers +and manipulating time. (Not by using tesseracts, though, I'm sorry to +say.) + +These functions convert between five formats: A date string, an Emacs +time structure, a decoded time list, a second number, and a day number. + +Here's a bunch of time/date/second/day examples: + +@example +(parse-time-string "Sat Sep 12 12:21:54 1998 +0200") +@result{} (54 21 12 12 9 1998 6 nil 7200) + +(date-to-time "Sat Sep 12 12:21:54 1998 +0200") +@result{} (13818 19266) + +(time-to-seconds '(13818 19266)) +@result{} 905595714.0 + +(seconds-to-time 905595714.0) +@result{} (13818 19266 0) + +(time-to-days '(13818 19266)) +@result{} 729644 + +(days-to-time 729644) +@result{} (961933 65536) + +(time-since '(13818 19266)) +@result{} (0 430) + +(time-less-p '(13818 19266) '(13818 19145)) +@result{} nil + +(subtract-time '(13818 19266) '(13818 19145)) +@result{} (0 121) + +(days-between "Sat Sep 12 12:21:54 1998 +0200" + "Sat Sep 07 12:21:54 1998 +0200") +@result{} 5 + +(date-leap-year-p 2000) +@result{} t + +(time-to-day-in-year '(13818 19266)) +@result{} 255 + +(time-to-number-of-days + (time-since + (date-to-time "Mon, 01 Jan 2001 02:22:26 GMT"))) +@result{} 4.146122685185185 +@end example + +And finally, we have @code{safe-date-to-time}, which does the same as +@code{date-to-time}, but returns a zero time if the date is +syntactically malformed. + +The five data representations used are the following: + +@table @var +@item date +An RFC822 (or similar) date string. For instance: @code{"Sat Sep 12 +12:21:54 1998 +0200"}. + +@item time +An internal Emacs time. For instance: @code{(13818 26466)}. + +@item seconds +A floating point representation of the internal Emacs time. For +instance: @code{905595714.0}. + +@item days +An integer number representing the number of days since 00000101. For +instance: @code{729644}. + +@item decoded time +A list of decoded time. For instance: @code{(54 21 12 12 9 1998 6 t +7200)}. +@end table + +All the examples above represent the same moment. + +These are the functions available: + +@table @code +@item date-to-time +Take a date and return a time. + +@item time-to-seconds +Take a time and return seconds. + +@item seconds-to-time +Take seconds and return a time. + +@item time-to-days +Take a time and return days. + +@item days-to-time +Take days and return a time. + +@item date-to-day +Take a date and return days. + +@item time-to-number-of-days +Take a time and return the number of days that represents. + +@item safe-date-to-time +Take a date and return a time. If the date is not syntactically valid, +return a ``zero'' date. + +@item time-less-p +Take two times and say whether the first time is less (i. e., earlier) +than the second time. + +@item time-since +Take a time and return a time saying how long it was since that time. + +@item subtract-time +Take two times and subtract the second from the first. I. e., return +the time between the two times. + +@item days-between +Take two days and return the number of days between those two days. + +@item date-leap-year-p +Take a year number and say whether it's a leap year. + +@item time-to-day-in-year +Take a time and return the day number within the year that the time is +in. + +@end table + + +@node qp +@section qp + +This library deals with decoding and encoding Quoted-Printable text. + +Very briefly explained, qp encoding means translating all 8-bit +characters (and lots of control characters) into things that look like +@samp{=EF}; that is, an equal sign followed by the byte encoded as a hex +string. + +The following functions are defined by the library: + +@table @code +@item quoted-printable-decode-region +@findex quoted-printable-decode-region +QP-decode all the encoded text in the specified region. + +@item quoted-printable-decode-string +@findex quoted-printable-decode-string +Decode the QP-encoded text in a string and return the results. + +@item quoted-printable-encode-region +@findex quoted-printable-encode-region +QP-encode all the encodable characters in the specified region. The third +optional parameter @var{fold} specifies whether to fold long lines. +(Long here means 72.) + +@item quoted-printable-encode-string +@findex quoted-printable-encode-string +QP-encode all the encodable characters in a string and return the +results. + +@end table + + +@node base64 +@section base64 +@cindex base64 + +Base64 is an encoding that encodes three bytes into four characters, +thereby increasing the size by about 33%. The alphabet used for +encoding is very resistant to mangling during transit. + +The following functions are defined by this library: + +@table @code +@item base64-encode-region +@findex base64-encode-region +base64 encode the selected region. Return the length of the encoded +text. Optional third argument @var{no-line-break} means do not break +long lines into shorter lines. + +@item base64-encode-string +@findex base64-encode-string +base64 encode a string and return the result. + +@item base64-decode-region +@findex base64-decode-region +base64 decode the selected region. Return the length of the decoded +text. If the region can't be decoded, return @code{nil} and don't +modify the buffer. + +@item base64-decode-string +@findex base64-decode-string +base64 decode a string and return the result. If the string can't be +decoded, @code{nil} is returned. + +@end table + + +@node binhex +@section binhex +@cindex binhex +@cindex Apple +@cindex Macintosh + +@code{binhex} is an encoding that originated in Macintosh environments. +The following function is supplied to deal with these: + +@table @code +@item binhex-decode-region +@findex binhex-decode-region +Decode the encoded text in the region. If given a third parameter, only +decode the @code{binhex} header and return the filename. + +@end table + +@node uudecode +@section uudecode +@cindex uuencode +@cindex uudecode + +@code{uuencode} is probably still the most popular encoding of binaries +used on Usenet, although @code{base64} rules the mail world. + +The following function is supplied by this package: + +@table @code +@item uudecode-decode-region +@findex uudecode-decode-region +Decode the text in the region. +@end table + + +@node yenc +@section yenc +@cindex yenc + +@code{yenc} is used for encoding binaries on Usenet. The following +function is supplied by this package: + +@table @code +@item yenc-decode-region +@findex yenc-decode-region +Decode the encoded text in the region. + +@end table + + +@node rfc1843 +@section rfc1843 +@cindex rfc1843 +@cindex HZ +@cindex Chinese + +RFC1843 deals with mixing Chinese and @acronym{ASCII} characters in messages. In +essence, RFC1843 switches between @acronym{ASCII} and Chinese by doing this: + +@example +This sentence is in @acronym{ASCII}. +The next sentence is in GB.~@{<:Ky2;S@{#,NpJ)l6HK!#~@}Bye. +@end example + +Simple enough, and widely used in China. + +The following functions are available to handle this encoding: + +@table @code +@item rfc1843-decode-region +Decode HZ-encoded text in the region. + +@item rfc1843-decode-string +Decode a HZ-encoded string and return the result. + +@end table + + +@node mailcap +@section mailcap + +The @file{~/.mailcap} file is parsed by most @acronym{MIME}-aware message +handlers and describes how elements are supposed to be displayed. +Here's an example file: + +@example +image/*; gimp -8 %s +audio/wav; wavplayer %s +application/msword; catdoc %s ; copiousoutput ; nametemplate=%s.doc +@end example + +This says that all image files should be displayed with @code{gimp}, +that WAVE audio files should be played by @code{wavplayer}, and that +MS-WORD files should be inlined by @code{catdoc}. + +The @code{mailcap} library parses this file, and provides functions for +matching types. + +@table @code +@item mailcap-mime-data +@vindex mailcap-mime-data +This variable is an alist of alists containing backup viewing rules. + +@end table + +Interface functions: + +@table @code +@item mailcap-parse-mailcaps +@findex mailcap-parse-mailcaps +Parse the @file{~/.mailcap} file. + +@item mailcap-mime-info +Takes a @acronym{MIME} type as its argument and returns the matching viewer. + +@end table + + + + @node Standards @chapter Standards -The Emacs @sc{mime} library implements handling of various elements +The Emacs @acronym{MIME} library implements handling of various elements according to a (somewhat) large number of RFCs, drafts and standards documents. This chapter lists the relevant ones. They can all be -fetched from @samp{http://quimby.gnus.org/notes/}. +fetched from @uref{http://quimby.gnus.org/notes/}. @table @dfn @item RFC822 @@ -1326,10 +1735,6 @@ @item RFC1036 Standard for Interchange of USENET Messages -@item RFC1524 -A User Agent Configuration Mechanism For Multimedia Mail Format -Information - @item RFC2045 Format of Internet Message Bodies @@ -1337,7 +1742,7 @@ Media Types @item RFC2047 -Message Header Extensions for Non-ASCII Text +Message Header Extensions for Non-@acronym{ASCII} Text @item RFC2048 Registration Procedures @@ -1346,18 +1751,18 @@ Conformance Criteria and Examples @item RFC2231 -MIME Parameter Value and Encoded Word Extensions: Character Sets, +@acronym{MIME} Parameter Value and Encoded Word Extensions: Character Sets, Languages, and Continuations @item RFC1843 HZ - A Data Format for Exchanging Files of Arbitrarily Mixed Chinese and -ASCII characters +@acronym{ASCII} characters @item draft-ietf-drums-msg-fmt-05.txt Draft for the successor of RFC822 @item RFC2112 -The MIME Multipart/Related Content-type +The @acronym{MIME} Multipart/Related Content-type @item RFC1892 The Multipart/Report Content Type for the Reporting of Mail System @@ -1367,18 +1772,24 @@ Communicating Presentation Information in Internet Messages: The Content-Disposition Header Field +@item RFC2646 +Documentation of the text/plain format parameter for flowed text. + @end table @node Index @chapter Index @printindex cp -@printindex fn @summarycontents @contents @bye + +@c Local Variables: +@c mode: texinfo +@c coding: iso-8859-1 @c End: @ignore diff -r b6e48fab7ff3 -r fd8097053f04 man/gnus-faq.texi --- a/man/gnus-faq.texi Mon Aug 02 13:28:45 2004 +0000 +++ b/man/gnus-faq.texi Mon Aug 02 13:38:50 2004 +0000 @@ -1,675 +1,2606 @@ @c Insert "\input texinfo" at 1st line before texing this file alone. @c -*-texinfo-*- -@c Copyright (C) 1995, 98, 99, 2000 Free Software Foundation, Inc. -@setfilename ../info/gnus-faq.info +@c Copyright (C) 1995, 2001, 2003, 2004 Free Software Foundation, Inc. +@setfilename gnus-faq.info + +@c Frequently Asked Questions, FAQ - Introduction, Emacs for Heathens, Top @node Frequently Asked Questions +@comment node-name, next, previous, up + +@c @chapter Frequently Asked Questions @section Frequently Asked Questions - -This is the Gnus Frequently Asked Questions list. -If you have a Web browser, the official hypertext version is at -@file{http://www.ccs.neu.edu/software/gnus/}, and has -probably been updated since you got this manual. +@cindex FAQ +@cindex Frequently Asked Questions + +@c - Uncomment @chapter, comment @section +@c - run (texinfo-every-node-update) +@c - revert it. @menu -* Installation FAQ:: Installation of Gnus. -* Customization FAQ:: Customizing Gnus. -* Reading News FAQ:: News Reading Questions. -* Reading Mail FAQ:: Mail Reading Questions. +* FAQ - Introduction:: About Gnus and this FAQ. +* FAQ 1 - Installation:: Installation of Gnus. +* FAQ 2 - Startup / Group buffer:: Start up questions and the first + buffer Gnus shows you. +* FAQ 3 - Getting messages:: Making Gnus read your mail and news. +* FAQ 4 - Reading messages:: How to efficiently read messages. +* FAQ 5 - Composing messages:: Composing mails or Usenet postings. +* FAQ 6 - Old messages:: Importing, archiving, searching + and deleting messages. +* FAQ 7 - Gnus in a dial-up environment:: Reading mail and news while offline. +* FAQ 8 - Getting help:: When this FAQ isn't enough. +* FAQ 9 - Tuning Gnus:: How to make Gnus faster. +* FAQ - Glossary:: Terms used in the FAQ explained. @end menu -@node Installation FAQ +@subheading Abstract + + This is the new Gnus Frequently Asked Questions list. If you have a +Web browser, the official hypertext version is at +@uref{http://my.gnus.org/FAQ/}, the Docbook source is available from +@uref{http://sourceforge.net/projects/gnus/}. + + + Please submit features and suggestions to the + @email{faq-discuss@@my.gnus.org,FAQ discussion list}. + The list is protected against junk mail with + @uref{http://smarden.org/qconfirm/index.html,qconfirm, qconfirm}. As + a subscriber, your submissions will automatically pass. You can + also subscribe to the list by sending a blank email to + @email{faq-discuss-subscribe@@my.gnus.org} + and + @uref{http://mail1.kens.com/cgi-bin/ezmlm-browse?command=monthbythread%26list=faq-discuss,browse + the archive, browse the archive}. + +@node FAQ - Introduction, FAQ 1 - Installation, Frequently Asked Questions, Frequently Asked Questions +@comment node-name, next, previous, up +@heading Introduction + +This is the Gnus Frequently Asked Questions list. + +Gnus is a Usenet Newsreader and Electronic Mail User Agent implemented + as a part of Emacs. It's been around in some form for almost a decade + now, and has been distributed as a standard part of Emacs for much of + that time. Gnus 5 is the latest (and greatest) incarnation. The + original version was called GNUS, and was written by Masanobu UMEDA. + When autumn crept up in '94, Lars Magne Ingebrigtsen grew bored and + decided to rewrite Gnus. + + Its biggest strength is the fact that it is extremely + customizable. It is somewhat intimidating at first glance, but + most of the complexity can be ignored until you're ready to take + advantage of it. If you receive a reasonable volume of e-mail + (you're on various mailing lists), or you would like to read + high-volume mailing lists but cannot keep up with them, or read + high volume newsgroups or are just bored, then Gnus is what you + want. + + This FAQ was maintained by Justin Sheehy until March 2002. He + would like to thank Steve Baur and Per Abrahamsen for doing a wonderful + job with this FAQ before him. We would like to do the same - thanks, + Justin! + + + If you have a Web browser, the official hypertext version is at:@* + @uref{http://my.gnus.org/FAQ/}. + This version is much nicer than the unofficial hypertext + versions that are archived at Utrecht, Oxford, Smart Pages, Ohio + State, and other FAQ archives. See the resources question below + if you want information on obtaining it in another format. + + + The information contained here was compiled with the assistance + of the Gnus development mailing list, and any errors or + misprints are the my.gnus.org team's fault, sorry. + + +@ifnottex +@node FAQ 1 - Installation, FAQ 2 - Startup / Group buffer, FAQ - Introduction, Frequently Asked Questions +@end ifnottex @subsection Installation -@itemize @bullet -@item -Q1.1 What is the latest version of Gnus? - -The latest (and greatest) version is 5.0.10. You might also run -across something called @emph{September Gnus}. September Gnus -is the alpha version of the next major release of Gnus. It is currently -not stable enough to run unless you are prepared to debug lisp. - -@item -Q1.2 Where do I get Gnus? - -Any of the following locations: - -@itemize @minus -@item -@file{ftp://ftp.ifi.uio.no/pub/emacs/gnus/gnus.tar.gz} - -@item -@file{ftp://ftp.pilgrim.umass.edu/pub/misc/ding/} - -@item -@file{gopher://gopher.pilgrim.umass.edu/11/pub/misc/ding/} - -@item -@file{ftp://aphrodite.nectar.cs.cmu.edu/pub/ding-gnus/} - -@item -@file{ftp://ftp.solace.mh.se:/pub/gnu/elisp/} - -@end itemize - -@item -Q1.3 Which version of Emacs do I need? - -At least GNU Emacs 19.28, or XEmacs 19.12 is recommended. GNU Emacs -19.25 has been reported to work under certain circumstances, but it -doesn't @emph{officially} work on it. 19.27 has also been reported to -work. Gnus has been reported to work under OS/2 as well as Unix. - - -@item -Q1.4 Where is timezone.el? - -Upgrade to XEmacs 19.13. In earlier versions of XEmacs this file was -placed with Gnus 4.1.3, but that has been corrected. - - -@item -Q1.5 When I run Gnus on XEmacs 19.13 I get weird error messages. - -You're running an old version of Gnus. Upgrade to at least version -5.0.4. - - -@item -Q1.6 How do I unsubscribe from the Mailing List? - -Send an e-mail message to @file{ding-request@@ifi.uio.no} with the magic word -@emph{unsubscribe} somewhere in it, and you will be removed. - -If you are reading the digest version of the list, send an e-mail message -to @* -@file{ding-rn-digests-d-request@@moe.shore.net} -with @emph{unsubscribe} as the subject and you will be removed. - - -@item -Q1.7 How do I run Gnus on both Emacs and XEmacs? - -The basic answer is to byte-compile under XEmacs, and then you can -run under either Emacsen. There is, however, a potential version -problem with easymenu.el with Gnu Emacs prior to 19.29. - -Per Abrahamsen writes :@* -The internal easymenu.el interface changed between 19.28 and 19.29 in -order to make it possible to create byte compiled files that can be -shared between Gnu Emacs and XEmacs. The change is upward -compatible, but not downward compatible. -This gives the following compatibility table: - -@example -Compiled with: | Can be used with: -----------------+-------------------------------------- -19.28 | 19.28 19.29 -19.29 | 19.29 XEmacs -XEmacs | 19.29 XEmacs -@end example - -If you have Gnu Emacs 19.28 or earlier, or XEmacs 19.12 or earlier, get -a recent version of auc-menu.el from -@file{ftp://ftp.iesd.auc.dk/pub/emacs-lisp/auc-menu.el}, and install it -under the name easymenu.el somewhere early in your load path. - - -@item -Q1.8 What resources are available? - -There is the newsgroup Gnu.emacs.gnus. Discussion of Gnus 5.x is now -taking place there. There is also a mailing list, send mail to -@file{ding-request@@ifi.uio.no} with the magic word @emph{subscribe} -somewhere in it. - -@emph{NOTE:} the traffic on this list is heavy so you may not want to be -on it (unless you use Gnus as your mailer reader, that is). The mailing -list is mainly for developers and testers. - -Gnus has a home World Wide Web page at@* -@file{http://www.gnus.org/}. - -Gnus has a write up in the X Applications FAQ at@* -@file{http://www.ee.ryerson.ca:8080/~elf/xapps/Q-III.html}. - -The Gnus manual is also available on the World Wide Web. The canonical -source is in Norway at@* -@file{http://www.gnus.org/manual/gnus_toc.html}. - -There are three mirrors in the United States: -@enumerate -@item -@file{http://www.miranova.com/gnus-man/} - -@item -@file{http://www.pilgrim.umass.edu/pub/misc/ding/manual/gnus_toc.html} - -@item -@file{http://www.rtd.com/~woo/gnus/} - -@end enumerate - -PostScript copies of the Gnus Reference card are available from@* -@file{ftp://ftp.cs.ualberta.ca/pub/oolog/gnus/}. They are mirrored at@* -@file{ftp://ftp.pilgrim.umass.edu/pub/misc/ding/refcard/} in the -United States. And@* -@file{ftp://marvin.fkphy.uni-duesseldorf.de/pub/gnus/} -in Germany. - -An online version of the Gnus FAQ is available at@* -@file{http://www.miranova.com/~steve/gnus-faq.html}. Off-line formats -are also available:@* -ASCII: @file{ftp://ftp.miranova.com/pub/gnus/gnus-faq}@* -PostScript: @file{ftp://ftp.miranova.com/pub/gnus/gnus-faq.ps}. - - -@item -Q1.9 Gnus hangs on connecting to NNTP server - -I am running XEmacs on SunOS and Gnus prints a message about Connecting -to NNTP server and then just hangs. - -Ben Wing writes :@* -I wonder if you're hitting the infamous @emph{libresolv} problem. -The basic problem is that under SunOS you can compile either -with DNS or NIS name lookup libraries but not both. Try -substituting the IP address and see if that works; if so, you -need to download the sources and recompile. - - -@item -Q1.10 Mailcrypt 3.4 doesn't work - -This problem is verified to still exist in Gnus 5.0.9 and Mailcrypt 3.4. -The answer comes from Peter Arius -. - -I found out that mailcrypt uses -@code{gnus-eval-in-buffer-window}, which is a macro. -It seems as if you have -compiled mailcrypt with plain old GNUS in load path, and the XEmacs byte -compiler has inserted that macro definition into -@file{mc-toplev.elc}. -The solution is to recompile @file{mc-toplev.el} with Gnus 5 in -load-path, and it works fine. - -Steve Baur adds :@* -The problem also manifests itself if neither GNUS 4 nor Gnus 5 is in the -load-path. - - -@item -Q1.11 What other packages work with Gnus? - -@itemize @minus -@item -Mailcrypt. - -Mailcrypt is an Emacs interface to PGP. It works, it installs -without hassle, and integrates very easily. Mailcrypt can be -obtained from@* -@file{ftp://cag.lcs.mit.edu/pub/patl/mailcrypt-3.4.tar.gz}. - -@item -Tools for Mime. - -Tools for Mime is an Emacs MUA interface to MIME. Installation is -a two-step process unlike most other packages, so you should -be prepared to move the byte-compiled code somewhere. There -are currently two versions of this package available. It can -be obtained from@* -@file{ftp://ftp.jaist.ac.jp/pub/GNU/elisp/}. -Be sure to apply the supplied patch. It works with Gnus through -version 5.0.9. In order for all dependencies to work correctly -the load sequence is as follows: -@lisp - (load "tm-setup") - (load "gnus") - (load "mime-compose") -@end lisp - -@emph{NOTE:} Loading the package disables citation highlighting by -default. To get the old behavior back, use the @kbd{M-t} command. - -@end itemize - -@end itemize - - -@node Customization FAQ -@subsection Customization - -@itemize @bullet -@item -Q2.1 Custom Edit does not work under XEmacs - -The custom package has not been ported to XEmacs. - - -@item -Q2.2 How do I quote messages? - -I see lots of messages with quoted material in them. I am wondering -how to have Gnus do it for me. - -This is Gnus, so there are a number of ways of doing this. You can use -the built-in commands to do this. There are the @kbd{F} and @kbd{R} -keys from the summary buffer which automatically include the article -being responded to. These commands are also selectable as @i{Followup -and Yank} and @i{Reply and Yank} in the Post menu. - -@kbd{C-c C-y} grabs the previous message and prefixes each line with -@code{ail-indentation-spaces} spaces or @code{mail-yank-prefix} if that is -non-nil, unless you have set your own @code{mail-citation-hook}, which will -be called to do the job. - -You might also consider the Supercite package, which allows for pretty -arbitrarily complex quoting styles. Some people love it, some people -hate it. - - -@item -Q2.3 How can I keep my nnvirtual:* groups sorted? - -How can I most efficiently arrange matters so as to keep my nnvirtual:* -(etc) groups at the top of my group selection buffer, whilst keeping -everything sorted in alphabetical order. - -If you don't subscribe often to new groups then the easiest way is to -first sort the groups and then manually kill and yank the virtuals -wherever you want them. - - -@item -Q2.4 Any good suggestions on stuff for an all.SCORE file? - -Here is a collection of suggestions from the Gnus mailing list. - -@enumerate -@item -From ``Dave Disser'' @* -I like blasting anything without lowercase letters. Weeds out most of -the make $$ fast, as well as the lame titles like ``IBM'' and ``HP-UX'' -with no further description. -@lisp - (("Subject" - ("^\\(Re: \\)?[^a-z]*$" -200 nil R))) -@end lisp - -@item -From ``Peter Arius'' @* -The most vital entries in my (still young) all.SCORE: -@lisp -(("xref" - ("alt.fan.oj-simpson" -1000 nil s)) - ("subject" - (concat "\\<\\(make\\|fast\\|big\\)\\s-*" - "\\(money\\|cash\\|bucks?\\)\\>" - -1000 nil r) - ("$$$$" -1000 nil s))) -@end lisp - -@item -From ``Per Abrahamsen'' @* -@lisp -(("subject" - ;; CAPS OF THE WORLD, UNITE - ("^..[^a-z]+$" -1 nil R) - ;; $$$ Make Money $$$ (Try work) - ("$" -1 nil s) - ;; I'm important! And I have exclamation marks to prove it! - ("!" -1 nil s))) -@end lisp +@menu +* [1.1]:: What is the latest version of Gnus? +* [1.2]:: What's new in 5.10.0? +* [1.3]:: Where and how to get Gnus? +* [1.4]:: What to do with the tarball now? +* [1.5]:: Which version of Emacs do I need? +* [1.6]:: How do I run Gnus on both Emacs and XEmacs? +@end menu + + +@ifnottex +@node [1.1], [1.2], FAQ 1 - Installation, FAQ 1 - Installation +@end ifnottex +@subsubheading Question 1.1: + +What is the latest version of Gnus? + +Answer: + + Jingle please: Gnus 5.10.0 is released, get it while it's + hot! As well as the step in version number is rather + small, Gnus 5.10 has tons of new features which you + shouldn't miss, however if you are cautious, you might + prefer to stay with 5.8.8 respectively 5.9 (they are + basically the same) until some bugfix releases are out. + +@ifnottex +@node [1.2], [1.3], [1.1], FAQ 1 - Installation +@end ifnottex +@subsubheading Question 1.2: + +What's new in 5.10.0? + +Answer: + + First of all, you should have a look into the file + GNUS-NEWS in the toplevel directory of the Gnus tarball, + there the most important changes are listed. Here's a + short list of the changes I find especially + important/interesting: + + + + +@itemize @bullet{} @item -From ``heddy boubaker'' @* -I would like to contribute with mine. -@lisp -( - (read-only t) - ("subject" - ;; ALL CAPS SUBJECTS - ("^\\([Rr][Ee]: +\\)?[^a-z]+$" -1 nil R) - ;; $$$ Make Money $$$ - ("$$" -10 nil s) - ;; Empty subjects are worthless! - ("^ *\\([(<]none[>)]\\|(no subject\\( given\\)?)\\)? *$" - -10 nil r) - ;; Sometimes interesting announces occur! - ("ANN?OU?NC\\(E\\|ING\\)" +10 nil r) - ;; Some people think they're on mailing lists - ("\\(un\\)?sub?scribe" -100 nil r) - ;; Stop Micro$oft NOW!! - ;; ("concat" used to avoid overfull box.) - (concat "\\(m\\(icro\\)?[s$]\\(oft\\|lot\\)?-?\\)?" - "wind?\\(ows\\|aube\\|oze\\)?[- ]*" - "\\('?95\\|NT\\|3[.]1\\|32\\)" -1001 nil r) - ;; I've nothing to buy - ("\\(for\\|4\\)[- ]*sale" -100 nil r) - ;; SELF-DISCIPLINED people - ("\\[[^a-z0-9 \t\n][^a-z0-9 \t\n]\\]" +100 nil r) - ) - ("from" - ;; To keep track of posters from my site - (".dgac.fr" +1000 nil s)) - ("followup" - ;; Keep track of answers to my posts - ("boubaker" +1000 nil s)) - ("lines" - ;; Some people have really nothing to say!! - (1 -10 nil <=)) - (mark -100) - (expunge -1000) - ) -@end lisp - + Major rewrite of the Gnus agent, Gnus agent is now + active by default. + +@item + Many new article washing functions for dealing with + ugly formatted articles. + +@item + Anti Spam features. + +@item + message-utils now included in Gnus. + @item -From ``Christopher Jones'' @* -The sample @file{all.SCORE} files from Per and boubaker could be -augmented with: -@lisp - (("subject" - ;; No junk mail please! - ("please ignore" -500 nil s) - ("test" -500 nil e)) - ) -@end lisp - -@item -From ``Brian Edmonds'' @* -Augment any of the above with a fast method of scoring down -excessively cross posted articles. -@lisp - ("xref" - ;; the more cross posting, the exponentially worse the article - ("^xref: \\S-+ \\S-+ \\S-+ \\S-+" -1 nil r) - ("^xref: \\S-+ \\S-+ \\S-+ \\S-+ \\S-+" -2 nil r) - ("^xref: \\S-+ \\S-+ \\S-+ \\S-+ \\S-+ \\S-+" -4 nil r) - ("^xref: \\S-+ \\S-+ \\S-+ \\S-+ \\S-+ \\S-+ \\S-+" -8 nil r) - ("^xref: \\S-+ \\S-+ \\S-+ \\S-+ \\S-+ \\S-+ \\S-+ \\S-+" - -16 nil r) - (concat "^xref: \\S-+ \\S-+ \\S-+ \\S-+ \\S-+ \\S-+ \\S-+" - " \\S-+ \\S-+" - -32 nil r) - (concat "^xref: \\S-+ \\S-+ \\S-+ \\S-+ \\S-+ \\S-+ \\S-+" - " \\S-+ \\S-+ \\S-+" -64 nil r) - (concat "^xref: \\S-+ \\S-+ \\S-+ \\S-+ \\S-+ \\S-+ \\S-+" - " \\S-+ \\S-+ \\S-+ \\S-+" -128 nil r) - (concat "^xref: \\S-+ \\S-+ \\S-+ \\S-+ \\S-+ \\S-+ \\S-+" - " \\S-+ \\S-+ \\S-+ \\S-+ \\S-+" -256 nil r) - (concat "^xref: \\S-+ \\S-+ \\S-+ \\S-+ \\S-+ \\S-+ \\S-+" - " \\S-+" \\S-+ \\S-+ \\S-+ \\S-+ \\S-+" -512 nil r)) -@end lisp - -@end enumerate - - -@item -Q2.5 What do I use to yank-through when replying? - -You should probably reply and followup with @kbd{R} and @kbd{F}, instead -of @kbd{r} and @kbd{f}, which solves your problem. But you could try -something like: + New format specifiers for summary lines, e.g. %B for + a complex trn-style thread tree. + +@end itemize + +@ifnottex +@node [1.3], [1.4], [1.2], FAQ 1 - Installation +@end ifnottex +@subsubheading Question 1.3: + +Where and how to get Gnus? + +Answer: + + The latest released version of Gnus isn't included in + Emacs 21 and until now it also isn't available through the + package system of XEmacs 21.4, therefor you should get the + Gnus tarball from + @uref{http://www.gnus.org/dist/gnus.tar.gz} + or via anonymous FTP from + @uref{ftp://ftp.gnus.org/pub/gnus/gnus.tar.gz}. + +@ifnottex +@node [1.4], [1.5], [1.3], FAQ 1 - Installation +@end ifnottex +@subsubheading Question 1.4: + + What to do with the tarball now? + + +Answer: + + Untar it via @samp{tar xvzf gnus.tar.gz} and do the common + @samp{./configure; make; make install} circle. + (under MS-Windows either get the Cygwin environment from + @uref{http://www.cygwin.com} + which allows you to do what's described above or unpack the + tarball with some packer (e.g. Winace from + @uref{http://www.winace.com}) + and use the batch-file make.bat included in the tarball to install + Gnus. If you don't want to (or aren't allowed to) install Gnus + system-wide, you can install it in your home directory and add the + following lines to your ~/.xemacs/init.el or ~/.emacs: + + +@example +(add-to-list 'load-path "/path/to/gnus/lisp") +(if (featurep 'xemacs) + (add-to-list 'Info-directory-list "/path/to/gnus/texi/") + (add-to-list 'Info-default-directory-list "/path/to/gnus/texi/")) +@end example + +@noindent + Make sure that you don't have any Gnus related stuff + before this line, on MS Windows use something like + "C:/path/to/lisp" (yes, "/"). + +@ifnottex +@node [1.5], [1.6], [1.4], FAQ 1 - Installation +@end ifnottex +@subsubheading Question 1.5: + +Which version of Emacs do I need? + +Answer: + + Gnus 5.10.0 requires an Emacs version that is greater + than or equal to Emacs 20.7 or XEmacs 21.1. + +@ifnottex +@node [1.6], , [1.5], FAQ 1 - Installation +@end ifnottex +@subsubheading Question 1.6: + +How do I run Gnus on both Emacs and XEmacs? + +Answer: + + You can't use the same copy of Gnus in both as the Lisp + files are byte-compiled to a format which is different + depending on which Emacs did the compilation. Get one copy + of Gnus for Emacs and one for XEmacs. + +@ifnottex +@node FAQ 2 - Startup / Group buffer, FAQ 3 - Getting messages, FAQ 1 - Installation, Frequently Asked Questions +@end ifnottex +@subsection Startup / Group buffer + +@menu +* [2.1]:: Every time I start Gnus I get a message + "Gnus auto-save file exists. Do you want to read it?", + what does this mean and how to prevent it? +* [2.2]:: Gnus doesn't remember which groups I'm subscribed to, what's this? +* [2.3]:: How to change the format of the lines in Group buffer? +* [2.4]:: My group buffer becomes a bit crowded, is there a way to sort my + groups into categories so I can easier browse through them? +* [2.5]:: How to manually sort the groups in Group buffer? How to sort the + groups in a topic? +@end menu + +@ifnottex +@node [2.1], [2.2], FAQ 2 - Startup / Group buffer, FAQ 2 - Startup / Group buffer +@end ifnottex +@subsubheading Question 2.1: + + Every time I start Gnus I get a message "Gnus auto-save + file exists. Do you want to read it?", what does this mean + and how to prevent it? + + +Answer: + + This message means that the last time you used Gnus, it + wasn't properly exited and therefor couldn't write its + informations to disk (e.g. which messages you read), you + are now asked if you want to restore those informations + from the auto-save file. + + + To prevent this message make sure you exit Gnus + via @samp{q} in group buffer instead of + just killing Emacs. + +@ifnottex +@node [2.2], [2.3], [2.1], FAQ 2 - Startup / Group buffer +@end ifnottex +@subsubheading Question: 2.2 + + Gnus doesn't remember which groups I'm subscribed to, + what's this? + + +Answer: + + You get the message described in the q/a pair above while + starting Gnus, right? It's an other symptom for the same + problem, so read the answer above. + +@ifnottex +@node [2.3], [2.4], [2.2], FAQ 2 - Startup / Group buffer +@end ifnottex +@subsubheading Question 2.3: + + How to change the format of the lines in Group buffer? + + +Answer: + + You've got to tweak the value of the variable + gnus-group-line-format. See the manual node "Group Line + Specification" for information on how to do this. An + example for this (guess from whose .gnus :-)): + + +@example + +(setq gnus-group-line-format "%P%M%S[%5t]%5y : %(%g%)\n") + +@end example + +@ifnottex +@node [2.4], [2.5], [2.3], FAQ 2 - Startup / Group buffer +@end ifnottex +@subsubheading Question 2.4: + + My group buffer becomes a bit crowded, is there a way to + sort my groups into categories so I can easier browse + through them? + + +Answer: + + Gnus offers the topic mode, it allows you to sort your + groups in, well, topics, e.g. all groups dealing with + Linux under the topic linux, all dealing with music under + the topic music and all dealing with scottish music under + the topic scottish which is a subtopic of music. + + + To enter topic mode, just hit t while in Group buffer. Now + you can use @samp{T n} to create a topic + at point and @samp{T m} to move a group to + a specific topic. For more commands see the manual or the + menu. You might want to include the %P specifier at the + beginning of your gnus-group-line-format variable to have + the groups nicely indented. + +@ifnottex +@node [2.5], , [2.4], FAQ 2 - Startup / Group buffer +@end ifnottex +@subsubheading Question 2.5: + + How to manually sort the groups in Group buffer? How to + sort the groups in a topic? + + +Answer: + + Move point over the group you want to move and + hit @samp{C-k}, now move point to the + place where you want the group to be and + hit @samp{C-y}. + +@ifnottex +@node FAQ 3 - Getting messages, FAQ 4 - Reading messages, FAQ 2 - Startup / Group buffer, Frequently Asked Questions +@end ifnottex +@subsection Getting messages + +@menu +* [3.1]:: I just installed Gnus, started it via M-x gnus but it only says + "nntp (news) open error", what to do? +* [3.2]:: I'm working under Windows and have no idea what ~/.gnus means. +* [3.3]:: My news server requires authentication, how to store user name + and password on disk? +* [3.4]:: Gnus seems to start up OK, but I can't find out how to + subscribe to a group. +* [3.5]:: Gnus doesn't show all groups / Gnus says I'm not allowed to + post on this server as well as I am, what's that? +* [3.6]:: I want Gnus to fetch news from several servers, is this possible? +* [3.7]:: And how about local spool files? +* [3.8]:: OK, reading news works now, but I want to be able to read my mail + with Gnus, too. How to do it? +* [3.9]:: And what about IMAP? +* [3.10]:: At the office we use one of those MS Exchange servers, + can I use Gnus to read my mail from it? +* [3.11]:: Can I tell Gnus not to delete the mails on the server + it retrieves via POP3? +@end menu + +@ifnottex +@node [3.1], [3.2], FAQ 3 - Getting messages, FAQ 3 - Getting messages +@end ifnottex +@subsubheading Question 3.1: + + I just installed Gnus, started it via + @samp{M-x gnus} + but it only says "nntp (news) open error", what to do? + + +Answer: + + You've got to tell Gnus where to fetch the news from. Read + the documentation for information on how to do this. As a + first start, put those lines in ~/.gnus: + + +@example +(setq gnus-select-method '(nntp "news.yourprovider.net")) +(setq user-mail-address "you@@yourprovider.net") +(setq user-full-name "Your Name") +@end example + +@ifnottex +@node [3.2], [3.3], [3.1], FAQ 3 - Getting messages +@end ifnottex +@subsubheading Question 3.2: + + I'm working under Windows and have no idea what ~/.gnus means. + + +Answer: + + The ~/ means the home directory where Gnus and Emacs look for the +configuration files. However, you don't really need to know what this +means, it suffices that Emacs knows what it means :-) You can type +@samp{C-x C-f ~/.gnus RET } (yes, with the forward slash, even on +Windows), and Emacs will open the right file for you. (It will most +likely be new, and thus empty.) However, I'd discourage you from +doing so, since the directory Emacs chooses will most certainly not be +what you want, so let's do it the correct way. The first thing you've +got to do is to create a suitable directory (no blanks in directory +name please) e.g. @file{c:\myhome}. Then you must set the environment +variable HOME to this directory. To do this under Win9x or Me include +the line + + +@example + +SET HOME=C:\myhome + +@end example + +@noindent + in your autoexec.bat and reboot. Under NT, 2000 and XP, + hit Winkey+Pause/Break to enter system options (if it + doesn't work, go to Control Panel -> System). There you'll + find the possibility to set environment variables, create + a new one with name HOME and value @file{c:\myhome}, a reboot is + not necessary. + + + Now to create ~/.gnus, say + @samp{C-x C-f ~/.gnus RET C-x C-s}. + in Emacs. + +@ifnottex +@node [3.3], [3.4], [3.2], FAQ 3 - Getting messages +@end ifnottex +@subsubheading Question 3.3: + + My news server requires authentication, how to store + user name and password on disk? + + +Answer: + + Create a file ~/.authinfo which includes for each server a line like this + + +@example +machine news.yourprovider.net login YourUserName password YourPassword +@end example + +@noindent +. + Make sure that the file isn't readable to others if you + work on a OS which is capable of doing so. (Under Unix + say + +@example +chmod 600 ~/.authinfo +@end example + +@noindent + in a shell.) + +@ifnottex +@node [3.4], [3.5], [3.3], FAQ 3 - Getting messages +@end ifnottex +@subsubheading Question 3.4: + + Gnus seems to start up OK, but I can't find out how to + subscribe to a group. + + +Answer: + + If you know the name of the group say @samp{U + name.of.group RET} in group buffer (use the + tab-completion Luke). Otherwise hit ^ in group buffer, + this brings you to the server buffer. Now place point (the + cursor) over the server which carries the group you want, + hit @samp{RET}, move point to the group + you want to subscribe to and say @samp{u} + to subscribe to it. + +@ifnottex +@node [3.5], [3.6], [3.4], FAQ 3 - Getting messages +@end ifnottex +@subsubheading Question 3.5: + + Gnus doesn't show all groups / Gnus says I'm not allowed to + post on this server as well as I am, what's that? + + +Answer: + + Some providers allow restricted anonymous access and full + access only after authorization. To make Gnus send authinfo + to those servers append + + +@example +force yes +@end example + + +@noindent + to the line for those servers in ~/.authinfo. + +@ifnottex +@node [3.6], [3.7], [3.5], FAQ 3 - Getting messages +@end ifnottex +@subsubheading Question 3.6: + + I want Gnus to fetch news from several servers, is this possible? + + +Answer: + + Of course. You can specify more sources for articles in the + variable gnus-secondary-select-methods. Add something like + this in ~/.gnus: + + +@example +(add-to-list 'gnus-secondary-select-methods + '(nntp "news.yourSecondProvider.net")) +(add-to-list 'gnus-secondary-select-methods + '(nntp "news.yourThirdProvider.net")) +@end example + +@ifnottex +@node [3.7], [3.8], [3.6], FAQ 3 - Getting messages +@end ifnottex +@subsubheading Question 3.7: + + And how about local spool files? + + +Answer: + + No problem, this is just one more select method called + nnspool, so you want this: + + +@example +(add-to-list 'gnus-secondary-select-methods '(nnspool "")) +@end example + +@noindent + Or this if you don't want an NNTP Server as primary news source: + + +@example +(setq gnus-select-method '(nnspool "")) +@end example + +@noindent + Gnus will look for the spool file in /usr/spool/news, if you + want something different, change the line above to something like this: + + +@example +(add-to-list 'gnus-secondary-select-methods + '(nnspool "" (nnspool-directory "/usr/local/myspoolddir"))) +@end example + +@noindent + This sets the spool directory for this server only. + You might have to specify more stuff like the program used + to post articles, see the Gnus manual on how to do this. + +@ifnottex +@node [3.8], [3.9], [3.7], FAQ 3 - Getting messages +@end ifnottex +@subsubheading Question 3.8: + + OK, reading news works now, but I want to be able to read my mail + with Gnus, too. How to do it? + + +Answer: + + That's a bit harder since there are many possible sources + for mail, many possible ways for storing mail and many + different ways for sending mail. The most common cases are + these: 1: You want to read your mail from a pop3 server and + send them directly to a SMTP Server 2: Some program like + fetchmail retrieves your mail and stores it on disk from + where Gnus shall read it. Outgoing mail is sent by + Sendmail, Postfix or some other MTA. Sometimes, you even + need a combination of the above cases. + + + However, the first thing to do is to tell Gnus in which way + it should store the mail, in Gnus terminology which back end + to use. Gnus supports many different back ends, the most + commonly used one is nnml. It stores every mail in one file + and is therefor quite fast. However you might prefer a one + file per group approach if your file system has problems with + many small files, the nnfolder back end is then probably the + choice for you. To use nnml add the following to ~/.gnus: + + +@example +(add-to-list 'gnus-secondary-select-methods '(nnml "")) +@end example + +@noindent + As you might have guessed, if you want nnfolder, it's + + +@example +(add-to-list 'gnus-secondary-select-methods '(nnfolder "")) +@end example + + + Now we need to tell Gnus, where to get it's mail from. If + it's a POP3 server, then you need something like this: + + +@example +(eval-after-load "mail-source" + '(add-to-list 'mail-sources '(pop :server "pop.YourProvider.net" + :user "yourUserName" + :password "yourPassword"))) +@end example + +@noindent + Make sure ~/.gnus isn't readable to others if you store + your password there. If you want to read your mail from a + traditional spool file on your local machine, it's + + +@example +(eval-after-load "mail-source" + '(add-to-list 'mail-sources '(file :path "/path/to/spool/file"))) +@end example + +@noindent + If it's a Maildir, with one file per message as used by + postfix, Qmail and (optionally) fetchmail it's + + +@example +(eval-after-load "mail-source" + '(add-to-list 'mail-sources '(maildir :path "/path/to/Maildir/" + :subdirs ("cur" "new"))) +@end example + +@noindent + And finally if you want to read your mail from several files + in one directory, for example because procmail already split your + mail, it's + + +@example +(eval-after-load "mail-source" + '(add-to-list 'mail-sources '(directory :path "/path/to/procmail-dir/" + :suffix ".prcml")) +@end example + +@noindent + Where :suffix ".prcml" tells Gnus only to use files with the + suffix .prcml. + + + OK, now you only need to tell Gnus how to send mail. If you + want to send mail via sendmail (or whichever MTA is playing + the role of sendmail on your system), you don't need to do + anything. However, if you want to send your mail to an + SMTP Server you need the following in your ~/.gnus + + +@example +(setq send-mail-function 'smtpmail-send-it) +(setq message-send-mail-function 'smtpmail-send-it) +(setq smtpmail-default-smtp-server "smtp.yourProvider.net") +@end example + +@ifnottex +@node [3.9], [3.10], [3.8], FAQ 3 - Getting messages +@end ifnottex +@subsubheading Question 3.9: + + And what about IMAP? + + +Answer: + + There are two ways of using IMAP with Gnus. The first one is + to use IMAP like POP3, that means Gnus fetches the mail from + the IMAP server and stores it on disk. If you want to do + this (you don't really want to do this) add the following to + ~/.gnus + + +@example +(add-to-list 'mail-sources '(imap :server "mail.mycorp.com" + :user "username" + :pass "password" + :stream network + :authentication login + :mailbox "INBOX" + :fetchflag "\\Seen")) +@end example + +@noindent + You might have to tweak the values for stream and/or + authentification, see the Gnus manual node "Mail Source + Specifiers" for possible values. + + + If you want to use IMAP the way it's intended, you've got to + follow a different approach. You've got to add the nnimap + back end to your select method and give the information + about the server there. + @example -(defconst mail-yank-ignored-headers - "^.*:" - "Delete these headers from message when it's inserted in reply.") +(add-to-list + 'gnus-secondary-select-methods + '(nnimap "Give the baby a name" + (nnimap-address "imap.yourProvider.net") + (nnimap-port 143) + (nnimap-list-pattern "archive.*"))) +@end example + +@noindent + Again, you might have to specify how to authenticate to the + server if Gnus can't guess the correct way, see the Manual + Node "IMAP" for detailed information. + +@ifnottex +@node [3.10], [3.11], [3.9], FAQ 3 - Getting messages +@end ifnottex +@subsubheading Question 3.10: + + At the office we use one of those MS Exchange servers, can I use + Gnus to read my mail from it? + + +Answer: + + Offer your administrator a pair of new running shoes for + activating IMAP on the server and follow the instructions + above. + +@ifnottex +@node [3.11], , [3.10], FAQ 3 - Getting messages +@end ifnottex +@subsubheading Question 3.11: + + Can I tell Gnus not to delete the mails on the server it + retrieves via POP3? + + +Answer: + + First of all, that's not the way POP3 is intended to work, + if you have the possibility, you should use the IMAP + Protocol if you want your messages to stay on the + server. Nevertheless there might be situations where you + need the feature, but sadly Gnus itself has no predefined + functionality to do so. + + + However this is Gnus county so there are possibilities to + achieve what you want. The easiest way is to get an external + program which retrieves copies of the mail and stores them + on disk, so Gnus can read it from there. On Unix systems you + could use e.g. fetchmail for this, on MS Windows you can use + Hamster, an excellent local news and mail server. + + + The other solution would be, to replace the method Gnus + uses to get mail from POP3 servers by one which is capable + of leaving the mail on the server. If you use XEmacs, get + the package mail-lib, it includes an enhanced pop3.el, + look in the file, there's documentation on how to tell + Gnus to use it and not to delete the retrieved mail. For + GNU Emacs look for the file epop3.el which can do the same + (If you know the home of this file, please send me an + e-mail). You can also tell Gnus to use an external program + (e.g. fetchmail) to fetch your mail, see the info node + "Mail Source Specifiers" in the Gnus manual on how to do + it. + + +@ifnottex +@node FAQ 4 - Reading messages, FAQ 5 - Composing messages, FAQ 3 - Getting messages, Frequently Asked Questions +@end ifnottex +@subsection Reading messages + +@menu +* [4.1]:: When I enter a group, all read messages are gone. + How to view them again? +* [4.2]:: How to tell Gnus to show an important message every time + I enter a group, even when it's read? +* [4.3]:: How to view the headers of a message? +* [4.4]:: How to view the raw unformatted message? +* [4.5]:: How can I change the headers Gnus displays by default at the + top of the article buffer? +* [4.6]:: I'd like Gnus NOT to render HTML-mails but show me the + text part if it's available. How to do it? +* [4.7]:: Can I use some other browser than w3 to render my HTML-mails? +* [4.8]:: Is there anything I can do to make poorly formatted mails + more readable? +* [4.9]:: Is there a way to automatically ignore posts by specific authors + or with specific words in the subject? And can I highlight more + interesting ones in some way? +* [4.10]:: How can I disable threading in some (e.g. mail-) groups, or set + other variables specific for some groups? +* [4.11]:: Can I highlight messages written by me and follow-ups to those? +* [4.12]:: The number of total messages in a group which Gnus displays in + group buffer is by far to high, especially in mail groups. + Is this a bug? +* [4.13]:: I don't like the layout of summary and article buffer, + how to change it? Perhaps even a three pane display? +* [4.14]:: I don't like the way the Summary buffer looks, how to tweak it? +* [4.15]:: How to split incoming mails in several groups? +@end menu + +@ifnottex +@node [4.1], [4.2], FAQ 4 - Reading messages, FAQ 4 - Reading messages +@end ifnottex +@subsubheading Question 4.1: + + When I enter a group, all read messages are gone. How to view them again? + + +Answer: + + If you enter the group by saying + @samp{RET} + in summary buffer with point over the group, only unread and ticked messages are loaded. Say + @samp{C-u RET} + instead to load all available messages. If you want only the e.g. 300 newest say + @samp{C-u 300 RET} + + + Loading only unread messages can be annoying if you have threaded view enabled, say + + +@example +(setq gnus-fetch-old-headers 'some) +@end example + + +@noindent + in ~/.gnus to load enough old articles to prevent teared threads, replace 'some with t to load + all articles (Warning: Both settings enlarge the amount of data which is + fetched when you enter a group and slow down the process of entering a group). + + + If you already use Gnus 5.10.0, you can say + @samp{/o N} + In summary buffer to load the last N messages, this feature is not available in 5.8.8 + + + If you don't want all old messages, but the parent of the message you're just reading, + you can say @samp{^}, if you want to retrieve the whole thread + the message you're just reading belongs to, @samp{A T} is your friend. + +@ifnottex +@node [4.2], [4.3], [4.1], FAQ 4 - Reading messages +@end ifnottex +@subsubheading Question 4.2: + + How to tell Gnus to show an important message every time I + enter a group, even when it's read? + + +Answer: + + You can tick important messages. To do this hit + @samp{u} while point is in summary buffer + over the message. When you want to remove the mark, hit + either @samp{d} (this deletes the tick + mark and set's unread mark) or @samp{M c} + (which deletes all marks for the message). + +@ifnottex +@node [4.3], [4.4], [4.2], FAQ 4 - Reading messages +@end ifnottex +@subsubheading Question 4.3: + + How to view the headers of a message? + + +Answer: + + Say @samp{t} + to show all headers, one more + @samp{t} + hides them again. + +@ifnottex +@node [4.4], [4.5], [4.3], FAQ 4 - Reading messages +@end ifnottex +@subsubheading Question 4.4: + + How to view the raw unformatted message? + + +Answer: + + Say + @samp{C-u g} + to show the raw message + @samp{g} + returns to normal view. + +@ifnottex +@node [4.5], [4.6], [4.4], FAQ 4 - Reading messages +@end ifnottex +@subsubheading Question 4.5: + + How can I change the headers Gnus displays by default at + the top of the article buffer? + + +Answer: + + The variable gnus-visible-headers controls which headers + are shown, its value is a regular expression, header lines + which match it are shown. So if you want author, subject, + date, and if the header exists, Followup-To and MUA / NUA + say this in ~/.gnus: + +@example +(setq gnus-visible-headers + "^\\(From:\\|Subject:\\|Date:\\|Followup-To:\ +\\|X-Newsreader:\\|User-Agent:\\|X-Mailer:\\)") +@end example + +@ifnottex +@node [4.6], [4.7], [4.5], FAQ 4 - Reading messages +@end ifnottex +@subsubheading Question 4.6: + + I'd like Gnus NOT to render HTML-mails but show me the + text part if it's available. How to do it? + + +Answer: + + Say + + +@example +(eval-after-load "mm-decode" + '(progn + (add-to-list 'mm-discouraged-alternatives "text/html") + (add-to-list 'mm-discouraged-alternatives "text/richtext"))) +@end example + +@noindent + in ~/.gnus. If you don't want HTML rendered, even if there's no text alternative add + + +@example +(setq mm-automatic-display (remove "text/html" mm-automatic-display)) +@end example + +@noindent + too. + +@ifnottex +@node [4.7], [4.8], [4.6], FAQ 4 - Reading messages +@end ifnottex +@subsubheading Question 4.7: + + Can I use some other browser than w3 to render my HTML-mails? + + +Answer: + + Only if you use Gnus 5.10.0 or younger. In this case you've got the + choice between w3, w3m, links, lynx and html2text, which + one is used can be specified in the variable + mm-text-html-renderer, so if you want links to render your + mail say + + +@example +(setq mm-text-html-renderer 'links) +@end example + +@ifnottex +@node [4.8], [4.9], [4.7], FAQ 4 - Reading messages +@end ifnottex +@subsubheading Question 4.8: + + Is there anything I can do to make poorly formatted mails + more readable? + + +Answer: + + Gnus offers you several functions to "wash" incoming mail, + you can find them if you browse through the menu, item Article->Washing. The most + interesting ones are probably "Wrap long lines" ( + @samp{W w} + ), "Decode ROT13" ( + @samp{W r} + ) and "Outlook Deuglify" which repairs the dumb quoting used + by many users of Microsoft products ( + @samp{W Y f} gives you full deuglify. + See @samp{W Y C-h} or + have a look at the menus for other deuglifications). + Outlook deuglify is only available since Gnus 5.10.0. + +@ifnottex +@node [4.9], [4.10], [4.8], FAQ 4 - Reading messages +@end ifnottex +@subsubheading Question 4.9: + + Is there a way to automatically ignore posts by specific + authors or with specific words in the subject? And can I + highlight more interesting ones in some way? + + +Answer: + + You want Scoring. Scoring means, that you define rules + which assign each message an integer value. Depending on + the value the message is highlighted in summary buffer (if + it's high, say +2000) or automatically marked read (if the + value is low, say -800) or some other action happens. + + + There are basically three ways of setting up rules which assign + the scoring-value to messages. The first and easiest way is to set + up rules based on the article you are just reading. Say you're + reading a message by a guy who always writes nonsense and you want + to ignore his messages in the future. Hit + @samp{L}, to set up a rule which lowers the score. + Now Gnus asks you which the criteria for lowering the Score shall + be. Hit @samp{?} twice to see all possibilities, + we want @samp{a} which means the author (the from + header). Now Gnus wants to know which kind of matching we want. + Hit either @samp{e} for an exact match or + @samp{s} for substring-match and delete afterwards + everything but the name to score down all authors with the given + name no matter which email address is used. Now you need to tell + Gnus when to apply the rule and how long it should last, hit e.g. + @samp{p} to apply the rule now and let it last + forever. If you want to raise the score instead of lowering it say + @samp{I} instead of @samp{L}. + + + You can also set up rules by hand. To do this say @samp{V + f} in summary buffer. Then you are asked for the name + of the score file, it's name.of.group.SCORE for rules valid in + only one group or all.Score for rules valid in all groups. See the + Gnus manual for the exact syntax, basically it's one big list + whose elements are lists again. the first element of those lists + is the header to score on, then one more list with what to match, + which score to assign, when to expire the rule and how to do the + matching. If you find me very interesting, you could e.g. add the + following to your all.Score: + + +@example +(("references" ("hschmi22.userfqdn.rz-online.de" 500 nil s)) + ("message-id" ("hschmi22.userfqdn.rz-online.de" 999 nil s))) +@end example + +@noindent + This would add 999 to the score of messages written by me + and 500 to the score of messages which are a (possibly + indirect) answer to a message written by me. Of course + nobody with a sane mind would do this :-) + + + The third alternative is adaptive scoring. This means Gnus + watches you and tries to find out what you find + interesting and what annoying and sets up rules + which reflect this. Adaptive scoring can be a huge help + when reading high traffic groups. If you want to activate + adaptive scoring say + + +@example +(setq gnus-use-adaptive-scoring t) @end example - -@item -Q2.6 I don't like the default WWW browser - -Now when choosing an URL Gnus starts up a W3 buffer, I would like it -to always use Netscape (I don't browse in text-mode ;-). - -@enumerate -@item -Activate `Customize...' from the `Help' menu. - -@item -Scroll down to the `WWW Browser' field. - -@item -Click `mouse-2' on `WWW Browser'. - -@item -Select `Netscape' from the pop up menu. - -@item -Press `C-c C-c' - -@end enumerate - -If you are using XEmacs then to specify Netscape do -@lisp - (setq gnus-button-url 'gnus-netscape-open-url) -@end lisp - - -@item -Q2.7 What, if any, relation is between ``ask-server'' and ``(setq -gnus-read-active-file 'some)''? - -In order for Gnus to show you the complete list of newsgroups, it will -either have to either store the list locally, or ask the server to -transmit the list. You enable the first with - -@lisp - (setq gnus-save-killed-list t) -@end lisp - -and the second with - -@lisp - (setq gnus-read-active-file t) -@end lisp - -If both are disabled, Gnus will not know what newsgroups exists. There -is no option to get the list by casting a spell. - - -@item -Q2.8 Moving between groups is slow. - -Per Abrahamsen writes:@* - -Do you call @code{define-key} or something like that in one of the -summary mode hooks? This would force Emacs to recalculate the keyboard -shortcuts. Removing the call should speed up @kbd{M-x gnus-summary-mode -RET} by a couple of orders of magnitude. You can use - -@lisp -(define-key gnus-summary-mode-map KEY COMMAND) -@end lisp - -in your @file{.gnus} instead. - -@end itemize - - -@node Reading News FAQ -@subsection Reading News - +@noindent + in ~/.gnus. + +@ifnottex +@node [4.10], [4.11], [4.9], FAQ 4 - Reading messages +@end ifnottex +@subsubheading Question 4.10: + + How can I disable threading in some (e.g. mail-) groups, or + set other variables specific for some groups? + + +Answer: + + While in group buffer move point over the group and hit + @samp{G c}, this opens a buffer where you + can set options for the group. At the bottom of the buffer + you'll find an item that allows you to set variables + locally for the group. To disable threading enter + gnus-show-threads as name of variable and nil as + value. Hit button done at the top of the buffer when + you're ready. + +@ifnottex +@node [4.11], [4.12], [4.10], FAQ 4 - Reading messages +@end ifnottex +@subsubheading Question 4.11: + + Can I highlight messages written by me and follow-ups to + those? + + +Answer: + + Stop those "Can I ..." questions, the answer is always yes + in Gnus Country :-). It's a three step process: First we + make faces (specifications of how summary-line shall look + like) for those postings, then we'll give them some + special score and finally we'll tell Gnus to use the new + faces. You can find detailed instructions on how to do it on + @uref{http://my.gnus.org/Members/dzimmerm/HowTo%2C2002-07-25%2C1027619165012198456/view,my.gnus.org} + +@ifnottex +@node [4.12], [4.13], [4.11], FAQ 4 - Reading messages +@end ifnottex +@subsubheading Question 4.12: + + The number of total messages in a group which Gnus + displays in group buffer is by far to high, especially in + mail groups. Is this a bug? + + +Answer: + + No, that's a matter of design of Gnus, fixing this would + mean reimplementation of major parts of Gnus' + back ends. Gnus thinks "highest-article-number - + lowest-article-number = total-number-of-articles". This + works OK for Usenet groups, but if you delete and move + many messages in mail groups, this fails. To cure the + symptom, enter the group via @samp{C-u RET} + (this makes Gnus get all messages), then + hit @samp{M P b} to mark all messages and + then say @samp{B m name.of.group} to move + all messages to the group they have been in before, they + get new message numbers in this process and the count is + right again (until you delete and move your mail to other + groups again). + +@ifnottex +@node [4.13], [4.14], [4.12], FAQ 4 - Reading messages +@end ifnottex +@subsubheading Question 4.13: + + I don't like the layout of summary and article buffer, how + to change it? Perhaps even a three pane display? + + +Answer: + + You can control the windows configuration by calling the + function gnus-add-configuration. The syntax is a bit + complicated but explained very well in the manual node + "Window Layout". Some popular examples: + + + Instead 25% summary 75% article buffer 35% summary and 65% + article (the 1.0 for article means "take the remaining + space"): + + +@example +(gnus-add-configuration + '(article (vertical 1.0 + (summary .35 point) + (article 1.0)))) +@end example + + + A three pane layout, Group buffer on the left, summary + buffer top-right, article buffer bottom-right: + + +@example +(gnus-add-configuration + '(article + (horizontal 1.0 + (vertical 25 + (group 1.0)) + (vertical 1.0 + (summary 0.25 point) + (article 1.0))))) +(gnus-add-configuration + '(summary + (horizontal 1.0 + (vertical 25 + (group 1.0)) + (vertical 1.0 + (summary 1.0 point))))) +@end example + +@ifnottex +@node [4.14], [4.15], [4.13], FAQ 4 - Reading messages +@end ifnottex +@subsubheading Question 4.14: + + I don't like the way the Summary buffer looks, how to tweak it? + + +Answer: + + You've got to play around with the variable + gnus-summary-line-format. It's value is a string of + symbols which stand for things like author, date, subject + etc. A list of the available specifiers can be found in the + manual node "Summary Buffer Lines" and the often forgotten + node "Formatting Variables" and it's sub-nodes. There + you'll find useful things like positioning the cursor and + tabulators which allow you a summary in table form, but + sadly hard tabulators are broken in 5.8.8. + + + Since 5.10.0, Gnus offers you some very nice new specifiers, + e.g. %B which draws a thread-tree and %&user-date which + gives you a date where the details are dependent of the + articles age. Here's an example which uses both: + + +@example +(setq gnus-summary-line-format + ":%U%R %B %s %-60=|%4L |%-20,20f |%&user-date; \n") +@end example + +@noindent + resulting in: + + +@smallexample +:O Re: [Richard Stallman] rfc2047.el | 13 |Lars Magne Ingebrigt |Sat 23:06 +:O Re: Revival of the ding-patches list | 13 |Lars Magne Ingebrigt |Sat 23:12 +:R > Re: Find correct list of articles for a gro| 25 |Lars Magne Ingebrigt |Sat 23:16 +:O \-> ... | 21 |Kai Grossjohann | 0:01 +:R > Re: Cry for help: deuglify.el - moving stuf| 28 |Lars Magne Ingebrigt |Sat 23:34 +:O \-> ... | 115 |Raymond Scholz | 1:24 +:O \-> ... | 19 |Lars Magne Ingebrigt |15:33 +:O Slow mailing list | 13 |Lars Magne Ingebrigt |Sat 23:49 +:O Re: `@@' mark not documented | 13 |Lars Magne Ingebrigt |Sat 23:50 +:R > Re: Gnus still doesn't count messages prope| 23 |Lars Magne Ingebrigt |Sat 23:57 +:O \-> ... | 18 |Kai Grossjohann | 0:35 +:O \-> ... | 13 |Lars Magne Ingebrigt | 0:56 +@end smallexample + +@ifnottex +@node [4.15], , [4.14], FAQ 4 - Reading messages +@end ifnottex +@subsubheading Question 4.15: + + How to split incoming mails in several groups? + + +Answer: + + Gnus offers two possibilities for splitting mail, the easy + nnmail-split-methods and the more powerful Fancy Mail + Splitting. I'll only talk about the first one, refer to + the manual, node "Fancy Mail Splitting" for the latter. + + + The value of nnmail-split-methods is a list, each element + is a list which stands for a splitting rule. Each rule has + the form "group where matching articles should go to", + "regular expression which has to be matched", the first + rule which matches wins. The last rule must always be a + general rule (regular expression .*) which denotes where + articles should go which don't match any other rule. If + the folder doesn't exist yet, it will be created as soon + as an article lands there. By default the mail will be + send to all groups whose rules match. If you + don't want that (you probably don't want), say + + +@example +(setq nnmail-crosspost nil) +@end example + +@noindent + in ~/.gnus. + + + An example might be better than thousand words, so here's + my nnmail-split-methods. Note that I send duplicates in a + special group and that the default group is spam, since I + filter all mails out which are from some list I'm + subscribed to or which are addressed directly to me + before. Those rules kill about 80% of the Spam which + reaches me (Email addresses are changed to prevent spammers + from using them): + + +@example +(setq nnmail-split-methods + '(("duplicates" "^Gnus-Warning:.*duplicate") + ("XEmacs-NT" "^\\(To:\\|CC:\\).*localpart@@xemacs.bla.*") + ("Gnus-Tut" "^\\(To:\\|CC:\\).*localpart@@socha.bla.*") + ("tcsh" "^\\(To:\\|CC:\\).*localpart@@mx.gw.bla.*") + ("BAfH" "^\\(To:\\|CC:\\).*localpart@@.*uni-muenchen.bla.*") + ("Hamster-src" + "^\\(CC:\\|To:\\).*hamster-sourcen@@yahoogroups.\\(de\\|com\\).*") + ("Tagesschau" "^From: tagesschau $") + ("Replies" "^\\(CC:\\|To:\\).*localpart@@Frank-Schmitt.bla.*") + ("EK" + "^From:.*\\(localpart@@privateprovider.bla\\|localpart@@workplace.bla\\).*") + ("Spam" + "^Content-Type:.*\\(ks_c_5601-1987\\|EUC-KR\\|big5\\|iso-2022-jp\\).*") + ("Spam" + "^Subject:.*\\(This really work\\|XINGA\\|ADV:\\|XXX\\|adult\\|sex\\).*") + ("Spam" + "^Subject:.*\\(\=\?ks_c_5601-1987\?\\|\=\?euc-kr\?\\|\=\?big5\?\\).*") + ("Spam" "^X-Mailer:\\(.*BulkMailer.*\\|.*MIME::Lite.*\\|\\)") + ("Spam" + "^X-Mailer:\\(.*CyberCreek Avalanche\\|.*http\:\/\/GetResponse\.com\\)") + ("Spam" + "^From:.*\\(verizon\.net\\|prontomail\.com\\|money\\|ConsumerDirect\\).*") + ("Spam" "^Delivered-To: GMX delivery to spamtrap@@gmx.bla$") + ("Spam" "^Received: from link2buy.com") + ("Spam" "^CC: .*azzrael@@t-online.bla") + ("Spam" "^X-Mailer-Version: 1.50 BETA") + ("Uni" "^\\(CC:\\|To:\\).*localpart@@uni-koblenz.bla.*") + ("Inbox" + "^\\(CC:\\|To:\\).*\\(my\ name\\|address@@one.bla\\|adress@@two.bla\\)") + ("Spam" ""))) +@end example + + +@ifnottex +@node FAQ 5 - Composing messages, FAQ 6 - Old messages, FAQ 4 - Reading messages, Frequently Asked Questions +@end ifnottex +@subsection Composing messages + +@menu +* [5.1]:: What are the basic commands I need to know for sending mail and + postings? +* [5.2]:: How to enable automatic word-wrap when composing messages? +* [5.3]:: How to set stuff like From, Organization, Reply-To, signature...? +* [5.4]:: Can I set things like From, Signature etc group based on the + group I post too? +* [5.5]:: Is there a spell-checker? Perhaps even on-the-fly spell-checking? +* [5.6]:: Can I set the dictionary based on the group I'm posting to? +* [5.7]:: Is there some kind of address-book, so I needn't remember all + those email addresses? +* [5.8]:: Sometimes I see little images at the top of article buffer. + What's that and how can I send one with my postings, too? +* [5.9]:: Sometimes I accidentally hit r instead of f in newsgroups. + Can Gnus warn me, when I'm replying by mail in newsgroups? +* [5.10]:: How to tell Gnus not to generate a sender header? +* [5.11]:: I want Gnus to locally store copies of my send mail and news, + how to do it? +* [5.12]:: People tell me my Message-IDs are not correct, + why aren't they and how to fix it? +@end menu + +@ifnottex +@node [5.1], [5.2], FAQ 5 - Composing messages, FAQ 5 - Composing messages +@end ifnottex +@subsubheading Question 5.1: + + What are the basic commands I need to know for sending mail and postings? + + +Answer: + + To start composing a new mail hit @samp{m} + either in Group or Summary buffer, for a posting, it's + either @samp{a} in Group buffer and + filling the Newsgroups header manually + or @samp{a} in the Summary buffer of the + group where the posting shall be send to. Replying by mail + is + @samp{r} if you don't want to cite the + author, or import the cited text manually and + @samp{R} to cite the text of the original + message. For a follow up to a newsgroup, it's + @samp{f} and @samp{F} + (analog to @samp{r} and + @samp{R}. + + + Enter new headers above the line saying "--text follows + this line--", enter the text below the line. When ready + hit @samp{C-c C-c}, to send the message, + if you want to finish it later hit @samp{C-c + C-d} to save it in the drafts group, where you + can start editing it again by saying @samp{D + e}. + +@ifnottex +@node [5.2], [5.3], [5.1], FAQ 5 - Composing messages +@end ifnottex +@subsubheading Question 5.2: + + How to enable automatic word-wrap when composing messages? + + +Answer: + + Say + + +@example +(add-hook 'message-mode-hook + (lambda () + (setq fill-column 72) + (turn-on-auto-fill))) +@end example + +@noindent + in ~/.gnus. You can reformat a paragraph by hitting + @samp{M-q} (as usual) + +@ifnottex +@node [5.3], [5.4], [5.2], FAQ 5 - Composing messages +@end ifnottex +@subsubheading Question 5.3: + + How to set stuff like From, Organization, Reply-To, signature...? + + +Answer: + + There are other ways, but you should use posting styles + for this. (See below why). + This example should make the syntax clear: + + +@example +(setq gnus-posting-styles + '((".*" + (name "Frank Schmitt") + (address "me@@there.bla") + (organization "Hamme net, kren mer och nimmi") + (signature-file "~/.signature") + ("X-SampleHeader" "foobar") + (eval (setq some-variable "Foo bar"))))) +@end example + +@noindent + The ".*" means that this settings are the default ones + (see below), valid values for the first element of the + following lists are signature, signature-file, + organization, address, name or body. The attribute name + can also be a string. In that case, this will be used as + a header name, and the value will be inserted in the + headers of the article; if the value is `nil', the header + name will be removed. You can also say (eval (foo bar)), + then the function foo will be evaluated with argument bar + and the result will be thrown away. + +@ifnottex +@node [5.4], [5.5], [5.3], FAQ 5 - Composing messages +@end ifnottex +@subsubheading Question 5.4: + + Can I set things like From, Signature etc group based on the group I post too? + + +Answer: + + That's the strength of posting styles. Before, we used ".*" + to set the default for all groups. You can use a regexp + like "^gmane" and the following settings are only applied + to postings you send to the gmane hierarchy, use + ".*binaries" instead and they will be applied to postings + send to groups containing the string binaries in their + name etc. + + + You can instead of specifying a regexp specify a function + which is evaluated, only if it returns true, the + corresponding settings take effect. Two interesting + candidates for this are message-news-p which returns t if + the current Group is a newsgroup and the corresponding + message-mail-p. + + + Note that all forms that match are applied, that means in + the example below, when I post to + gmane.mail.spam.spamassassin.general, the settings under + ".*" are applied and the settings under message-news-p and + those under "^gmane" and those under + "^gmane\\.mail\\.spam\\.spamassassin\\.general$". Because + of this put general settings at the top and specific ones + at the bottom. + + +@example +(setq gnus-posting-styles + '((".*" ;;default + (name "Frank Schmitt") + (organization "Hamme net, kren mer och nimmi") + (signature-file "~/.signature")) + ((message-news-p) ;;Usenet news? + (address "mySpamTrap@@Frank-Schmitt.bla") + ("Reply-To" "hereRealRepliesOnlyPlease@@Frank-Schmitt.bla")) + ((message-mail-p) ;;mail? + (address "usedForMails@@Frank-Schmitt.bla")) + ("^gmane" ;;this is mail, too in fact + (address "usedForMails@@Frank-Schmitt.net") + ("Reply-To" nil)) + ("^gmane.mail.spam.spamassassin.general$" + (eval (setq mail-envelope-from "Azzrael@@rz-online.de")) + (address "Azzrael@@rz-online.de")))) +@end example + +@ifnottex +@node [5.5], [5.6], [5.4], FAQ 5 - Composing messages +@end ifnottex +@subsubheading Question 5.5: + + Is there a spell-checker? Perhaps even on-the-fly spell-checking? + + +Answer: + +You can use ispell.el to spell-check stuff in Emacs. So the first +thing to do is to make sure that you've got either @itemize @bullet @item -Q3.1 How do I convert my kill files to score files? - -@email{ethanb@@ptolemy.astro.washington.edu, Ethan Bradford} write a -kill-to-score translator. It is available from@* -@file{http://baugi.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}. - - -@item -Q3.2 My news server has a lot of groups, and killing groups is painfully -slow. - -Don't do that then. The best way to get rid of groups that should be -dead is to edit your newsrc directly. This problem will be addressed -in the near future. - - +@uref{http://fmg-www.cs.ucla.edu/fmg-members/geoff/ispell.html,ispell} +or @item -Q3.3 How do I use an NNTP server with authentication? - -Put the following into your .gnus: -@lisp - (add-hook 'nntp-server-opened-hook 'nntp-send-authinfo) -@end lisp - - -@item -Q3.4 Not reading the first article. - -How do I avoid reading the first article when a group is selected? - -@enumerate -@item -Use @kbd{RET} to select the group instead of @kbd{SPC}. - -@item -@code{(setq gnus-auto-select first nil)} - -@item -Luis Fernandes writes:@* -This is what I use...customize as necessary... - -@lisp -;;; Don't auto-select first article if reading sources, or -;;; archives or jobs postings, etc. and just display the -;;; summary buffer +@uref{http://aspell.sourceforge.net/,aspell} +@end itemize +@noindent +installed and in your Path. + +Then you need +@uref{http://www.kdstevens.com/~stevens/ispell-page.html,ispell.el,ispell.el} +and for on-the-fly spell-checking +@uref{http://www-sop.inria.fr/mimosa/personnel/Manuel.Serrano/flyspell/flyspell.html,flyspell.el,flyspell.el}. +Ispell.el is shipped with Gnus Emacs and available through the Emacs +package system, flyspell.el is shipped with Emacs and part of XEmacs +text-modes package which is available through the package system, so +there should be no need to install them manually. + + + Ispell.el assumes you use ispell, if you choose aspell say + + +@example +(setq ispell-program-name "aspell") +@end example + + +@noindent + in your Emacs configuration file. + + + If you want your outgoing messages to be spell-checked, say + + +@example +(add-hook 'message-send-hook 'ispell-message) +@end example + +@noindent + In your ~/.gnus, if you prefer on-the-fly spell-checking say + + +@example +(add-hook 'message-mode-hook (lambda () (flyspell-mode 1))) +@end example + +@ifnottex +@node [5.6], [5.7], [5.5], FAQ 5 - Composing messages +@end ifnottex +@subsubheading Question 5.6: + + Can I set the dictionary based on the group I'm posting to? + + +Answer: + + Yes, say something like + + +@example (add-hook 'gnus-select-group-hook - (function - (lambda () - (cond ((string-match "sources" gnus-newsgroup-name) - (setq gnus-auto-select-first nil)) - ((string-match "jobs" gnus-newsgroup-name) - (setq gnus-auto-select-first nil)) - ((string-match "comp\\.archives" gnus-newsgroup-name) - (setq gnus-auto-select-first nil)) - ((string-match "reviews" gnus-newsgroup-name) - (setq gnus-auto-select-first nil)) - ((string-match "announce" gnus-newsgroup-name) - (setq gnus-auto-select-first nil)) - ((string-match "binaries" gnus-newsgroup-name) - (setq gnus-auto-select-first nil)) - (t - (setq gnus-auto-select-first t)))))) -@end lisp - -@item -Per Abrahamsen writes:@* -Another possibility is to create an @file{all.binaries.all.SCORE} file -like this: - -@lisp -((local - (gnus-auto-select-first nil))) -@end lisp - -and insert -@lisp - (setq gnus-auto-select-first t) -@end lisp - -in your @file{.gnus}. - -@end enumerate - -@item -Q3.5 Why aren't BBDB known posters marked in the summary buffer? - -Brian Edmonds writes:@* -Due to changes in Gnus 5.0, @file{bbdb-gnus.el} no longer marks known -posters in the summary buffer. An updated version, @file{gnus-bbdb.el} -is available at the locations listed below. This package also supports -autofiling of incoming mail to folders specified in the BBDB. Extensive -instructions are included as comments in the file. - -Send mail to @file{majordomo@@edmonds.home.cs.ubc.ca} with the following -line in the body of the message: @emph{get misc gnus-bbdb.el}. - -Or get it from the World Wide Web:@* -@file{http://www.cs.ubc.ca/spider/edmonds/gnus-bbdb.el}. - -@end itemize - - -@node Reading Mail FAQ -@subsection Reading Mail - + (lambda () + (cond + ((string-match + "^de\\." (gnus-group-real-name gnus-newsgroup-name)) + (ispell-change-dictionary "deutsch8")) + (t + (ispell-change-dictionary "english"))))) +@end example + + +@noindent + in ~/.gnus. Change "^de\\." and "deutsch8" to something + that suits your needs. + +@ifnottex +@node [5.7], [5.8], [5.6], FAQ 5 - Composing messages +@end ifnottex +@subsubheading Question 5.7: + + Is there some kind of address-book, so I needn't remember + all those email addresses? + + +Answer: + + There's an very basic solution for this, mail aliases. + You can store your mail addresses in a ~/.mailrc file using a simple + alias syntax: + + +@example +alias al "Al " +@end example + +@noindent + Then typing your alias (followed by a space or punctuation + character) on a To: or Cc: line in the message buffer will + cause Gnus to insert the full address for you. See the + node "Mail Aliases" in Message (not Gnus) manual for + details. + + + However, what you really want is the Insidious Big Brother + Database bbdb. Get it through the XEmacs package system or from + @uref{http://bbdb.sourceforge.net/,bbdb's homepage}. + Now place the following in ~/.gnus, to activate bbdb for Gnus: + + +@example +(require 'bbdb) +(bbdb-initialize 'gnus 'message) +@end example + +@noindent + Now you probably want some general bbdb configuration, + place them in ~/.emacs: + + +@example +(require 'bbdb) +;;If you don't live in Northern America, you should disable the +;;syntax check for telephone numbers by saying +(setq bbdb-north-american-phone-numbers-p nil) +;;Tell bbdb about your email address: +(setq bbdb-user-mail-names + (regexp-opt '("Your.Email@@here.bla" + "Your.other@@mail.there.bla"))) +;;cycling while completing email addresses +(setq bbdb-complete-name-allow-cycling t) +;;No popup-buffers +(setq bbdb-use-pop-up nil) +@end example + +@noindent + Now you should be ready to go. Say @samp{M-x bbdb RET + RET} to open a bbdb buffer showing all + entries. Say @samp{c} to create a new + entry, @samp{b} to search your BBDB and + @samp{C-o} to add a new field to an + entry. If you want to add a sender to the BBDB you can + also just hit `:' on the posting in the summary buffer and + you are done. When you now compose a new mail, + hit @samp{TAB} to cycle through know + recipients. + +@ifnottex +@node [5.8], [5.9], [5.7], FAQ 5 - Composing messages +@end ifnottex +@subsubheading Question 5.8: + + Sometimes I see little images at the top of article + buffer. What's that and how can I send one with my + postings, too? + + +Answer: + + Those images are called X-Faces. They are 48*48 pixel b/w + pictures, encoded in a header line. If you want to include + one in your posts, you've got to convert some image to a + X-Face. So fire up some image manipulation program (say + Gimp), open the image you want to include, cut out the + relevant part, reduce color depth to 1 bit, resize to + 48*48 and save as bitmap. Now you should get the compface + package from + @uref{ftp://ftp.cs.indiana.edu:/pub/faces/,this site}. + and create the actual X-face by saying + + +@example +cat file.xbm | xbm2ikon |compface > file.face +cat ./file.face | sed 's/\\/\\\\/g' | sed 's/\"/\\\"/g' > ./file.face.quoted +@end example + +@noindent +If you can't use compface, there's an online X-face converter at@* +@uref{http://www.dairiki.org/xface/}. If you use MS Windows, you +could also use the WinFace program from +@uref{http://www.xs4all.nl/~walterln/winface/}. + +Now you only have to tell Gnus to include the X-face in your postings +by saying + +@example +(setq message-default-headers + (with-temp-buffer + (insert "X-Face: ") + (insert-file-contents "~/.xemacs/xface") + (buffer-string))) +@end example + +@noindent + in ~/.gnus. + +@ifnottex +@node [5.9], [5.10], [5.8], FAQ 5 - Composing messages +@end ifnottex +@subsubheading Question 5.9: + + Sometimes I accidentally hit r instead of f in + newsgroups. Can Gnus warn me, when I'm replying by mail in + newsgroups? + + +Answer: + + Put this in ~/.gnus: + + +@example +(setq gnus-confirm-mail-reply-to-news t) +@end example + +@noindent + if you already use Gnus 5.10.0, if you still use 5.8.8 or + 5.9 try this instead: + + +@example +(defadvice gnus-summary-reply (around reply-in-news activate) + (interactive) + (when (or (not (gnus-news-group-p gnus-newsgroup-name)) + (y-or-n-p "Really reply? ")) + ad-do-it)) +@end example + +@ifnottex +@node [5.10], [5.11], [5.9], FAQ 5 - Composing messages +@end ifnottex +@subsubheading Question 5.10: + + How to tell Gnus not to generate a sender header? + + +Answer: + + Since 5.10.0 Gnus doesn't generate a sender header by + default. For older Gnus' try this in ~/.gnus: + + +@example +(eval-after-load "message" + '(add-to-list 'message-syntax-checks '(sender . disabled))) +@end example + + +@ifnottex +@node [5.11], [5.12], [5.10], FAQ 5 - Composing messages +@end ifnottex +@subsubheading Question 5.11: + + I want gnus to locally store copies of my send mail and + news, how to do it? + + +Answer: + + You must set the variable gnus-message-archive-group to do + this. You can set it to a string giving the name of the + group where the copies shall go or like in the example + below use a function which is evaluated and which returns + the group to use. + + +@example +(setq gnus-message-archive-group + '((if (message-news-p) + "nnml:Send-News" + "nnml:Send-Mail"))) +@end example + + +@ifnottex +@node [5.12], , [5.11], FAQ 5 - Composing messages +@end ifnottex +@subsubheading Question 5.12: + + People tell me my Message-IDs are not correct, why + aren't they and how to fix it? + + +Answer: + + The message-ID is an unique identifier for messages you + send. To make it unique, Gnus need to know which machine + name to put after the "@@". If the name of the machine + where Gnus is running isn't suitable (it probably isn't + at most private machines) you can tell Gnus what to use + by saying +@example +(setq message-user-fqdn "yourmachine.yourdomain.tld") +@end example +@noindent + in ~/.gnus. If you use Gnus 5.9 or ealier, you can use this +instead: +@example +(eval-after-load "message" + '(let (myfqdn "yourmachine.yourdomain.tld");; <-- Edit this! + (if (boundp 'message-user-fqdn) + (setq message-user-fqdn fqdn) + (gnus-message 1 "Redefining `message-make-fqdn'.") + (defun message-make-fqdn () + "Return user's fully qualified domain name." + fqdn)))) +@end example + + If you have no idea what to insert for + "yourmachine.yourdomain.tld", you've got several + choices. You can either ask your provider if he allows + you to use something like + yourUserName.userfqdn.provider.net, or you can use + somethingUnique.yourdomain.tld if you own the domain + yourdomain.tld, or you can register at a service which + gives private users a FQDN for free, e.g. + @uref{http://www.stura.tu-freiberg.de/~dlx/addfqdn.html}. + (Sorry but this website is in German, if you know of an + English one offering the same, drop me a note). + + + Finally you can tell Gnus not to generate a Message-ID + for News at all (and letting the server do the job) by saying + + +@example +(setq message-required-news-headers + (remove' Message-ID message-required-news-headers)) +@end example + +@noindent + you can also tell Gnus not to generate Message-IDs for mail by saying + + +@example +(setq message-required-mail-headers + (remove' Message-ID message-required-mail-headers)) +@end example + +@noindent + , however some mail servers don't generate proper + Message-IDs, too, so test if your Mail Server behaves + correctly by sending yourself a Mail and looking at the Message-ID. + + +@ifnottex +@node FAQ 6 - Old messages, FAQ 7 - Gnus in a dial-up environment, FAQ 5 - Composing messages, Frequently Asked Questions +@end ifnottex +@subsection Old messages + +@menu +* [6.1]:: How to import my old mail into Gnus? +* [6.2]:: How to archive interesting messages? +* [6.3]:: How to search for a specific message? +* [6.4]:: How to get rid of old unwanted mail? +* [6.5]:: I want that all read messages are expired (at least in some + groups). How to do it? +* [6.6]:: I don't want expiration to delete my mails but to move them + to another group. +@end menu + +@ifnottex +@node [6.1], [6.2], FAQ 6 - Old messages, FAQ 6 - Old messages +@end ifnottex +@subsubheading Question 6.1: + + How to import my old mail into Gnus? + + +Answer: + + The easiest way is to tell your old mail program to + export the messages in mbox format. Most Unix mailers + are able to do this, if you come from the MS Windows + world, you may find tools at + @uref{http://mbx2mbox.sourceforge.net/}. + + + Now you've got to import this mbox file into Gnus. To do + this, create a nndoc group based on the mbox file by + saying @samp{G f /path/file.mbox RET} in + Group buffer. You now have read-only access to your + mail. If you want to import the messages to your normal + Gnus mail groups hierarchy, enter the nndoc group you've + just created by saying @samp{C-u RET} + (thus making sure all messages are retrieved), mark all + messages by saying @samp{M P b} and + either copy them to the desired group by saying + @samp{B c name.of.group RET} or send them + through nnmail-split-methods (respool them) by saying + @samp{B r}. + +@ifnottex +@node [6.2], [6.3], [6.1], FAQ 6 - Old messages +@end ifnottex +@subsubheading Question 6.2: + + How to archive interesting messages? + + +Answer: + + If you stumble across an interesting message, say in + gnu.emacs.gnus and want to archive it there are several + solutions. The first and easiest is to save it to a file + by saying @samp{O f}. However, wouldn't + it be much more convenient to have more direct access to + the archived message from Gnus? If you say yes, put this + snippet by Frank Haun in + ~/.gnus: + + +@example +(defun my-archive-article (&optional n) + "Copies one or more article(s) to a corresponding `nnml:' group, e.g. +`gnus.ding' goes to `nnml:1.gnus.ding'. And `nnml:List-gnus.ding' goes +to `nnml:1.List-gnus-ding'. + +Use process marks or mark a region in the summary buffer to archive +more then one article." + (interactive "P") + (let ((archive-name + (format + "nnml:1.%s" + (if (featurep 'xemacs) + (replace-in-string gnus-newsgroup-name "^.*:" "") + (replace-regexp-in-string "^.*:" "" gnus-newsgroup-name))))) + (gnus-summary-copy-article n archive-name))) +@end example + +@noindent + You can now say @samp{M-x + my-archive-article} in summary buffer to + archive the article under the cursor in a nnml + group. (Change nnml to your preferred back end) + + + Of course you can also make sure the cache is enabled by saying + + +@example +(setq gnus-use-cache t) +@end example + +@noindent + then you only have to set either the tick or the dormant + mark for articles you want to keep, setting the read + mark will remove them from cache. + +@ifnottex +@node [6.3], [6.4], [6.2], FAQ 6 - Old messages +@end ifnottex +@subsubheading Question 6.3: + + How to search for a specific message? + + +Answer: + + There are several ways for this, too. For a posting from + a Usenet group the easiest solution is probably to ask + @uref{http://groups.google.com,groups.google.com}, + if you found the posting there, tell Google to display + the raw message, look for the message-id, and say + @samp{M-^ the@@message.id RET} in a + summary buffer. + Since Gnus 5.10.0 there's also a Gnus interface for + groups.google.com which you can call with + @samp{G W}) in group buffer. + + + Another idea which works for both mail and news groups + is to enter the group where the message you are + searching is and use the standard Emacs search + @samp{C-s}, it's smart enough to look at + articles in collapsed threads, too. If you want to + search bodies, too try @samp{M-s} + instead. Further on there are the + gnus-summary-limit-to-foo functions, which can help you, + too. + + + Of course you can also use grep to search through your + local mail, but this is both slow for big archives and + inconvenient since you are not displaying the found mail + in Gnus. Here comes nnir into action. Nnir is a front end + to search engines like swish-e or swish++ and + others. You index your mail with one of those search + engines and with the help of nnir you can search trough + the indexed mail and generate a temporary group with all + messages which met your search criteria. If this sound + cool to you get nnir.el from + @uref{ftp://ls6-ftp.cs.uni-dortmund.de/pub/src/emacs/} + or @uref{ftp://ftp.is.informatik.uni-duisburg.de/pub/src/emacs/}. + Instructions on how to use it are at the top of the file. + +@ifnottex +@node [6.4], [6.5], [6.3], FAQ 6 - Old messages +@end ifnottex +@subsubheading Question 6.4: + + How to get rid of old unwanted mail? + + +Answer: + + You can of course just mark the mail you don't need + anymore by saying @samp{#} with point + over the mail and then say @samp{B DEL} + to get rid of them forever. You could also instead of + actually deleting them, send them to a junk-group by + saying @samp{B m nnml:trash-bin} which + you clear from time to time, but both are not the intended + way in Gnus. + + + In Gnus, we let mail expire like news expires on a news + server. That means you tell Gnus the message is + expirable (you tell Gnus "I don't need this mail + anymore") by saying @samp{E} with point + over the mail in summary buffer. Now when you leave the + group, Gnus looks at all messages which you marked as + expirable before and if they are old enough (default is + older than a week) they are deleted. + +@ifnottex +@node [6.5], [6.6], [6.4], FAQ 6 - Old messages +@end ifnottex +@subsubheading Question 6.5: + + I want that all read messages are expired (at least in + some groups). How to do it? + + +Answer: + + If you want all read messages to be expired (e.g. in + mailing lists where there's an online archive), you've + got two choices: auto-expire and + total-expire. Auto-expire means, that every article + which has no marks set and is selected for reading is + marked as expirable, Gnus hits @samp{E} + for you every time you read a message. Total-expire + follows a slightly different approach, here all article + where the read mark is set are expirable. + + + To activate auto-expire, include auto-expire in the + Group parameters for the group. (Hit @samp{G + c} in summary buffer with point over the + group to change group parameters). For total-expire add + total-expire to the group-parameters. + + + Which method you choose is merely a matter of taste: + Auto-expire is faster, but it doesn't play together with + Adaptive Scoring, so if you want to use this feature, + you should use total-expire. + + + If you want a message to be excluded from expiration in + a group where total or auto expire is active, set either + tick (hit @samp{u}) or dormant mark (hit + @samp{u}), when you use auto-expire, you + can also set the read mark (hit + @samp{d}). + +@ifnottex +@node [6.6], , [6.5], FAQ 6 - Old messages +@end ifnottex +@subsubheading Question 6.6: + + I don't want expiration to delete my mails but to move them + to another group. + + +Answer: + + Say something like this in ~/.gnus: + + +@example +(setq nnmail-expiry-target "nnml:expired") +@end example + +@noindent + (If you want to change the value of nnmail-expiry-target + on a per group basis see the question "How can I disable + threading in some (e.g. mail-) groups, or set other + variables specific for some groups?") + + +@ifnottex +@node FAQ 7 - Gnus in a dial-up environment, FAQ 8 - Getting help, FAQ 6 - Old messages, Frequently Asked Questions +@end ifnottex +@subsection Gnus in a dial-up environment + +@menu +* [7.1]:: I don't have a permanent connection to the net, how can I + minimize the time I've got to be connected? +* [7.2]:: So what was this thing about the Agent? +* [7.3]:: I want to store article bodies on disk, too. How to do it? +* [7.4]:: How to tell Gnus not to try to send mails / postings while + I'm offline? +@end menu + + +@ifnottex +@node [7.1], [7.2], FAQ 7 - Gnus in a dial-up environment, FAQ 7 - Gnus in a dial-up environment +@end ifnottex +@subsubheading Question 7.1: + + I don't have a permanent connection to the net, how can + I minimize the time I've got to be connected? + + +Answer: + + You've got basically two options: Either you use the + Gnus Agent (see below) for this, or you can install + programs which fetch your news and mail to your local + disk and Gnus reads the stuff from your local + machine. + + + If you want to follow the second approach, you need a + program which fetches news and offers them to Gnus, a + program which does the same for mail and a program which + receives the mail you write from Gnus and sends them + when you're online. + + +Let's talk about Unix systems first: For the news part, the easiest +solution is a small nntp server like +@uref{http://www.leafnode.org/,Leafnode} or +@uref{http://infa.abo.fi/~patrik/sn/,sn}, of course you can also +install a full featured news server like +@uref{http://www.isc.org/products/INN/,inn}. + +Then you want to fetch your Mail, popular choices are @itemize @bullet @item -Q4.1 What does the message ``Buffer has changed on disk'' mean in a mail -group? - -Your filter program should not deliver mail directly to your folders, -instead it should put the mail into spool files. Gnus will then move -the mail safely from the spool files into the folders. This will -eliminate the problem. Look it up in the manual, in the section -entitled ``Mail & Procmail''. - - -@item -Q4.2 How do you make articles un-expirable? - -I am using nnml to read news and have used -@code{gnus-auto-expirable-newsgroups} to automagically expire articles -in some groups (Gnus being one of them). Sometimes there are -interesting articles in these groups that I want to keep. Is there any -way of explicitly marking an article as un-expirable - that is mark it -as read but not expirable? - -Use @kbd{u}, @kbd{!}, @kbd{d} or @kbd{M-u} in the summary buffer. You -just remove the @kbd{E} mark by setting some other mark. It's not -necessary to tick the articles. - - +@uref{http://www.catb.org/~esr/fetchmail/,fetchmail} and @item -Q4.3 How do I delete bogus nnml: groups? - -My problem is that I have various mail (nnml) groups generated while -experimenting with Gnus. How do I remove them now? Setting the level to -9 does not help. Also @code{gnus-group-check-bogus-groups} does not -recognize them. - -Removing mail groups is tricky at the moment. (It's on the to-do list, -though.) You basically have to kill the groups in Gnus, shut down Gnus, -edit the active file to exclude these groups, and probably remove the -nnml directories that contained these groups as well. Then start Gnus -back up again. - - -@item -Q4.4 What happened to my new mail groups? - -I got new mail, but I have -never seen the groups they should have been placed in. - -They are probably there, but as zombies. Press @kbd{A z} to list -zombie groups, and then subscribe to the groups you want with @kbd{u}. -This is all documented quite nicely in the user's manual. - - -@item -Q4.5 Not scoring mail groups - -How do you @emph{totally} turn off scoring in mail groups? - -Use an nnbabyl:all.SCORE (or nnmh, or nnml, or whatever) file containing: +@uref{http://www.qcc.ca/~charlesc/software/getmail-3.0/,getmail}. +@end itemize +You should tell those to write the mail to your disk and Gnus to read +it from there. Last but not least the mail sending part: This can be +done with every MTA like @uref{http://www.sendmail.org/,sendmail}, +@uref{http://www.qmail.org/,postfix}, @uref{http://www.exim.org/,exim} +or @uref{http://www.qmail.org/,qmail}. + + + On windows boxes I'd vote for + @uref{http://www.tglsoft.de/,Hamster}, + it's a small freeware, open-source program which fetches + your mail and news from remote servers and offers them + to Gnus (or any other mail and/or news reader) via nntp + respectively POP3 or IMAP. It also includes a smtp + server for receiving mails from Gnus. + +@ifnottex +@node [7.2], [7.3], [7.1], FAQ 7 - Gnus in a dial-up environment +@end ifnottex +@subsubheading Question 7.2: + + So what was this thing about the Agent? + + +Answer: + + The Gnus agent is part of Gnus, it allows you to fetch + mail and news and store them on disk for reading them + later when you're offline. It kind of mimics offline + newsreaders like e.g. Forte Agent. If you want to use + the Agent place the following in ~/.gnus if you are + still using 5.8.8 or 5.9 (it's the default since 5.10.0): + @example -((adapt ignore) - (local (gnus-use-scoring nil)) - (exclude-files "all.SCORE")) +(setq gnus-agent t) @end example - -@end itemize - + + + Now you've got to select the servers whose groups can be + stored locally. To do this, open the server buffer + (that is press @samp{^} while in the + group buffer). Now select a server by moving point to + the line naming that server. Finally, agentize the + server by typing @samp{J a}. If you + make a mistake, or change your mind, you can undo this + action by typing @samp{J r}. When + you're done, type 'q' to return to the group buffer. + Now the next time you enter a group on a agentized + server, the headers will be stored on disk and read from + there the next time you enter the group. + +@ifnottex +@node [7.3], [7.4], [7.2], FAQ 7 - Gnus in a dial-up environment +@end ifnottex +@subsubheading Question 7.3: + + I want to store article bodies on disk, too. How to do it? + + +Answer: + + You can tell the agent to automatically fetch the bodies + of articles which fulfill certain predicates, this is + done in a special buffer which can be reached by + saying @samp{J c} in group + buffer. Please refer to the documentation for + information which predicates are possible and how + exactly to do it. + + + Further on you can tell the agent manually which + articles to store on disk. There are two ways to do + this: Number one: In the summary buffer, process mark a + set of articles that shall be stored in the agent by + saying @samp{#} with point over the + article and then type @samp{J s}. The + other possibility is to set, again in the summary + buffer, downloadable (%) marks for the articles you + want by typing @samp{@@} with point over + the article and then typing @samp{J u}. + What's the difference? Well, process marks are erased as + soon as you exit the summary buffer while downloadable + marks are permanent. You can actually set downloadable + marks in several groups then use fetch session ('J s' in + the GROUP buffer) to fetch all of those articles. The + only downside is that fetch session also fetches all of + the headers for every selected group on an agentized + server. Depending on the volume of headers, the initial + fetch session could take hours. + +@ifnottex +@node [7.4], , [7.3], FAQ 7 - Gnus in a dial-up environment +@end ifnottex +@subsubheading Question 7.4: + + How to tell Gnus not to try to send mails / postings + while I'm offline? + + +Answer: + + All you've got to do is to tell Gnus when you are online + (plugged) and when you are offline (unplugged), the rest + works automatically. You can toggle plugged/unplugged + state by saying @samp{J j} in group + buffer. To start Gnus unplugged say @samp{M-x + gnus-unplugged} instead of + @samp{M-x gnus}. Note that for this to + work, the agent must be active. + + +@ifnottex +@node FAQ 8 - Getting help, FAQ 9 - Tuning Gnus, FAQ 7 - Gnus in a dial-up environment, Frequently Asked Questions +@end ifnottex +@subsection Getting help + +@menu +* [8.1]:: How to find information and help inside Emacs? +* [8.2]:: I can't find anything in the Gnus manual about X + (e.g. attachments, PGP, MIME...), is it not documented? +* [8.3]:: Which websites should I know? +* [8.4]:: Which mailing lists and newsgroups are there? +* [8.5]:: Where to report bugs? +* [8.6]:: I need real-time help, where to find it? +@end menu + +@ifnottex +@node [8.1], [8.2], FAQ 8 - Getting help, FAQ 8 - Getting help +@end ifnottex +@subsubheading Question 8.1: + + How to find information and help inside Emacs? + + +Answer: + + The first stop should be the Gnus manual (Say + @samp{C-h i d m Gnus RET} to start the + Gnus manual, then walk through the menus or do a + full-text search with @samp{s}). Then + there are the general Emacs help commands starting with + C-h, type @samp{C-h ? ?} to get a list + of all available help commands and their meaning. Finally + @samp{M-x apropos-command} lets you + search through all available functions and @samp{M-x + apropos} searches the bound variables. + +@ifnottex +@node [8.2], [8.3], [8.1], FAQ 8 - Getting help +@end ifnottex +@subsubheading Question 8.2: + + I can't find anything in the Gnus manual about X + (e.g. attachments, PGP, MIME...), is it not documented? + + +Answer: + + There's not only the Gnus manual but also the manuals + for message, emacs-mime, sieve and pgg. Those packages + are distributed with Gnus and used by Gnus but aren't + really part of core Gnus, so they are documented in + different info files, you should have a look in those + manuals, too. + +@ifnottex +@node [8.3], [8.4], [8.2], FAQ 8 - Getting help +@end ifnottex +@subsubheading Question 8.3: + + Which websites should I know? + + +Answer: + + The two most important ones are the + @uref{http://www.gnus.org,official Gnus website}. + and it's sister site + @uref{http://my.gnus.org,my.gnus.org (MGO)}, + hosting an archive of lisp snippets, howtos, a (not + really finished) tutorial and this FAQ. + + + Tell me about other sites which are interesting. + +@ifnottex +@node [8.4], [8.5], [8.3], FAQ 8 - Getting help +@end ifnottex +@subsubheading Question 8.4: + + Which mailing lists and newsgroups are there? + + +Answer: + + There's the newsgroup gnu.emacs.gnus (pull it from + e.g. news.gnus.org) which deals with general questions + and the ding mailing list (ding@@gnus.org) dealing with + development of Gnus. You can read the ding list via + NNTP, too under the name gnus.ding from news.gnus.org. + + + If you want to stay in the big8, + news.software.newssreaders is also read by some Gnus + users (but chances for qualified help are much better in + the above groups) and if you speak German, there's + de.comm.software.gnus. + +@ifnottex +@node [8.5], [8.6], [8.4], FAQ 8 - Getting help +@end ifnottex +@subsubheading Question 8.5: + + Where to report bugs? + + +Answer: + +Say @samp{M-x gnus-bug}, this will start a message to the +@email{bugs@@gnus.org,gnus bug mailing list} including information +about your environment which make it easier to help you. + +@ifnottex +@node [8.6], , [8.5], FAQ 8 - Getting help +@end ifnottex +@subsubheading Question 8.6: + + I need real-time help, where to find it? + + +Answer: + + Point your IRC client to irc.my.gnus.org channel + #mygnus. Don't be afraid if people there speak German, + they are willing and capable of switching to + English when people from outside Germany enter. + + +@ifnottex +@node FAQ 9 - Tuning Gnus, FAQ - Glossary, FAQ 8 - Getting help, Frequently Asked Questions +@end ifnottex +@subsection Tuning Gnus + +@menu +* [9.1]:: Starting Gnus is really slow, how to speed it up? +* [9.2]:: How to speed up the process of entering a group? +* [9.3]:: Sending mail becomes slower and slower, what's up? +@end menu + +@ifnottex +@node [9.1], [9.2], FAQ 9 - Tuning Gnus, FAQ 9 - Tuning Gnus +@end ifnottex +@subsubheading Question 9.1: + + Starting Gnus is really slow, how to speed it up? + + +Answer: + + The reason for this could be the way Gnus reads it's + active file, see the node "The Active File" in the Gnus + manual for things you might try to speed the process up. + An other idea would be to byte compile your ~/.gnus (say + @samp{M-x byte-compile-file RET ~/.gnus + RET} to do it). Finally, if you have require + statements in your .gnus, you could replace them with + eval-after-load, which loads the stuff not at startup + time, but when it's needed. Say you've got this in your + ~/.gnus: + + +@example +(require 'message) +(add-to-list 'message-syntax-checks '(sender . disabled)) +@end example + +@noindent + then as soon as you start Gnus, message.el is loaded. If + you replace it with + + +@example +(eval-after-load "message" + '(add-to-list 'message-syntax-checks '(sender . disabled))) +@end example + +@noindent + it's loaded when it's needed. + +@ifnottex +@node [9.2], [9.3], [9.1], FAQ 9 - Tuning Gnus +@end ifnottex +@subsubheading Question 9.2: + + How to speed up the process of entering a group? + + +Answer: + + A speed killer is setting the variable + gnus-fetch-old-headers to anything different from nil, + so don't do this if speed is an issue. To speed up + building of summary say + + +@example +(gnus-compile) +@end example + +@noindent + at the bottom of your ~/.gnus, this will make gnus + byte-compile things like + gnus-summary-line-format. + then you could increase the value of gc-cons-threshold + by saying something like + + +@example +(setq gc-cons-threshold 3500000) +@end example + +@noindent + in ~/.emacs. If you don't care about width of CJK + characters or use Gnus 5.10.0 or younger together with a + recent GNU Emacs, you should say + + +@example +(setq gnus-use-correct-string-widths nil) +@end example + + +@noindent + in ~/.gnus (thanks to Jesper harder for the last + two suggestions). Finally if you are still using 5.8.8 + or 5.9 and experience speed problems with summary + buffer generation, you definitely should update to + 5.10.0 since there quite some work on improving it has + been done. + +@ifnottex +@node [9.3], , [9.2], FAQ 9 - Tuning Gnus +@end ifnottex +@subsubheading Question 9.3: + + Sending mail becomes slower and slower, what's up? + + +Answer: + + The reason could be that you told Gnus to archive the + messages you wrote by setting + gnus-message-archive-group. Try to use a nnml group + instead of an archive group, this should bring you back + to normal speed. + + +@ifnottex +@node FAQ - Glossary, , FAQ 9 - Tuning Gnus, Frequently Asked Questions +@end ifnottex +@subsection Glossary + +@table @dfn + +@item ~/.gnus + When the term ~/.gnus is used it just means your Gnus + configuration file. You might as well call it ~/.gnus.el or + specify another name. + + +@item Back End + In Gnus terminology a back end is a virtual server, a layer + between core Gnus and the real NNTP-, POP3-, IMAP- or + whatever-server which offers Gnus a standardized interface + to functions like "get message", "get Headers" etc. + + +@item Emacs + When the term Emacs is used in this FAQ, it means either GNU + Emacs or XEmacs. + + +@item Message + In this FAQ message means a either a mail or a posting to a + Usenet Newsgroup or to some other fancy back end, no matter + of which kind it is. + + +@item MUA + MUA is an acronym for Mail User Agent, it's the program you + use to read and write e-mails. + + +@item NUA + NUA is an acronym for News User Agent, it's the program you + use to read and write Usenet news. + +@end table + +@c @bye @ignore arch-tag: 64dc5692-edb4-4848-a965-7aa0181acbb8 diff -r b6e48fab7ff3 -r fd8097053f04 man/gnus.texi --- a/man/gnus.texi Mon Aug 02 13:28:45 2004 +0000 +++ b/man/gnus.texi Mon Aug 02 13:38:50 2004 +0000 @@ -1,10 +1,10 @@ -\input texinfo @c -*- mode: texinfo; coding: iso-latin-1; -*- +\input texinfo @setfilename ../info/gnus @settitle Gnus Manual -@synindex fn cp -@synindex vr cp -@synindex pg cp +@syncodeindex fn cp +@syncodeindex vr cp +@syncodeindex pg cp @dircategory Emacs @direntry * Gnus: (gnus). The newsreader Gnus. @@ -20,38 +20,61 @@ \usepackage[latin1]{inputenc} \usepackage{pagestyle} \usepackage{epsfig} -\usepackage{bembo} \usepackage{pixidx} +\input{gnusconfig.tex} + +\ifx\pdfoutput\undefined +\else +\usepackage[pdftex,bookmarks,colorlinks=true]{hyperref} +\usepackage{thumbpdf} +\pdfcompresslevel=9 +\fi \makeindex \begin{document} +\newcommand{\gnusversionname}{Gnus v5.10.6} \newcommand{\gnuschaptername}{} \newcommand{\gnussectionname}{} \newcommand{\gnusbackslash}{/} +\newcommand{\gnusref}[1]{``#1'' on page \pageref{#1}} +\ifx\pdfoutput\undefined +\newcommand{\gnusuref}[1]{\gnustt{#1}} +\else +\newcommand{\gnusuref}[1]{\href{#1}{\gnustt{#1}}} +\fi \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}} \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}} \newcommand{\gnuskindex}[1]{\index{#1}} \newcommand{\gnusindex}[1]{\index{#1}} -\newcommand{\gnustt}[1]{{\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}} +\newcommand{\gnustt}[1]{{\gnusselectttfont{}#1}} \newcommand{\gnuscode}[1]{\gnustt{#1}} -\newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}''} +\newcommand{\gnusasis}[1]{\gnustt{#1}} +\newcommand{\gnusurl}[1]{\gnustt{#1}} +\newcommand{\gnuscommand}[1]{\gnustt{#1}} +\newcommand{\gnusenv}[1]{\gnustt{#1}} +\newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\gnusselectttfont{}#1}''} \newcommand{\gnuslisp}[1]{\gnustt{#1}} \newcommand{\gnuskbd}[1]{`\gnustt{#1}'} +\newcommand{\gnuskey}[1]{`\gnustt{#1}'} \newcommand{\gnusfile}[1]{`\gnustt{#1}'} \newcommand{\gnusdfn}[1]{\textit{#1}} \newcommand{\gnusi}[1]{\textit{#1}} +\newcommand{\gnusr}[1]{\textrm{#1}} \newcommand{\gnusstrong}[1]{\textbf{#1}} \newcommand{\gnusemph}[1]{\textit{#1}} \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}} \newcommand{\gnussc}[1]{\textsc{#1}} \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}} +\newcommand{\gnusversion}[1]{{\small\textit{#1}}} \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}} \newcommand{\gnusresult}[1]{\gnustt{=> #1}} +\newcommand{\gnusacronym}[1]{\textsc{#1}} +\newcommand{\gnusemail}[1]{\textit{#1}} \newcommand{\gnusbullet}{{${\bullet}$}} \newcommand{\gnusdollar}{\$} @@ -67,7 +90,7 @@ \newcommand{\gnusbraceleft}{{$>$}} \newcommand{\gnusbraceright}{{$>$}} -\newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head.eps,height=1cm}}} +\newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head,height=1cm}}} \newcommand{\gnusinteresting}{ \marginpar[\mbox{}\hfill\gnushead]{\gnushead} } @@ -106,7 +129,7 @@ } \newcommand{\gnusicon}[1]{ -\marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=tmp/#1-up.ps,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=tmp/#1-up.ps,height=1cm}}} +\marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=ps/#1-up,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=ps/#1-up,height=1cm}}} } \newcommand{\gnuspicon}[1]{ @@ -133,6 +156,11 @@ } }{\end{list}} +\newenvironment{asislist}% +{\begin{list}{}{ +} +}{\end{list}} + \newenvironment{kbdlist}% {\begin{list}{}{ \labelwidth=0cm @@ -186,9 +214,9 @@ { \ifodd\count0 \mbox{} \hfill -\raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}} +\raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}} \else -\raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}} +\raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}} \hfill \mbox{} \fi } @@ -210,9 +238,9 @@ { \ifodd\count0 \mbox{} \hfill -\raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}} +\raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}} \else -\raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}} +\raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}} \hfill \mbox{} \fi } @@ -234,9 +262,9 @@ { \ifodd\count0 \mbox{} \hfill -\raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}} +\raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}} \else -\raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}} +\raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}} \hfill \mbox{} \fi } @@ -257,10 +285,10 @@ \parindent=0cm \addtolength{\textheight}{2cm} -\gnustitle{\gnustitlename}\\ +\gnustitle{\gnustitlename}\hfill\gnusversion{\gnusversionname}\\ \rule{15cm}{1mm}\\ \vfill -\hspace*{0cm}\epsfig{figure=ps/gnus-big-logo.eps,height=15cm} +\hspace*{0cm}\epsfig{figure=ps/gnus-big-logo,height=15cm} \vfill \rule{15cm}{1mm}\\ \gnusauthor{by Lars Magne Ingebrigtsen} @@ -272,7 +300,9 @@ \thispagestyle{empty} -Copyright \copyright{} 1995,96,97,98,99,2000,2001 Free Software Foundation, Inc. +Copyright \copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001, +2002, 2003, 2004 +Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document @@ -300,7 +330,8 @@ This file documents Gnus, the GNU Emacs newsreader. -Copyright (C) 1995,96,97,98,99,2000,2001 Free Software Foundation, Inc. +Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003 + 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 @@ -329,7 +360,9 @@ @page @vskip 0pt plus 1filll -Copyright @copyright{} 1995,96,97,98,99,2000,2001 Free Software Foundation, Inc. +Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001, +2002, 2003 + 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 @@ -360,11 +393,11 @@ @ifinfo You can read news (and mail) from within Emacs by using Gnus. The news -can be gotten by any nefarious means you can think of---@sc{nntp}, local +can be gotten by any nefarious means you can think of---@acronym{NNTP}, local spool or your mbox file. All at the same time, if you want to push your luck. -This manual corresponds to Gnus 5.9.0. +This manual corresponds to Gnus v5.10.6. @end ifinfo @@ -396,94 +429,103 @@ @end iftex @menu -* Starting Up:: Finding news can be a pain. -* The Group Buffer:: Selecting, subscribing and killing groups. -* The Summary Buffer:: Reading, saving and posting articles. -* The Article Buffer:: Displaying and handling articles. -* Composing Messages:: Information on sending mail and news. -* Select Methods:: Gnus reads all messages from various select methods. -* Scoring:: Assigning values to articles. -* Various:: General purpose settings. -* The End:: Farewell and goodbye. -* Appendices:: Terminology, Emacs intro, FAQ, History, Internals. -* Index:: Variable, function and concept index. -* Key Index:: Key Index. +* Starting Up:: Finding news can be a pain. +* Group Buffer:: Selecting, subscribing and killing groups. +* Summary Buffer:: Reading, saving and posting articles. +* Article Buffer:: Displaying and handling articles. +* Composing Messages:: Information on sending mail and news. +* Select Methods:: Gnus reads all messages from various select methods. +* Scoring:: Assigning values to articles. +* Various:: General purpose settings. +* The End:: Farewell and goodbye. +* Appendices:: Terminology, Emacs intro, @acronym{FAQ}, History, Internals. +* Index:: Variable, function and concept index. +* Key Index:: Key Index. + +Other related manuals + +* Message:(message). Composing messages. +* Emacs-MIME:(emacs-mime). Composing messages; @acronym{MIME}-specific parts. +* Sieve:(sieve). Managing Sieve scripts in Emacs. +* PGG:(pgg). @acronym{PGP/MIME} with Gnus. @detailmenu --- The Detailed Node Listing --- Starting Gnus -* Finding the News:: Choosing a method for getting news. -* The First Time:: What does Gnus do the first time you start it? -* The Server is Down:: How can I read my mail then? -* Slave Gnusae:: You can have more than one Gnus active at a time. -* Fetching a Group:: Starting Gnus just to read a group. -* New Groups:: What is Gnus supposed to do with new groups? -* Startup Files:: Those pesky startup files---@file{.newsrc}. -* Auto Save:: Recovering from a crash. -* The Active File:: Reading the active file over a slow line Takes Time. -* Changing Servers:: You may want to move from one server to another. -* Startup Variables:: Other variables you might change. +* Finding the News:: Choosing a method for getting news. +* The First Time:: What does Gnus do the first time you start it? +* The Server is Down:: How can I read my mail then? +* Slave Gnusae:: You can have more than one Gnus active at a time. +* Fetching a Group:: Starting Gnus just to read a group. +* New Groups:: What is Gnus supposed to do with new groups? +* Changing Servers:: You may want to move from one server to another. +* Startup Files:: Those pesky startup files---@file{.newsrc}. +* Auto Save:: Recovering from a crash. +* The Active File:: Reading the active file over a slow line Takes Time. +* Startup Variables:: Other variables you might change. New Groups -* Checking New Groups:: Determining what groups are new. -* Subscription Methods:: What Gnus should do with new groups. -* Filtering New Groups:: Making Gnus ignore certain new groups. - -The Group Buffer - -* Group Buffer Format:: Information listed and how you can change it. -* Group Maneuvering:: Commands for moving in the group buffer. -* Selecting a Group:: Actually reading news. -* Group Data:: Changing the info for a group. -* Subscription Commands:: Unsubscribing, killing, subscribing. -* Group Levels:: Levels? What are those, then? -* Group Score:: A mechanism for finding out what groups you like. -* Marking Groups:: You can mark groups for later processing. -* Foreign Groups:: Creating and editing groups. -* Group Parameters:: Each group may have different parameters set. -* Listing Groups:: Gnus can list various subsets of the groups. -* Sorting Groups:: Re-arrange the group order. -* Group Maintenance:: Maintaining a tidy @file{.newsrc} file. -* Browse Foreign Server:: You can browse a server. See what it has to offer. -* Exiting Gnus:: Stop reading news and get some work done. -* Group Topics:: A folding group mode divided into topics. -* Misc Group Stuff:: Other stuff that you can to do. +* Checking New Groups:: Determining what groups are new. +* Subscription Methods:: What Gnus should do with new groups. +* Filtering New Groups:: Making Gnus ignore certain new groups. + +Group Buffer + +* Group Buffer Format:: Information listed and how you can change it. +* Group Maneuvering:: Commands for moving in the group buffer. +* Selecting a Group:: Actually reading news. +* Subscription Commands:: Unsubscribing, killing, subscribing. +* Group Data:: Changing the info for a group. +* Group Levels:: Levels? What are those, then? +* Group Score:: A mechanism for finding out what groups you like. +* Marking Groups:: You can mark groups for later processing. +* Foreign Groups:: Creating and editing groups. +* Group Parameters:: Each group may have different parameters set. +* Listing Groups:: Gnus can list various subsets of the groups. +* Sorting Groups:: Re-arrange the group order. +* Group Maintenance:: Maintaining a tidy @file{.newsrc} file. +* Browse Foreign Server:: You can browse a server. See what it has to offer. +* Exiting Gnus:: Stop reading news and get some work done. +* Group Topics:: A folding group mode divided into topics. +* Misc Group Stuff:: Other stuff that you can to do. Group Buffer Format -* Group Line Specification:: Deciding how the group buffer is to look. -* Group Modeline Specification:: The group buffer modeline. -* Group Highlighting:: Having nice colors in the group buffer. +* Group Line Specification:: Deciding how the group buffer is to look. +* Group Mode Line Specification:: The group buffer mode line. +* Group Highlighting:: Having nice colors in the group buffer. Group Topics -* Topic Variables:: How to customize the topics the Lisp Way. -* Topic Commands:: Interactive E-Z commands. -* Topic Sorting:: Sorting each topic individually. -* Topic Topology:: A map of the world. -* Topic Parameters:: Parameters that apply to all groups in a topic. +* Topic Commands:: Interactive E-Z commands. +* Topic Variables:: How to customize the topics the Lisp Way. +* Topic Sorting:: Sorting each topic individually. +* Topic Topology:: A map of the world. +* Topic Parameters:: Parameters that apply to all groups in a topic. Misc Group Stuff -* Scanning New Messages:: Asking Gnus to see whether new messages have arrived. -* Group Information:: Information and help on groups and Gnus. -* Group Timestamp:: Making Gnus keep track of when you last read a group. -* File Commands:: Reading and writing the Gnus files. - -The Summary Buffer +* Scanning New Messages:: Asking Gnus to see whether new messages have arrived. +* Group Information:: Information and help on groups and Gnus. +* Group Timestamp:: Making Gnus keep track of when you last read a group. +* File Commands:: Reading and writing the Gnus files. +* Sieve Commands:: Managing Sieve scripts. + +Summary Buffer * Summary Buffer Format:: Deciding how the summary buffer is to look. * Summary Maneuvering:: Moving around the summary buffer. * Choosing Articles:: Reading articles. * Paging the Article:: Scrolling the current article. * Reply Followup and Post:: Posting articles. +* Delayed Articles:: Send articles at a later time. * Marking Articles:: Marking articles as read, expirable, etc. * Limiting:: You can limit the summary buffer. * Threading:: How threads are made. -* Sorting:: How articles and threads are sorted. +* Sorting the Summary Buffer:: How articles and threads are sorted. * Asynchronous Fetching:: Gnus might be able to pre-fetch articles. * Article Caching:: You may store articles in a cache. * Persistent Articles:: Making articles expiry-resistant. @@ -500,75 +542,84 @@ * Tree Display:: A more visual display of threads. * Mail Group Commands:: Some commands can only be used in mail groups. * Various Summary Stuff:: What didn't fit anywhere else. -* Exiting the Summary Buffer:: Returning to the Group buffer. +* Exiting the Summary Buffer:: Returning to the Group buffer, + or reselecting the current group. * Crosspost Handling:: How crossposted articles are dealt with. * Duplicate Suppression:: An alternative when crosspost handling fails. +* Security:: Decrypt and Verify. +* Mailing List:: Mailing list minor mode. Summary Buffer Format -* Summary Buffer Lines:: You can specify how summary lines should look. -* To From Newsgroups:: How to not display your own name. -* Summary Buffer Mode Line:: You can say how the mode line should look. -* Summary Highlighting:: Making the summary buffer all pretty and nice. +* Summary Buffer Lines:: You can specify how summary lines should look. +* To From Newsgroups:: How to not display your own name. +* Summary Buffer Mode Line:: You can say how the mode line should look. +* Summary Highlighting:: Making the summary buffer all pretty and nice. Choosing Articles -* Choosing Commands:: Commands for choosing articles. -* Choosing Variables:: Variables that influence these commands. +* Choosing Commands:: Commands for choosing articles. +* Choosing Variables:: Variables that influence these commands. Reply, Followup and Post -* Summary Mail Commands:: Sending mail. -* Summary Post Commands:: Sending news. -* Summary Message Commands:: Other Message-related commands. -* Canceling and Superseding:: ``Whoops, I shouldn't have called him that.'' +* Summary Mail Commands:: Sending mail. +* Summary Post Commands:: Sending news. +* Summary Message Commands:: Other Message-related commands. +* Canceling and Superseding:: Marking Articles -* Unread Articles:: Marks for unread articles. -* Read Articles:: Marks for read articles. -* Other Marks:: Marks that do not affect readedness. -* Setting Marks:: How to set and remove marks. -* Generic Marking Commands:: How to customize the marking. -* Setting Process Marks:: How to mark articles for later processing. +* Unread Articles:: Marks for unread articles. +* Read Articles:: Marks for read articles. +* Other Marks:: Marks that do not affect readedness. + +Marking Articles + +* Setting Marks:: How to set and remove marks. +* Generic Marking Commands:: How to customize the marking. +* Setting Process Marks:: How to mark articles for later processing. Threading -* Customizing Threading:: Variables you can change to affect the threading. -* Thread Commands:: Thread based commands in the summary buffer. +* Customizing Threading:: Variables you can change to affect the threading. +* Thread Commands:: Thread based commands in the summary buffer. Customizing Threading -* Loose Threads:: How Gnus gathers loose threads into bigger threads. -* Filling In Threads:: Making the threads displayed look fuller. -* More Threading:: Even more variables for fiddling with threads. -* Low-Level Threading:: You thought it was over... but you were wrong! +* Loose Threads:: How Gnus gathers loose threads into bigger threads. +* Filling In Threads:: Making the threads displayed look fuller. +* More Threading:: Even more variables for fiddling with threads. +* Low-Level Threading:: You thought it was over@dots{} but you were wrong! Decoding Articles -* Uuencoded Articles:: Uudecode articles. -* Shell Archives:: Unshar articles. -* PostScript Files:: Split PostScript. -* Other Files:: Plain save and binhex. -* Decoding Variables:: Variables for a happy decoding. -* Viewing Files:: You want to look at the result of the decoding? +* Uuencoded Articles:: Uudecode articles. +* Shell Archives:: Unshar articles. +* PostScript Files:: Split PostScript. +* Other Files:: Plain save and binhex. +* Decoding Variables:: Variables for a happy decoding. +* Viewing Files:: You want to look at the result of the decoding? Decoding Variables -* Rule Variables:: Variables that say how a file is to be viewed. -* Other Decode Variables:: Other decode variables. -* Uuencoding and Posting:: Variables for customizing uuencoding. +* Rule Variables:: Variables that say how a file is to be viewed. +* Other Decode Variables:: Other decode variables. +* Uuencoding and Posting:: Variables for customizing uuencoding. Article Treatment -* Article Highlighting:: You want to make the article look like fruit salad. -* Article Fontisizing:: Making emphasized text look nice. -* Article Hiding:: You also want to make certain info go away. -* Article Washing:: Lots of way-neat functions to make life better. -* Article Buttons:: Click on URLs, Message-IDs, addresses and the like. -* Article Date:: Grumble, UT! -* Article Signature:: What is a signature? -* Article Miscellanea:: Various other stuff. +* Article Highlighting:: You want to make the article look like fruit salad. +* Article Fontisizing:: Making emphasized text look nice. +* Article Hiding:: You also want to make certain info go away. +* Article Washing:: Lots of way-neat functions to make life better. +* Article Header:: Doing various header transformations. +* Article Buttons:: Click on URLs, Message-IDs, addresses and the like. +* Article Button Levels:: Controlling appearance of buttons. +* Article Date:: Grumble, UT! +* Article Display:: Display various stuff---X-Face, Picons, Smileys +* Article Signature:: What is a signature? +* Article Miscellanea:: Various other stuff. Alternative Approaches @@ -577,100 +628,120 @@ Various Summary Stuff -* Summary Group Information:: Information oriented commands. -* Searching for Articles:: Multiple article commands. -* Summary Generation Commands:: (Re)generating the summary buffer. -* Really Various Summary Commands:: Those pesky non-conformant commands. - -The Article Buffer - -* Hiding Headers:: Deciding what headers should be displayed. -* Using MIME:: Pushing articles through @sc{mime} before reading them. -* Customizing Articles:: Tailoring the look of the articles. -* Article Keymap:: Keystrokes available in the article buffer. -* Misc Article:: Other stuff. +* Summary Group Information:: Information oriented commands. +* Searching for Articles:: Multiple article commands. +* Summary Generation Commands:: +* Really Various Summary Commands:: Those pesky non-conformant commands. + +Article Buffer + +* Hiding Headers:: Deciding what headers should be displayed. +* Using MIME:: Pushing articles through @acronym{MIME} before reading them. +* Customizing Articles:: Tailoring the look of the articles. +* Article Keymap:: Keystrokes available in the article buffer. +* Misc Article:: Other stuff. Composing Messages -* Mail:: Mailing and replying. -* Posting Server:: What server should you post via? -* Mail and Post:: Mailing and posting at the same time. -* Archived Messages:: Where Gnus stores the messages you've sent. -* Posting Styles:: An easier way to specify who you are. -* Drafts:: Postponing messages and rejected messages. -* Rejected Articles:: What happens if the server doesn't like your article? +* Mail:: Mailing and replying. +* Posting Server:: What server should you post and mail via? +* Mail and Post:: Mailing and posting at the same time. +* Archived Messages:: Where Gnus stores the messages you've sent. +* Posting Styles:: An easier way to specify who you are. +* Drafts:: Postponing messages and rejected messages. +* Rejected Articles:: What happens if the server doesn't like your article? +* Signing and encrypting:: How to compose secure messages. Select Methods -* The Server Buffer:: Making and editing virtual servers. -* Getting News:: Reading USENET news with Gnus. -* Getting Mail:: Reading your personal mail with Gnus. -* Browsing the Web:: Getting messages from a plethora of Web sources. -* Other Sources:: Reading directories, files, SOUP packets. -* Combined Groups:: Combining groups into one group. -* Gnus Unplugged:: Reading news and mail offline. - -The Server Buffer - -* Server Buffer Format:: You can customize the look of this buffer. -* Server Commands:: Commands to manipulate servers. -* Example Methods:: Examples server specifications. -* Creating a Virtual Server:: An example session. -* Server Variables:: Which variables to set. -* Servers and Methods:: You can use server names as select methods. -* Unavailable Servers:: Some servers you try to contact may be down. +* Server Buffer:: Making and editing virtual servers. +* Getting News:: Reading USENET news with Gnus. +* Getting Mail:: Reading your personal mail with Gnus. +* Browsing the Web:: Getting messages from a plethora of Web sources. +* IMAP:: Using Gnus as a @acronym{IMAP} client. +* Other Sources:: Reading directories, files, SOUP packets. +* Combined Groups:: Combining groups into one group. +* Gnus Unplugged:: Reading news and mail offline. + +Server Buffer + +* Server Buffer Format:: You can customize the look of this buffer. +* Server Commands:: Commands to manipulate servers. +* Example Methods:: Examples server specifications. +* Creating a Virtual Server:: An example session. +* Server Variables:: Which variables to set. +* Servers and Methods:: You can use server names as select methods. +* Unavailable Servers:: Some servers you try to contact may be down. Getting News -* NNTP:: Reading news from an @sc{nntp} server. -* News Spool:: Reading news from the local spool. +* NNTP:: Reading news from an @acronym{NNTP} server. +* News Spool:: Reading news from the local spool. + +@acronym{NNTP} + +* Direct Functions:: Connecting directly to the server. +* Indirect Functions:: Connecting indirectly to the server. +* Common Variables:: Understood by several connection functions. Getting Mail -* Mail in a Newsreader:: Important introductory notes. -* Getting Started Reading Mail:: A simple cookbook example. -* Splitting Mail:: How to create mail groups. -* Mail Sources:: How to tell Gnus where to get mail from. -* Mail Back End Variables:: Variables for customizing mail handling. -* Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail. -* Group Mail Splitting:: Use group customize to drive mail splitting. -* Incorporating Old Mail:: What about the old mail you have? -* Expiring Mail:: Getting rid of unwanted mail. -* Washing Mail:: Removing cruft from the mail you get. -* Duplicates:: Dealing with duplicated mail. -* Not Reading Mail:: Using mail back ends for reading other files. -* Choosing a Mail Back End:: Gnus can read a variety of mail formats. +* Mail in a Newsreader:: Important introductory notes. +* Getting Started Reading Mail:: A simple cookbook example. +* Splitting Mail:: How to create mail groups. +* Mail Sources:: How to tell Gnus where to get mail from. +* Mail Back End Variables:: Variables for customizing mail handling. +* Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail. +* Group Mail Splitting:: Use group customize to drive mail splitting. +* Incorporating Old Mail:: What about the old mail you have? +* Expiring Mail:: Getting rid of unwanted mail. +* Washing Mail:: Removing cruft from the mail you get. +* Duplicates:: Dealing with duplicated mail. +* Not Reading Mail:: Using mail back ends for reading other files. +* Choosing a Mail Back End:: Gnus can read a variety of mail formats. Mail Sources -* Mail Source Specifiers:: How to specify what a mail source is. -* Mail Source Customization:: Some variables that influence things. -* Fetching Mail:: Using the mail source specifiers. +* Mail Source Specifiers:: How to specify what a mail source is. +* Mail Source Customization:: Some variables that influence things. +* Fetching Mail:: Using the mail source specifiers. Choosing a Mail Back End * Unix Mail Box:: Using the (quite) standard Un*x mbox. -* Rmail Babyl:: Emacs programs use the rmail babyl format. +* Rmail Babyl:: Emacs programs use the Rmail Babyl format. * Mail Spool:: Store your mail in a private spool? * MH Spool:: An mhspool-like back end. +* Maildir:: Another one-file-per-message format. * Mail Folders:: Having one file for each group. * Comparing Mail Back Ends:: An in-depth looks at pros and cons. Browsing the Web -* Web Searches:: Creating groups from articles that match a string. -* Slashdot:: Reading the Slashdot comments. -* Ultimate:: The Ultimate Bulletin Board systems. -* Web Archive:: Reading mailing list archived on web. +* Archiving Mail:: +* Web Searches:: Creating groups from articles that match a string. +* Slashdot:: Reading the Slashdot comments. +* Ultimate:: The Ultimate Bulletin Board systems. +* Web Archive:: Reading mailing list archived on web. +* RSS:: Reading RDF site summary. +* Customizing w3:: Doing stuff to Emacs/w3 from Gnus. + +@acronym{IMAP} + +* Splitting in IMAP:: Splitting mail with nnimap. +* Expiring in IMAP:: Expiring mail with nnimap. +* Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox. +* Expunging mailboxes:: Equivalent of a ``compress mailbox'' button. +* A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus. +* Debugging IMAP:: What to do when things don't work. Other Sources -* Directory Groups:: You can read a directory as if it was a newsgroup. -* Anything Groups:: Dired? Who needs dired? -* Document Groups:: Single files can be the basis of a group. -* SOUP:: Reading @sc{soup} packets ``offline''. -* Mail-To-News Gateways:: Posting articles via mail-to-news gateways. -* IMAP:: Using Gnus as a @sc{imap} client. +* Directory Groups:: You can read a directory as if it was a newsgroup. +* Anything Groups:: Dired? Who needs dired? +* Document Groups:: Single files can be the basis of a group. +* SOUP:: Reading @sc{soup} packets ``offline''. +* Mail-To-News Gateways:: Posting articles via mail-to-news gateways. Document Groups @@ -678,71 +749,69 @@ SOUP -* SOUP Commands:: Commands for creating and sending @sc{soup} packets -* SOUP Groups:: A back end for reading @sc{soup} packets. -* SOUP Replies:: How to enable @code{nnsoup} to take over mail and news. - -@sc{imap} - -* Splitting in IMAP:: Splitting mail with nnimap. -* Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox. -* Expunging mailboxes:: Equivalent of a "compress mailbox" button. +* SOUP Commands:: Commands for creating and sending @sc{soup} packets +* SOUP Groups:: A back end for reading @sc{soup} packets. +* SOUP Replies:: How to enable @code{nnsoup} to take over mail and news. Combined Groups -* Virtual Groups:: Combining articles from many groups. -* Kibozed Groups:: Looking through parts of the newsfeed for articles. +* Virtual Groups:: Combining articles from many groups. +* Kibozed Groups:: Looking through parts of the newsfeed for articles. Gnus Unplugged -* Agent Basics:: How it all is supposed to work. -* Agent Categories:: How to tell the Gnus Agent what to download. -* Agent Commands:: New commands for all the buffers. -* Agent Expiry:: How to make old articles go away. -* Agent and IMAP:: How to use the Agent with IMAP. -* Outgoing Messages:: What happens when you post/mail something? -* Agent Variables:: Customizing is fun. -* Example Setup:: An example @file{.gnus.el} file for offline people. -* Batching Agents:: How to fetch news from a @code{cron} job. -* Agent Caveats:: What you think it'll do and what it does. +* Agent Basics:: How it all is supposed to work. +* Agent Categories:: How to tell the Gnus Agent what to download. +* Agent Commands:: New commands for all the buffers. +* Agent Visuals:: Ways that the agent may effect your summary buffer. +* Agent as Cache:: The Agent is a big cache too. +* Agent Expiry:: How to make old articles go away. +* Agent Regeneration:: How to recover from lost connections and other accidents. +* Agent and IMAP:: How to use the Agent with @acronym{IMAP}. +* Outgoing Messages:: What happens when you post/mail something? +* Agent Variables:: Customizing is fun. +* Example Setup:: An example @file{~/.gnus.el} file for offline people. +* Batching Agents:: How to fetch news from a @code{cron} job. +* Agent Caveats:: What you think it'll do and what it does. Agent Categories -* Category Syntax:: What a category looks like. -* The Category Buffer:: A buffer for maintaining categories. -* Category Variables:: Customize'r'Us. +* Category Syntax:: What a category looks like. +* Category Buffer:: A buffer for maintaining categories. +* Category Variables:: Customize'r'Us. Agent Commands -* Group Agent Commands:: -* Summary Agent Commands:: -* Server Agent Commands:: +* Group Agent Commands:: Configure groups and fetch their contents. +* Summary Agent Commands:: Manually select then fetch specific articles. +* Server Agent Commands:: Select the servers that are supported by the agent. Scoring -* Summary Score Commands:: Adding score entries for the current group. -* Group Score Commands:: General score commands. -* Score Variables:: Customize your scoring. (My, what terminology). -* Score File Format:: What a score file may contain. -* Score File Editing:: You can edit score files by hand as well. -* Adaptive Scoring:: Big Sister Gnus knows what you read. -* Home Score File:: How to say where new score entries are to go. -* Followups To Yourself:: Having Gnus notice when people answer you. -* Scoring Tips:: How to score effectively. -* Reverse Scoring:: That problem child of old is not problem. -* Global Score Files:: Earth-spanning, ear-splitting score files. -* Kill Files:: They are still here, but they can be ignored. -* Converting Kill Files:: Translating kill files to score files. -* GroupLens:: Getting predictions on what you like to read. -* Advanced Scoring:: Using logical expressions to build score rules. -* Score Decays:: It can be useful to let scores wither away. +* Summary Score Commands:: Adding score entries for the current group. +* Group Score Commands:: General score commands. +* Score Variables:: Customize your scoring. (My, what terminology). +* Score File Format:: What a score file may contain. +* Score File Editing:: You can edit score files by hand as well. +* Adaptive Scoring:: Big Sister Gnus knows what you read. +* Home Score File:: How to say where new score entries are to go. +* Followups To Yourself:: Having Gnus notice when people answer you. +* Scoring On Other Headers:: Scoring on non-standard headers. +* Scoring Tips:: How to score effectively. +* Reverse Scoring:: That problem child of old is not problem. +* Global Score Files:: Earth-spanning, ear-splitting score files. +* Kill Files:: They are still here, but they can be ignored. +* Converting Kill Files:: Translating kill files to score files. +* GroupLens:: Getting predictions on what you like to read. +* Advanced Scoring:: Using logical expressions to build score rules. +* Score Decays:: It can be useful to let scores wither away. GroupLens -* Using GroupLens:: How to make Gnus use GroupLens. -* Rating Articles:: Letting GroupLens know how you rate articles. -* Displaying Predictions:: Displaying predictions given by GroupLens. -* GroupLens Variables:: Customizing GroupLens. +* Using GroupLens:: How to make Gnus use GroupLens. +* Rating Articles:: Letting GroupLens know how you rate articles. +* Displaying Predictions:: Displaying predictions given by GroupLens. +* GroupLens Variables:: Customizing GroupLens. Advanced Scoring @@ -752,116 +821,149 @@ Various -* Process/Prefix:: A convention used by many treatment commands. -* Interactive:: Making Gnus ask you many questions. -* Symbolic Prefixes:: How to supply some Gnus functions with options. -* Formatting Variables:: You can specify what buffers should look like. -* Windows Configuration:: Configuring the Gnus buffer windows. -* Faces and Fonts:: How to change how faces look. -* Compilation:: How to speed Gnus up. -* Mode Lines:: Displaying information in the mode lines. -* Highlighting and Menus:: Making buffers look all nice and cozy. -* Buttons:: Get tendinitis in ten easy steps! -* Daemons:: Gnus can do things behind your back. -* NoCeM:: How to avoid spam and other fatty foods. -* Undo:: Some actions can be undone. -* Moderation:: What to do if you're a moderator. -* XEmacs Enhancements:: There are more pictures and stuff under XEmacs. -* Fuzzy Matching:: What's the big fuzz? -* Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email. -* Various Various:: Things that are really various. +* Process/Prefix:: A convention used by many treatment commands. +* Interactive:: Making Gnus ask you many questions. +* Symbolic Prefixes:: How to supply some Gnus functions with options. +* Formatting Variables:: You can specify what buffers should look like. +* Window Layout:: Configuring the Gnus buffer windows. +* Faces and Fonts:: How to change how faces look. +* Compilation:: How to speed Gnus up. +* Mode Lines:: Displaying information in the mode lines. +* Highlighting and Menus:: Making buffers look all nice and cozy. +* Buttons:: Get tendinitis in ten easy steps! +* Daemons:: Gnus can do things behind your back. +* NoCeM:: How to avoid spam and other fatty foods. +* Undo:: Some actions can be undone. +* Predicate Specifiers:: Specifying predicates. +* Moderation:: What to do if you're a moderator. +* Image Enhancements:: Modern versions of Emacs/XEmacs can display images. +* Fuzzy Matching:: What's the big fuzz? +* Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email. +* Other modes:: Interaction with other modes. +* Various Various:: Things that are really various. Formatting Variables -* Formatting Basics:: A formatting variable is basically a format string. -* Mode Line Formatting:: Some rules about mode line formatting variables. -* Advanced Formatting:: Modifying output in various ways. -* User-Defined Specs:: Having Gnus call your own functions. -* Formatting Fonts:: Making the formatting look colorful and nice. - -XEmacs Enhancements - -* Picons:: How to display pictures of what your reading. -* Smileys:: Show all those happy faces the way they were meant to be shown. -* Toolbar:: Click'n'drool. -* XVarious:: Other XEmacsy Gnusey variables. - -Picons - -* Picon Basics:: What are picons and How do I get them. -* Picon Requirements:: Don't go further if you aren't using XEmacs. -* Easy Picons:: Displaying Picons---the easy way. -* Hard Picons:: The way you should do it. You'll learn something. -* Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with. +* Formatting Basics:: A formatting variable is basically a format string. +* Mode Line Formatting:: Some rules about mode line formatting variables. +* Advanced Formatting:: Modifying output in various ways. +* User-Defined Specs:: Having Gnus call your own functions. +* Formatting Fonts:: Making the formatting look colorful and nice. +* Positioning Point:: Moving point to a position after an operation. +* Tabulation:: Tabulating your output. +* Wide Characters:: Dealing with wide characters. + +Image Enhancements + +* X-Face:: Display a funky, teensy black-and-white image. +* Face:: Display a funkier, teensier colored image. +* Smileys:: Show all those happy faces the way they were meant to be shown. +* Picons:: How to display pictures of what you're reading. +* XVarious:: Other XEmacsy Gnusey variables. + +Thwarting Email Spam + +* The problem of spam:: Some background, and some solutions +* Anti-Spam Basics:: Simple steps to reduce the amount of spam. +* SpamAssassin:: How to use external anti-spam tools. +* Hashcash:: Reduce spam by burning CPU time. +* Filtering Spam Using The Spam ELisp Package:: +* Filtering Spam Using Statistics with spam-stat:: + +Filtering Spam Using The Spam ELisp Package + +* Spam ELisp Package Sequence of Events:: +* Spam ELisp Package Filtering of Incoming Mail:: +* Spam ELisp Package Global Variables:: +* Spam ELisp Package Configuration Examples:: +* Blacklists and Whitelists:: +* BBDB Whitelists:: +* Gmane Spam Reporting:: +* Anti-spam Hashcash Payments:: +* Blackholes:: +* Regular Expressions Header Matching:: +* Bogofilter:: +* ifile spam filtering:: +* spam-stat spam filtering:: +* SpamOracle:: +* Extending the Spam ELisp package:: + +Filtering Spam Using Statistics with spam-stat + +* Creating a spam-stat dictionary:: +* Splitting mail using spam-stat:: +* Low-level interface to the spam-stat dictionary:: Appendices -* History:: How Gnus got where it is today. -* On Writing Manuals:: Why this is not a beginner's guide. -* Terminology:: We use really difficult, like, words here. -* Customization:: Tailoring Gnus to your needs. -* Troubleshooting:: What you might try if things do not work. -* Gnus Reference Guide:: Rilly, rilly technical stuff. -* Emacs for Heathens:: A short introduction to Emacsian terms. -* Frequently Asked Questions:: A question-and-answer session. +* XEmacs:: Requirements for installing under XEmacs. +* History:: How Gnus got where it is today. +* On Writing Manuals:: Why this is not a beginner's guide. +* Terminology:: We use really difficult, like, words here. +* Customization:: Tailoring Gnus to your needs. +* Troubleshooting:: What you might try if things do not work. +* Gnus Reference Guide:: Rilly, rilly technical stuff. +* Emacs for Heathens:: A short introduction to Emacsian terms. +* Frequently Asked Questions:: The Gnus FAQ History -* Gnus Versions:: What Gnus versions have been released. -* Other Gnus Versions:: Other Gnus versions that also have been released. -* Why?:: What's the point of Gnus? -* Compatibility:: Just how compatible is Gnus with @sc{gnus}? -* Conformity:: Gnus tries to conform to all standards. -* Emacsen:: Gnus can be run on a few modern Emacsen. -* Gnus Development:: How Gnus is developed. -* Contributors:: Oodles of people. -* New Features:: Pointers to some of the new stuff in Gnus. +* Gnus Versions:: What Gnus versions have been released. +* Other Gnus Versions:: Other Gnus versions that also have been released. +* Why?:: What's the point of Gnus? +* Compatibility:: Just how compatible is Gnus with @sc{gnus}? +* Conformity:: Gnus tries to conform to all standards. +* Emacsen:: Gnus can be run on a few modern Emacsen. +* Gnus Development:: How Gnus is developed. +* Contributors:: Oodles of people. +* New Features:: Pointers to some of the new stuff in Gnus. New Features -* ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus. -* September Gnus:: The Thing Formally Known As Gnus 5.2/5.3. -* Red Gnus:: Third time best---Gnus 5.4/5.5. -* Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7. -* Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9. +* ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus. +* September Gnus:: The Thing Formally Known As Gnus 5.2/5.3. +* Red Gnus:: Third time best---Gnus 5.4/5.5. +* Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7. +* Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9. +* Oort Gnus:: It's big. It's far out. Gnus 5.10. Customization -* Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere. -* Slow Terminal Connection:: You run a remote Emacs. -* Little Disk Space:: You feel that having large setup files is icky. -* Slow Machine:: You feel like buying a faster machine. +* Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere. +* Slow Terminal Connection:: You run a remote Emacs. +* Little Disk Space:: You feel that having large setup files is icky. +* Slow Machine:: You feel like buying a faster machine. Gnus Reference Guide -* Gnus Utility Functions:: Common functions and variable to use. -* Back End Interface:: How Gnus communicates with the servers. -* Score File Syntax:: A BNF definition of the score file standard. -* Headers:: How Gnus stores headers internally. -* Ranges:: A handy format for storing mucho numbers. -* Group Info:: The group info format. -* Extended Interactive:: Symbolic prefixes and stuff. -* Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen. -* Various File Formats:: Formats of files that Gnus use. +* Gnus Utility Functions:: Common functions and variable to use. +* Back End Interface:: How Gnus communicates with the servers. +* Score File Syntax:: A BNF definition of the score file standard. +* Headers:: How Gnus stores headers internally. +* Ranges:: A handy format for storing mucho numbers. +* Group Info:: The group info format. +* Extended Interactive:: Symbolic prefixes and stuff. +* Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen. +* Various File Formats:: Formats of files that Gnus use. Back End Interface -* Required Back End Functions:: Functions that must be implemented. -* Optional Back End Functions:: Functions that need not be implemented. -* Error Messaging:: How to get messages and report errors. -* Writing New Back Ends:: Extending old back ends. -* Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end. -* Mail-like Back Ends:: Some tips on mail back ends. +* Required Back End Functions:: Functions that must be implemented. +* Optional Back End Functions:: Functions that need not be implemented. +* Error Messaging:: How to get messages and report errors. +* Writing New Back Ends:: Extending old back ends. +* Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end. +* Mail-like Back Ends:: Some tips on mail back ends. Various File Formats -* Active File Format:: Information on articles and groups available. -* Newsgroups File Format:: Group descriptions. +* Active File Format:: Information on articles and groups available. +* Newsgroups File Format:: Group descriptions. Emacs for Heathens -* Keystrokes:: Entering text and executing commands. -* Emacs Lisp:: The built-in Emacs programming language. +* Keystrokes:: Entering text and executing commands. +* Emacs Lisp:: The built-in Emacs programming language. @end detailmenu @end menu @@ -882,24 +984,24 @@ @kbd{M-x gnus-other-frame} instead. If things do not go smoothly at startup, you have to twiddle some -variables in your @file{~/.gnus} file. This file is similar to -@file{~/.emacs}, but is read when gnus starts. +variables in your @file{~/.gnus.el} file. This file is similar to +@file{~/.emacs}, but is read when Gnus starts. If you puzzle at any terms used in this manual, please refer to the terminology section (@pxref{Terminology}). @menu -* Finding the News:: Choosing a method for getting news. -* The First Time:: What does Gnus do the first time you start it? -* The Server is Down:: How can I read my mail then? -* Slave Gnusae:: You can have more than one Gnus active at a time. -* Fetching a Group:: Starting Gnus just to read a group. -* New Groups:: What is Gnus supposed to do with new groups? -* Startup Files:: Those pesky startup files---@file{.newsrc}. -* Auto Save:: Recovering from a crash. -* The Active File:: Reading the active file over a slow line Takes Time. -* Changing Servers:: You may want to move from one server to another. -* Startup Variables:: Other variables you might change. +* Finding the News:: Choosing a method for getting news. +* The First Time:: What does Gnus do the first time you start it? +* The Server is Down:: How can I read my mail then? +* Slave Gnusae:: You can have more than one Gnus active at a time. +* Fetching a Group:: Starting Gnus just to read a group. +* New Groups:: What is Gnus supposed to do with new groups? +* Changing Servers:: You may want to move from one server to another. +* Startup Files:: Those pesky startup files---@file{.newsrc}. +* Auto Save:: Recovering from a crash. +* The Active File:: Reading the active file over a slow line Takes Time. +* Startup Variables:: Other variables you might change. @end menu @@ -915,7 +1017,7 @@ native method. All groups not fetched with this method are foreign groups. -For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where +For instance, if the @samp{news.somewhere.edu} @acronym{NNTP} server is where you want to get your daily dosage of news from, you'd say: @lisp @@ -929,16 +1031,18 @@ @end lisp If you can use a local spool, you probably should, as it will almost -certainly be much faster. +certainly be much faster. But do not use the local spool if your +server is running Leafnode; in this case, use @code{(nntp "localhost")}. @vindex gnus-nntpserver-file @cindex NNTPSERVER -@cindex @sc{nntp} server +@cindex @acronym{NNTP} server If this variable is not set, Gnus will take a look at the -@code{NNTPSERVER} environment variable. If that variable isn't set, +@env{NNTPSERVER} environment variable. If that variable isn't set, Gnus will see whether @code{gnus-nntpserver-file} -(@file{/etc/nntpserver} by default) has any opinions on the matter. If -that fails as well, Gnus will try to use the machine running Emacs as an @sc{nntp} server. That's a long shot, though. +(@file{/etc/nntpserver} by default) has any opinions on the matter. +If that fails as well, Gnus will try to use the machine running Emacs +as an @acronym{NNTP} server. That's a long shot, though. @vindex gnus-nntp-server If @code{gnus-nntp-server} is set, this variable will override @@ -948,7 +1052,7 @@ @vindex gnus-secondary-servers @vindex gnus-nntp-server You can also make Gnus prompt you interactively for the name of an -@sc{nntp} server. If you give a non-numerical prefix to @code{gnus} +@acronym{NNTP} server. If you give a non-numerical prefix to @code{gnus} (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers in the @code{gnus-secondary-servers} list (if any). You can also just type in the name of any server you feel like visiting. (Note that this @@ -957,8 +1061,8 @@ server.) @findex gnus-group-browse-foreign-server -@kindex B @r{(Group)} -However, if you use one @sc{nntp} server regularly and are just +@kindex B (Group) +However, if you use one @acronym{NNTP} server regularly and are just interested in a couple of groups from a different server, you would be better served by using the @kbd{B} command in the group buffer. It will let you have a look at what groups are available, and you can subscribe @@ -1033,7 +1137,7 @@ if you're in a hurry as well. This command will not attempt to contact your primary server---instead, it will just activate all groups on level 1 and 2. (You should preferably keep no native groups on those two -levels.) +levels.) Also @pxref{Group Levels}. @node Slave Gnusae @@ -1046,7 +1150,7 @@ that is no problem whatsoever. You just do it. The problem appears when you want to run two Gnusae that use the same -@code{.newsrc} file. +@file{.newsrc} file. To work around that problem some, we here at the Think-Tank at the Gnus Towers have come up with a new concept: @dfn{Masters} and @@ -1056,6 +1160,7 @@ me. Usage of the patent (@dfn{Master/Slave Relationships In Computer Applications}) will be much more expensive, of course.) +@findex gnus-slave Anyway, you start one Gnus up the normal way with @kbd{M-x gnus} (or however you do it). Each subsequent slave Gnusae should be started with @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc} @@ -1066,8 +1171,13 @@ they were created, so the latest changes will have precedence.) Information from the slave files has, of course, precedence over the -information in the normal (i.e., master) @code{.newsrc} file. - +information in the normal (i.e., master) @file{.newsrc} file. + +If the @file{.newsrc*} files have not been saved in the master when the +slave starts, you may be prompted as to whether to read an auto-save +file. If you answer ``yes'', the unsaved changes to the master will be +incorporated into the slave. If you answer ``no'', the slave may see some +messages as unread that have been read in the master. @node Fetching a Group @section Fetching a Group @@ -1097,9 +1207,9 @@ when you do the @kbd{g} command (@pxref{Scanning New Messages}). @menu -* Checking New Groups:: Determining what groups are new. -* Subscription Methods:: What Gnus should do with new groups. -* Filtering New Groups:: Making Gnus ignore certain new groups. +* Checking New Groups:: Determining what groups are new. +* Subscription Methods:: What Gnus should do with new groups. +* Filtering New Groups:: Making Gnus ignore certain new groups. @end menu @@ -1251,13 +1361,14 @@ @vindex gnus-auto-subscribed-groups Yet another variable that meddles here is @code{gnus-auto-subscribed-groups}. It works exactly like -@code{gnus-options-subscribe}, and is therefore really superfluous, but I -thought it would be nice to have two of these. This variable is more -meant for setting some ground rules, while the other variable is used -more for user fiddling. By default this variable makes all new groups -that come from mail back ends (@code{nnml}, @code{nnbabyl}, -@code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed. If you -don't like that, just set this variable to @code{nil}. +@code{gnus-options-subscribe}, and is therefore really superfluous, +but I thought it would be nice to have two of these. This variable is +more meant for setting some ground rules, while the other variable is +used more for user fiddling. By default this variable makes all new +groups that come from mail back ends (@code{nnml}, @code{nnbabyl}, +@code{nnfolder}, @code{nnmbox}, @code{nnmh}, and @code{nnmaildir}) +subscribed. If you don't like that, just set this variable to +@code{nil}. New groups that match this regexp are subscribed using @code{gnus-subscribe-options-newsgroup-method}. @@ -1267,7 +1378,7 @@ @section Changing Servers @cindex changing servers -Sometimes it is necessary to move from one @sc{nntp} server to another. +Sometimes it is necessary to move from one @acronym{NNTP} server to another. This happens very rarely, but perhaps you change jobs, or one server is very flaky and you want to use another. @@ -1277,7 +1388,7 @@ @emph{Wrong!} Article numbers are not (in any way) kept synchronized between different -@sc{nntp} servers, and the only way Gnus keeps track of what articles +@acronym{NNTP} servers, and the only way Gnus keeps track of what articles you have read is by keeping track of article numbers. So when you change @code{gnus-select-method}, your @file{.newsrc} file becomes worthless. @@ -1308,9 +1419,18 @@ gnus-group-clear-data-on-native-groups} command to clear out all data that you have on your native groups. Use with caution. +@kindex M-x gnus-group-clear-data +@findex gnus-group-clear-data +Clear the data from the current group only---nix out marks and the +list of read articles (@code{gnus-group-clear-data}). + After changing servers, you @strong{must} move the cache hierarchy away, since the cached articles will have wrong article numbers, which will affect which articles Gnus thinks are read. +@code{gnus-group-clear-data-on-native-groups} will ask you if you want +to have it done automatically; for @code{gnus-group-clear-data}, you +can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the +cache for all groups). @node Startup Files @@ -1363,9 +1483,14 @@ several servers where not all servers support @code{ask-server}. @vindex gnus-startup-file +@vindex gnus-backup-startup-file +@vindex version-control The @code{gnus-startup-file} variable says where the startup files are. The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup file being whatever that one is, with a @samp{.eld} appended. +If you want version control for this file, set +@code{gnus-backup-startup-file}. It respects the same values as the +@code{version-control} variable. @vindex gnus-save-newsrc-hook @vindex gnus-save-quick-newsrc-hook @@ -1387,6 +1512,7 @@ @end lisp @vindex gnus-init-file +@vindex gnus-site-init-file When Gnus starts, it will read the @code{gnus-site-init-file} (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file} (@file{~/.gnus} by default) files. These are normal Emacs Lisp files @@ -1424,7 +1550,7 @@ this variable is @code{nil}, which it is by default, Gnus will dribble into the directory where the @file{.newsrc} file is located. (This is normally the user's home directory.) The dribble file will get the same -file permissions as the @code{.newsrc} file. +file permissions as the @file{.newsrc} file. @vindex gnus-always-read-dribble-file If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will @@ -1480,7 +1606,7 @@ If this variable is @code{nil}, Gnus will ask for group info in total lock-step, which isn't very fast. If it is @code{some} and you use an -@sc{nntp} server, Gnus will pump out commands as fast as it can, and +@acronym{NNTP} server, Gnus will pump out commands as fast as it can, and read all the replies in one swoop. This will normally result in better performance, but if the server does not support the aforementioned @code{LIST ACTIVE group} command, this isn't very nice to the server. @@ -1538,7 +1664,7 @@ If non-@code{nil}, the startup message won't be displayed. That way, your boss might not notice as easily that you are reading news instead of doing your job. Note that this variable is used before -@file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead. +@file{~/.gnus.el} is loaded, so it should be set in @file{.emacs} instead. @item gnus-no-groups-message @vindex gnus-no-groups-message @@ -1556,10 +1682,30 @@ @end table -@node The Group Buffer -@chapter The Group Buffer +@node Group Buffer +@chapter Group Buffer @cindex group buffer +@c Alex Schroeder suggests to rearrange this as follows: +@c +@c ok, just save it for reference. I'll go to bed in a minute. +@c 1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels, +@c 4. Subscription Commands, 5. Group Maneuvering, 6. Group Data, +@c 7. Group Score, 8. Group Buffer Format +@c Group Levels should have more information on levels 5 to 9. I +@c suggest to split the 4th paragraph ("Gnus considers groups...") as follows: +@c First, "Gnus considers groups... (default 9)." +@c New, a table summarizing what levels 1 to 9 mean. +@c Third, "Gnus treats subscribed ... reasons of efficiency" +@c Then expand the next paragraph or add some more to it. +@c This short one sentence explains levels 1 and 2, therefore I understand +@c that I should keep important news at 3 and boring news at 4. +@c Say so! Then go on to explain why I should bother with levels 6 to 9. +@c Maybe keep those that you don't want to read temporarily at 6, +@c those that you never want to read at 8, those that offend your +@c human rights at 9... + + The @dfn{group buffer} lists all (or parts) of the available groups. It is the first buffer shown when Gnus starts, and will never be killed as long as Gnus is active. @@ -1567,7 +1713,7 @@ @iftex @iflatex \gnusfigure{The Group Buffer}{320}{ -\put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}} +\put(75,50){\epsfig{figure=ps/group,height=9cm}} \put(120,37){\makebox(0,0)[t]{Buffer name}} \put(120,38){\vector(1,2){10}} \put(40,60){\makebox(0,0)[r]{Mode line}} @@ -1579,23 +1725,23 @@ @end iftex @menu -* Group Buffer Format:: Information listed and how you can change it. -* Group Maneuvering:: Commands for moving in the group buffer. -* Selecting a Group:: Actually reading news. -* Group Data:: Changing the info for a group. -* Subscription Commands:: Unsubscribing, killing, subscribing. -* Group Levels:: Levels? What are those, then? -* Group Score:: A mechanism for finding out what groups you like. -* Marking Groups:: You can mark groups for later processing. -* Foreign Groups:: Creating and editing groups. -* Group Parameters:: Each group may have different parameters set. -* Listing Groups:: Gnus can list various subsets of the groups. -* Sorting Groups:: Re-arrange the group order. -* Group Maintenance:: Maintaining a tidy @file{.newsrc} file. -* Browse Foreign Server:: You can browse a server. See what it has to offer. -* Exiting Gnus:: Stop reading news and get some work done. -* Group Topics:: A folding group mode divided into topics. -* Misc Group Stuff:: Other stuff that you can to do. +* Group Buffer Format:: Information listed and how you can change it. +* Group Maneuvering:: Commands for moving in the group buffer. +* Selecting a Group:: Actually reading news. +* Subscription Commands:: Unsubscribing, killing, subscribing. +* Group Data:: Changing the info for a group. +* Group Levels:: Levels? What are those, then? +* Group Score:: A mechanism for finding out what groups you like. +* Marking Groups:: You can mark groups for later processing. +* Foreign Groups:: Creating and editing groups. +* Group Parameters:: Each group may have different parameters set. +* Listing Groups:: Gnus can list various subsets of the groups. +* Sorting Groups:: Re-arrange the group order. +* Group Maintenance:: Maintaining a tidy @file{.newsrc} file. +* Browse Foreign Server:: You can browse a server. See what it has to offer. +* Exiting Gnus:: Stop reading news and get some work done. +* Group Topics:: A folding group mode divided into topics. +* Misc Group Stuff:: Other stuff that you can to do. @end menu @@ -1603,9 +1749,9 @@ @section Group Buffer Format @menu -* Group Line Specification:: Deciding how the group buffer is to look. -* Group Modeline Specification:: The group buffer modeline. -* Group Highlighting:: Having nice colors in the group buffer. +* Group Line Specification:: Deciding how the group buffer is to look. +* Group Mode Line Specification:: The group buffer mode line. +* Group Highlighting:: Having nice colors in the group buffer. @end menu @@ -1637,13 +1783,13 @@ a @code{printf} specifications, for those of you who use (feh!) C. @xref{Formatting Variables}. -@samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above. +@samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above. There should always be a colon on the line; the cursor always moves to -the colon after performing an operation. Nothing else is required---not -even the group name. All displayed text is just window dressing, and is -never examined by Gnus. Gnus stores all real information it needs using -text properties. +the colon after performing an operation. @xref{Positioning +Point}. Nothing else is required---not even the group name. All +displayed text is just window dressing, and is never examined by Gnus. +Gnus stores all real information it needs using text properties. (Note that if you make a really strange, wonderful, spreadsheet-like layout, everybody will believe you are hard at work with the accounting @@ -1674,10 +1820,22 @@ @item R Number of read articles. +@item U +Number of unseen articles. + @item t Estimated total number of articles. (This is really @var{max-number} minus @var{min-number} plus 1.) +Gnus uses this estimation because the @acronym{NNTP} protocol provides +efficient access to @var{max-number} and @var{min-number} but getting +the true unread message count is not possible efficiently. For +hysterical raisins, even the mail back ends, where the true number of +unread messages might be available efficiently, use the same limited +interface. To remove this restriction from Gnus means that the back +end interface has to be changed, which is not an easy job. If you +want to work on this, please contact the Gnus mailing list. + @item y Number of unread, unticked, non-dormant articles. @@ -1690,8 +1848,15 @@ @item G Group name. +@item C +Group comment (@pxref{Group Parameters}) or group name if there is no +comment element in the group parameters. + @item D -Newsgroup description. +Newsgroup description. You need to read the group descriptions +before these will appear, and to do that, you either have to set +@code{gnus-read-active-file} or use the group buffer @kbd{M-d} +command. @item o @samp{m} if moderated. @@ -1702,6 +1867,9 @@ @item s Select method. +@item B +If the summary buffer for the group is open or not. + @item n Select from where. @@ -1748,9 +1916,9 @@ group, or a bogus native group. -@node Group Modeline Specification -@subsection Group Modeline Specification -@cindex group modeline +@node Group Mode Line Specification +@subsection Group Mode Line Specification +@cindex group mode line @vindex gnus-group-mode-line-format The mode line can be changed by setting @@ -1783,15 +1951,16 @@ (cond (window-system (setq custom-background-mode 'light) (defface my-group-face-1 - '((t (:foreground "Red" :bold t))) "First group face") + '((t (:foreground "Red" :bold t))) "First group face") (defface my-group-face-2 - '((t (:foreground "DarkSeaGreen4" :bold t))) "Second group face") + '((t (:foreground "DarkSeaGreen4" :bold t))) + "Second group face") (defface my-group-face-3 - '((t (:foreground "Green4" :bold t))) "Third group face") + '((t (:foreground "Green4" :bold t))) "Third group face") (defface my-group-face-4 - '((t (:foreground "SteelBlue" :bold t))) "Fourth group face") + '((t (:foreground "SteelBlue" :bold t))) "Fourth group face") (defface my-group-face-5 - '((t (:foreground "Blue" :bold t))) "Fifth group face"))) + '((t (:foreground "Blue" :bold t))) "Fifth group face"))) (setq gnus-group-highlight '(((> unread 200) . my-group-face-1) @@ -1822,8 +1991,8 @@ @item ticked The number of ticked articles in the group. @item total -The total number of articles in the group. Or rather, MAX-NUMBER minus -MIN-NUMBER plus one. +The total number of articles in the group. Or rather, +@var{max-number} minus @var{min-number} plus one. @item topic When using the topic minor mode, this variable is bound to the current topic being inserted. @@ -1850,37 +2019,37 @@ @table @kbd @item n -@kindex n @r{(Group)} +@kindex n (Group) @findex gnus-group-next-unread-group Go to the next group that has unread articles (@code{gnus-group-next-unread-group}). @item p -@itemx @key{DEL} -@kindex @key{DEL} @r{(Group)} -@kindex p @r{(Group)} +@itemx DEL +@kindex DEL (Group) +@kindex p (Group) @findex gnus-group-prev-unread-group Go to the previous group that has unread articles (@code{gnus-group-prev-unread-group}). @item N -@kindex N @r{(Group)} +@kindex N (Group) @findex gnus-group-next-group Go to the next group (@code{gnus-group-next-group}). @item P -@kindex P @r{(Group)} +@kindex P (Group) @findex gnus-group-prev-group Go to the previous group (@code{gnus-group-prev-group}). @item M-n -@kindex M-n @r{(Group)} +@kindex M-n (Group) @findex gnus-group-next-unread-group-same-level Go to the next unread group on the same (or lower) level (@code{gnus-group-next-unread-group-same-level}). @item M-p -@kindex M-p @r{(Group)} +@kindex M-p (Group) @findex gnus-group-prev-unread-group-same-level Go to the previous unread group on the same (or lower) level (@code{gnus-group-prev-unread-group-same-level}). @@ -1891,20 +2060,20 @@ @table @kbd @item j -@kindex j @r{(Group)} +@kindex j (Group) @findex gnus-group-jump-to-group Jump to a group (and make it visible if it isn't already) (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just like living groups. @item , -@kindex , @r{(Group)} +@kindex , (Group) @findex gnus-group-best-unread-group Jump to the unread group with the lowest level (@code{gnus-group-best-unread-group}). @item . -@kindex . @r{(Group)} +@kindex . (Group) @findex gnus-group-first-unread-group Jump to the first group with unread articles (@code{gnus-group-first-unread-group}). @@ -1923,17 +2092,17 @@ @table @kbd -@item @key{SPC} -@kindex @key{SPC} @r{(Group)} +@item SPACE +@kindex SPACE (Group) @findex gnus-group-read-group Select the current group, switch to the summary buffer and display the first unread article (@code{gnus-group-read-group}). If there are no unread articles in the group, or if you give a non-numerical prefix to this command, Gnus will offer to fetch all the old articles in this -group from the server. If you give a numerical prefix @var{N}, @var{N} -determines the number of articles Gnus will fetch. If @var{N} is -positive, Gnus fetches the @var{N} newest articles, if @var{N} is -negative, Gnus fetches the @code{abs(@var{N})} oldest articles. +group from the server. If you give a numerical prefix @var{n}, @var{n} +determines the number of articles Gnus will fetch. If @var{n} is +positive, Gnus fetches the @var{n} newest articles, if @var{n} is +negative, Gnus fetches the @code{abs(@var{n})} oldest articles. Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u @@ -1943,9 +2112,8 @@ @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old ones. -@item @key{RET} -@kindex @key{RET} @r{(Group)} - +@item RET +@kindex RET (Group) @findex gnus-group-select-group Select the current group and switch to the summary buffer (@code{gnus-group-select-group}). Takes the same arguments as @@ -1953,27 +2121,27 @@ does not display the first unread article automatically upon group entry. -@item M-@key{RET} -@kindex M-@key{RET} @r{(Group)} +@item M-RET +@kindex M-RET (Group) @findex gnus-group-quick-select-group This does the same as the command above, but tries to do it with the minimum amount of fuzz (@code{gnus-group-quick-select-group}). No scoring/killing will be performed, there will be no highlights and no expunging. This might be useful if you're in a real hurry and have to enter some humongous group. If you give a 0 prefix to this command -(i.e., @kbd{0 M-@key{RET}}), Gnus won't even generate the summary buffer, +(i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer, which is useful if you want to toggle threading before generating the summary buffer (@pxref{Summary Generation Commands}). -@item M-@key{SPC} -@kindex M-@key{SPC} @r{(Group)} +@item M-SPACE +@kindex M-SPACE (Group) @findex gnus-group-visible-select-group -This is yet one more command that does the same as the @key{RET} +This is yet one more command that does the same as the @kbd{RET} command, but this one does it without expunging and hiding dormants (@code{gnus-group-visible-select-group}). -@item C-M-@key{RET} -@kindex C-M-@key{RET} @r{(Group)} +@item C-M-RET +@kindex C-M-RET (Group) @findex gnus-group-select-group-ephemerally Finally, this command selects the current group ephemerally without doing any processing of its contents @@ -1984,55 +2152,58 @@ @end table @vindex gnus-large-newsgroup -The @code{gnus-large-newsgroup} variable says what Gnus should consider -to be a big group. This is 200 by default. If the group has more +The @code{gnus-large-newsgroup} variable says what Gnus should +consider to be a big group. If it is @code{nil}, no groups are +considered big. The default value is 200. If the group has more (unread and/or ticked) articles than this, Gnus will query the user -before entering the group. The user can then specify how many articles -should be fetched from the server. If the user specifies a negative -number (@code{-n}), the @code{n} oldest articles will be fetched. If it -is positive, the @code{n} articles that have arrived most recently will -be fetched. +before entering the group. The user can then specify how many +articles should be fetched from the server. If the user specifies a +negative number (@var{-n}), the @var{n} oldest articles will be +fetched. If it is positive, the @var{n} articles that have arrived +most recently will be fetched. + +@vindex gnus-large-ephemeral-newsgroup +@code{gnus-large-ephemeral-newsgroup} is the same as +@code{gnus-large-newsgroup}, but is only used for ephemeral +newsgroups. @vindex gnus-select-group-hook @vindex gnus-auto-select-first -@code{gnus-auto-select-first} control whether any articles are selected -automatically when entering a group with the @key{SPC} command. - -@table @code - -@item nil -Don't select any articles when entering the group. Just display the -full summary buffer. - -@item t -Select the first unread article when entering the group. +@vindex gnus-auto-select-subject +If @code{gnus-auto-select-first} is non-@code{nil}, select an article +automatically when entering a group with the @kbd{SPACE} command. +Which article this is is controlled by the +@code{gnus-auto-select-subject} variable. Valid values for this +variable is: + +@table @code + +@item unread +Place point on the subject line of the first unread article. + +@item first +Place point on the subject line of the first article. + +@item unseen +Place point on the subject line of the first unseen article. + +@item unseen-or-unread +Place point on the subject line of the first unseen article, and if +there is no such article, place point on the subject line of the first +unread article. @item best -Select the highest scored article in the group when entering the -group. - -@end table - -This variable can also be a function. In that case, that function will -be called to place point on a subject line, and/or select some article. -Useful functions include: - -@table @code -@item gnus-summary-first-unread-subject -Place point on the subject line of the first unread article, but -don't select the article. - -@item gnus-summary-first-unread-article -Select the first unread article. - -@item gnus-summary-best-unread-article -Select the highest-scored unread article. -@end table - +Place point on the subject line of the highest-scored unread article. + +@end table + +This variable can also be a function. In that case, that function +will be called to place point on a subject line. If you want to prevent automatic selection in some group (say, in a -binary group with Huge articles) you can set this variable to @code{nil} -in @code{gnus-select-group-hook}, which is called when a group is +binary group with Huge articles) you can set the +@code{gnus-auto-select-first} variable to @code{nil} in +@code{gnus-select-group-hook}, which is called when a group is selected. @@ -2044,8 +2215,8 @@ @item S t @itemx u -@kindex S t @r{(Group)} -@kindex u @r{(Group)} +@kindex S t (Group) +@kindex u (Group) @findex gnus-group-unsubscribe-current-group @c @icon{gnus-group-unsubscribe} Toggle subscription to the current group @@ -2053,8 +2224,8 @@ @item S s @itemx U -@kindex S s @r{(Group)} -@kindex U @r{(Group)} +@kindex S s (Group) +@kindex U (Group) @findex gnus-group-unsubscribe-group Prompt for a group to subscribe, and then subscribe it. If it was subscribed already, unsubscribe it instead @@ -2062,21 +2233,21 @@ @item S k @itemx C-k -@kindex S k @r{(Group)} -@kindex C-k @r{(Group)} +@kindex S k (Group) +@kindex C-k (Group) @findex gnus-group-kill-group @c @icon{gnus-group-kill-group} Kill the current group (@code{gnus-group-kill-group}). @item S y @itemx C-y -@kindex S y @r{(Group)} -@kindex C-y @r{(Group)} +@kindex S y (Group) +@kindex C-y (Group) @findex gnus-group-yank-group Yank the last killed group (@code{gnus-group-yank-group}). @item C-x C-t -@kindex C-x C-t @r{(Group)} +@kindex C-x C-t (Group) @findex gnus-group-transpose-groups Transpose two groups (@code{gnus-group-transpose-groups}). This isn't really a subscription command, but you can use it instead of a @@ -2084,18 +2255,18 @@ @item S w @itemx C-w -@kindex S w @r{(Group)} -@kindex C-w @r{(Group)} +@kindex S w (Group) +@kindex C-w (Group) @findex gnus-group-kill-region Kill all groups in the region (@code{gnus-group-kill-region}). @item S z -@kindex S z @r{(Group)} +@kindex S z (Group) @findex gnus-group-kill-all-zombies Kill all zombie groups (@code{gnus-group-kill-all-zombies}). @item S C-k -@kindex S C-k @r{(Group)} +@kindex S C-k (Group) @findex gnus-group-kill-level Kill all groups on a certain level (@code{gnus-group-kill-level}). These groups can't be yanked back after killing, so this command should @@ -2116,7 +2287,7 @@ @table @kbd @item c -@kindex c @r{(Group)} +@kindex c (Group) @findex gnus-group-catchup-current @vindex gnus-group-catchup-group-hook @c @icon{gnus-group-catchup-current} @@ -2126,13 +2297,13 @@ the group buffer. @item C -@kindex C @r{(Group)} +@kindex C (Group) @findex gnus-group-catchup-current-all Mark all articles in this group, even the ticked ones, as read (@code{gnus-group-catchup-current-all}). @item M-c -@kindex M-c @r{(Group)} +@kindex M-c (Group) @findex gnus-group-clear-data Clear the data from the current group---nix out marks and the list of read articles (@code{gnus-group-clear-data}). @@ -2140,7 +2311,7 @@ @item M-x gnus-group-clear-data-on-native-groups @kindex M-x gnus-group-clear-data-on-native-groups @findex gnus-group-clear-data-on-native-groups -If you have switched from one @sc{nntp} server to another, all your marks +If you have switched from one @acronym{NNTP} server to another, all your marks and read ranges have become worthless. You can use this command to clear out all data that you have on your native groups. Use with caution. @@ -2164,7 +2335,7 @@ @table @kbd @item S l -@kindex S l @r{(Group)} +@kindex S l (Group) @findex gnus-group-set-current-level Set the level of the current group. If a numeric prefix is given, the next @var{n} groups will have their levels set. The user will be @@ -2304,37 +2475,37 @@ @table @kbd @item # -@kindex # @r{(Group)} +@kindex # (Group) @itemx M m -@kindex M m @r{(Group)} +@kindex M m (Group) @findex gnus-group-mark-group Set the mark on the current group (@code{gnus-group-mark-group}). @item M-# -@kindex M-# @r{(Group)} +@kindex M-# (Group) @itemx M u -@kindex M u @r{(Group)} +@kindex M u (Group) @findex gnus-group-unmark-group Remove the mark from the current group (@code{gnus-group-unmark-group}). @item M U -@kindex M U @r{(Group)} +@kindex M U (Group) @findex gnus-group-unmark-all-groups Remove the mark from all groups (@code{gnus-group-unmark-all-groups}). @item M w -@kindex M w @r{(Group)} +@kindex M w (Group) @findex gnus-group-mark-region Mark all groups between point and mark (@code{gnus-group-mark-region}). @item M b -@kindex M b @r{(Group)} +@kindex M b (Group) @findex gnus-group-mark-buffer Mark all groups in the buffer (@code{gnus-group-mark-buffer}). @item M r -@kindex M r @r{(Group)} +@kindex M r (Group) @findex gnus-group-mark-regexp Mark all groups that match some regular expression (@code{gnus-group-mark-regexp}). @@ -2362,15 +2533,21 @@ @table @kbd @item G m -@kindex G m @r{(Group)} +@kindex G m (Group) @findex gnus-group-make-group @cindex making groups Make a new group (@code{gnus-group-make-group}). Gnus will prompt you for a name, a method and possibly an @dfn{address}. For an easier way -to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}. +to subscribe to @acronym{NNTP} groups (@pxref{Browse Foreign Server}). + +@item G M +@kindex G M (Group) +@findex gnus-group-read-ephemeral-group +Make an ephemeral group (@code{gnus-group-read-ephemeral-group}). Gnus +will prompt you for a name, a method and an @dfn{address}. @item G r -@kindex G r @r{(Group)} +@kindex G r (Group) @findex gnus-group-rename-group @cindex renaming groups Rename the current group to something else @@ -2379,45 +2556,45 @@ on some back ends. @item G c -@kindex G c @r{(Group)} +@kindex G c (Group) @cindex customizing @findex gnus-group-customize Customize the group parameters (@code{gnus-group-customize}). @item G e -@kindex G e @r{(Group)} +@kindex G e (Group) @findex gnus-group-edit-group-method @cindex renaming groups Enter a buffer where you can edit the select method of the current group (@code{gnus-group-edit-group-method}). @item G p -@kindex G p @r{(Group)} +@kindex G p (Group) @findex gnus-group-edit-group-parameters Enter a buffer where you can edit the group parameters (@code{gnus-group-edit-group-parameters}). @item G E -@kindex G E @r{(Group)} +@kindex G E (Group) @findex gnus-group-edit-group Enter a buffer where you can edit the group info (@code{gnus-group-edit-group}). @item G d -@kindex G d @r{(Group)} +@kindex G d (Group) @findex gnus-group-make-directory-group @cindex nndir Make a directory group (@pxref{Directory Groups}). You will be prompted for a directory name (@code{gnus-group-make-directory-group}). @item G h -@kindex G h @r{(Group)} +@kindex G h (Group) @cindex help group @findex gnus-group-make-help-group Make the Gnus help group (@code{gnus-group-make-help-group}). @item G a -@kindex G a @r{(Group)} +@kindex G a (Group) @cindex (ding) archive @cindex archive group @findex gnus-group-make-archive-group @@ -2429,7 +2606,7 @@ group will be created from @code{gnus-group-archive-directory}. @item G k -@kindex G k @r{(Group)} +@kindex G k (Group) @findex gnus-group-make-kiboze-group @cindex nnkiboze Make a kiboze group. You will be prompted for a name, for a regexp to @@ -2438,7 +2615,7 @@ @xref{Kibozed Groups}. @item G D -@kindex G D @r{(Group)} +@kindex G D (Group) @findex gnus-group-enter-directory @cindex nneething Read an arbitrary directory as if it were a newsgroup with the @@ -2446,62 +2623,70 @@ @xref{Anything Groups}. @item G f -@kindex G f @r{(Group)} +@kindex G f (Group) @findex gnus-group-make-doc-group @cindex ClariNet Briefs @cindex nndoc Make a group based on some file or other (@code{gnus-group-make-doc-group}). If you give a prefix to this command, you will be prompted for a file name and a file type. -Currently supported types are @code{babyl}, @code{mbox}, @code{digest}, -@code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs}, -@code{rfc934}, @code{rfc822-forward}, @code{nsmail} and @code{forward}. -If you run this command without a prefix, Gnus will guess at the file +Currently supported types are @code{mbox}, @code{babyl}, +@code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, +@code{rfc934}, @code{rfc822-forward}, @code{mime-parts}, +@code{standard-digest}, @code{slack-digest}, @code{clari-briefs}, +@code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}. If +you run this command without a prefix, Gnus will guess at the file type. @xref{Document Groups}. @item G u -@kindex G u @r{(Group)} +@kindex G u (Group) @vindex gnus-useful-groups @findex gnus-group-make-useful-group Create one of the groups mentioned in @code{gnus-useful-groups} (@code{gnus-group-make-useful-group}). @item G w -@kindex G w @r{(Group)} +@kindex G w (Group) @findex gnus-group-make-web-group -@cindex DejaNews -@cindex Alta Vista -@cindex InReference +@cindex Google @cindex nnweb +@cindex gmane Make an ephemeral group based on a web search (@code{gnus-group-make-web-group}). If you give a prefix to this command, make a solid group instead. You will be prompted for the search engine type and the search string. Valid search engine types -include @code{dejanews}, @code{altavista} and @code{reference}. +include @code{google}, @code{dejanews}, and @code{gmane}. @xref{Web Searches}. -If you use the @code{dejanews} search engine, you can limit the search +If you use the @code{google} search engine, you can limit the search to a particular group by using a match string like -@samp{~g alt.sysadmin.recovery shaving}. - -@item G @key{DEL} -@kindex G @key{DEL} @r{(Group)} +@samp{shaving group:alt.sysadmin.recovery}. + +@item G R +@kindex G R (Group) +@findex gnus-group-make-rss-group +Make a group based on an @acronym{RSS} feed +(@code{gnus-group-make-rss-group}). You will be prompted for an URL. +@xref{RSS}. + +@item G DEL +@kindex G DEL (Group) @findex gnus-group-delete-group This function will delete the current group (@code{gnus-group-delete-group}). If given a prefix, this function will actually delete all the articles in the group, and forcibly remove the group itself from the face of the Earth. Use a prefix only if you are absolutely sure of what you are doing. This command can't be used on -read-only groups (like @code{nntp} group), though. +read-only groups (like @code{nntp} groups), though. @item G V -@kindex G V @r{(Group)} +@kindex G V (Group) @findex gnus-group-make-empty-virtual Make a new, fresh, empty @code{nnvirtual} group (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}. @item G v -@kindex G v @r{(Group)} +@kindex G v (Group) @findex gnus-group-add-to-virtual Add the current group to an @code{nnvirtual} group (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention. @@ -2514,7 +2699,7 @@ If @code{gnus-activate-foreign-newsgroups} is a positive number, Gnus will check all foreign groups with this level or lower at startup. This might take quite a while, especially if you subscribe to lots of -groups from different @sc{nntp} servers. Also @pxref{Group Levels}; +groups from different @acronym{NNTP} servers. Also @pxref{Group Levels}; @code{gnus-activate-level} also affects activation of foreign newsgroups. @@ -2531,11 +2716,14 @@ (auto-expire . t)) @end example -We see that each element consists of a "dotted pair"---the thing before +We see that each element consists of a ``dotted pair''---the thing before the dot is the key, while the thing after the dot is the value. All the parameters have this form @emph{except} local variable specs, which are not dotted pairs, but proper lists. +Some parameters have correspondent customizable variables, each of which +is an alist of regexps and values. + The following group parameters can be used: @table @code @@ -2544,7 +2732,7 @@ Address used by when doing followups and new posts. @example -(to-address . "some@@where.com") +(to-address . "some@@where.com") @end example This is primarily useful in mail groups that represent closed mailing @@ -2560,8 +2748,7 @@ group is therefore impossible---you have to send mail to the mailing list address instead. -Some parameters have corresponding customizable variables, each of which -is an alist of regexps and values. +See also @code{gnus-parameter-to-address-alist}. @item to-list @cindex to-list @@ -2581,12 +2768,33 @@ sending the message if @code{gnus-add-to-list} is set to @code{t}. @vindex gnus-add-to-list -If you do an @kbd{a} command in a mail group and you don't have a -@code{to-list} group parameter, one will be added automatically upon -sending the message. +@findex gnus-mailing-list-mode +@cindex mail list groups +If this variable is set, @code{gnus-mailing-list-mode} is turned on when +entering summary buffer. See also @code{gnus-parameter-to-list-alist}. +@anchor{subscribed} +@item subscribed +@cindex subscribed +@cindex Mail-Followup-To +@findex gnus-find-subscribed-addresses +If this parameter is set to @code{t}, Gnus will consider the +to-address and to-list parameters for this group as addresses of +mailing lists you are subscribed to. Giving Gnus this information is +(only) a first step in getting it to generate correct Mail-Followup-To +headers for your posts to these lists. The second step is to put the +following in your @file{.gnus.el} + +@lisp +(setq message-subscribed-address-functions + '(gnus-find-subscribed-addresses)) +@end lisp + +@xref{Mailing Lists, ,Mailing Lists, message, The Message Manual}, for +a complete treatment of available MFT support. + @item visible @cindex visible If the group parameter list has the element @code{(visible . t)}, @@ -2596,10 +2804,11 @@ @item broken-reply-to @cindex broken-reply-to Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To} -headers in this group are to be ignored. This can be useful if you're -reading a mailing list group where the listserv has inserted -@code{Reply-To} headers that point back to the listserv itself. This is -broken behavior. So there! +headers in this group are to be ignored, and for the header to be hidden +if @code{reply-to} is part of @code{gnus-boring-article-headers}. This +can be useful if you're reading a mailing list group where the listserv +has inserted @code{Reply-To} headers that point back to the listserv +itself. That is broken behavior. So there! @item to-group @cindex to-group @@ -2623,12 +2832,18 @@ precedence over any default @code{Gcc} rules as described later (@pxref{Archived Messages}). +@strong{Caveat}: Adding @code{(gcc-self . t)} to the parameter list of +@code{nntp} groups (or the like) isn't valid. An @code{nntp} server +doesn't accept articles. + @item auto-expire @cindex auto-expire If the group parameter has an element that looks like @code{(auto-expire . t)}, all articles read will be marked as expirable. For an alternative approach, @pxref{Expiring Mail}. +See also @code{gnus-auto-expirable-newsgroups}. + @item total-expire @cindex total-expire If the group parameter has an element that looks like @@ -2642,11 +2857,17 @@ @item expiry-wait @cindex expiry-wait @vindex nnmail-expiry-wait-function -If the group parameter has an element that looks like @code{(expiry-wait -. 10)}, this value will override any @code{nnmail-expiry-wait} and -@code{nnmail-expiry-wait-function} when expiring expirable messages. -The value can either be a number of days (not necessarily an integer) or -the symbols @code{never} or @code{immediate}. +If the group parameter has an element that looks like +@code{(expiry-wait . 10)}, this value will override any +@code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function} +(@pxref{Expiring Mail}) when expiring expirable messages. The value +can either be a number of days (not necessarily an integer) or the +symbols @code{never} or @code{immediate}. + +@item expiry-target +@cindex expiry-target +Where expired messages end up. This parameter overrides +@code{nnmail-expiry-target}. @item score-file @cindex score file group parameter @@ -2661,12 +2882,14 @@ All adaptive score entries will be put into this file. @item admin-address +@cindex admin-address When unsubscribing from a mailing list you should never send the unsubscription notice to the mailing list itself. Instead, you'd send messages to the administrative address. This parameter allows you to put the admin address somewhere convenient. @item display +@cindex display Elements that look like @code{(display . MODE)} say which articles to display on entering the group. Valid values are: @@ -2674,18 +2897,51 @@ @item all Display all articles, both read and unread. +@item an integer +Display the last @var{integer} articles in the group. This is the same as +entering the group with @kbd{C-u @var{integer}}. + @item default Display the default visible articles, which normally includes unread and ticked articles. -@end table + +@item an array +Display articles that satisfy a predicate. + +Here are some examples: + +@table @code +@item [unread] +Display only unread articles. + +@item [not expire] +Display everything except expirable articles. + +@item [and (not reply) (not expire)] +Display everything except expirable and articles you've already +responded to. +@end table + +The available operators are @code{not}, @code{and} and @code{or}. +Predicates include @code{tick}, @code{unsend}, @code{undownload}, +@code{unread}, @code{dormant}, @code{expire}, @code{reply}, +@code{killed}, @code{bookmark}, @code{score}, @code{save}, +@code{cache}, @code{forward}, @code{unseen} and @code{recent}. + +@end table + +The @code{display} parameter works by limiting the summary buffer to +the subset specified. You can pop the limit by using the @kbd{/ w} +command (@pxref{Limiting}). @item comment -Elements that look like @code{(comment . "This is a comment")} -are arbitrary comments on the group. They are currently ignored by -Gnus, but provide a place for you to store information on particular -groups. +@cindex comment +Elements that look like @code{(comment . "This is a comment")} are +arbitrary comments on the group. You can display comments in the +group line (@pxref{Group Line Specification}). @item charset +@cindex charset Elements that look like @code{(charset . iso-8859-1)} will make @code{iso-8859-1} the default charset; that is, the charset that will be used for all articles that do not specify a charset. @@ -2693,14 +2949,16 @@ See also @code{gnus-group-charset-alist}. @item ignored-charsets -Elements that look like @code{(ignored-charsets x-known iso-8859-1)} +@cindex ignored-charset +Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)} will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the default charset will be used for decoding articles. See also @code{gnus-group-ignored-charsets-alist}. @item posting-style -You can store additional posting style information for this group only +@cindex posting-style +You can store additional posting style information for this group here (@pxref{Posting Styles}). The format is that of an entry in the @code{gnus-posting-styles} alist, except that there's no regexp matching the group name (of course). Style elements in this group parameter will @@ -2713,16 +2971,51 @@ @example (posting-style (name "Funky Name") + ("X-My-Header" "Funky Value") (signature "Funky Signature")) @end example +@item post-method +@cindex post-method +If it is set, the value is used as the method for posting message +instead of @code{gnus-post-method}. + @item banner -An item like @code{(banner . "regex")} causes any part of an article -that matches the regular expression "regex" to be stripped. Instead of -"regex", you can also use the symbol @code{signature} which strips the +@cindex banner +An item like @code{(banner . @var{regexp})} causes any part of an article +that matches the regular expression @var{regexp} to be stripped. Instead of +@var{regexp}, you can also use the symbol @code{signature} which strips the last signature or any of the elements of the alist @code{gnus-article-banner-alist}. +@item sieve +@cindex sieve +This parameter contains a Sieve test that should match incoming mail +that should be placed in this group. From this group parameter, a +Sieve @samp{IF} control structure is generated, having the test as the +condition and @samp{fileinto "group.name";} as the body. + +For example, if the @samp{INBOX.list.sieve} group has the @code{(sieve +address "sender" "sieve-admin@@extundo.com")} group parameter, when +translating the group parameter into a Sieve script (@pxref{Sieve +Commands}) the following Sieve code is generated: + +@example +if address \"sender\" \"sieve-admin@@extundo.com\" @{ + fileinto \"INBOX.list.sieve\"; +@} +@end example + +The Sieve language is described in RFC 3028. @xref{Top, Emacs Sieve, +Top, sieve, Emacs Sieve}. + +@item (agent parameters) +If the agent has been enabled, you can set any of the its parameters +to control the behavior of the agent in individual groups. See Agent +Parameters in @ref{Category Syntax}. Most users will choose to set +agent parameters in either an agent category or group topic to +minimize the configuration effort. + @item (@var{variable} @var{form}) You can use the group parameters to set variables local to the group you are entering. If you want to turn threading off in @samp{news.answers}, @@ -2731,7 +3024,33 @@ in the summary buffer you enter, and the form @code{nil} will be @code{eval}ed there. -This can also be used as a group-specific hook function, if you like. +Note that this feature sets the variable locally to the summary buffer. +But some variables are evaluated in the article buffer, or in the +message buffer (of a reply or followup or otherwise newly created +message). As a workaround, it might help to add the variable in +question to @code{gnus-newsgroup-variables}. @xref{Various Summary +Stuff}. So if you want to set @code{message-from-style} via the group +parameters, then you may need the following statement elsewhere in your +@file{~/.gnus} file: + +@lisp +(add-to-list 'gnus-newsgroup-variables 'message-from-style) +@end lisp + +@vindex gnus-list-identifiers +A use for this feature is to remove a mailing list identifier tag in +the subject fields of articles. E.g. if the news group + +@example +nntp+news.gnus.org:gmane.text.docbook.apps +@end example + +has the tag @samp{DOC-BOOK-APPS:} in the subject of all articles, this +tag can be removed from the article subjects in the summary buffer for +the group by putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")} +into the group parameters for the group. + +This can also be used as a group-specific hook function, if you'd like. If you want to hear a beep when you enter a group, you could put something like @code{(dummy-variable (ding))} in the parameters of that group. @code{dummy-variable} will be set to the result of the @@ -2745,6 +3064,35 @@ silly Lisp errors.) You might also be interested in reading about topic parameters (@pxref{Topic Parameters}). +@vindex gnus-parameters +Group parameters can be set via the @code{gnus-parameters} variable too. +But some variables, such as @code{visible}, have no effect. For +example: + +@lisp +(setq gnus-parameters + '(("mail\\..*" + (gnus-show-threads nil) + (gnus-use-scoring nil) + (gnus-summary-line-format + "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n") + (gcc-self . t) + (display . all)) + + ("^nnimap:\\(foo.bar\\)$" + (to-group . "\\1")) + + ("mail\\.me" + (gnus-use-scoring t)) + + ("list\\..*" + (total-expire . t) + (broken-reply-to . t)))) +@end lisp + +String value of parameters will be subjected to regexp substitution, as +the @code{to-group} example shows. + @node Listing Groups @section Listing Groups @@ -2756,20 +3104,20 @@ @item l @itemx A s -@kindex A s @r{(Group)} -@kindex l @r{(Group)} +@kindex A s (Group) +@kindex l (Group) @findex gnus-group-list-groups List all groups that have unread articles (@code{gnus-group-list-groups}). If the numeric prefix is used, this command will list only groups of level ARG and lower. By default, it -only lists groups of level five (i. e., +only lists groups of level five (i.e., @code{gnus-group-default-list-level}) or lower (i.e., just subscribed groups). @item L @itemx A u -@kindex A u @r{(Group)} -@kindex L @r{(Group)} +@kindex A u (Group) +@kindex L (Group) @findex gnus-group-list-all-groups List all groups, whether they have unread articles or not (@code{gnus-group-list-all-groups}). If the numeric prefix is used, @@ -2778,14 +3126,14 @@ unsubscribed groups). @item A l -@kindex A l @r{(Group)} +@kindex A l (Group) @findex gnus-group-list-level List all unread groups on a specific level (@code{gnus-group-list-level}). If given a prefix, also list the groups with no unread articles. @item A k -@kindex A k @r{(Group)} +@kindex A k (Group) @findex gnus-group-list-killed List all killed groups (@code{gnus-group-list-killed}). If given a prefix argument, really list all groups that are available, but aren't @@ -2793,23 +3141,23 @@ from the server. @item A z -@kindex A z @r{(Group)} +@kindex A z (Group) @findex gnus-group-list-zombies List all zombie groups (@code{gnus-group-list-zombies}). @item A m -@kindex A m @r{(Group)} +@kindex A m (Group) @findex gnus-group-list-matching List all unread, subscribed groups with names that match a regexp (@code{gnus-group-list-matching}). @item A M -@kindex A M @r{(Group)} +@kindex A M (Group) @findex gnus-group-list-all-matching List groups that match a regexp (@code{gnus-group-list-all-matching}). @item A A -@kindex A A @r{(Group)} +@kindex A A (Group) @findex gnus-group-list-active List absolutely all groups in the active file(s) of the server(s) you are connected to (@code{gnus-group-list-active}). This @@ -2820,27 +3168,43 @@ Take the output with some grains of salt. @item A a -@kindex A a @r{(Group)} +@kindex A a (Group) @findex gnus-group-apropos List all groups that have names that match a regexp (@code{gnus-group-apropos}). @item A d -@kindex A d @r{(Group)} +@kindex A d (Group) @findex gnus-group-description-apropos List all groups that have names or descriptions that match a regexp (@code{gnus-group-description-apropos}). @item A c -@kindex A c @r{(Group)} +@kindex A c (Group) @findex gnus-group-list-cached List all groups with cached articles (@code{gnus-group-list-cached}). @item A ? -@kindex A ? @r{(Group)} +@kindex A ? (Group) @findex gnus-group-list-dormant List all groups with dormant articles (@code{gnus-group-list-dormant}). +@item A / +@kindex A / (Group) +@findex gnus-group-list-limit +List groups limited within the current selection +(@code{gnus-group-list-limit}). + +@item A f +@kindex A f (Group) +@findex gnus-group-list-flush +Flush groups from the current selection (@code{gnus-group-list-flush}). + +@item A p +@kindex A p (Group) +@findex gnus-group-list-plus +List groups plus the current selection (@code{gnus-group-list-plus}). + @end table @vindex gnus-permanently-visible-groups @@ -2861,7 +3225,7 @@ @section Sorting Groups @cindex sorting groups -@kindex C-c C-s @r{(Group)} +@kindex C-c C-s (Group) @findex gnus-group-sort-groups @vindex gnus-group-sort-function The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the @@ -2900,6 +3264,10 @@ @findex gnus-group-sort-by-method Sort alphabetically on the select method. +@item gnus-group-sort-by-server +@findex gnus-group-sort-by-server +Sort alphabetically on the Gnus server name. + @end table @@ -2913,41 +3281,47 @@ @table @kbd @item G S a -@kindex G S a @r{(Group)} +@kindex G S a (Group) @findex gnus-group-sort-groups-by-alphabet Sort the group buffer alphabetically by group name (@code{gnus-group-sort-groups-by-alphabet}). @item G S u -@kindex G S u @r{(Group)} +@kindex G S u (Group) @findex gnus-group-sort-groups-by-unread Sort the group buffer by the number of unread articles (@code{gnus-group-sort-groups-by-unread}). @item G S l -@kindex G S l @r{(Group)} +@kindex G S l (Group) @findex gnus-group-sort-groups-by-level Sort the group buffer by group level (@code{gnus-group-sort-groups-by-level}). @item G S v -@kindex G S v @r{(Group)} +@kindex G S v (Group) @findex gnus-group-sort-groups-by-score Sort the group buffer by group score (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}. @item G S r -@kindex G S r @r{(Group)} +@kindex G S r (Group) @findex gnus-group-sort-groups-by-rank Sort the group buffer by group rank (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}. @item G S m -@kindex G S m @r{(Group)} +@kindex G S m (Group) @findex gnus-group-sort-groups-by-method -Sort the group buffer alphabetically by back end name +Sort the group buffer alphabetically by back end name@* (@code{gnus-group-sort-groups-by-method}). +@item G S n +@kindex G S n (Group) +@findex gnus-group-sort-groups-by-real-name +Sort the group buffer alphabetically by real (unprefixed) group name +(@code{gnus-group-sort-groups-by-real-name}). + @end table All the commands below obey the process/prefix convention @@ -2960,43 +3334,56 @@ @table @kbd @item G P a -@kindex G P a @r{(Group)} +@kindex G P a (Group) @findex gnus-group-sort-selected-groups-by-alphabet Sort the groups alphabetically by group name (@code{gnus-group-sort-selected-groups-by-alphabet}). @item G P u -@kindex G P u @r{(Group)} +@kindex G P u (Group) @findex gnus-group-sort-selected-groups-by-unread Sort the groups by the number of unread articles (@code{gnus-group-sort-selected-groups-by-unread}). @item G P l -@kindex G P l @r{(Group)} +@kindex G P l (Group) @findex gnus-group-sort-selected-groups-by-level Sort the groups by group level (@code{gnus-group-sort-selected-groups-by-level}). @item G P v -@kindex G P v @r{(Group)} +@kindex G P v (Group) @findex gnus-group-sort-selected-groups-by-score Sort the groups by group score (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}. @item G P r -@kindex G P r @r{(Group)} +@kindex G P r (Group) @findex gnus-group-sort-selected-groups-by-rank Sort the groups by group rank (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}. @item G P m -@kindex G P m @r{(Group)} +@kindex G P m (Group) @findex gnus-group-sort-selected-groups-by-method -Sort the groups alphabetically by back end name +Sort the groups alphabetically by back end name@* (@code{gnus-group-sort-selected-groups-by-method}). -@end table - +@item G P n +@kindex G P n (Group) +@findex gnus-group-sort-selected-groups-by-real-name +Sort the groups alphabetically by real (unprefixed) group name +(@code{gnus-group-sort-selected-groups-by-real-name}). + +@item G P s +@kindex G P s (Group) +@findex gnus-group-sort-selected-groups +Sort the groups according to @code{gnus-group-sort-function}. + +@end table + +And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually +move groups around. @node Group Maintenance @@ -3005,13 +3392,13 @@ @table @kbd @item b -@kindex b @r{(Group)} +@kindex b (Group) @findex gnus-group-check-bogus-groups Find bogus groups and delete them (@code{gnus-group-check-bogus-groups}). @item F -@kindex F @r{(Group)} +@kindex F (Group) @findex gnus-group-find-new-groups Find new groups and process them (@code{gnus-group-find-new-groups}). With 1 @kbd{C-u}, use the @code{ask-server} method to query the server @@ -3020,15 +3407,17 @@ zombies. @item C-c C-x -@kindex C-c C-x @r{(Group)} +@kindex C-c C-x (Group) @findex gnus-group-expire-articles Run all expirable articles in the current group through the expiry -process (if any) (@code{gnus-group-expire-articles}). +process (if any) (@code{gnus-group-expire-articles}). That is, delete +all expirable articles in the group that have been around for a while. +(@pxref{Expiring Mail}). @item C-c C-M-x -@kindex C-c C-M-x @r{(Group)} +@kindex C-c C-M-x (Group) @findex gnus-group-expire-all-groups -Run all articles in all groups through the expiry process +Run all expirable articles in all groups through the expiry process (@code{gnus-group-expire-all-groups}). @end table @@ -3041,7 +3430,7 @@ @table @kbd @item B -@kindex B @r{(Group)} +@kindex B (Group) @findex gnus-group-browse-foreign-server You will be queried for a select method and a server name. Gnus will then attempt to contact this server and let you browse the groups there @@ -3066,14 +3455,14 @@ @findex gnus-group-prev-group Go to the previous group (@code{gnus-group-prev-group}). -@item @key{SPC} -@kindex @key{SPC} (Browse) +@item SPACE +@kindex SPACE (Browse) @findex gnus-browse-read-group Enter the current group and display the first article (@code{gnus-browse-read-group}). -@item @key{RET} -@kindex @key{RET} (Browse) +@item RET +@kindex RET (Browse) @findex gnus-browse-select-group Enter the current group (@code{gnus-browse-select-group}). @@ -3090,6 +3479,11 @@ @findex gnus-browse-exit Exit browse mode (@code{gnus-browse-exit}). +@item d +@kindex d (Browse) +@findex gnus-browse-describe-group +Describe the current group (@code{gnus-browse-describe-group}). + @item ? @kindex ? (Browse) @findex gnus-browse-describe-briefly @@ -3106,20 +3500,20 @@ @table @kbd @item z -@kindex z @r{(Group)} +@kindex z (Group) @findex gnus-group-suspend Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus, but it kills all buffers except the Group buffer. I'm not sure why this is a gain, but then who am I to judge? @item q -@kindex q @r{(Group)} +@kindex q (Group) @findex gnus-group-exit @c @icon{gnus-group-exit} Quit Gnus (@code{gnus-group-exit}). @item Q -@kindex Q @r{(Group)} +@kindex Q (Group) @findex gnus-group-quit Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}). The dribble file will be saved, though (@pxref{Auto Save}). @@ -3127,17 +3521,12 @@ @vindex gnus-exit-gnus-hook @vindex gnus-suspend-gnus-hook +@vindex gnus-after-exiting-gnus-hook @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and @code{gnus-exit-gnus-hook} is called when you quit Gnus, while @code{gnus-after-exiting-gnus-hook} is called as the final item when exiting Gnus. -@findex gnus-unload -@cindex unloading -If you wish to completely unload Gnus and all its adherents, you can use -the @code{gnus-unload} command. This command is also very handy when -trying to customize meta-variables. - Note: @quotation @@ -3162,7 +3551,7 @@ @iftex @iflatex \gnusfigure{Group Topics}{400}{ -\put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}} +\put(75,50){\epsfig{figure=ps/group-topic,height=9cm}} } @end iflatex @end iftex @@ -3183,73 +3572,32 @@ @end example @findex gnus-topic-mode -@kindex t @r{(Group)} +@kindex t (Group) To get this @emph{fab} functionality you simply turn on (ooh!) the @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This is a toggling command.) Go ahead, just try it. I'll still be here when you get back. La de -dum... Nice tune, that... la la la... What, you're back? Yes, and now -press @kbd{l}. There. All your groups are now listed under -@samp{misc}. Doesn't that make you feel all warm and fuzzy? Hot and -bothered? +dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back? +Yes, and now press @kbd{l}. There. All your groups are now listed +under @samp{misc}. Doesn't that make you feel all warm and fuzzy? +Hot and bothered? If you want this permanently enabled, you should add that minor mode to -the hook for the group mode: +the hook for the group mode. Put the following line in your +@file{~/.gnus.el} file: @lisp (add-hook 'gnus-group-mode-hook 'gnus-topic-mode) @end lisp @menu -* Topic Variables:: How to customize the topics the Lisp Way. -* Topic Commands:: Interactive E-Z commands. -* Topic Sorting:: Sorting each topic individually. -* Topic Topology:: A map of the world. -* Topic Parameters:: Parameters that apply to all groups in a topic. -@end menu - - -@node Topic Variables -@subsection Topic Variables -@cindex topic variables - -Now, if you select a topic, it will fold/unfold that topic, which is -really neat, I think. - -@vindex gnus-topic-line-format -The topic lines themselves are created according to the -@code{gnus-topic-line-format} variable (@pxref{Formatting Variables}). -Valid elements are: - -@table @samp -@item i -Indentation. -@item n -Topic name. -@item v -Visibility. -@item l -Level. -@item g -Number of groups in the topic. -@item a -Number of unread articles in the topic. -@item A -Number of unread articles in the topic and all its subtopics. -@end table - -@vindex gnus-topic-indent-level -Each sub-topic (and the groups in the sub-topics) will be indented with -@code{gnus-topic-indent-level} times the topic level number of spaces. -The default is 2. - -@vindex gnus-topic-mode-hook -@code{gnus-topic-mode-hook} is called in topic minor mode buffers. - -@vindex gnus-topic-display-empty-topics -The @code{gnus-topic-display-empty-topics} says whether to display even -topics that have no unread articles in them. The default is @code{t}. +* Topic Commands:: Interactive E-Z commands. +* Topic Variables:: How to customize the topics the Lisp Way. +* Topic Sorting:: Sorting each topic individually. +* Topic Topology:: A map of the world. +* Topic Parameters:: Parameters that apply to all groups in a topic. +@end menu @node Topic Commands @@ -3260,6 +3608,16 @@ available. In addition, a few of the standard keys change their definitions slightly. +In general, the following kinds of operations are possible on topics. +First of all, you want to create topics. Secondly, you want to put +groups in topics and to move them around until you have an order you +like. The third kind of operation is to show/hide parts of the whole +shebang. You might want to hide a topic including its subtopics and +groups, to get a better overview of the other groups. + +Here is a list of the basic keys that you might need to set up topics +the way you like. + @table @kbd @item T n @@ -3268,6 +3626,77 @@ Prompt for a new topic name and create it (@code{gnus-topic-create-topic}). +@item T TAB +@itemx TAB +@kindex T TAB (Topic) +@kindex TAB (Topic) +@findex gnus-topic-indent +``Indent'' the current topic so that it becomes a sub-topic of the +previous topic (@code{gnus-topic-indent}). If given a prefix, +``un-indent'' the topic instead. + +@item M-TAB +@kindex M-TAB (Topic) +@findex gnus-topic-unindent +``Un-indent'' the current topic so that it becomes a sub-topic of the +parent of its current parent (@code{gnus-topic-unindent}). + +@end table + +The following two keys can be used to move groups and topics around. +They work like the well-known cut and paste. @kbd{C-k} is like cut and +@kbd{C-y} is like paste. Of course, this being Emacs, we use the terms +kill and yank rather than cut and paste. + +@table @kbd + +@item C-k +@kindex C-k (Topic) +@findex gnus-topic-kill-group +Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the +topic will be removed along with the topic. + +@item C-y +@kindex C-y (Topic) +@findex gnus-topic-yank-group +Yank the previously killed group or topic +(@code{gnus-topic-yank-group}). Note that all topics will be yanked +before all groups. + +So, to move a topic to the beginning of the list of topics, just hit +@kbd{C-k} on it. This is like the ``cut'' part of cut and paste. Then, +move the cursor to the beginning of the buffer (just below the ``Gnus'' +topic) and hit @kbd{C-y}. This is like the ``paste'' part of cut and +paste. Like I said -- E-Z. + +You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So +you can move topics around as well as groups. + +@end table + +After setting up the topics the way you like them, you might wish to +hide a topic, or to show it again. That's why we have the following +key. + +@table @kbd + +@item RET +@kindex RET (Topic) +@findex gnus-topic-select-group +@itemx SPACE +Either select a group or fold a topic (@code{gnus-topic-select-group}). +When you perform this command on a group, you'll enter the group, as +usual. When done on a topic line, the topic will be folded (if it was +visible) or unfolded (if it was folded already). So it's basically a +toggling command on topics. In addition, if you give a numerical +prefix, group on that level (and lower) will be displayed. + +@end table + +Now for a list of other commands, in no particular order. + +@table @kbd + @item T m @kindex T m (Topic) @findex gnus-topic-move-group @@ -3335,66 +3764,30 @@ @kindex T # (Topic) @findex gnus-topic-mark-topic Mark all groups in the current topic with the process mark -(@code{gnus-topic-mark-topic}). +(@code{gnus-topic-mark-topic}). This command works recursively on +sub-topics unless given a prefix. @item T M-# @kindex T M-# (Topic) @findex gnus-topic-unmark-topic Remove the process mark from all groups in the current topic -(@code{gnus-topic-unmark-topic}). - -@item T TAB -@itemx TAB -@kindex T TAB (Topic) -@kindex TAB (Topic) -@findex gnus-topic-indent -``Indent'' the current topic so that it becomes a sub-topic of the -previous topic (@code{gnus-topic-indent}). If given a prefix, -``un-indent'' the topic instead. - -@item M-TAB -@kindex M-TAB (Topic) -@findex gnus-topic-unindent -``Un-indent'' the current topic so that it becomes a sub-topic of the -parent of its current parent (@code{gnus-topic-unindent}). - -@item @key{RET} -@kindex @key{RET} (Topic) -@findex gnus-topic-select-group -@itemx @key{SPC} -Either select a group or fold a topic (@code{gnus-topic-select-group}). -When you perform this command on a group, you'll enter the group, as -usual. When done on a topic line, the topic will be folded (if it was -visible) or unfolded (if it was folded already). So it's basically a -toggling command on topics. In addition, if you give a numerical -prefix, group on that level (and lower) will be displayed. +(@code{gnus-topic-unmark-topic}). This command works recursively on +sub-topics unless given a prefix. @item C-c C-x @kindex C-c C-x (Topic) @findex gnus-topic-expire-articles -Run all expirable articles in the current group or topic through the expiry -process (if any) (@code{gnus-topic-expire-articles}). - -@item C-k -@kindex C-k (Topic) -@findex gnus-topic-kill-group -Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the -topic will be removed along with the topic. - -@item C-y -@kindex C-y (Topic) -@findex gnus-topic-yank-group -Yank the previously killed group or topic -(@code{gnus-topic-yank-group}). Note that all topics will be yanked -before all groups. +Run all expirable articles in the current group or topic through the +expiry process (if any) +(@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}). @item T r @kindex T r (Topic) @findex gnus-topic-rename Rename a topic (@code{gnus-topic-rename}). -@item T @key{DEL} -@kindex T @key{DEL} (Topic) +@item T DEL +@kindex T DEL (Topic) @findex gnus-topic-delete Delete an empty topic (@code{gnus-topic-delete}). @@ -3404,6 +3797,16 @@ List all groups that Gnus knows about in a topics-ified way (@code{gnus-topic-list-active}). +@item T M-n +@kindex T M-n (Topic) +@findex gnus-topic-goto-next-topic +Go to the next topic (@code{gnus-topic-goto-next-topic}). + +@item T M-p +@kindex T M-p (Topic) +@findex gnus-topic-goto-previous-topic +Go to the next topic (@code{gnus-topic-goto-previous-topic}). + @item G p @kindex G p (Topic) @findex gnus-topic-edit-parameters @@ -3416,6 +3819,48 @@ @end table +@node Topic Variables +@subsection Topic Variables +@cindex topic variables + +The previous section told you how to tell Gnus which topics to display. +This section explains how to tell Gnus what to display about each topic. + +@vindex gnus-topic-line-format +The topic lines themselves are created according to the +@code{gnus-topic-line-format} variable (@pxref{Formatting Variables}). +Valid elements are: + +@table @samp +@item i +Indentation. +@item n +Topic name. +@item v +Visibility. +@item l +Level. +@item g +Number of groups in the topic. +@item a +Number of unread articles in the topic. +@item A +Number of unread articles in the topic and all its subtopics. +@end table + +@vindex gnus-topic-indent-level +Each sub-topic (and the groups in the sub-topics) will be indented with +@code{gnus-topic-indent-level} times the topic level number of spaces. +The default is 2. + +@vindex gnus-topic-mode-hook +@code{gnus-topic-mode-hook} is called in topic minor mode buffers. + +@vindex gnus-topic-display-empty-topics +The @code{gnus-topic-display-empty-topics} says whether to display even +topics that have no unread articles in them. The default is @code{t}. + + @node Topic Sorting @subsection Topic Sorting @cindex topic sorting @@ -3461,9 +3906,24 @@ Sort the current topic alphabetically by back end name (@code{gnus-topic-sort-groups-by-method}). -@end table - -@xref{Sorting Groups}, for more information about group sorting. +@item T S e +@kindex T S e (Topic) +@findex gnus-topic-sort-groups-by-server +Sort the current topic alphabetically by server name +(@code{gnus-topic-sort-groups-by-server}). + +@item T S s +@kindex T S s (Topic) +@findex gnus-topic-sort-groups +Sort the current topic according to the function(s) given by the +@code{gnus-group-sort-function} variable +(@code{gnus-topic-sort-groups}). + +@end table + +When given a prefix argument, all these commands will sort in reverse +order. @xref{Sorting Groups}, for more information about group +sorting. @node Topic Topology @@ -3474,6 +3934,7 @@ So, let's have a look at an example group buffer: @example +@group Gnus Emacs -- I wuw it! 3: comp.emacs @@ -3484,6 +3945,7 @@ Misc 8: comp.binaries.fractals 13: comp.sources.unix +@end group @end example So, here we have one top-level topic (@samp{Gnus}), two topics under @@ -3514,9 +3976,11 @@ @subsection Topic Parameters @cindex topic parameters -All groups in a topic will inherit group parameters from the parent (and -ancestor) topic parameters. All valid group parameters are valid topic -parameters (@pxref{Group Parameters}). +All groups in a topic will inherit group parameters from the parent +(and ancestor) topic parameters. All valid group parameters are valid +topic parameters (@pxref{Group Parameters}). When the agent is +enabled, all agent parameters (See Agent Parameters in @ref{Category +Syntax}) are also valid topic parameters. In addition, the following parameters are only valid as topic parameters: @@ -3528,6 +3992,11 @@ value should be a regexp to match the groups that should go in that topic. +@item subscribe-level +When subscribing new groups by topic (see the @code{subscribe} parameter), +the group will be subscribed with the level specified in the +@code{subscribe-level} instead of @code{gnus-level-default-subscribed}. + @end table Group parameters (of course) override topic parameters, and topic @@ -3536,6 +4005,7 @@ verb, although you may feel free to disagree with me here.) @example +@group Gnus Emacs 3: comp.emacs @@ -3548,6 +4018,7 @@ 8: comp.binaries.fractals 13: comp.sources.unix 452: alt.sex.emacs +@end group @end example The @samp{Emacs} topic has the topic parameter @code{(score-file @@ -3577,30 +4048,51 @@ @section Misc Group Stuff @menu -* Scanning New Messages:: Asking Gnus to see whether new messages have arrived. -* Group Information:: Information and help on groups and Gnus. -* Group Timestamp:: Making Gnus keep track of when you last read a group. -* File Commands:: Reading and writing the Gnus files. +* Scanning New Messages:: Asking Gnus to see whether new messages have arrived. +* Group Information:: Information and help on groups and Gnus. +* Group Timestamp:: Making Gnus keep track of when you last read a group. +* File Commands:: Reading and writing the Gnus files. +* Sieve Commands:: Managing Sieve scripts. @end menu @table @kbd @item ^ -@kindex ^ @r{(Group)} +@kindex ^ (Group) @findex gnus-group-enter-server-mode Enter the server buffer (@code{gnus-group-enter-server-mode}). -@xref{The Server Buffer}. +@xref{Server Buffer}. @item a -@kindex a @r{(Group)} +@kindex a (Group) @findex gnus-group-post-news -Post an article to a group (@code{gnus-group-post-news}). If given a -prefix, the current group name will be used as the default. +Start composing a message (a news by default) +(@code{gnus-group-post-news}). If given a prefix, post to the group +under the point. If the prefix is 1, prompt for a group to post to. +Contrary to what the name of this function suggests, the prepared +article might be a mail instead of a news, if a mail group is specified +with the prefix argument. @xref{Composing Messages}. @item m -@kindex m @r{(Group)} +@kindex m (Group) @findex gnus-group-mail -Mail a message somewhere (@code{gnus-group-mail}). +Mail a message somewhere (@code{gnus-group-mail}). If given a prefix, +use the posting style of the group under the point. If the prefix is 1, +prompt for a group name to find the posting style. +@xref{Composing Messages}. + +@item i +@kindex i (Group) +@findex gnus-group-news +Start composing a news (@code{gnus-group-news}). If given a prefix, +post to the group under the point. If the prefix is 1, prompt +for group to post to. @xref{Composing Messages}. + +This function actually prepares a news even when using mail groups. +This is useful for ``posting'' messages to mail groups without actually +sending them over the network: they're just saved directly to the group +in question. The corresponding back end must have a request-post method +for this to work though. @end table @@ -3631,8 +4123,8 @@ @item gnus-group-name-charset-method-alist @vindex gnus-group-name-charset-method-alist -An alist of method and the charset for group names. It is used to show -non-ASCII group names. +An alist of method and the charset for group names. It is used to show +non-@acronym{ASCII} group names. For example: @lisp @@ -3641,9 +4133,12 @@ @end lisp @item gnus-group-name-charset-group-alist +@cindex UTF-8 group names @vindex gnus-group-name-charset-group-alist -An alist of regexp of group name and the charset for group names. -It is used to show non-ASCII group names. +An alist of regexp of group name and the charset for group names. It +is used to show non-@acronym{ASCII} group names. @code{((".*" +utf-8))} is the default value if UTF-8 is supported, otherwise the +default is @code{nil}. For example: @lisp @@ -3661,7 +4156,7 @@ @table @kbd @item g -@kindex g @r{(Group)} +@kindex g (Group) @findex gnus-group-get-new-news @c @icon{gnus-group-get-new-news} Check the server(s) for new articles. If the numerical prefix is used, @@ -3671,7 +4166,7 @@ back end(s). @item M-g -@kindex M-g @r{(Group)} +@kindex M-g (Group) @findex gnus-group-get-new-news-this-group @vindex gnus-goto-next-group-when-activating @c @icon{gnus-group-get-new-news-this-group} @@ -3683,11 +4178,11 @@ @findex gnus-activate-all-groups @cindex activating groups @item C-c M-g -@kindex C-c M-g @r{(Group)} +@kindex C-c M-g (Group) Activate absolutely all groups (@code{gnus-activate-all-groups}). @item R -@kindex R @r{(Group)} +@kindex R (Group) @cindex restarting @findex gnus-group-restart Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc} @@ -3713,27 +4208,58 @@ @item H f -@kindex H f @r{(Group)} +@kindex H f (Group) @findex gnus-group-fetch-faq @vindex gnus-group-faq-directory @cindex FAQ @cindex ange-ftp -Try to fetch the FAQ for the current group -(@code{gnus-group-fetch-faq}). Gnus will try to get the FAQ from -@code{gnus-group-faq-directory}, which is usually a directory on a -remote machine. This variable can also be a list of directories. In -that case, giving a prefix to this command will allow you to choose -between the various sites. @code{ange-ftp} (or @code{efs}) will be used -for fetching the file. +Try to fetch the @acronym{FAQ} for the current group +(@code{gnus-group-fetch-faq}). Gnus will try to get the @acronym{FAQ} +from @code{gnus-group-faq-directory}, which is usually a directory on +a remote machine. This variable can also be a list of directories. +In that case, giving a prefix to this command will allow you to choose +between the various sites. @code{ange-ftp} (or @code{efs}) will be +used for fetching the file. If fetching from the first site is unsuccessful, Gnus will attempt to go through @code{gnus-group-faq-directory} and try to open them one by one. +@item H c +@kindex H c (Group) +@findex gnus-group-fetch-charter +@vindex gnus-group-charter-alist +@cindex charter +Try to open the charter for the current group in a web browser +(@code{gnus-group-fetch-charter}). Query for a group if given a +prefix argument. + +Gnus will use @code{gnus-group-charter-alist} to find the location of +the charter. If no location is known, Gnus will fetch the control +messages for the group, which in some cases includes the charter. + +@item H C +@kindex H C (Group) +@findex gnus-group-fetch-control +@vindex gnus-group-fetch-control-use-browse-url +@cindex control message +Fetch the control messages for the group from the archive at +@code{ftp.isc.org} (@code{gnus-group-fetch-control}). Query for a +group if given a prefix argument. + +If @code{gnus-group-fetch-control-use-browse-url} is non-@code{nil}, +Gnus will open the control messages in a browser using +@code{browse-url}. Otherwise they are fetched using @code{ange-ftp} +and displayed in an ephemeral group. + +Note that the control messages are compressed. To use this command +you need to turn on @code{auto-compression-mode} (@pxref{Compressed +Files, ,Compressed Files, emacs, The Emacs Manual}). + @item H d @itemx C-c C-d @c @icon{gnus-group-describe-group} -@kindex H d @r{(Group)} -@kindex C-c C-d @r{(Group)} +@kindex H d (Group) +@kindex C-c C-d (Group) @cindex describing groups @cindex group description @findex gnus-group-describe-group @@ -3741,26 +4267,26 @@ a prefix, force Gnus to re-read the description from the server. @item M-d -@kindex M-d @r{(Group)} +@kindex M-d (Group) @findex gnus-group-describe-all-groups Describe all groups (@code{gnus-group-describe-all-groups}). If given a prefix, force Gnus to re-read the description file from the server. @item H v @itemx V -@kindex V @r{(Group)} -@kindex H v @r{(Group)} +@kindex V (Group) +@kindex H v (Group) @cindex version @findex gnus-version Display current Gnus version numbers (@code{gnus-version}). @item ? -@kindex ? @r{(Group)} +@kindex ? (Group) @findex gnus-group-describe-briefly Give a very short help message (@code{gnus-group-describe-briefly}). @item C-c C-i -@kindex C-c C-i @r{(Group)} +@kindex C-c C-i (Group) @cindex info @cindex manual @findex gnus-info-find-node @@ -3807,6 +4333,20 @@ "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n") @end lisp +If you would like greater control of the time format, you can use a +user-defined format spec. Something like the following should do the +trick: + +@lisp +(setq gnus-group-line-format + "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n") +(defun gnus-user-format-function-d (headers) + (let ((time (gnus-group-timestamp gnus-tmp-group))) + (if time + (format-time-string "%b %d %H:%M" time) + ""))) +@end lisp + @node File Commands @subsection File Commands @@ -3815,15 +4355,15 @@ @table @kbd @item r -@kindex r @r{(Group)} +@kindex r (Group) @findex gnus-group-read-init-file @vindex gnus-init-file @cindex reading init file Re-read the init file (@code{gnus-init-file}, which defaults to -@file{~/.gnus}) (@code{gnus-group-read-init-file}). +@file{~/.gnus.el}) (@code{gnus-group-read-init-file}). @item s -@kindex s @r{(Group)} +@kindex s (Group) @findex gnus-group-save-newsrc @cindex saving .newsrc Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted) @@ -3831,15 +4371,77 @@ file(s) whether Gnus thinks it is necessary or not. @c @item Z -@c @kindex Z @r{(Group)} +@c @kindex Z (Group) @c @findex gnus-group-clear-dribble @c Clear the dribble buffer (@code{gnus-group-clear-dribble}). @end table -@node The Summary Buffer -@chapter The Summary Buffer +@node Sieve Commands +@subsection Sieve Commands +@cindex group sieve commands + +Sieve is a server-side mail filtering language. In Gnus you can use +the @code{sieve} group parameter (@pxref{Group Parameters}) to specify +sieve rules that should apply to each group. Gnus provides two +commands to translate all these group parameters into a proper Sieve +script that can be transfered to the server somehow. + +@vindex gnus-sieve-file +@vindex gnus-sieve-region-start +@vindex gnus-sieve-region-end +The generated Sieve script is placed in @code{gnus-sieve-file} (by +default @file{~/.sieve}). The Sieve code that Gnus generate is placed +between two delimiters, @code{gnus-sieve-region-start} and +@code{gnus-sieve-region-end}, so you may write additional Sieve code +outside these delimiters that will not be removed the next time you +regenerate the Sieve script. + +@vindex gnus-sieve-crosspost +The variable @code{gnus-sieve-crosspost} controls how the Sieve script +is generated. If it is non-@code{nil} (the default) articles is +placed in all groups that have matching rules, otherwise the article +is only placed in the group with the first matching rule. For +example, the group parameter @samp{(sieve address "sender" +"owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve +code if @code{gnus-sieve-crosspost} is @code{nil}. (When +@code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same +except that the line containing the call to @code{stop} is removed.) + +@example +if address "sender" "owner-ding@@hpc.uh.edu" @{ + fileinto "INBOX.ding"; + stop; +@} +@end example + +@xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}. + +@table @kbd + +@item D g +@kindex D g (Group) +@findex gnus-sieve-generate +@vindex gnus-sieve-file +@cindex generating sieve script +Regenerate a Sieve script from the @code{sieve} group parameters and +put you into the @code{gnus-sieve-file} without saving it. + +@item D u +@kindex D u (Group) +@findex gnus-sieve-update +@vindex gnus-sieve-file +@cindex updating sieve script +Regenerates the Gnus managed part of @code{gnus-sieve-file} using the +@code{sieve} group parameters, save the file and upload it to the +server using the @code{sieveshell} program. + +@end table + + +@node Summary Buffer +@chapter Summary Buffer @cindex summary buffer A line for each article is displayed in the summary buffer. You can @@ -3856,10 +4458,11 @@ * Choosing Articles:: Reading articles. * Paging the Article:: Scrolling the current article. * Reply Followup and Post:: Posting articles. +* Delayed Articles:: Send articles at a later time. * Marking Articles:: Marking articles as read, expirable, etc. * Limiting:: You can limit the summary buffer. * Threading:: How threads are made. -* Sorting:: How articles and threads are sorted. +* Sorting the Summary Buffer:: How articles and threads are sorted. * Asynchronous Fetching:: Gnus might be able to pre-fetch articles. * Article Caching:: You may store articles in a cache. * Persistent Articles:: Making articles expiry-resistant. @@ -3880,6 +4483,8 @@ or reselecting the current group. * Crosspost Handling:: How crossposted articles are dealt with. * Duplicate Suppression:: An alternative when crosspost handling fails. +* Security:: Decrypt and Verify. +* Mailing List:: Mailing list minor mode. @end menu @@ -3890,17 +4495,17 @@ @iftex @iflatex \gnusfigure{The Summary Buffer}{180}{ -\put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}} -\put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}} +\put(0,0){\epsfig{figure=ps/summary,width=7.5cm}} +\put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}} } @end iflatex @end iftex @menu -* Summary Buffer Lines:: You can specify how summary lines should look. -* To From Newsgroups:: How to not display your own name. -* Summary Buffer Mode Line:: You can say how the mode line should look. -* Summary Highlighting:: Making the summary buffer all pretty and nice. +* Summary Buffer Lines:: You can specify how summary lines should look. +* To From Newsgroups:: How to not display your own name. +* Summary Buffer Mode Line:: You can say how the mode line should look. +* Summary Highlighting:: Making the summary buffer all pretty and nice. @end menu @findex mail-extract-address-components @@ -3935,9 +4540,17 @@ lines as a normal @code{format} string, with some extensions (@pxref{Formatting Variables}). -The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}. - -The following format specification characters are understood: +There should always be a colon or a point position marker on the line; +the cursor always moves to the point position marker or the colon after +performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't +possible to change this. Just write a new function +@code{gnus-goto-colon} which does whatever you like with the cursor.) +@xref{Positioning Point}. + +The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}. + +The following format specification characters and extended format +specification(s) are understood: @table @samp @item N @@ -3954,8 +4567,8 @@ @item n The name (from the @code{From} header). @item f -The name, code @code{To} header or the @code{Newsgroups} header -(@pxref{To From Newsgroups}). +The name, @code{To} header or the @code{Newsgroups} header (@pxref{To +From Newsgroups}). @item a The name (from the @code{From} header). This differs from the @code{n} spec in that it uses the function designated by the @@ -3967,10 +4580,66 @@ @item L Number of lines in the article. @item c -Number of characters in the article. This specifier is not supported in some -methods (like nnfolder). +Number of characters in the article. This specifier is not supported +in some methods (like nnfolder). +@item k +Pretty-printed version of the number of characters in the article; +for example, @samp{1.2k} or @samp{0.4M}. @item I Indentation based on thread level (@pxref{Customizing Threading}). +@item B +A complex trn-style thread tree, showing response-connecting trace +lines. A thread could be drawn like this: + +@example +> ++-> +| +-> +| | \-> +| | \-> +| \-> ++-> +\-> +@end example + +You can customize the appearance with the following options. Note +that it is possible to make the thread display look really neat by +replacing the default @acronym{ASCII} characters with graphic +line-drawing glyphs. +@table @code +@item gnus-sum-thread-tree-root +@vindex gnus-sum-thread-tree-root +Used for the root of a thread. If @code{nil}, use subject +instead. The default is @samp{> }. + +@item gnus-sum-thread-tree-false-root +@vindex gnus-sum-thread-tree-false-root +Used for the false root of a thread (@pxref{Loose Threads}). If +@code{nil}, use subject instead. The default is @samp{> }. + +@item gnus-sum-thread-tree-single-indent +@vindex gnus-sum-thread-tree-single-indent +Used for a thread with just one message. If @code{nil}, use subject +instead. The default is @samp{}. + +@item gnus-sum-thread-tree-vertical +@vindex gnus-sum-thread-tree-vertical +Used for drawing a vertical line. The default is @samp{| }. + +@item gnus-sum-thread-tree-indent +@vindex gnus-sum-thread-tree-indent +Used for indenting. The default is @samp{ }. + +@item gnus-sum-thread-tree-leaf-with-other +@vindex gnus-sum-thread-tree-leaf-with-other +Used for a leaf with brothers. The default is @samp{+-> }. + +@item gnus-sum-thread-tree-single-leaf +@vindex gnus-sum-thread-tree-single-leaf +Used for a leaf without brothers. The default is @samp{\-> } + +@end table + @item T Nothing if the article is a root and lots of spaces if it isn't (it pushes everything after it off the screen). @@ -3985,12 +4654,12 @@ @item < Twenty minus thread level spaces. @item U -Unread. +Unread. @xref{Read Articles}. @item R This misleadingly named specifier is the @dfn{secondary mark}. This mark will say whether the article has been replied to, has been cached, -or has been saved. +or has been saved. @xref{Other Marks}. @item i Score as a number (@pxref{Scoring}). @@ -4024,15 +4693,22 @@ The line number. @item O Download mark. +@item &user-date; +Age sensitive date format. Various date format is defined in +@code{gnus-user-date-format-alist}. @item u User defined specifier. The next character in the format string should be a letter. Gnus will call the function -@code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter +@code{gnus-user-format-function-@var{x}}, where @var{x} is the letter following @samp{%u}. The function will be passed the current header as argument. The function should return a string, which will be inserted into the summary just like information from any other summary specifier. @end table +Text between @samp{%(} and @samp{%)} will be highlighted with +@code{gnus-mouse-face} when the mouse point is placed inside the area. +There can only be one such area. + The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs have to be handled with care. For reasons of efficiency, Gnus will compute what column these characters will end up in, and ``hard-code'' @@ -4094,30 +4770,40 @@ @vindex nnmail-extra-headers A related variable is @code{nnmail-extra-headers}, which controls when -to include extra headers when generating overview (@sc{nov}) files. If -you have old overview files, you should regenerate them after changing -this variable. +to include extra headers when generating overview (@acronym{NOV}) files. +If you have old overview files, you should regenerate them after +changing this variable, by entering the server buffer using @kbd{^}, +and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause +regeneration. @vindex gnus-summary-line-format You also have to instruct Gnus to display the data by changing the @code{%n} spec to the @code{%f} spec in the @code{gnus-summary-line-format} variable. -In summary, you'd typically do something like the following: +In summary, you'd typically put something like the following in +@file{~/.gnus.el}: @lisp (setq gnus-extra-headers '(To Newsgroups)) (setq nnmail-extra-headers gnus-extra-headers) (setq gnus-summary-line-format - "%U%R%z%I%(%[%4L: %-20,20f%]%) %s\n") + "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n") (setq gnus-ignored-from-addresses "Your Name Here") @end lisp -Now, this is mostly useful for mail groups, where you have control over -the @sc{nov} files that are created. However, if you can persuade your -nntp admin to add: +(The values listed above are the default values in Gnus. Alter them +to fit your needs.) + +A note for news server administrators, or for users who wish to try to +convince their news server administrator to provide some additional +support: + +The above is mostly useful for mail groups, where you have control over +the @acronym{NOV} files that are created. However, if you can persuade your +nntp admin to add (in the usual implementation, notably INN): @example Newsgroups:full @@ -4227,22 +4913,22 @@ @table @kbd @item G M-n @itemx M-n -@kindex M-n @r{(Summary)} -@kindex G M-n @r{(Summary)} +@kindex M-n (Summary) +@kindex G M-n (Summary) @findex gnus-summary-next-unread-subject Go to the next summary line of an unread article (@code{gnus-summary-next-unread-subject}). @item G M-p @itemx M-p -@kindex M-p @r{(Summary)} -@kindex G M-p @r{(Summary)} +@kindex M-p (Summary) +@kindex G M-p (Summary) @findex gnus-summary-prev-unread-subject Go to the previous summary line of an unread article (@code{gnus-summary-prev-unread-subject}). @item G g -@kindex G g @r{(Summary)} +@kindex G g (Summary) @findex gnus-summary-goto-subject Ask for an article number and then go to the summary line of that article without displaying the article (@code{gnus-summary-goto-subject}). @@ -4264,13 +4950,13 @@ the next group. If this variable is @code{t} and the next group is empty, Gnus will exit summary mode and return to the group buffer. If this variable is neither @code{t} nor @code{nil}, Gnus will select the -next group, no matter whether it has any unread articles or not. As a -special case, if this variable is @code{quietly}, Gnus will select the -next group without asking for confirmation. If this variable is -@code{almost-quietly}, the same will happen only if you are located on -the last article in the group. Finally, if this variable is -@code{slightly-quietly}, the @kbd{Z n} command will go to the next group -without confirmation. Also @pxref{Group Levels}. +next group with unread articles. As a special case, if this variable +is @code{quietly}, Gnus will select the next group without asking for +confirmation. If this variable is @code{almost-quietly}, the same +will happen only if you are located on the last article in the group. +Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n} +command will go to the next group without confirmation. Also +@pxref{Group Levels}. @item gnus-auto-select-same @vindex gnus-auto-select-same @@ -4309,8 +4995,8 @@ @cindex selecting articles @menu -* Choosing Commands:: Commands for choosing articles. -* Choosing Variables:: Variables that influence these commands. +* Choosing Commands:: Commands for choosing articles. +* Choosing Variables:: Variables that influence these commands. @end menu @@ -4324,78 +5010,83 @@ @ref{Exiting the Summary Buffer}. @table @kbd -@item @key{SPC} -@kindex @key{SPC} @r{(Summary)} +@item SPACE +@kindex SPACE (Summary) @findex gnus-summary-next-page Select the current article, or, if that one's read already, the next unread article (@code{gnus-summary-next-page}). +If you have an article window open already and you press @kbd{SPACE} +again, the article will be scrolled. This lets you conveniently +@kbd{SPACE} through an entire newsgroup. @xref{Paging the Article}. + @item G n @itemx n -@kindex n @r{(Summary)} -@kindex G n @r{(Summary)} +@kindex n (Summary) +@kindex G n (Summary) @findex gnus-summary-next-unread-article @c @icon{gnus-summary-next-unread} Go to next unread article (@code{gnus-summary-next-unread-article}). @item G p @itemx p -@kindex p @r{(Summary)} +@kindex p (Summary) @findex gnus-summary-prev-unread-article @c @icon{gnus-summary-prev-unread} Go to previous unread article (@code{gnus-summary-prev-unread-article}). @item G N @itemx N -@kindex N @r{(Summary)} -@kindex G N @r{(Summary)} +@kindex N (Summary) +@kindex G N (Summary) @findex gnus-summary-next-article Go to the next article (@code{gnus-summary-next-article}). @item G P @itemx P -@kindex P @r{(Summary)} -@kindex G P @r{(Summary)} +@kindex P (Summary) +@kindex G P (Summary) @findex gnus-summary-prev-article Go to the previous article (@code{gnus-summary-prev-article}). @item G C-n -@kindex G C-n @r{(Summary)} +@kindex G C-n (Summary) @findex gnus-summary-next-same-subject Go to the next article with the same subject (@code{gnus-summary-next-same-subject}). @item G C-p -@kindex G C-p @r{(Summary)} +@kindex G C-p (Summary) @findex gnus-summary-prev-same-subject Go to the previous article with the same subject (@code{gnus-summary-prev-same-subject}). @item G f @itemx . -@kindex G f @r{(Summary)} -@kindex . @r{(Summary)} +@kindex G f (Summary) +@kindex . (Summary) @findex gnus-summary-first-unread-article Go to the first unread article (@code{gnus-summary-first-unread-article}). @item G b @itemx , -@kindex G b @r{(Summary)} -@kindex , @r{(Summary)} +@kindex G b (Summary) +@kindex , (Summary) @findex gnus-summary-best-unread-article -Go to the article with the highest score -(@code{gnus-summary-best-unread-article}). +Go to the unread article with the highest score +(@code{gnus-summary-best-unread-article}). If given a prefix argument, +go to the first unread article that has a score over the default score. @item G l @itemx l -@kindex l @r{(Summary)} -@kindex G l @r{(Summary)} +@kindex l (Summary) +@kindex G l (Summary) @findex gnus-summary-goto-last-article Go to the previous article read (@code{gnus-summary-goto-last-article}). @item G o -@kindex G o @r{(Summary)} +@kindex G o (Summary) @findex gnus-summary-pop-article @cindex history @cindex article history @@ -4408,11 +5099,12 @@ @item G j @itemx j -@kindex j @r{(Summary)} -@kindex G j @r{(Summary)} +@kindex j (Summary) +@kindex G j (Summary) @findex gnus-summary-goto-article Ask for an article number or @code{Message-ID}, and then go to that article (@code{gnus-summary-goto-article}). + @end table @@ -4432,7 +5124,9 @@ @item gnus-select-article-hook @vindex gnus-select-article-hook This hook is called whenever an article is selected. By default it -exposes any threads hidden under the selected article. +exposes any threads hidden under the selected article. If you would +like each article to be saved in the Agent as you read it, putting +@code{gnus-agent-fetch-selected-article} on this hook will do so. @item gnus-mark-article-hook @vindex gnus-mark-article-hook @@ -4458,34 +5152,43 @@ @table @kbd -@item @key{SPC} -@kindex @key{SPC} @r{(Summary)} +@item SPACE +@kindex SPACE (Summary) @findex gnus-summary-next-page -Pressing @key{SPC} will scroll the current article forward one page, +Pressing @kbd{SPACE} will scroll the current article forward one page, or, if you have come to the end of the current article, will choose the next article (@code{gnus-summary-next-page}). -@item @key{DEL} -@kindex @key{DEL} @r{(Summary)} +@vindex gnus-article-boring-faces +@vindex gnus-article-skip-boring +If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of +the article consists only of citations and signature, then it will be +skipped; the next article will be shown instead. You can customize +what is considered uninteresting with +@code{gnus-article-boring-faces}. You can manually view the article's +pages, no matter how boring, using @kbd{C-M-v}. + +@item DEL +@kindex DEL (Summary) @findex gnus-summary-prev-page Scroll the current article back one page (@code{gnus-summary-prev-page}). -@item @key{RET} -@kindex @key{RET} @r{(Summary)} +@item RET +@kindex RET (Summary) @findex gnus-summary-scroll-up Scroll the current article one line forward (@code{gnus-summary-scroll-up}). -@item M-@key{RET} -@kindex M-@key{RET} @r{(Summary)} +@item M-RET +@kindex M-RET (Summary) @findex gnus-summary-scroll-down Scroll the current article one line backward (@code{gnus-summary-scroll-down}). @item A g @itemx g -@kindex A g @r{(Summary)} -@kindex g @r{(Summary)} +@kindex A g (Summary) +@kindex g (Summary) @findex gnus-summary-show-article @vindex gnus-summary-show-article-charset-alist (Re)fetch the current article (@code{gnus-summary-show-article}). If @@ -4494,7 +5197,7 @@ the way it came from the server. If given a numerical prefix, you can do semi-manual charset stuff. -@kbd{C-u 0 g cn-gb-2312 @key{RET}} will decode the message as if it were +@kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were encoded in the @code{cn-gb-2312} charset. If you have @lisp @@ -4507,29 +5210,29 @@ @item A < @itemx < -@kindex < @r{(Summary)} -@kindex A < @r{(Summary)} +@kindex < (Summary) +@kindex A < (Summary) @findex gnus-summary-beginning-of-article Scroll to the beginning of the article (@code{gnus-summary-beginning-of-article}). @item A > @itemx > -@kindex > @r{(Summary)} -@kindex A > @r{(Summary)} +@kindex > (Summary) +@kindex A > (Summary) @findex gnus-summary-end-of-article Scroll to the end of the article (@code{gnus-summary-end-of-article}). @item A s @itemx s -@kindex A s @r{(Summary)} -@kindex s @r{(Summary)} +@kindex A s (Summary) +@kindex s (Summary) @findex gnus-summary-isearch-article Perform an isearch in the article buffer (@code{gnus-summary-isearch-article}). @item h -@kindex h @r{(Summary)} +@kindex h (Summary) @findex gnus-summary-select-article-buffer Select the article buffer (@code{gnus-summary-select-article-buffer}). @@ -4543,7 +5246,7 @@ * Summary Mail Commands:: Sending mail. * Summary Post Commands:: Sending news. * Summary Message Commands:: Other Message-related commands. -* Canceling and Superseding:: ``Whoops, I shouldn't have called him that.'' +* Canceling and Superseding:: @end menu @@ -4558,8 +5261,8 @@ @item S r @itemx r -@kindex S r @r{(Summary)} -@kindex r @r{(Summary)} +@kindex S r (Summary) +@kindex r (Summary) @findex gnus-summary-reply @c @icon{gnus-summary-mail-reply} @c @icon{gnus-summary-reply} @@ -4568,8 +5271,8 @@ @item S R @itemx R -@kindex R @r{(Summary)} -@kindex S R @r{(Summary)} +@kindex R (Summary) +@kindex S R (Summary) @findex gnus-summary-reply-with-original @c @icon{gnus-summary-reply-with-original} Mail a reply to the author of the current article and include the @@ -4577,24 +5280,58 @@ command uses the process/prefix convention. @item S w -@kindex S w @r{(Summary)} +@kindex S w (Summary) @findex gnus-summary-wide-reply Mail a wide reply to the author of the current article (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that goes out to all people listed in the @code{To}, @code{From} (or -@code{Reply-to}) and @code{Cc} headers. +@code{Reply-to}) and @code{Cc} headers. If @code{Mail-Followup-To} is +present, that's used instead. @item S W -@kindex S W @r{(Summary)} +@kindex S W (Summary) @findex gnus-summary-wide-reply-with-original Mail a wide reply to the current article and include the original message (@code{gnus-summary-wide-reply-with-original}). This command uses the process/prefix convention. +@item S v +@kindex S v (Summary) +@findex gnus-summary-very-wide-reply +Mail a very wide reply to the author of the current article +(@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply +that goes out to all people listed in the @code{To}, @code{From} (or +@code{Reply-to}) and @code{Cc} headers in all the process/prefixed +articles. This command uses the process/prefix convention. + +@item S V +@kindex S V (Summary) +@findex gnus-summary-very-wide-reply-with-original +Mail a very wide reply to the author of the current article and include the +original message (@code{gnus-summary-very-wide-reply-with-original}). This +command uses the process/prefix convention. + +@item S B r +@kindex S B r (Summary) +@findex gnus-summary-reply-broken-reply-to +Mail a reply to the author of the current article but ignore the +@code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}). +If you need this because a mailing list incorrectly sets a +@code{Reply-To} header pointing to the list, you probably want to set +the @code{broken-reply-to} group parameter instead, so things will work +correctly. @xref{Group Parameters}. + +@item S B R +@kindex S B R (Summary) +@findex gnus-summary-reply-broken-reply-to-with-original +Mail a reply to the author of the current article and include the +original message but ignore the @code{Reply-To} field +(@code{gnus-summary-reply-broken-reply-to-with-original}). + @item S o m @itemx C-c C-f -@kindex S o m @r{(Summary)} -@kindex C-c C-f @r{(Summary)} +@kindex S o m (Summary) +@kindex C-c C-f (Summary) @findex gnus-summary-mail-forward @c @icon{gnus-summary-mail-forward} Forward the current article to some other person @@ -4602,23 +5339,40 @@ is forwarded according to the value of (@code{message-forward-as-mime}) and (@code{message-forward-show-mml}); if the prefix is 1, decode the message and forward directly inline; if the prefix is 2, forward message -as an rfc822 MIME section; if the prefix is 3, decode message and -forward as an rfc822 MIME section; if the prefix is 4, forward message +as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and +forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message directly inline; otherwise, the message is forwarded as no prefix given but use the flipped value of (@code{message-forward-as-mime}). By -default, the message is decoded and forwarded as an rfc822 MIME section. +default, the message is decoded and forwarded as an rfc822 @acronym{MIME} +section. @item S m @itemx m -@kindex m @r{(Summary)} -@kindex S m @r{(Summary)} +@kindex m (Summary) +@kindex S m (Summary) @findex gnus-summary-mail-other-window @c @icon{gnus-summary-mail-originate} -Send a mail to some other person -(@code{gnus-summary-mail-other-window}). +Prepare a mail (@code{gnus-summary-mail-other-window}). By default, use +the posting style of the current group. If given a prefix, disable that. +If the prefix is 1, prompt for a group name to find the posting style. + +@item S i +@itemx i +@kindex i (Summary) +@kindex S i (Summary) +@findex gnus-summary-news-other-window +Prepare a news (@code{gnus-summary-news-other-window}). By default, +post to the current group. If given a prefix, disable that. If the +prefix is 1, prompt for a group to post to. + +This function actually prepares a news even when using mail groups. +This is useful for ``posting'' messages to mail groups without actually +sending them over the network: they're just saved directly to the group +in question. The corresponding back end must have a request-post method +for this to work though. @item S D b -@kindex S D b @r{(Summary)} +@kindex S D b (Summary) @findex gnus-summary-resend-bounced-mail @cindex bouncing mail If you have sent a mail, but the mail was bounced back to you for some @@ -4631,7 +5385,7 @@ very well fail, though. @item S D r -@kindex S D r @r{(Summary)} +@kindex S D r (Summary) @findex gnus-summary-resend-message Not to be confused with the previous command, @code{gnus-summary-resend-message} will prompt you for an address to @@ -4646,20 +5400,20 @@ ship a mail to a different account of yours. (If you're both @code{root} and @code{postmaster} and get a mail for @code{postmaster} to the @code{root} account, you may want to resend it to -@code{postmaster}. Ordnung muß sein! +@code{postmaster}. Ordnung muss sein! This command understands the process/prefix convention (@pxref{Process/Prefix}). @item S O m -@kindex S O m @r{(Summary)} +@kindex S O m (Summary) @findex gnus-uu-digest-mail-forward Digest the current series (@pxref{Decoding Articles}) and forward the result using mail (@code{gnus-uu-digest-mail-forward}). This command uses the process/prefix convention (@pxref{Process/Prefix}). @item S M-c -@kindex S M-c @r{(Summary)} +@kindex S M-c (Summary) @findex gnus-summary-mail-crosspost-complaint @cindex crossposting @cindex excessive crossposting @@ -4675,7 +5429,8 @@ @end table -Also @pxref{(message)Header Commands} for more information. +Also @xref{Header Commands, ,Header Commands, message, The Message +Manual}, for more information. @node Summary Post Commands @@ -4688,39 +5443,40 @@ @table @kbd @item S p @itemx a -@kindex a @r{(Summary)} -@kindex S p @r{(Summary)} +@kindex a (Summary) +@kindex S p (Summary) @findex gnus-summary-post-news @c @icon{gnus-summary-post-news} -Post an article to the current group -(@code{gnus-summary-post-news}). +Prepare for posting an article (@code{gnus-summary-post-news}). By +default, post to the current group. If given a prefix, disable that. +If the prefix is 1, prompt for another group instead. @item S f @itemx f -@kindex f @r{(Summary)} -@kindex S f @r{(Summary)} +@kindex f (Summary) +@kindex S f (Summary) @findex gnus-summary-followup @c @icon{gnus-summary-followup} Post a followup to the current article (@code{gnus-summary-followup}). @item S F @itemx F -@kindex S F @r{(Summary)} -@kindex F @r{(Summary)} +@kindex S F (Summary) +@kindex F (Summary) @c @icon{gnus-summary-followup-with-original} @findex gnus-summary-followup-with-original Post a followup to the current article and include the original message -(@code{gnus-summary-followup-with-original}). This command uses the +(@code{gnus-summary-followup-with-original}). This command uses the process/prefix convention. @item S n -@kindex S n @r{(Summary)} +@kindex S n (Summary) @findex gnus-summary-followup-to-mail Post a followup to the current article via news, even if you got the message through mail (@code{gnus-summary-followup-to-mail}). @item S N -@kindex S N @r{(Summary)} +@kindex S N (Summary) @findex gnus-summary-followup-to-mail-with-original Post a followup to the current article via news, even if you got the message through mail and include the original message @@ -4728,7 +5484,7 @@ the process/prefix convention. @item S o p -@kindex S o p @r{(Summary)} +@kindex S o p (Summary) @findex gnus-summary-post-forward Forward the current article to a newsgroup (@code{gnus-summary-post-forward}). @@ -4736,14 +5492,14 @@ of (@code{message-forward-as-mime}) and (@code{message-forward-show-mml}); if the prefix is 1, decode the message and forward directly inline; if the prefix is 2, forward message -as an rfc822 MIME section; if the prefix is 3, decode message and -forward as an rfc822 MIME section; if the prefix is 4, forward message +as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and +forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message directly inline; otherwise, the message is forwarded as no prefix given but use the flipped value of (@code{message-forward-as-mime}). By -default, the message is decoded and forwarded as an rfc822 MIME section. +default, the message is decoded and forwarded as an rfc822 @acronym{MIME} section. @item S O p -@kindex S O p @r{(Summary)} +@kindex S O p (Summary) @findex gnus-uu-digest-post-forward @cindex digests @cindex making digests @@ -4752,14 +5508,15 @@ process/prefix convention. @item S u -@kindex S u @r{(Summary)} +@kindex S u (Summary) @findex gnus-uu-post-news @c @icon{gnus-uu-post-news} Uuencode a file, split it into parts, and post it as a series (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}). @end table -Also @pxref{(message)Header Commands} for more information. +Also @xref{Header Commands, ,Header Commands, message, The Message +Manual}, for more information. @node Summary Message Commands @@ -4767,7 +5524,7 @@ @table @kbd @item S y -@kindex S y @r{(Summary)} +@kindex S y (Summary) @findex gnus-summary-yank-message Yank the current article into an already existing Message composition buffer (@code{gnus-summary-yank-message}). This command prompts for @@ -4788,7 +5545,7 @@ Well, you can't cancel mail, but you can cancel posts. @findex gnus-summary-cancel-article -@kindex C @r{(Summary)} +@kindex C (Summary) @c @icon{gnus-summary-cancel-article} Find the article you wish to cancel (you can only cancel your own articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S @@ -4804,12 +5561,16 @@ want to use the standard posting method, use the @samp{a} symbolic prefix (@pxref{Symbolic Prefixes}). +Gnus ensures that only you can cancel your own messages using a +@code{Cancel-Lock} header (@pxref{Canceling News, Canceling News, , +message, Message Manual}). + If you discover that you have made some mistakes and want to do some corrections, you can post a @dfn{superseding} article that will replace your original article. @findex gnus-summary-supersede-article -@kindex S @r{(Summary)} +@kindex S (Summary) Go to the original article and press @kbd{S s} (@code{gnus-summary-supersede-article}). You will be put in a buffer where you can edit the article all you want before sending it off the @@ -4832,6 +5593,102 @@ Just remember, kids: There is no 'c' in 'supersede'. +@node Delayed Articles +@section Delayed Articles +@cindex delayed sending +@cindex send delayed + +Sometimes, you might wish to delay the sending of a message. For +example, you might wish to arrange for a message to turn up just in time +to remind your about the birthday of your Significant Other. For this, +there is the @code{gnus-delay} package. Setup is simple: + +@lisp +(gnus-delay-initialize) +@end lisp + +@findex gnus-delay-article +Normally, to send a message you use the @kbd{C-c C-c} command from +Message mode. To delay a message, use @kbd{C-c C-j} +(@code{gnus-delay-article}) instead. This will ask you for how long the +message should be delayed. Possible answers are: + +@itemize @bullet +@item +A time span. Consists of an integer and a letter. For example, +@code{42d} means to delay for 42 days. Available letters are @code{m} +(minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M} +(months) and @code{Y} (years). + +@item +A specific date. Looks like @code{YYYY-MM-DD}. The message will be +delayed until that day, at a specific time (eight o'clock by default). +See also @code{gnus-delay-default-hour}. + +@item +A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm +stuff. The deadline will be at that time today, except if that time has +already passed, then it's at the given time tomorrow. So if it's ten +o'clock in the morning and you specify @code{11:15}, then the deadline +is one hour and fifteen minutes hence. But if you specify @code{9:20}, +that means a time tomorrow. +@end itemize + +The action of the @code{gnus-delay-article} command is influenced by a +couple of variables: + +@table @code +@item gnus-delay-default-hour +@vindex gnus-delay-default-hour +When you specify a specific date, the message will be due on that hour +on the given date. Possible values are integers 0 through 23. + +@item gnus-delay-default-delay +@vindex gnus-delay-default-delay +This is a string and gives the default delay. It can be of any of the +formats described above. + +@item gnus-delay-group +@vindex gnus-delay-group +Delayed articles will be kept in this group on the drafts server until +they are due. You probably don't need to change this. The default +value is @code{"delayed"}. + +@item gnus-delay-header +@vindex gnus-delay-header +The deadline for each article will be stored in a header. This variable +is a string and gives the header name. You probably don't need to +change this. The default value is @code{"X-Gnus-Delayed"}. +@end table + +The way delaying works is like this: when you use the +@code{gnus-delay-article} command, you give a certain delay. Gnus +calculates the deadline of the message and stores it in the +@code{X-Gnus-Delayed} header and puts the message in the +@code{nndraft:delayed} group. + +@findex gnus-delay-send-queue +And whenever you get new news, Gnus looks through the group for articles +which are due and sends them. It uses the @code{gnus-delay-send-queue} +function for this. By default, this function is added to the hook +@code{gnus-get-new-news-hook}. But of course, you can change this. +Maybe you want to use the demon to send drafts? Just tell the demon to +execute the @code{gnus-delay-send-queue} function. + +@table @code +@item gnus-delay-initialize +@findex gnus-delay-initialize +By default, this function installs @code{gnus-delay-send-queue} in +@code{gnus-get-new-news-hook}. But it accepts the optional second +argument @code{no-check}. If it is non-@code{nil}, +@code{gnus-get-new-news-hook} is not changed. The optional first +argument is ignored. + +For example, @code{(gnus-delay-initialize nil t)} means to do nothing. +Presumably, you want to use the demon for sending due delayed articles. +Just don't forget to set that up :-) +@end table + @node Marking Articles @section Marking Articles @@ -4848,9 +5705,9 @@ In addition, you also have marks that do not affect readedness. @menu -* Unread Articles:: Marks for unread articles. -* Read Articles:: Marks for read articles. -* Other Marks:: Marks that do not affect readedness. +* Unread Articles:: Marks for unread articles. +* Read Articles:: Marks for read articles. +* Other Marks:: Marks that do not affect readedness. @end menu @ifinfo @@ -4878,9 +5735,10 @@ @dfn{Ticked articles} are articles that will remain visible always. If you see an article that you find interesting, or you want to put off reading it, or replying to it, until sometime later, you'd typically -tick it. However, articles can be expired, so if you want to keep an -article forever, you'll have to make it persistent (@pxref{Persistent -Articles}). +tick it. However, articles can be expired (from news servers by the +news server software, Gnus itself never expires ticked messages), so if +you want to keep an article forever, you'll have to make it persistent +(@pxref{Persistent Articles}). @item ? @vindex gnus-dormant-mark @@ -4889,8 +5747,10 @@ @dfn{Dormant articles} will only appear in the summary buffer if there are followups to it. If you want to see them even if they don't have followups, you can use the @kbd{/ D} command (@pxref{Limiting}). - -@item @key{SPC} +Otherwise (except for the visibility issue), they are just like ticked +messages. + +@item SPACE @vindex gnus-unread-mark Marked as unread (@code{gnus-unread-mark}). @@ -4952,7 +5812,7 @@ @item M @vindex gnus-duplicate-mark Article marked as read by duplicate suppression -(@code{gnus-duplicated-mark}). @xref{Duplicate Suppression}. +(@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}. @end table @@ -4998,6 +5858,11 @@ (@code{gnus-replied-mark}). @item +@vindex gnus-forwarded-mark +All articles that you have forwarded will be marked with an @samp{F} in +the second column (@code{gnus-forwarded-mark}). + +@item @vindex gnus-cached-mark Articles stored in the article cache will be marked with an @samp{*} in the second column (@code{gnus-cached-mark}). @xref{Article Caching}. @@ -5009,6 +5874,45 @@ (@code{gnus-saved-mark}). @item +@vindex gnus-recent-mark +Articles that according to the server haven't been shown to the user +before are marked with a @samp{N} in the second column +(@code{gnus-recent-mark}). Note that not all servers support this +mark, in which case it simply never appears. Compare with +@code{gnus-unseen-mark}. + +@item +@vindex gnus-unseen-mark +Articles that haven't been seen before in Gnus by the user are marked +with a @samp{.} in the second column (@code{gnus-unseen-mark}). +Compare with @code{gnus-recent-mark}. + +@item +@vindex gnus-downloaded-mark +When using the Gnus agent (@pxref{Agent Basics}), articles may be +downloaded for unplugged (offline) viewing. If you are using the +@samp{%O} spec, these articles get the @samp{+} mark in that spec. +(The variable @code{gnus-downloaded-mark} controls which character to +use.) + +@item +@vindex gnus-undownloaded-mark +When using the Gnus agent (@pxref{Agent Basics}), some articles might +not have been downloaded. Such articles cannot be viewed while you +are unplugged (offline). If you are using the @samp{%O} spec, these +articles get the @samp{-} mark in that spec. (The variable +@code{gnus-undownloaded-mark} controls which character to use.) + +@item +@vindex gnus-downloadable-mark +The Gnus agent (@pxref{Agent Basics}) downloads some articles +automatically, but it is also possible to explicitly mark articles for +download, even if they would not be downloaded automatically. Such +explicitly-marked articles get the @samp{%} mark in the first column. +(The variable @code{gnus-downloadable-mark} controls which character to +use.) + +@item @vindex gnus-not-empty-thread-mark @vindex gnus-empty-thread-mark If the @samp{%e} spec is used, the presence of threads or not will be @@ -5043,8 +5947,8 @@ @table @kbd @item M c @itemx M-u -@kindex M c @r{(Summary)} -@kindex M-u @r{(Summary)} +@kindex M c (Summary) +@kindex M-u (Summary) @findex gnus-summary-clear-mark-forward @cindex mark as unread Clear all readedness-marks from the current article @@ -5053,38 +5957,38 @@ @item M t @itemx ! -@kindex ! @r{(Summary)} -@kindex M t @r{(Summary)} +@kindex ! (Summary) +@kindex M t (Summary) @findex gnus-summary-tick-article-forward Tick the current article (@code{gnus-summary-tick-article-forward}). @xref{Article Caching}. @item M ? @itemx ? -@kindex ? @r{(Summary)} -@kindex M ? @r{(Summary)} +@kindex ? (Summary) +@kindex M ? (Summary) @findex gnus-summary-mark-as-dormant Mark the current article as dormant (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}. @item M d @itemx d -@kindex M d @r{(Summary)} -@kindex d @r{(Summary)} +@kindex M d (Summary) +@kindex d (Summary) @findex gnus-summary-mark-as-read-forward Mark the current article as read (@code{gnus-summary-mark-as-read-forward}). @item D -@kindex D @r{(Summary)} +@kindex D (Summary) @findex gnus-summary-mark-as-read-backward Mark the current article as read and move point to the previous line (@code{gnus-summary-mark-as-read-backward}). @item M k @itemx k -@kindex k @r{(Summary)} -@kindex M k @r{(Summary)} +@kindex k (Summary) +@kindex M k (Summary) @findex gnus-summary-kill-same-subject-and-select Mark all articles that have the same subject as the current one as read, and then select the next unread article @@ -5092,76 +5996,82 @@ @item M K @itemx C-k -@kindex M K @r{(Summary)} -@kindex C-k @r{(Summary)} +@kindex M K (Summary) +@kindex C-k (Summary) @findex gnus-summary-kill-same-subject Mark all articles that have the same subject as the current one as read (@code{gnus-summary-kill-same-subject}). @item M C -@kindex M C @r{(Summary)} +@kindex M C (Summary) @findex gnus-summary-catchup @c @icon{gnus-summary-catchup} Mark all unread articles as read (@code{gnus-summary-catchup}). @item M C-c -@kindex M C-c @r{(Summary)} +@kindex M C-c (Summary) @findex gnus-summary-catchup-all Mark all articles in the group as read---even the ticked and dormant articles (@code{gnus-summary-catchup-all}). @item M H -@kindex M H @r{(Summary)} +@kindex M H (Summary) @findex gnus-summary-catchup-to-here -Catchup the current group to point +Catchup the current group to point (before the point) (@code{gnus-summary-catchup-to-here}). +@item M h +@kindex M h (Summary) +@findex gnus-summary-catchup-from-here +Catchup the current group from point (after the point) +(@code{gnus-summary-catchup-from-here}). + @item C-w -@kindex C-w @r{(Summary)} +@kindex C-w (Summary) @findex gnus-summary-mark-region-as-read Mark all articles between point and mark as read (@code{gnus-summary-mark-region-as-read}). @item M V k -@kindex M V k @r{(Summary)} +@kindex M V k (Summary) @findex gnus-summary-kill-below Kill all articles with scores below the default score (or below the numeric prefix) (@code{gnus-summary-kill-below}). @item M e @itemx E -@kindex M e @r{(Summary)} -@kindex E @r{(Summary)} +@kindex M e (Summary) +@kindex E (Summary) @findex gnus-summary-mark-as-expirable Mark the current article as expirable (@code{gnus-summary-mark-as-expirable}). @item M b -@kindex M b @r{(Summary)} +@kindex M b (Summary) @findex gnus-summary-set-bookmark Set a bookmark in the current article (@code{gnus-summary-set-bookmark}). @item M B -@kindex M B @r{(Summary)} +@kindex M B (Summary) @findex gnus-summary-remove-bookmark Remove the bookmark from the current article (@code{gnus-summary-remove-bookmark}). @item M V c -@kindex M V c @r{(Summary)} +@kindex M V c (Summary) @findex gnus-summary-clear-above Clear all marks from articles with scores over the default score (or over the numeric prefix) (@code{gnus-summary-clear-above}). @item M V u -@kindex M V u @r{(Summary)} +@kindex M V u (Summary) @findex gnus-summary-tick-above Tick all articles with scores over the default score (or over the numeric prefix) (@code{gnus-summary-tick-above}). @item M V m -@kindex M V m @r{(Summary)} +@kindex M V m (Summary) @findex gnus-summary-mark-above Prompt for a mark, and mark all articles with scores over the default score (or over the numeric prefix) with this mark @@ -5174,7 +6084,7 @@ the next/previous unread article. If @code{nil}, point will just move one line up or down. As a special case, if this variable is @code{never}, all the marking commands as well as other commands (like -@key{SPC}) will move to the next article, whether it is unread or not. +@kbd{SPACE}) will move to the next article, whether it is unread or not. The default is @code{t}. @@ -5188,7 +6098,7 @@ previous (unread) article, I'm sure there are people that want that as well. -Multiply these five behaviors by five different marking commands, and +Multiply these five behaviors with five different marking commands, and you get a potentially complex set of variable to control what each command should do. @@ -5203,11 +6113,14 @@ article, you could say something like: @lisp +@group (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map) (defun my-alter-summary-map () (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next)) -@end lisp - +@end group +@end lisp + +@noindent or @lisp @@ -5220,12 +6133,19 @@ @subsection Setting Process Marks @cindex setting process marks +Process marks are displayed as @code{#} in the summary buffer, and are +used for marking articles in such a way that other commands will +process these articles. For instance, if you process mark four +articles and then use the @kbd{*} command, Gnus will enter these four +commands into the cache. For more information, +@pxref{Process/Prefix}. + @table @kbd @item M P p @itemx # -@kindex # @r{(Summary)} -@kindex M P p @r{(Summary)} +@kindex # (Summary) +@kindex M P p (Summary) @findex gnus-summary-mark-as-processable Mark the current article with the process mark (@code{gnus-summary-mark-as-processable}). @@ -5233,101 +6153,106 @@ @item M P u @itemx M-# -@kindex M P u @r{(Summary)} -@kindex M-# @r{(Summary)} +@kindex M P u (Summary) +@kindex M-# (Summary) Remove the process mark, if any, from the current article (@code{gnus-summary-unmark-as-processable}). @item M P U -@kindex M P U @r{(Summary)} +@kindex M P U (Summary) @findex gnus-summary-unmark-all-processable Remove the process mark from all articles (@code{gnus-summary-unmark-all-processable}). @item M P i -@kindex M P i @r{(Summary)} +@kindex M P i (Summary) @findex gnus-uu-invert-processable Invert the list of process marked articles (@code{gnus-uu-invert-processable}). @item M P R -@kindex M P R @r{(Summary)} +@kindex M P R (Summary) @findex gnus-uu-mark-by-regexp Mark articles that have a @code{Subject} header that matches a regular expression (@code{gnus-uu-mark-by-regexp}). @item M P G -@kindex M P G @r{(Summary)} +@kindex M P G (Summary) @findex gnus-uu-unmark-by-regexp Unmark articles that have a @code{Subject} header that matches a regular expression (@code{gnus-uu-unmark-by-regexp}). @item M P r -@kindex M P r @r{(Summary)} +@kindex M P r (Summary) @findex gnus-uu-mark-region Mark articles in region (@code{gnus-uu-mark-region}). +@item M P g +@kindex M P g (Summary) +@findex gnus-uu-unmark-region +Unmark articles in region (@code{gnus-uu-unmark-region}). + @item M P t -@kindex M P t @r{(Summary)} +@kindex M P t (Summary) @findex gnus-uu-mark-thread Mark all articles in the current (sub)thread (@code{gnus-uu-mark-thread}). @item M P T -@kindex M P T @r{(Summary)} +@kindex M P T (Summary) @findex gnus-uu-unmark-thread Unmark all articles in the current (sub)thread (@code{gnus-uu-unmark-thread}). @item M P v -@kindex M P v @r{(Summary)} +@kindex M P v (Summary) @findex gnus-uu-mark-over Mark all articles that have a score above the prefix argument (@code{gnus-uu-mark-over}). @item M P s -@kindex M P s @r{(Summary)} +@kindex M P s (Summary) @findex gnus-uu-mark-series Mark all articles in the current series (@code{gnus-uu-mark-series}). @item M P S -@kindex M P S @r{(Summary)} +@kindex M P S (Summary) @findex gnus-uu-mark-sparse Mark all series that have already had some articles marked (@code{gnus-uu-mark-sparse}). @item M P a -@kindex M P a @r{(Summary)} +@kindex M P a (Summary) @findex gnus-uu-mark-all Mark all articles in series order (@code{gnus-uu-mark-series}). @item M P b -@kindex M P b @r{(Summary)} +@kindex M P b (Summary) @findex gnus-uu-mark-buffer Mark all articles in the buffer in the order they appear (@code{gnus-uu-mark-buffer}). @item M P k -@kindex M P k @r{(Summary)} +@kindex M P k (Summary) @findex gnus-summary-kill-process-mark Push the current process mark set onto the stack and unmark all articles (@code{gnus-summary-kill-process-mark}). @item M P y -@kindex M P y @r{(Summary)} +@kindex M P y (Summary) @findex gnus-summary-yank-process-mark Pop the previous process mark set from the stack and restore it (@code{gnus-summary-yank-process-mark}). @item M P w -@kindex M P w @r{(Summary)} +@kindex M P w (Summary) @findex gnus-summary-save-process-mark Push the current process mark set onto the stack (@code{gnus-summary-save-process-mark}). @end table -Also see the @kbd{&} command in @pxref{Searching for Articles} for how to +Also see the @kbd{&} command in @ref{Searching for Articles}, for how to set process marks based on article body contents. @@ -5348,28 +6273,31 @@ @item / / @itemx / s -@kindex / / @r{(Summary)} +@kindex / / (Summary) @findex gnus-summary-limit-to-subject Limit the summary buffer to articles that match some subject -(@code{gnus-summary-limit-to-subject}). +(@code{gnus-summary-limit-to-subject}). If given a prefix, exclude +matching articles. @item / a -@kindex / a @r{(Summary)} +@kindex / a (Summary) @findex gnus-summary-limit-to-author Limit the summary buffer to articles that match some author -(@code{gnus-summary-limit-to-author}). +(@code{gnus-summary-limit-to-author}). If given a prefix, exclude +matching articles. @item / x -@kindex / x @r{(Summary)} +@kindex / x (Summary) @findex gnus-summary-limit-to-extra Limit the summary buffer to articles that match one of the ``extra'' headers (@pxref{To From Newsgroups}) -(@code{gnus-summary-limit-to-extra}). +(@code{gnus-summary-limit-to-extra}). If given a prefix, exclude +matching articles. @item / u @itemx x -@kindex / u @r{(Summary)} -@kindex x @r{(Summary)} +@kindex / u (Summary) +@kindex x (Summary) @findex gnus-summary-limit-to-unread Limit the summary buffer to articles not marked as read (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the @@ -5377,87 +6305,113 @@ dormant articles will also be excluded. @item / m -@kindex / m @r{(Summary)} +@kindex / m (Summary) @findex gnus-summary-limit-to-marks Ask for a mark and then limit to all articles that have been marked with that mark (@code{gnus-summary-limit-to-marks}). @item / t -@kindex / t @r{(Summary)} +@kindex / t (Summary) @findex gnus-summary-limit-to-age Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days (@code{gnus-summary-limit-to-age}). If given a prefix, limit to articles younger than that number of days. @item / n -@kindex / n @r{(Summary)} +@kindex / n (Summary) @findex gnus-summary-limit-to-articles Limit the summary buffer to the current article (@code{gnus-summary-limit-to-articles}). Uses the process/prefix convention (@pxref{Process/Prefix}). @item / w -@kindex / w @r{(Summary)} +@kindex / w (Summary) @findex gnus-summary-pop-limit Pop the previous limit off the stack and restore it (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off the stack. +@item / . +@kindex / . (Summary) +@findex gnus-summary-limit-to-unseen +Limit the summary buffer to the unseen articles +(@code{gnus-summary-limit-to-unseen}). + @item / v -@kindex / v @r{(Summary)} +@kindex / v (Summary) @findex gnus-summary-limit-to-score Limit the summary buffer to articles that have a score at or above some score (@code{gnus-summary-limit-to-score}). +@item / p +@kindex / p (Summary) +@findex gnus-summary-limit-to-display-predicate +Limit the summary buffer to articles that satisfy the @code{display} +group parameter predicate +(@code{gnus-summary-limit-to-display-predicate}). @xref{Group +Parameters}, for more on this predicate. + @item / E @itemx M S -@kindex M S @r{(Summary)} -@kindex / E @r{(Summary)} +@kindex M S (Summary) +@kindex / E (Summary) @findex gnus-summary-limit-include-expunged Include all expunged articles in the limit (@code{gnus-summary-limit-include-expunged}). @item / D -@kindex / D @r{(Summary)} +@kindex / D (Summary) @findex gnus-summary-limit-include-dormant Include all dormant articles in the limit (@code{gnus-summary-limit-include-dormant}). @item / * -@kindex / * @r{(Summary)} +@kindex / * (Summary) @findex gnus-summary-limit-include-cached Include all cached articles in the limit (@code{gnus-summary-limit-include-cached}). @item / d -@kindex / d @r{(Summary)} +@kindex / d (Summary) @findex gnus-summary-limit-exclude-dormant Exclude all dormant articles from the limit (@code{gnus-summary-limit-exclude-dormant}). @item / M -@kindex / M @r{(Summary)} +@kindex / M (Summary) @findex gnus-summary-limit-exclude-marks Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}). @item / T -@kindex / T @r{(Summary)} +@kindex / T (Summary) @findex gnus-summary-limit-include-thread Include all the articles in the current thread in the limit. @item / c -@kindex / c @r{(Summary)} +@kindex / c (Summary) @findex gnus-summary-limit-exclude-childless-dormant -Exclude all dormant articles that have no children from the limit +Exclude all dormant articles that have no children from the limit@* (@code{gnus-summary-limit-exclude-childless-dormant}). @item / C -@kindex / C @r{(Summary)} +@kindex / C (Summary) @findex gnus-summary-limit-mark-excluded-as-read Mark all excluded unread articles as read -(@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix, +(@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix, also mark excluded ticked and dormant articles as read. +@item / N +@kindex / N (Summary) +@findex gnus-summary-insert-new-articles +Insert all new articles in the summary buffer. It scans for new emails +if @var{back-end}@code{-get-new-mail} is non-@code{nil}. + +@item / o +@kindex / o (Summary) +@findex gnus-summary-insert-old-articles +Insert all old articles in the summary buffer. If given a numbered +prefix, fetch this number of articles. + @end table @@ -5476,7 +6430,7 @@ or simply missing. Weird news propagation exacerbates the problem, so one has to employ other heuristics to get pleasing results. A plethora of approaches exists, as detailed in horrible detail in -@pxref{Customizing Threading}. +@ref{Customizing Threading}. First, a quick overview of the concepts: @@ -5508,8 +6462,8 @@ @menu -* Customizing Threading:: Variables you can change to affect the threading. -* Thread Commands:: Thread based commands in the summary buffer. +* Customizing Threading:: Variables you can change to affect the threading. +* Thread Commands:: Thread based commands in the summary buffer. @end menu @@ -5518,10 +6472,10 @@ @cindex customizing threading @menu -* Loose Threads:: How Gnus gathers loose threads into bigger threads. -* Filling In Threads:: Making the threads displayed look fuller. -* More Threading:: Even more variables for fiddling with threads. -* Low-Level Threading:: You thought it was over... but you were wrong! +* Loose Threads:: How Gnus gathers loose threads into bigger threads. +* Filling In Threads:: Making the threads displayed look fuller. +* More Threading:: Even more variables for fiddling with threads. +* Low-Level Threading:: You thought it was over@dots{} but you were wrong! @end menu @@ -5546,10 +6500,10 @@ @iftex @iflatex \gnusfigure{The Summary Buffer}{390}{ -\put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}} -\put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}} -\put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}} -\put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}} +\put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}} +\put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}} +\put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}} +\put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}} } @end iflatex @end iftex @@ -5566,12 +6520,15 @@ @item dummy @vindex gnus-summary-dummy-line-format +@vindex gnus-summary-make-false-root-always Gnus will create a dummy summary line that will pretend to be the parent. This dummy line does not correspond to any real article, so selecting it will just select the first real article after the dummy article. @code{gnus-summary-dummy-line-format} is used to specify the format of the dummy roots. It accepts only one format spec: @samp{S}, which is the subject of the article. @xref{Formatting Variables}. +If you want all threads to have a dummy root, even the non-gathered +ones, set @code{gnus-summary-make-false-root-always} to @code{t}. @item empty Gnus won't actually make any article the parent, but simply leave the @@ -5661,6 +6618,10 @@ @item gnus-simplify-whitespace @findex gnus-simplify-whitespace Remove excessive whitespace. + +@item gnus-simplify-all-whitespace +@findex gnus-simplify-all-whitespace +Remove all whitespace. @end table You may also write your own functions, of course. @@ -5715,20 +6676,26 @@ @item gnus-fetch-old-headers @vindex gnus-fetch-old-headers If non-@code{nil}, Gnus will attempt to build old threads by fetching -more old headers---headers to articles marked as read. If you -would like to display as few summary lines as possible, but still -connect as many loose threads as possible, you should set this variable -to @code{some} or a number. If you set it to a number, no more than -that number of extra old headers will be fetched. In either case, -fetching old headers only works if the back end you are using carries -overview files---this would normally be @code{nntp}, @code{nnspool} and -@code{nnml}. Also remember that if the root of the thread has been -expired by the server, there's not much Gnus can do about that. +more old headers---headers to articles marked as read. If you would +like to display as few summary lines as possible, but still connect as +many loose threads as possible, you should set this variable to +@code{some} or a number. If you set it to a number, no more than that +number of extra old headers will be fetched. In either case, fetching +old headers only works if the back end you are using carries overview +files---this would normally be @code{nntp}, @code{nnspool}, +@code{nnml}, and @code{nnmaildir}. Also remember that if the root of +the thread has been expired by the server, there's not much Gnus can +do about that. This variable can also be set to @code{invisible}. This won't have any visible effects, but is useful if you use the @kbd{A T} command a lot (@pxref{Finding the Parent}). +@item gnus-fetch-old-ephemeral-headers +@vindex gnus-fetch-old-ephemeral-headers +Same as @code{gnus-fetch-old-headers}, but only used for ephemeral +newsgroups. + @item gnus-build-sparse-threads @vindex gnus-build-sparse-threads Fetching old headers can be slow. A low-rent similar effect can be @@ -5744,6 +6711,18 @@ off sparse leaf nodes that don't lead anywhere. This variable is @code{nil} by default. +@item gnus-read-all-available-headers +@vindex gnus-read-all-available-headers +This is a rather obscure variable that few will find useful. It's +intended for those non-news newsgroups where the back end has to fetch +quite a lot to present the summary buffer, and where it's impossible to +go back to parents of articles. This is mostly the case in the +web-based groups, like the @code{nnultimate} groups. + +If you don't use those, then it's safe to leave this as the default +@code{nil}. If you want to use this variable, it should be a regexp +that matches the group name, or @code{t} for all groups. + @end table @@ -5763,6 +6742,22 @@ If non-@code{nil}, all threads will be hidden when the summary buffer is generated. +This can also be a predicate specifier (@pxref{Predicate Specifiers}). +Available predicates are @code{gnus-article-unread-p} and +@code{gnus-article-unseen-p}. + +Here's an example: + +@lisp +(setq gnus-thread-hide-subtree + '(or gnus-article-unread-p + gnus-article-unseen-p)) +@end lisp + +(It's a pretty nonsensical example, since all unseen articles are also +unread, but you get my drift.) + + @item gnus-thread-expunge-below @vindex gnus-thread-expunge-below All threads that have a total score (as defined by @@ -5778,9 +6773,9 @@ @item gnus-thread-ignore-subject @vindex gnus-thread-ignore-subject Sometimes somebody changes the subject in the middle of a thread. If -this variable is non-@code{nil}, the subject change is ignored. If it -is @code{nil}, which is the default, a change in the subject will result -in a new thread. +this variable is non-@code{nil}, which is the default, the subject +change is ignored. If it is @code{nil}, a change in the subject will +result in a new thread. @item gnus-thread-indent-level @vindex gnus-thread-indent-level @@ -5844,8 +6839,8 @@ @item T k @itemx C-M-k -@kindex T k @r{(Summary)} -@kindex C-M-k @r{(Summary)} +@kindex T k (Summary) +@kindex C-M-k (Summary) @findex gnus-summary-kill-thread Mark all articles in the current (sub-)thread as read (@code{gnus-summary-kill-thread}). If the prefix argument is positive, @@ -5854,65 +6849,65 @@ @item T l @itemx C-M-l -@kindex T l @r{(Summary)} -@kindex C-M-l @r{(Summary)} +@kindex T l (Summary) +@kindex C-M-l (Summary) @findex gnus-summary-lower-thread Lower the score of the current (sub-)thread (@code{gnus-summary-lower-thread}). @item T i -@kindex T i @r{(Summary)} +@kindex T i (Summary) @findex gnus-summary-raise-thread Increase the score of the current (sub-)thread (@code{gnus-summary-raise-thread}). @item T # -@kindex T # @r{(Summary)} +@kindex T # (Summary) @findex gnus-uu-mark-thread Set the process mark on the current (sub-)thread (@code{gnus-uu-mark-thread}). @item T M-# -@kindex T M-# @r{(Summary)} +@kindex T M-# (Summary) @findex gnus-uu-unmark-thread Remove the process mark from the current (sub-)thread (@code{gnus-uu-unmark-thread}). @item T T -@kindex T T @r{(Summary)} +@kindex T T (Summary) @findex gnus-summary-toggle-threads Toggle threading (@code{gnus-summary-toggle-threads}). @item T s -@kindex T s @r{(Summary)} +@kindex T s (Summary) @findex gnus-summary-show-thread -Expose the (sub-)thread hidden under the current article, if any +Expose the (sub-)thread hidden under the current article, if any@* (@code{gnus-summary-show-thread}). @item T h -@kindex T h @r{(Summary)} +@kindex T h (Summary) @findex gnus-summary-hide-thread Hide the current (sub-)thread (@code{gnus-summary-hide-thread}). @item T S -@kindex T S @r{(Summary)} +@kindex T S (Summary) @findex gnus-summary-show-all-threads Expose all hidden threads (@code{gnus-summary-show-all-threads}). @item T H -@kindex T H @r{(Summary)} +@kindex T H (Summary) @findex gnus-summary-hide-all-threads Hide all threads (@code{gnus-summary-hide-all-threads}). @item T t -@kindex T t @r{(Summary)} +@kindex T t (Summary) @findex gnus-summary-rethread-current Re-thread the current article's thread (@code{gnus-summary-rethread-current}). This works even when the summary buffer is otherwise unthreaded. @item T ^ -@kindex T ^ @r{(Summary)} +@kindex T ^ (Summary) @findex gnus-summary-reparent-thread Make the current article the child of the marked (or previous) article (@code{gnus-summary-reparent-thread}). @@ -5925,35 +6920,35 @@ @table @kbd @item T n -@kindex T n @r{(Summary)} -@itemx C-M-n -@kindex C-M-n @r{(Summary)} +@kindex T n (Summary) +@itemx C-M-f +@kindex C-M-n (Summary) @itemx M-down -@kindex M-down @r{(Summary)} +@kindex M-down (Summary) @findex gnus-summary-next-thread Go to the next thread (@code{gnus-summary-next-thread}). @item T p -@kindex T p @r{(Summary)} -@itemx C-M-p -@kindex C-M-p @r{(Summary)} +@kindex T p (Summary) +@itemx C-M-b +@kindex C-M-p (Summary) @itemx M-up -@kindex M-up @r{(Summary)} +@kindex M-up (Summary) @findex gnus-summary-prev-thread Go to the previous thread (@code{gnus-summary-prev-thread}). @item T d -@kindex T d @r{(Summary)} +@kindex T d (Summary) @findex gnus-summary-down-thread Descend the thread (@code{gnus-summary-down-thread}). @item T u -@kindex T u @r{(Summary)} +@kindex T u (Summary) @findex gnus-summary-up-thread Ascend the thread (@code{gnus-summary-up-thread}). @item T o -@kindex T o @r{(Summary)} +@kindex T o (Summary) @findex gnus-summary-top-thread Go to the top of the thread (@code{gnus-summary-top-thread}). @end table @@ -5973,8 +6968,8 @@ Matching}). -@node Sorting -@section Sorting +@node Sorting the Summary Buffer +@section Sorting the Summary Buffer @findex gnus-thread-sort-by-total-score @findex gnus-thread-sort-by-date @@ -5982,7 +6977,10 @@ @findex gnus-thread-sort-by-subject @findex gnus-thread-sort-by-author @findex gnus-thread-sort-by-number +@findex gnus-thread-sort-by-random @vindex gnus-thread-sort-functions +@findex gnus-thread-sort-by-most-recent-number +@findex gnus-thread-sort-by-most-recent-date If you are using a threaded summary display, you can sort the threads by setting @code{gnus-thread-sort-functions}, which can be either a single function, a list of functions, or a list containing functions and @@ -5991,7 +6989,10 @@ By default, sorting is done on article numbers. Ready-made sorting predicate functions include @code{gnus-thread-sort-by-number}, @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject}, -@code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and +@code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, +@code{gnus-thread-sort-by-most-recent-number}, +@code{gnus-thread-sort-by-most-recent-date}, +@code{gnus-thread-sort-by-random} and @code{gnus-thread-sort-by-total-score}. Each function takes two threads and returns non-@code{nil} if the first @@ -6042,14 +7043,18 @@ @findex gnus-article-sort-by-score @findex gnus-article-sort-by-subject @findex gnus-article-sort-by-author +@findex gnus-article-sort-by-random @findex gnus-article-sort-by-number -If you are using an unthreaded display for some strange reason or other, -you have to fiddle with the @code{gnus-article-sort-functions} variable. -It is very similar to the @code{gnus-thread-sort-functions}, except that -it uses slightly different functions for article comparison. Available -sorting predicate functions are @code{gnus-article-sort-by-number}, -@code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject}, -@code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}. +If you are using an unthreaded display for some strange reason or +other, you have to fiddle with the @code{gnus-article-sort-functions} +variable. It is very similar to the +@code{gnus-thread-sort-functions}, except that it uses slightly +different functions for article comparison. Available sorting +predicate functions are @code{gnus-article-sort-by-number}, +@code{gnus-article-sort-by-author}, +@code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date}, +@code{gnus-article-sort-by-random}, and +@code{gnus-article-sort-by-score}. If you want to sort an unthreaded summary display by subject, you could say something like: @@ -6068,7 +7073,7 @@ @cindex article pre-fetch @cindex pre-fetch -If you read your news from an @sc{nntp} server that's far away, the +If you read your news from an @acronym{NNTP} server that's far away, the network latencies may make reading articles a chore. You have to wait for a while after pressing @kbd{n} to go to the next article before the article appears. Why can't Gnus just go ahead and fetch the article @@ -6089,12 +7094,12 @@ extra connection takes some time, so Gnus startup will be slower. Gnus will fetch more articles than you will read. This will mean that -the link between your machine and the @sc{nntp} server will become more +the link between your machine and the @acronym{NNTP} server will become more loaded than if you didn't use article pre-fetch. The server itself will also become more loaded---both with the extra article requests, and the extra connection. -Ok, so now you know that you shouldn't really use this thing... unless +Ok, so now you know that you shouldn't really use this thing@dots{} unless you really want to. @vindex gnus-asynchronous @@ -6112,13 +7117,15 @@ @vindex gnus-async-prefetch-article-p @findex gnus-async-read-p There are probably some articles that you don't want to pre-fetch---read -articles, for instance. The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched. This function should -return non-@code{nil} when the article in question is to be -pre-fetched. The default is @code{gnus-async-read-p}, which returns -@code{nil} on read articles. The function is called with an article -data structure as the only parameter. - -If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like: +articles, for instance. The @code{gnus-async-prefetch-article-p} +variable controls whether an article is to be pre-fetched. This +function should return non-@code{nil} when the article in question is +to be pre-fetched. The default is @code{gnus-async-read-p}, which +returns @code{nil} on read articles. The function is called with an +article data structure as the only parameter. + +If, for instance, you wish to pre-fetch only unread articles shorter +than 100 lines, you could say something like: @lisp (defun my-async-short-unread-p (data) @@ -6159,7 +7166,7 @@ @cindex article caching @cindex caching -If you have an @emph{extremely} slow @sc{nntp} connection, you may +If you have an @emph{extremely} slow @acronym{NNTP} connection, you may consider turning article caching on. Each article will then be stored locally under your home directory. As you may surmise, this could potentially use @emph{huge} amounts of disk space, as well as eat up all @@ -6200,7 +7207,7 @@ picture? The @code{gnus-jog-cache} command will go through all subscribed newsgroups, request all unread articles, score them, and store them in the cache. You should only ever, ever ever ever, use this -command if 1) your connection to the @sc{nntp} server is really, really, +command if 1) your connection to the @acronym{NNTP} server is really, really, really slow and 2) you have a really, really, really huge disk. Seriously. One way to cut down on the number of articles downloaded is to score unwanted articles down and have them marked as read. They will @@ -6226,10 +7233,14 @@ file (@code{gnus-cache-active-file}). If this file (or any other parts of the cache) becomes all messed up for some reason or other, Gnus offers two functions that will try to set things right. @kbd{M-x -gnus-cache-generate-nov-databases} will (re)build all the @sc{nov} +gnus-cache-generate-nov-databases} will (re)build all the @acronym{NOV} files, and @kbd{gnus-cache-generate-active} will (re)generate the active file. +@findex gnus-cache-move-cache +@code{gnus-cache-move-cache} will move your whole +@code{gnus-cache-directory} to some other location. You get asked to +where, isn't that cool? @node Persistent Articles @section Persistent Articles @@ -6253,12 +7264,12 @@ @table @kbd @item * -@kindex * @r{(Summary)} +@kindex * (Summary) @findex gnus-cache-enter-article Make the current article persistent (@code{gnus-cache-enter-article}). @item M-* -@kindex M-* @r{(Summary)} +@kindex M-* (Summary) @findex gnus-cache-remove-article Remove the current article from the persistent articles (@code{gnus-cache-remove-article}). This will normally delete the @@ -6298,7 +7309,7 @@ bound before exploding and taking your machine down with you. I put that in there just to keep y'all on your toes. -This variable is @code{nil} by default. +The default value is 20. @node Saving Articles @@ -6311,6 +7322,10 @@ approach (uudecoding, unsharing) you should use @code{gnus-uu} (@pxref{Decoding Articles}). +For the commands listed here, the target is a file. If you want to +save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article}) +command (@pxref{Mail Group Commands}). + @vindex gnus-save-all-headers If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete unwanted headers before saving the article. @@ -6324,61 +7339,76 @@ @item O o @itemx o -@kindex O o @r{(Summary)} -@kindex o @r{(Summary)} +@kindex O o (Summary) +@kindex o (Summary) @findex gnus-summary-save-article @c @icon{gnus-summary-save-article} Save the current article using the default article saver (@code{gnus-summary-save-article}). @item O m -@kindex O m @r{(Summary)} +@kindex O m (Summary) @findex gnus-summary-save-article-mail Save the current article in mail format (@code{gnus-summary-save-article-mail}). @item O r -@kindex O r @r{(Summary)} +@kindex O r (Summary) @findex gnus-summary-save-article-rmail -Save the current article in rmail format +Save the current article in Rmail format (@code{gnus-summary-save-article-rmail}). @item O f -@kindex O f @r{(Summary)} +@kindex O f (Summary) @findex gnus-summary-save-article-file @c @icon{gnus-summary-save-article-file} Save the current article in plain file format (@code{gnus-summary-save-article-file}). @item O F -@kindex O F @r{(Summary)} +@kindex O F (Summary) @findex gnus-summary-write-article-file Write the current article in plain file format, overwriting any previous file contents (@code{gnus-summary-write-article-file}). @item O b -@kindex O b @r{(Summary)} +@kindex O b (Summary) @findex gnus-summary-save-article-body-file Save the current article body in plain file format (@code{gnus-summary-save-article-body-file}). @item O h -@kindex O h @r{(Summary)} +@kindex O h (Summary) @findex gnus-summary-save-article-folder Save the current article in mh folder format (@code{gnus-summary-save-article-folder}). @item O v -@kindex O v @r{(Summary)} +@kindex O v (Summary) @findex gnus-summary-save-article-vm Save the current article in a VM folder (@code{gnus-summary-save-article-vm}). @item O p -@kindex O p @r{(Summary)} +@itemx | +@kindex O p (Summary) +@kindex | (Summary) @findex gnus-summary-pipe-output Save the current article in a pipe. Uhm, like, what I mean is---Pipe the current article to a process (@code{gnus-summary-pipe-output}). +If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the +complete headers in the piped output. + +@item O P +@kindex O P (Summary) +@findex gnus-summary-muttprint +@vindex gnus-summary-muttprint-program +Save the current article into muttprint. That is, print it using the +external program @uref{http://muttprint.sourceforge.net/, +Muttprint}. The program name and options to use is controlled by the +variable @code{gnus-summary-muttprint-program}. +(@code{gnus-summary-muttprint}). + @end table @vindex gnus-prompt-before-saving @@ -6407,7 +7437,7 @@ @findex gnus-summary-save-in-rmail @vindex gnus-rmail-save-name @findex gnus-plain-save-name -This is the default format, @dfn{babyl}. Uses the function in the +This is the default format, @dfn{Babyl}. Uses the function in the @code{gnus-rmail-save-name} variable to get a file name to save the article in. The default is @code{gnus-plain-save-name}. @@ -6426,6 +7456,13 @@ the @code{gnus-file-save-name} variable to get a file name to save the article in. The default is @code{gnus-numeric-save-name}. +@item gnus-summary-write-to-file +@findex gnus-summary-write-to-file +Write the article straight to an ordinary file. The file is +overwritten if it exists. Uses the function in the +@code{gnus-file-save-name} variable to get a file name to save the +article in. The default is @code{gnus-numeric-save-name}. + @item gnus-summary-save-body-in-file @findex gnus-summary-save-body-in-file Append the article body to an ordinary file. Uses the function in the @@ -6454,7 +7491,7 @@ @vindex gnus-article-save-directory All of these functions, except for the last one, will save the article in the @code{gnus-article-save-directory}, which is initialized from the -@code{SAVEDIR} environment variable. This is @file{~/News/} by +@env{SAVEDIR} environment variable. This is @file{~/News/} by default. As you can see above, the functions use different functions to find a @@ -6478,13 +7515,17 @@ @item gnus-plain-save-name @findex gnus-plain-save-name File names like @file{~/News/alt.andrea-dworkin}. + +@item gnus-sender-save-name +@findex gnus-sender-save-name +File names like @file{~/News/larsi}. @end table @vindex gnus-split-methods You can have Gnus suggest where to save articles by plonking a regexp into the @code{gnus-split-methods} alist. For instance, if you would like to save articles related to Gnus in the file @file{gnus-stuff}, and articles -related to VM in @code{vm-stuff}, you could set this variable to something +related to VM in @file{vm-stuff}, you could set this variable to something like: @lisp @@ -6553,9 +7594,9 @@ a spool, you could @lisp -(setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy +(setq gnus-use-long-file-name '(not-save)) ; @r{to get a hierarchy} (setq gnus-default-article-saver - 'gnus-summary-save-in-file) ; no encoding + 'gnus-summary-save-in-file) ; @r{no encoding} @end lisp Then just save with @kbd{o}. You'd then read this hierarchy with @@ -6572,12 +7613,12 @@ encoded in some way or other. Gnus can decode them for you. @menu -* Uuencoded Articles:: Uudecode articles. -* Shell Archives:: Unshar articles. -* PostScript Files:: Split PostScript. -* Other Files:: Plain save and binhex. -* Decoding Variables:: Variables for a happy decoding. -* Viewing Files:: You want to look at the result of the decoding? +* Uuencoded Articles:: Uudecode articles. +* Shell Archives:: Unshar articles. +* PostScript Files:: Split PostScript. +* Other Files:: Plain save and binhex. +* Decoding Variables:: Variables for a happy decoding. +* Viewing Files:: You want to look at the result of the decoding? @end menu @cindex series @@ -6609,24 +7650,24 @@ @table @kbd @item X u -@kindex X u @r{(Summary)} +@kindex X u (Summary) @findex gnus-uu-decode-uu @c @icon{gnus-uu-decode-uu} Uudecodes the current series (@code{gnus-uu-decode-uu}). @item X U -@kindex X U @r{(Summary)} +@kindex X U (Summary) @findex gnus-uu-decode-uu-and-save Uudecodes and saves the current series (@code{gnus-uu-decode-uu-and-save}). @item X v u -@kindex X v u @r{(Summary)} +@kindex X v u (Summary) @findex gnus-uu-decode-uu-view Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}). @item X v U -@kindex X v U @r{(Summary)} +@kindex X v U (Summary) @findex gnus-uu-decode-uu-and-save-view Uudecodes, views and saves the current series (@code{gnus-uu-decode-uu-and-save-view}). @@ -6667,22 +7708,22 @@ @table @kbd @item X s -@kindex X s @r{(Summary)} +@kindex X s (Summary) @findex gnus-uu-decode-unshar Unshars the current series (@code{gnus-uu-decode-unshar}). @item X S -@kindex X S @r{(Summary)} +@kindex X S (Summary) @findex gnus-uu-decode-unshar-and-save Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}). @item X v s -@kindex X v s @r{(Summary)} +@kindex X v s (Summary) @findex gnus-uu-decode-unshar-view Unshars and views the current series (@code{gnus-uu-decode-unshar-view}). @item X v S -@kindex X v S @r{(Summary)} +@kindex X v S (Summary) @findex gnus-uu-decode-unshar-and-save-view Unshars, views and saves the current series (@code{gnus-uu-decode-unshar-and-save-view}). @@ -6696,24 +7737,24 @@ @table @kbd @item X p -@kindex X p @r{(Summary)} +@kindex X p (Summary) @findex gnus-uu-decode-postscript Unpack the current PostScript series (@code{gnus-uu-decode-postscript}). @item X P -@kindex X P @r{(Summary)} +@kindex X P (Summary) @findex gnus-uu-decode-postscript-and-save Unpack and save the current PostScript series (@code{gnus-uu-decode-postscript-and-save}). @item X v p -@kindex X v p @r{(Summary)} +@kindex X v p (Summary) @findex gnus-uu-decode-postscript-view View the current PostScript series (@code{gnus-uu-decode-postscript-view}). @item X v P -@kindex X v P @r{(Summary)} +@kindex X v P (Summary) @findex gnus-uu-decode-postscript-and-save-view View and save the current PostScript series (@code{gnus-uu-decode-postscript-and-save-view}). @@ -6725,13 +7766,13 @@ @table @kbd @item X o -@kindex X o @r{(Summary)} +@kindex X o (Summary) @findex gnus-uu-decode-save Save the current series (@code{gnus-uu-decode-save}). @item X b -@kindex X b @r{(Summary)} +@kindex X b (Summary) @findex gnus-uu-decode-binhex Unbinhex the current series (@code{gnus-uu-decode-binhex}). This doesn't really work yet. @@ -6744,9 +7785,9 @@ Adjective, not verb. @menu -* Rule Variables:: Variables that say how a file is to be viewed. -* Other Decode Variables:: Other decode variables. -* Uuencoding and Posting:: Variables for customizing uuencoding. +* Rule Variables:: Variables that say how a file is to be viewed. +* Other Decode Variables:: Other decode variables. +* Uuencoding and Posting:: Variables for customizing uuencoding. @end menu @@ -6769,7 +7810,7 @@ @vindex gnus-uu-user-view-rules @cindex sox This variable is consulted first when viewing files. If you wish to use, -for instance, @code{sox} to convert an @samp{.au} sound file, you could +for instance, @code{sox} to convert an @file{.au} sound file, you could say something like: @lisp (setq gnus-uu-user-view-rules @@ -6824,9 +7865,9 @@ @item gnus-uu-ignore-files-by-type @vindex gnus-uu-ignore-files-by-type -Files with a @sc{mime} type matching this variable won't be viewed. +Files with a @acronym{MIME} type matching this variable won't be viewed. Note that Gnus tries to guess what type the file is based on the name. -@code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly +@code{gnus-uu} is not a @acronym{MIME} package (yet), so this is slightly kludgey. @item gnus-uu-tmp-dir @@ -6876,7 +7917,7 @@ @vindex gnus-uu-view-with-metamail @cindex metamail Non-@code{nil} means that @code{gnus-uu} will ignore the viewing -commands defined by the rule variables and just fudge a @sc{mime} +commands defined by the rule variables and just fudge a @acronym{MIME} content type based on the file name. The result will be fed to @code{metamail} for viewing. @@ -6915,7 +7956,7 @@ thread. This may not be smart, as no other decoder I have seen is able to follow threads when collecting uuencoded articles. (Well, I have seen one package that does that---@code{gnus-uu}, but somehow, I don't -think that counts...) Default is @code{nil}. +think that counts@dots{}) Default is @code{nil}. @item gnus-uu-post-separate-description @vindex gnus-uu-post-separate-description @@ -6981,14 +8022,17 @@ these articles easier. @menu -* Article Highlighting:: You want to make the article look like fruit salad. -* Article Fontisizing:: Making emphasized text look nice. -* Article Hiding:: You also want to make certain info go away. -* Article Washing:: Lots of way-neat functions to make life better. -* Article Buttons:: Click on URLs, Message-IDs, addresses and the like. -* Article Date:: Grumble, UT! -* Article Signature:: What is a signature? -* Article Miscellanea:: Various other stuff. +* Article Highlighting:: You want to make the article look like fruit salad. +* Article Fontisizing:: Making emphasized text look nice. +* Article Hiding:: You also want to make certain info go away. +* Article Washing:: Lots of way-neat functions to make life better. +* Article Header:: Doing various header transformations. +* Article Buttons:: Click on URLs, Message-IDs, addresses and the like. +* Article Button Levels:: Controlling appearance of buttons. +* Article Date:: Grumble, UT! +* Article Display:: Display various stuff---X-Face, Picons, Smileys +* Article Signature:: What is a signature? +* Article Miscellanea:: Various other stuff. @end menu @@ -7002,7 +8046,7 @@ @table @kbd @item W H a -@kindex W H a @r{(Summary)} +@kindex W H a (Summary) @findex gnus-article-highlight @findex gnus-article-maybe-highlight Do much highlighting of the current article @@ -7010,7 +8054,7 @@ text, the signature, and adds buttons to the body and the head. @item W H h -@kindex W H h @r{(Summary)} +@kindex W H h (Summary) @findex gnus-article-highlight-headers @vindex gnus-header-face-alist Highlight the headers (@code{gnus-article-highlight-headers}). The @@ -7024,7 +8068,7 @@ @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one. @item W H c -@kindex W H c @r{(Summary)} +@kindex W H c (Summary) @findex gnus-article-highlight-citation Highlight cited text (@code{gnus-article-highlight-citation}). @@ -7037,10 +8081,6 @@ If the article size if bigger than this variable (which is 25000 by default), no citation highlighting will be performed. -@item gnus-cite-prefix-regexp -@vindex gnus-cite-prefix-regexp -Regexp matching the longest possible citation prefix on a line. - @item gnus-cite-max-prefix @vindex gnus-cite-max-prefix Maximum possible length for a citation prefix (default 20). @@ -7082,7 +8122,7 @@ @item W H s -@kindex W H s @r{(Summary)} +@kindex W H s (Summary) @vindex gnus-signature-separator @vindex gnus-signature-face @findex gnus-article-highlight-signature @@ -7103,7 +8143,7 @@ @cindex article emphasis @findex gnus-article-emphasize -@kindex W e @r{(Summary)} +@kindex W e (Summary) People commonly add emphasis to words in news articles by writing things like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make this look nicer by running the article through the @kbd{W e} @@ -7120,7 +8160,7 @@ highlighting. @lisp -(setq gnus-article-emphasis +(setq gnus-emphasis-alist '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline) ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold))) @end lisp @@ -7174,38 +8214,38 @@ @table @kbd @item W W a -@kindex W W a @r{(Summary)} +@kindex W W a (Summary) @findex gnus-article-hide Do quite a lot of hiding on the article buffer (@kbd{gnus-article-hide}). In particular, this function will hide -headers, PGP, cited text and the signature. +headers, @acronym{PGP}, cited text and the signature. @item W W h -@kindex W W h @r{(Summary)} +@kindex W W h (Summary) @findex gnus-article-hide-headers Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding Headers}. @item W W b -@kindex W W b @r{(Summary)} +@kindex W W b (Summary) @findex gnus-article-hide-boring-headers Hide headers that aren't particularly interesting (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}. @item W W s -@kindex W W s @r{(Summary)} +@kindex W W s (Summary) @findex gnus-article-hide-signature Hide signature (@code{gnus-article-hide-signature}). @xref{Article Signature}. @item W W l -@kindex W W l @r{(Summary)} +@kindex W W l (Summary) @findex gnus-article-hide-list-identifiers @vindex gnus-list-identifiers Strip list identifiers specified in @code{gnus-list-identifiers}. These are strings some mailing list servers add to the beginning of all @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading -@samp{Re: } is skipped before stripping. @code{gnus-list-identifiers} +@samp{Re: } is skipped before stripping. @code{gnus-list-identifiers} may not contain @code{\\(..\\)}. @table @code @@ -7217,38 +8257,17 @@ @end table -@item W W p -@kindex W W p @r{(Summary)} -@findex gnus-article-hide-pgp -@vindex gnus-article-hide-pgp-hook -Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). The -@code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp} -signature has been hidden. For example, to automatically verify -articles that have signatures in them do: -@lisp -;;; Hide pgp cruft if any. - -(setq gnus-treat-strip-pgp t) - -;;; After hiding pgp, verify the message; -;;; only happens if pgp signature is found. - -(add-hook 'gnus-article-hide-pgp-hook - (lambda () - (save-excursion - (set-buffer gnus-original-article-buffer) - (mc-verify)))) -@end lisp - @item W W P -@kindex W W P @r{(Summary)} +@kindex W W P (Summary) @findex gnus-article-hide-pem -Hide @sc{pem} (privacy enhanced messages) cruft +Hide @acronym{PEM} (privacy enhanced messages) cruft (@code{gnus-article-hide-pem}). @item W W B -@kindex W W B @r{(Summary)} +@kindex W W B (Summary) @findex gnus-article-strip-banner +@vindex gnus-article-banner-alist +@vindex gnus-article-address-banner-alist @cindex banner @cindex OneList @cindex stripping advertisements @@ -7265,8 +8284,33 @@ corresponding regular expression in @code{gnus-article-banner-alist} is used. +Regardless of a group, you can hide things like advertisements only when +the sender of an article has a certain mail address specified in +@code{gnus-article-address-banner-alist}. + +@table @code + +@item gnus-article-address-banner-alist +@vindex gnus-article-address-banner-alist +Alist of mail addresses and banners. Each element has the form +@code{(@var{address} . @var{banner})}, where @var{address} is a regexp +matching a mail address in the From header, @var{banner} is one of a +symbol @code{signature}, an item in @code{gnus-article-banner-alist}, +a regexp and @code{nil}. If @var{address} matches author's mail +address, it will remove things like advertisements. For example, if a +sender has the mail address @samp{hail@@yoo-hoo.co.jp} and there is a +banner something like @samp{Do You Yoo-hoo!?} in all articles he +sends, you can use the following element to remove them: + +@lisp +("@@yoo-hoo\\.co\\.jp\\'" . + "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n") +@end lisp + +@end table + @item W W c -@kindex W W c @r{(Summary)} +@kindex W W c (Summary) @findex gnus-article-hide-citation Hide citation (@code{gnus-article-hide-citation}). Some variables for customizing the hiding: @@ -7296,13 +8340,13 @@ @item gnus-cited-lines-visible @vindex gnus-cited-lines-visible The number of lines at the beginning of the cited text to leave -shown. This can also be a cons cell with the number of lines at the top +shown. This can also be a cons cell with the number of lines at the top and bottom of the text, respectively, to remain visible. @end table @item W W C-c -@kindex W W C-c @r{(Summary)} +@kindex W W C-c (Summary) @findex gnus-article-hide-citation-maybe Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the @@ -7321,7 +8365,7 @@ @end table @item W W C -@kindex W W C @r{(Summary)} +@kindex W W C (Summary) @findex gnus-article-hide-citation-in-followups Hide cited text in articles that aren't roots (@code{gnus-article-hide-citation-in-followups}). This isn't very @@ -7363,15 +8407,22 @@ you type this, you see the article exactly as it exists on disk or on the server. +@item g +Force redisplaying of the current article +(@code{gnus-summary-show-article}). This is also not really washing. +If you type this, you see the article without any previously applied +interactive Washing functions but with all default treatments +(@pxref{Customizing Articles}). + @item W l -@kindex W l @r{(Summary)} +@kindex W l (Summary) @findex gnus-summary-stop-page-breaking Remove page breaks from the current article (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page delimiters. @item W r -@kindex W r @r{(Summary)} +@kindex W r (Summary) @findex gnus-summary-caesar-message @c @icon{gnus-summary-caesar-message} Do a Caesar rotate (rot13) on the article buffer @@ -7379,51 +8430,87 @@ Unreadable articles that tell you to read them with Caesar rotate or rot13. (Typically offensive jokes and such.) -It's commonly called @dfn{rot13} because each letter is rotated 13 +It's commonly called ``rot13'' because each letter is rotated 13 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter #15). It is sometimes referred to as ``Caesar rotate'' because Caesar is rumored to have employed this form of, uh, somewhat weak encryption. +@item W m +@kindex W m (Summary) +@findex gnus-summary-morse-message +Morse decode the article buffer (@code{gnus-summary-morse-message}). + @item W t @item t -@kindex W t @r{(Summary)} -@kindex t @r{(Summary)} +@kindex W t (Summary) +@kindex t (Summary) @findex gnus-summary-toggle-header Toggle whether to display all headers in the article buffer (@code{gnus-summary-toggle-header}). @item W v -@kindex W v @r{(Summary)} -@findex gnus-summary-verbose-header +@kindex W v (Summary) +@findex gnus-summary-verbose-headers Toggle whether to display all headers in the article buffer permanently -(@code{gnus-summary-verbose-header}). +(@code{gnus-summary-verbose-headers}). @item W o -@kindex W o @r{(Summary)} +@kindex W o (Summary) @findex gnus-article-treat-overstrike Treat overstrike (@code{gnus-article-treat-overstrike}). @item W d -@kindex W d @r{(Summary)} +@kindex W d (Summary) @findex gnus-article-treat-dumbquotes @vindex gnus-article-dumbquotes-map @cindex Smartquotes -@cindex M******** sm*rtq**t*s +@cindex M****s*** sm*rtq**t*s @cindex Latin 1 -Treat M******** sm*rtq**t*s according to +Treat M****s*** sm*rtq**t*s according to @code{gnus-article-dumbquotes-map} (@code{gnus-article-treat-dumbquotes}). Note that this function guesses whether a character is a sm*rtq**t* or not, so it should only be used interactively. -In reality, this function is translates a subset of the subset of the -@code{cp1252} (or @code{Windows-1252}) character set that isn't in ISO -Latin-1, including the quote characters @code{\222} and @code{\264}. -Messages in this character set often have a MIME header saying that -they are Latin-1. +Sm*rtq**t*s are M****s***'s unilateral extension to the character map in +an attempt to provide more quoting characters. If you see something +like @code{\222} or @code{\264} where you're expecting some kind of +apostrophe or quotation mark, then try this wash. + +@item W Y f +@kindex W Y f (Summary) +@findex gnus-article-outlook-deuglify-article +@cindex Outlook Express +Full deuglify of broken Outlook (Express) articles: Treat dumbquotes, +unwrap lines, repair attribution and rearrange citation. +(@code{gnus-article-outlook-deuglify-article}). + +@item W Y u +@kindex W Y u (Summary) +@findex gnus-article-outlook-unwrap-lines +@vindex gnus-outlook-deuglify-unwrap-min +@vindex gnus-outlook-deuglify-unwrap-max +Unwrap lines that appear to be wrapped citation lines. You can control +what lines will be unwrapped by frobbing +@code{gnus-outlook-deuglify-unwrap-min} and +@code{gnus-outlook-deuglify-unwrap-max}, indicating the minimum and +maximum length of an unwrapped citation line. +(@code{gnus-article-outlook-unwrap-lines}). + +@item W Y a +@kindex W Y a (Summary) +@findex gnus-article-outlook-repair-attribution +Repair a broken attribution line.@* +(@code{gnus-article-outlook-repair-attribution}). + +@item W Y c +@kindex W Y c (Summary) +@findex gnus-article-outlook-rearrange-citation +Repair broken citations by rearranging the text. +(@code{gnus-article-outlook-rearrange-citation}). @item W w -@kindex W w @r{(Summary)} +@kindex W w (Summary) @findex gnus-article-fill-cited-article Do word wrap (@code{gnus-article-fill-cited-article}). @@ -7431,18 +8518,18 @@ when filling. @item W Q -@kindex W Q @r{(Summary)} +@kindex W Q (Summary) @findex gnus-article-fill-long-lines Fill long lines (@code{gnus-article-fill-long-lines}). @item W C -@kindex W C @r{(Summary)} +@kindex W C (Summary) @findex gnus-article-capitalize-sentences Capitalize the first word in each sentence (@code{gnus-article-capitalize-sentences}). @item W c -@kindex W c @r{(Summary)} +@kindex W c (Summary) @findex gnus-article-remove-cr Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF (this takes care of DOS line endings), and then translate any remaining @@ -7450,133 +8537,152 @@ (@code{gnus-article-remove-cr}). @item W q -@kindex W q @r{(Summary)} +@kindex W q (Summary) @findex gnus-article-de-quoted-unreadable Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}). -Quoted-Printable is one common @sc{mime} encoding employed when sending -non-ASCII (i. e., 8-bit) articles. It typically makes strings like -@samp{déjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very -readable to me. Note that the this is usually done automatically by -Gnus if the message in question has a @code{Content-Transfer-Encoding} -header that says that this encoding has been done. +Quoted-Printable is one common @acronym{MIME} encoding employed when +sending non-@acronym{ASCII} (i.e., 8-bit) articles. It typically +makes strings like @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which +doesn't look very readable to me. Note that this is usually done +automatically by Gnus if the message in question has a +@code{Content-Transfer-Encoding} header that says that this encoding +has been done. If a prefix is given, a charset will be asked for. @item W 6 -@kindex W 6 @r{(Summary)} +@kindex W 6 (Summary) @findex gnus-article-de-base64-unreadable -Treat base64 (@code{gnus-article-de-base64-unreadable}). -Base64 is one common @sc{mime} encoding employed when sending non-ASCII -(i. e., 8-bit) articles. Note that the this is usually done -automatically by Gnus if the message in question has a -@code{Content-Transfer-Encoding} header that says that this encoding has -been done. +Treat base64 (@code{gnus-article-de-base64-unreadable}). Base64 is +one common @acronym{MIME} encoding employed when sending +non-@acronym{ASCII} (i.e., 8-bit) articles. Note that this is +usually done automatically by Gnus if the message in question has a +@code{Content-Transfer-Encoding} header that says that this encoding +has been done. If a prefix is given, a charset will be asked for. @item W Z -@kindex W Z @r{(Summary)} +@kindex W Z (Summary) @findex gnus-article-decode-HZ Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one common encoding employed when sending Chinese articles. It typically makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}. +@item W u +@kindex W u (Summary) +@findex gnus-article-unsplit-urls +Remove newlines from within URLs. Some mailers insert newlines into +outgoing email messages to keep lines short. This reformatting can +split long URLs onto multiple lines. Repair those URLs by removing +the newlines (@code{gnus-article-unsplit-urls}). + @item W h -@kindex W h @r{(Summary)} +@kindex W h (Summary) @findex gnus-article-wash-html -Treat HTML (@code{gnus-article-wash-html}). -Note that the this is usually done automatically by Gnus if the message -in question has a @code{Content-Type} header that says that this type -has been done. - -@item W f -@kindex W f @r{(Summary)} -@cindex x-face -@findex gnus-article-display-x-face -@findex gnus-article-x-face-command -@vindex gnus-article-x-face-command -@vindex gnus-article-x-face-too-ugly -@iftex -@iflatex -\include{xface} -@end iflatex -@end iftex -@anchor{X-Face} -Look for and display any X-Face headers -(@code{gnus-article-display-x-face}). The command executed by this -function is given by the @code{gnus-article-x-face-command} variable. -If this variable is a string, this string will be executed in a -sub-shell. If it is a function, this function will be called with the -face as the argument. If the @code{gnus-article-x-face-too-ugly} (which -is a regexp) matches the @code{From} header, the face will not be shown. -The default action under Emacs is to fork off the @code{display} -program@footnote{@code{display} is from the ImageMagick package. For the -@code{uncompface} and @code{icontopbm} programs look for a package -like `compface' or `faces-xface' on a GNU/Linux system.} -to view the face. Under XEmacs or Emacs 21+ with suitable image -support, the default action is to display the face before the -@code{From} header. (It's nicer if XEmacs has been compiled with X-Face -support---that will make display somewhat faster. If there's no native -X-Face support, Gnus will try to convert the @code{X-Face} header using -external programs from the @code{pbmplus} package and -friends.@footnote{On a GNU/Linux system look for packages with names -like @code{netpbm} or @code{libgr-progs}.}) If you -want to have this function in the display hook, it should probably come -last. +Treat @acronym{HTML} (@code{gnus-article-wash-html}). Note that this is +usually done automatically by Gnus if the message in question has a +@code{Content-Type} header that says that the message is @acronym{HTML}. + +If a prefix is given, a charset will be asked for. + +@vindex gnus-article-wash-function +The default is to use the function specified by +@code{mm-text-html-renderer} (@pxref{Display Customization, ,Display +Customization, emacs-mime, The Emacs MIME Manual}) to convert the +@acronym{HTML}, but this is controlled by the +@code{gnus-article-wash-function} variable. Pre-defined functions you +can use include: + +@table @code +@item w3 +Use Emacs/w3. + +@item w3m +Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}. + +@item links +Use @uref{http://links.sf.net/, Links}. + +@item lynx +Use @uref{http://lynx.isc.org/, Lynx}. + +@item html2text +Use html2text---a simple @acronym{HTML} converter included with Gnus. + +@end table @item W b -@kindex W b @r{(Summary)} +@kindex W b (Summary) @findex gnus-article-add-buttons Add clickable buttons to the article (@code{gnus-article-add-buttons}). @xref{Article Buttons}. @item W B -@kindex W B @r{(Summary)} +@kindex W B (Summary) @findex gnus-article-add-buttons-to-head Add clickable buttons to the article headers (@code{gnus-article-add-buttons-to-head}). -@item W W H -@kindex W W H @r{(Summary)} -@findex gnus-article-strip-headers-from-body +@item W p +@kindex W p (Summary) +@findex gnus-article-verify-x-pgp-sig +Verify a signed control message +(@code{gnus-article-verify-x-pgp-sig}). Control messages such as +@code{newgroup} and @code{checkgroups} are usually signed by the +hierarchy maintainer. You need to add the @acronym{PGP} public key of +the maintainer to your keyring to verify the +message.@footnote{@acronym{PGP} keys for many hierarchies are +available at @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}} + +@item W s +@kindex W s (Summary) +@findex gnus-summary-force-verify-and-decrypt +Verify a signed (@acronym{PGP}, @acronym{PGP/MIME} or +@acronym{S/MIME}) message +(@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}. + +@item W a +@kindex W a (Summary) +@findex gnus-article-strip-headers-in-body Strip headers like the @code{X-No-Archive} header from the beginning of -article bodies (@code{gnus-article-strip-headers-from-body}). +article bodies (@code{gnus-article-strip-headers-in-body}). @item W E l -@kindex W E l @r{(Summary)} +@kindex W E l (Summary) @findex gnus-article-strip-leading-blank-lines Remove all blank lines from the beginning of the article (@code{gnus-article-strip-leading-blank-lines}). @item W E m -@kindex W E m @r{(Summary)} +@kindex W E m (Summary) @findex gnus-article-strip-multiple-blank-lines Replace all blank lines with empty lines and then all multiple empty lines with a single empty line. (@code{gnus-article-strip-multiple-blank-lines}). @item W E t -@kindex W E t @r{(Summary)} +@kindex W E t (Summary) @findex gnus-article-remove-trailing-blank-lines Remove all blank lines at the end of the article (@code{gnus-article-remove-trailing-blank-lines}). @item W E a -@kindex W E a @r{(Summary)} +@kindex W E a (Summary) @findex gnus-article-strip-blank-lines Do all the three commands above (@code{gnus-article-strip-blank-lines}). @item W E A -@kindex W E A @r{(Summary)} +@kindex W E A (Summary) @findex gnus-article-strip-all-blank-lines Remove all blank lines (@code{gnus-article-strip-all-blank-lines}). @item W E s -@kindex W E s @r{(Summary)} +@kindex W E s (Summary) @findex gnus-article-strip-leading-space Remove all white space from the beginning of all lines of the article body (@code{gnus-article-strip-leading-space}). @item W E e -@kindex W E e @r{(Summary)} +@kindex W E e (Summary) @findex gnus-article-strip-trailing-space Remove all white space from the end of all lines of the article body (@code{gnus-article-strip-trailing-space}). @@ -7586,19 +8692,53 @@ @xref{Customizing Articles}, for how to wash articles automatically. +@node Article Header +@subsection Article Header + +These commands perform various transformations of article header. + +@table @kbd + +@item W G u +@kindex W G u (Summary) +@findex gnus-article-treat-unfold-headers +Unfold folded header lines (@code{gnus-article-treat-unfold-headers}). + +@item W G n +@kindex W G n (Summary) +@findex gnus-article-treat-fold-newsgroups +Fold the @code{Newsgroups} and @code{Followup-To} headers +(@code{gnus-article-treat-fold-newsgroups}). + +@item W G f +@kindex W G f (Summary) +@findex gnus-article-treat-fold-headers +Fold all the message headers +(@code{gnus-article-treat-fold-headers}). + +@item W E w +@kindex W E w (Summary) +@findex gnus-article-remove-leading-whitespace +Remove excessive whitespace from all headers +(@code{gnus-article-remove-leading-whitespace}). + +@end table + + @node Article Buttons @subsection Article Buttons @cindex buttons People often include references to other stuff in articles, and it would be nice if Gnus could just fetch whatever it is that people talk about -with the minimum of fuzz when you hit @key{RET} or use the middle mouse +with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse button on these references. +@vindex gnus-button-man-handler Gnus adds @dfn{buttons} to certain standard references by default: -Well-formed URLs, mail addresses and Message-IDs. This is controlled by -two variables, one that handles article bodies and one that handles -article heads: +Well-formed URLs, mail addresses, Message-IDs, Info links, man pages and +Emacs or Gnus related references. This is controlled by two variables, +one that handles article bodies and one that handles article heads: @table @code @@ -7607,15 +8747,17 @@ This is an alist where each entry has this form: @lisp -(REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR) +(@var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par}) @end lisp @table @var @item regexp -All text that match this regular expression will be considered an -external reference. Here's a typical regexp that matches embedded URLs: -@samp{]*\\)>}. +All text that match this regular expression (case insensitive) will be +considered an external reference. Here's a typical regexp that matches +embedded URLs: @samp{]*\\)>}. This can also be a +variable containing a regexp, useful variables to use include +@code{gnus-button-url-regexp} and @code{gnus-button-mid-or-mail-regexp}. @item button-par Gnus has to know which parts of the matches is to be highlighted. This @@ -7625,7 +8767,11 @@ @item use-p This form will be @code{eval}ed, and if the result is non-@code{nil}, this is considered a match. This is useful if you want extra sifting to -avoid false matches. +avoid false matches. Often variables named +@code{gnus-button-@var{*}-level} are used here, @xref{Article Button +Levels}, but any other form may be used too. + +@c @code{use-p} is @code{eval}ed only if @code{regexp} matches. @item function This function will be called when you click on this button. @@ -7649,16 +8795,77 @@ used to say what headers to apply the buttonize coding to: @lisp -(HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR) +(@var{header} @var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par}) @end lisp @var{header} is a regular expression. +@end table + +@subsubsection Related variables and functions + +@table @code +@item gnus-button-@var{*}-level +@xref{Article Button Levels}. + +@c Stuff related to gnus-button-browse-level @item gnus-button-url-regexp @vindex gnus-button-url-regexp A regular expression that matches embedded URLs. It is used in the default values of the variables above. +@c Stuff related to gnus-button-man-level + +@item gnus-button-man-handler +@vindex gnus-button-man-handler +The function to use for displaying man pages. It must take at least one +argument with a string naming the man page. + +@c Stuff related to gnus-button-message-level + +@item gnus-button-mid-or-mail-regexp +@vindex gnus-button-mid-or-mail-regexp +Regular expression that matches a message ID or a mail address. + +@item gnus-button-prefer-mid-or-mail +@vindex gnus-button-prefer-mid-or-mail +This variable determines what to do when the button on a string as +@samp{foo123@@bar.invalid} is pushed. Strings like this can be either a +message ID or a mail address. If it is one of the symbols @code{mid} or +@code{mail}, Gnus will always assume that the string is a message ID or +a mail address, respectively. If this variable is set to the symbol +@code{ask}, always query the user what do do. If it is a function, this +function will be called with the string as its only argument. The +function must return @code{mid}, @code{mail}, @code{invalid} or +@code{ask}. The default value is the function +@code{gnus-button-mid-or-mail-heuristic}. + +@item gnus-button-mid-or-mail-heuristic +@findex gnus-button-mid-or-mail-heuristic +Function that guesses whether its argument is a message ID or a mail +address. Returns @code{mid} if it's a message IDs, @code{mail} if +it's a mail address, @code{ask} if unsure and @code{invalid} if the +string is invalid. + +@item gnus-button-mid-or-mail-heuristic-alist +@vindex gnus-button-mid-or-mail-heuristic-alist +An alist of @code{(RATE . REGEXP)} pairs used by the function +@code{gnus-button-mid-or-mail-heuristic}. + +@c Stuff related to gnus-button-tex-level + +@item gnus-button-ctan-handler +@findex gnus-button-ctan-handler +The function to use for displaying CTAN links. It must take one +argument, the string naming the URL. + +@item gnus-ctan-url +@vindex gnus-ctan-url +Top directory of a CTAN (Comprehensive TeX Archive Network) archive used +by @code{gnus-button-ctan-handler}. + +@c Misc stuff + @item gnus-article-button-face @vindex gnus-article-button-face Face used on buttons. @@ -7672,6 +8879,74 @@ @xref{Customizing Articles}, for how to buttonize articles automatically. +@node Article Button Levels +@subsection Article button levels +@cindex button levels +The higher the value of the variables @code{gnus-button-@var{*}-level}, +the more buttons will appear. If the level is zero, no corresponding +buttons are displayed. With the default value (which is 5) you should +already see quite a lot of buttons. With higher levels, you will see +more buttons, but you may also get more false positives. To avoid them, +you can set the variables @code{gnus-button-@var{*}-level} local to +specific groups (@pxref{Group Parameters}). Here's an example for the +variable @code{gnus-parameters}: + +@lisp +;; @r{increase @code{gnus-button-*-level} in some groups:} +(setq gnus-parameters + '(("\\<\\(emacs\\|gnus\\)\\>" (gnus-button-emacs-level 10)) + ("\\" (gnus-button-man-level 10)) + ("\\" (gnus-button-tex-level 10)))) +@end lisp + +@table @code + +@item gnus-button-browse-level +@vindex gnus-button-browse-level +Controls the display of references to message IDs, mail addresses and +news URLs. Related variables and functions include +@code{gnus-button-url-regexp}, @code{browse-url}, and +@code{browse-url-browser-function}. + +@item gnus-button-emacs-level +@vindex gnus-button-emacs-level +Controls the display of Emacs or Gnus references. Related functions are +@code{gnus-button-handle-custom}, +@code{gnus-button-handle-describe-function}, +@code{gnus-button-handle-describe-variable}, +@code{gnus-button-handle-symbol}, +@code{gnus-button-handle-describe-key}, +@code{gnus-button-handle-apropos}, +@code{gnus-button-handle-apropos-command}, +@code{gnus-button-handle-apropos-variable}, +@code{gnus-button-handle-apropos-documentation}, and +@code{gnus-button-handle-library}. + +@item gnus-button-man-level +@vindex gnus-button-man-level +Controls the display of references to (Unix) man pages. +See @code{gnus-button-man-handler}. + +@item gnus-button-message-level +@vindex gnus-button-message-level +Controls the display of message IDs, mail addresses and news URLs. +Related variables and functions include +@code{gnus-button-mid-or-mail-regexp}, +@code{gnus-button-prefer-mid-or-mail}, +@code{gnus-button-mid-or-mail-heuristic}, and +@code{gnus-button-mid-or-mail-heuristic-alist}. + +@item gnus-button-tex-level +@vindex gnus-button-tex-level +Controls the display of references to @TeX{} or LaTeX stuff, e.g. for CTAN +URLs. See the variables @code{gnus-ctan-url}, +@code{gnus-button-ctan-handler}, +@code{gnus-button-ctan-directory-regexp}, and +@code{gnus-button-handle-ctan-bogus-regexp}. + +@end table + + @node Article Date @subsection Article Date @@ -7682,25 +8957,31 @@ @table @kbd @item W T u -@kindex W T u @r{(Summary)} +@kindex W T u (Summary) @findex gnus-article-date-ut Display the date in UT (aka. GMT, aka ZULU) (@code{gnus-article-date-ut}). @item W T i -@kindex W T i @r{(Summary)} +@kindex W T i (Summary) @findex gnus-article-date-iso8601 @cindex ISO 8601 Display the date in international format, aka. ISO 8601 (@code{gnus-article-date-iso8601}). @item W T l -@kindex W T l @r{(Summary)} +@kindex W T l (Summary) @findex gnus-article-date-local Display the date in the local timezone (@code{gnus-article-date-local}). +@item W T p +@kindex W T p (Summary) +@findex gnus-article-date-english +Display the date in a format that's easily pronounceable in English +(@code{gnus-article-date-english}). + @item W T s -@kindex W T s @r{(Summary)} +@kindex W T s (Summary) @vindex gnus-article-time-format @findex gnus-article-date-user @findex format-time-string @@ -7711,7 +8992,7 @@ for a list of possible format specs. @item W T e -@kindex W T e @r{(Summary)} +@kindex W T e (Summary) @findex gnus-article-date-lapsed @findex gnus-start-date-timer @findex gnus-stop-date-timer @@ -7722,6 +9003,7 @@ X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago @end example +@vindex gnus-article-date-lapsed-new-header The value of @code{gnus-article-date-lapsed-new-header} determines whether this header will just be added below the old Date one, or will replace it. @@ -7735,12 +9017,12 @@ (gnus-start-date-timer) @end lisp -in your @file{.gnus.el} file, or you can run it off of some hook. If +in your @file{~/.gnus.el} file, or you can run it off of some hook. If you want to stop the timer, you can use the @code{gnus-stop-date-timer} command. @item W T o -@kindex W T o @r{(Summary)} +@kindex W T o (Summary) @findex gnus-article-date-original Display the original date (@code{gnus-article-date-original}). This can be useful if you normally use some other conversion function and are @@ -7754,6 +9036,75 @@ preferred format automatically. +@node Article Display +@subsection Article Display +@cindex picons +@cindex x-face +@cindex smileys + +These commands add various frivolous display gimmicks to the article +buffer in Emacs versions that support them. + +@code{X-Face} headers are small black-and-white images supplied by the +message headers (@pxref{X-Face}). + +@code{Face} headers are small colored images supplied by the message +headers (@pxref{Face}). + +Smileys are those little @samp{:-)} symbols that people like to litter +their messages with (@pxref{Smileys}). + +Picons, on the other hand, reside on your own system, and Gnus will +try to match the headers to what you have (@pxref{Picons}). + +All these functions are toggles---if the elements already exist, +they'll be removed. + +@table @kbd +@item W D x +@kindex W D x (Summary) +@findex gnus-article-display-x-face +Display an @code{X-Face} in the @code{From} header. +(@code{gnus-article-display-x-face}). + +@item W D d +@kindex W D d (Summary) +@findex gnus-article-display-face +Display a @code{Face} in the @code{From} header. +(@code{gnus-article-display-face}). + +@item W D s +@kindex W D s (Summary) +@findex gnus-treat-smiley +Display smileys (@code{gnus-treat-smiley}). + +@item W D f +@kindex W D f (Summary) +@findex gnus-treat-from-picon +Piconify the @code{From} header (@code{gnus-treat-from-picon}). + +@item W D m +@kindex W D m (Summary) +@findex gnus-treat-mail-picon +Piconify all mail headers (i. e., @code{Cc}, @code{To}) +(@code{gnus-treat-mail-picon}). + +@item W D n +@kindex W D n (Summary) +@findex gnus-treat-newsgroups-picon +Piconify all news headers (i. e., @code{Newsgroups} and +@code{Followup-To}) (@code{gnus-treat-newsgroups-picon}). + +@item W D D +@kindex W D D (Summary) +@findex gnus-article-remove-images +Remove all images from the article buffer +(@code{gnus-article-remove-images}). + +@end table + + + @node Article Signature @subsection Article Signature @cindex signatures @@ -7771,13 +9122,13 @@ @lisp (setq gnus-signature-separator - '("^-- $" ; The standard - "^-- *$" ; A common mangling - "^-------*$" ; Many people just use a looong - ; line of dashes. Shame! - "^ *--------*$" ; Double-shame! - "^________*$" ; Underscores are also popular - "^========*$")) ; Pervert! + '("^-- $" ; @r{The standard} + "^-- *$" ; @r{A common mangling} + "^-------*$" ; @r{Many people just use a looong} + ; @r{line of dashes. Shame!} + "^ *--------*$" ; @r{Double-shame!} + "^________*$" ; @r{Underscores are also popular} + "^========*$")) ; @r{Pervert!} @end lisp The more permissive you are, the more likely it is that you'll get false @@ -7821,7 +9172,7 @@ @table @kbd @item A t -@kindex A t @r{(Summary)} +@kindex A t (Summary) @findex gnus-article-babel Translate the article from one language to another (@code{gnus-article-babel}). @@ -7830,54 +9181,54 @@ @node MIME Commands -@section @sc{mime} Commands +@section MIME Commands @cindex MIME decoding @cindex attachments @cindex viewing attachments The following commands all understand the numerical prefix. For -instance, @kbd{3 b} means ``view the third @sc{mime} part''. +instance, @kbd{3 b} means ``view the third @acronym{MIME} part''. @table @kbd @item b @itemx K v -@kindex b @r{(Summary)} -@kindex K v @r{(Summary)} -View the @sc{mime} part. +@kindex b (Summary) +@kindex K v (Summary) +View the @acronym{MIME} part. @item K o -@kindex K o @r{(Summary)} -Save the @sc{mime} part. +@kindex K o (Summary) +Save the @acronym{MIME} part. @item K c -@kindex K c @r{(Summary)} -Copy the @sc{mime} part. +@kindex K c (Summary) +Copy the @acronym{MIME} part. @item K e -@kindex K e @r{(Summary)} -View the @sc{mime} part externally. +@kindex K e (Summary) +View the @acronym{MIME} part externally. @item K i -@kindex K i @r{(Summary)} -View the @sc{mime} part internally. +@kindex K i (Summary) +View the @acronym{MIME} part internally. @item K | -@kindex K | @r{(Summary)} -Pipe the @sc{mime} part to an external command. -@end table - -The rest of these @sc{mime} commands do not use the numerical prefix in +@kindex K | (Summary) +Pipe the @acronym{MIME} part to an external command. +@end table + +The rest of these @acronym{MIME} commands do not use the numerical prefix in the same manner: @table @kbd @item K b -@kindex K b @r{(Summary)} -Make all the @sc{mime} parts have buttons in front of them. This is +@kindex K b (Summary) +Make all the @acronym{MIME} parts have buttons in front of them. This is mostly useful if you wish to save (or perform other actions) on inlined parts. @item K m -@kindex K m @r{(Summary)} +@kindex K m (Summary) @findex gnus-summary-repair-multipart Some multipart messages are transmitted with missing or faulty headers. This command will attempt to ``repair'' these messages so that they can @@ -7885,38 +9236,41 @@ (@code{gnus-summary-repair-multipart}). @item X m -@kindex X m @r{(Summary)} +@kindex X m (Summary) @findex gnus-summary-save-parts -Save all parts matching a @sc{mime} type to a directory +Save all parts matching a @acronym{MIME} type to a directory (@code{gnus-summary-save-parts}). Understands the process/prefix convention (@pxref{Process/Prefix}). @item M-t -@kindex M-t @r{(Summary)} -@findex gnus-summary-display-buttonized +@kindex M-t (Summary) +@findex gnus-summary-toggle-display-buttonized Toggle the buttonized display of the article buffer (@code{gnus-summary-toggle-display-buttonized}). @item W M w -@kindex W M w @r{(Summary)} +@kindex W M w (Summary) +@findex gnus-article-decode-mime-words Decode RFC 2047-encoded words in the article headers (@code{gnus-article-decode-mime-words}). @item W M c -@kindex W M c @r{(Summary)} +@kindex W M c (Summary) +@findex gnus-article-decode-charset Decode encoded article bodies as well as charsets (@code{gnus-article-decode-charset}). This command looks in the @code{Content-Type} header to determine the charset. If there is no such header in the article, you can give it a prefix, which will prompt for the charset to decode as. In regional -groups where people post using some common encoding (but do not include -MIME headers), you can set the @code{charset} group/topic parameter to -the required charset (@pxref{Group Parameters}). +groups where people post using some common encoding (but do not +include @acronym{MIME} headers), you can set the @code{charset} group/topic +parameter to the required charset (@pxref{Group Parameters}). @item W M v -@kindex W M v @r{(Summary)} -View all the @sc{mime} parts in the current article +@kindex W M v (Summary) +@findex gnus-mime-view-all-parts +View all the @acronym{MIME} parts in the current article (@code{gnus-mime-view-all-parts}). @end table @@ -7926,7 +9280,7 @@ @table @code @item gnus-ignored-mime-types @vindex gnus-ignored-mime-types -This is a list of regexps. @sc{mime} types that match a regexp from +This is a list of regexps. @acronym{MIME} types that match a regexp from this list will be completely ignored by Gnus. The default value is @code{nil}. @@ -7937,15 +9291,51 @@ '("text/x-vcard")) @end lisp +@item gnus-article-loose-mime +@vindex gnus-article-loose-mime +If non-@code{nil}, Gnus won't require the @samp{MIME-Version} header +before interpreting the message as a @acronym{MIME} message. This helps +when reading messages from certain broken mail user agents. The +default is @code{nil}. + +@item gnus-article-emulate-mime +@vindex gnus-article-emulate-mime +There are other, non-@acronym{MIME} encoding methods used. The most common +is @samp{uuencode}, but yEncode is also getting to be popular. If +this variable is non-@code{nil}, Gnus will look in message bodies to +see if it finds these encodings, and if so, it'll run them through the +Gnus @acronym{MIME} machinery. The default is @code{t}. + @item gnus-unbuttonized-mime-types @vindex gnus-unbuttonized-mime-types -This is a list of regexps. @sc{mime} types that match a regexp from -this list won't have @sc{mime} buttons inserted unless they aren't -displayed. The default value is @code{(".*/.*")}. +This is a list of regexps. @acronym{MIME} types that match a regexp from +this list won't have @acronym{MIME} buttons inserted unless they aren't +displayed or this variable is overridden by +@code{gnus-buttonized-mime-types}. The default value is +@code{(".*/.*")}. This variable is only used when +@code{gnus-inhibit-mime-unbuttonizing} is @code{nil}. + +@item gnus-buttonized-mime-types +@vindex gnus-buttonized-mime-types +This is a list of regexps. @acronym{MIME} types that match a regexp from +this list will have @acronym{MIME} buttons inserted unless they aren't +displayed. This variable overrides +@code{gnus-unbuttonized-mime-types}. The default value is @code{nil}. +This variable is only used when @code{gnus-inhibit-mime-unbuttonizing} +is @code{nil}. + +To see e.g. security buttons but no other buttons, you could set this +variable to @code{("multipart/signed")} and leave +@code{gnus-unbuttonized-mime-types} at the default value. + +@item gnus-inhibit-mime-unbuttonizing +@vindex gnus-inhibit-mime-unbuttonizing +If this is non-@code{nil}, then all @acronym{MIME} parts get buttons. The +default value is @code{nil}. @item gnus-article-mime-part-function @vindex gnus-article-mime-part-function -For each @sc{mime} part, this function will be called with the @sc{mime} +For each @acronym{MIME} part, this function will be called with the @acronym{MIME} handle as the parameter. The function is meant to be used to allow users to gather information from the article (e. g., add Vcard info to the bbdb database) or to do actions based on parts (e. g., automatically @@ -7966,7 +9356,43 @@ @vindex gnus-mime-multipart-functions @item gnus-mime-multipart-functions -Alist of @sc{mime} multipart types and functions to handle them. +Alist of @acronym{MIME} multipart types and functions to handle them. + +@vindex mm-file-name-rewrite-functions +@item mm-file-name-rewrite-functions +List of functions used for rewriting file names of @acronym{MIME} parts. +Each function takes a file name as input and returns a file name. + +Ready-made functions include@* +@code{mm-file-name-delete-whitespace}, +@code{mm-file-name-trim-whitespace}, +@code{mm-file-name-collapse-whitespace}, and +@code{mm-file-name-replace-whitespace}. The later uses the value of +the variable @code{mm-file-name-replace-whitespace} to replace each +whitespace character in a file name with that string; default value +is @code{"_"} (a single underscore). +@findex mm-file-name-delete-whitespace +@findex mm-file-name-trim-whitespace +@findex mm-file-name-collapse-whitespace +@findex mm-file-name-replace-whitespace +@vindex mm-file-name-replace-whitespace + +The standard functions @code{capitalize}, @code{downcase}, +@code{upcase}, and @code{upcase-initials} may be useful, too. + +Everybody knows that whitespace characters in file names are evil, +except those who don't know. If you receive lots of attachments from +such unenlightened users, you can make live easier by adding + +@lisp +(setq mm-file-name-rewrite-functions + '(mm-file-name-trim-whitespace + mm-file-name-collapse-whitespace + mm-file-name-replace-whitespace)) +@end lisp + +@noindent +to your @file{~/.gnus.el} file. @end table @@ -7975,9 +9401,9 @@ @section Charsets @cindex charsets -People use different charsets, and we have @sc{mime} to let us know what +People use different charsets, and we have @acronym{MIME} to let us know what charsets they use. Or rather, we wish we had. Many people use -newsreaders and mailers that do not understand or use @sc{mime}, and +newsreaders and mailers that do not understand or use @acronym{MIME}, and just send out messages without saying what character sets they use. To help a bit with this, some local news hierarchies have policies that say what character set is the default. For instance, the @samp{fj} @@ -7985,21 +9411,22 @@ @vindex gnus-group-charset-alist This knowledge is encoded in the @code{gnus-group-charset-alist} -variable, which is an alist of regexps (to match group names) and -default charsets to be used when reading these groups. - -In addition, some people do use soi-disant @sc{mime}-aware agents that -aren't. These blithely mark messages as being in @code{iso-8859-1} even -if they really are in @code{koi-8}. To help here, the +variable, which is an alist of regexps (use the first item to match full +group names) and default charsets to be used when reading these groups. + +@vindex gnus-newsgroup-ignored-charsets +In addition, some people do use soi-disant @acronym{MIME}-aware agents that +aren't. These blithely mark messages as being in @code{iso-8859-1} +even if they really are in @code{koi-8}. To help here, the @code{gnus-newsgroup-ignored-charsets} variable can be used. The -charsets that are listed here will be ignored. The variable can be set -on a group-by-group basis using the group parameters (@pxref{Group -Parameters}). The default value is @code{(unknown-8bit)}, which is -something some agents insist on having in there. +charsets that are listed here will be ignored. The variable can be +set on a group-by-group basis using the group parameters (@pxref{Group +Parameters}). The default value is @code{(unknown-8bit x-unknown)}, +which includes values some agents insist on having in there. @vindex gnus-group-posting-charset-alist When posting, @code{gnus-group-posting-charset-alist} is used to -determine which charsets should not be encoded using the @sc{mime} +determine which charsets should not be encoded using the @acronym{MIME} encodings. For instance, some hierarchies discourage using quoted-printable header encoding. @@ -8029,7 +9456,7 @@ Other charset tricks that may be useful, although not Gnus-specific: -If there are several @sc{mime} charsets that encode the same Emacs +If there are several @acronym{MIME} charsets that encode the same Emacs charset, you can choose what charset to use by saying the following: @lisp @@ -8038,7 +9465,7 @@ @end lisp This means that Russian will be encoded using @code{koi8-r} instead of -the default @code{iso-8859-5} @sc{mime} charset. +the default @code{iso-8859-5} @acronym{MIME} charset. If you want to read messages in @code{koi8-u}, you can cheat and say @@ -8056,13 +9483,6 @@ (define-coding-system-alias 'windows-1251 'cp1251) @end lisp -while if you use a non-Latin-1 language environment you could see the -Latin-1 subset of @code{windows-1252} using: - -@lisp -(define-coding-system-alias 'windows-1252 'latin-1) -@end lisp - @node Article Commands @section Article Commands @@ -8072,12 +9492,13 @@ @item A P @cindex PostScript @cindex printing -@kindex A P @r{(Summary)} +@kindex A P (Summary) @vindex gnus-ps-print-hook @findex gnus-summary-print-article Generate and print a PostScript image of the article buffer -(@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will be -run just before printing the buffer. +(@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will +be run just before printing the buffer. An alternative way to print +article is to use Muttprint (@pxref{Saving Articles}). @end table @@ -8092,39 +9513,50 @@ @table @kbd @item C-c C-s C-n -@kindex C-c C-s C-n @r{(Summary)} +@kindex C-c C-s C-n (Summary) @findex gnus-summary-sort-by-number Sort by article number (@code{gnus-summary-sort-by-number}). @item C-c C-s C-a -@kindex C-c C-s C-a @r{(Summary)} +@kindex C-c C-s C-a (Summary) @findex gnus-summary-sort-by-author Sort by author (@code{gnus-summary-sort-by-author}). @item C-c C-s C-s -@kindex C-c C-s C-s @r{(Summary)} +@kindex C-c C-s C-s (Summary) @findex gnus-summary-sort-by-subject Sort by subject (@code{gnus-summary-sort-by-subject}). @item C-c C-s C-d -@kindex C-c C-s C-d @r{(Summary)} +@kindex C-c C-s C-d (Summary) @findex gnus-summary-sort-by-date Sort by date (@code{gnus-summary-sort-by-date}). @item C-c C-s C-l -@kindex C-c C-s C-l @r{(Summary)} +@kindex C-c C-s C-l (Summary) @findex gnus-summary-sort-by-lines Sort by lines (@code{gnus-summary-sort-by-lines}). @item C-c C-s C-c -@kindex C-c C-s C-c @r{(Summary)} +@kindex C-c C-s C-c (Summary) @findex gnus-summary-sort-by-chars Sort by article length (@code{gnus-summary-sort-by-chars}). @item C-c C-s C-i -@kindex C-c C-s C-i @r{(Summary)} +@kindex C-c C-s C-i (Summary) @findex gnus-summary-sort-by-score Sort by score (@code{gnus-summary-sort-by-score}). + +@item C-c C-s C-r +@kindex C-c C-s C-r (Summary) +@findex gnus-summary-sort-by-random +Randomize (@code{gnus-summary-sort-by-random}). + +@item C-c C-s C-o +@kindex C-c C-s C-o (Summary) +@findex gnus-summary-sort-by-original +Sort using the default sorting method +(@code{gnus-summary-sort-by-original}). @end table These functions will work both when you use threading and when you don't @@ -8142,11 +9574,11 @@ @table @kbd @item ^ -@kindex ^ @r{(Summary)} +@kindex ^ (Summary) @findex gnus-summary-refer-parent-article If you'd like to read the parent of the current article, and it is not displayed in the summary buffer, you might still be able to. That is, -if the current group is fetched by @sc{nntp}, the parent hasn't expired +if the current group is fetched by @acronym{NNTP}, the parent hasn't expired and the @code{References} in the current article are not mangled, you can just press @kbd{^} or @kbd{A r} (@code{gnus-summary-refer-parent-article}). If everything goes well, @@ -8160,15 +9592,15 @@ @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current article. -@item A R @r{(Summary)} +@item A R (Summary) @findex gnus-summary-refer-references -@kindex A R @r{(Summary)} +@kindex A R (Summary) Fetch all articles mentioned in the @code{References} header of the article (@code{gnus-summary-refer-references}). -@item A T @r{(Summary)} +@item A T (Summary) @findex gnus-summary-refer-thread -@kindex A T @r{(Summary)} +@kindex A T (Summary) Display the full thread where the current article appears (@code{gnus-summary-refer-thread}). This command has to fetch all the headers in the current group to work, so it usually takes a while. If @@ -8184,12 +9616,12 @@ the available headers will be fetched. This variable can be overridden by giving the @kbd{A T} command a numerical prefix. -@item M-^ @r{(Summary)} +@item M-^ (Summary) @findex gnus-summary-refer-article -@kindex M-^ @r{(Summary)} +@kindex M-^ (Summary) @cindex Message-ID @cindex fetching by Message-ID -You can also ask the @sc{nntp} server for an arbitrary article, no +You can also ask the @acronym{NNTP} server for an arbitrary article, no matter what group it belongs to. @kbd{M-^} (@code{gnus-summary-refer-article}) will ask you for a @code{Message-ID}, which is one of those long, hard-to-read thingies @@ -8204,8 +9636,8 @@ @vindex gnus-refer-article-method If the group you are reading is located on a back end that does not support fetching by @code{Message-ID} very well (like @code{nnspool}), -you can set @code{gnus-refer-article-method} to an @sc{nntp} method. It -would, perhaps, be best if the @sc{nntp} server you consult is the one +you can set @code{gnus-refer-article-method} to an @acronym{NNTP} method. It +would, perhaps, be best if the @acronym{NNTP} server you consult is the one updating the spool you are reading from, but that's not really necessary. @@ -8215,20 +9647,21 @@ match. Here's an example setting that will first try the current method, and -then ask Deja if that fails: +then ask Google if that fails: @lisp (setq gnus-refer-article-method '(current - (nnweb "refer" (nnweb-type dejanews)))) -@end lisp - -Most of the mail back ends support fetching by @code{Message-ID}, but do -not do a particularly excellent job at it. That is, @code{nnmbox} and -@code{nnbabyl} are able to locate articles from any groups, while -@code{nnml} and @code{nnfolder} are only able to locate articles that -have been posted to the current group. (Anything else would be too time -consuming.) @code{nnmh} does not support this at all. + (nnweb "google" (nnweb-type google)))) +@end lisp + +Most of the mail back ends support fetching by @code{Message-ID}, but +do not do a particularly excellent job at it. That is, @code{nnmbox}, +@code{nnbabyl}, @code{nnmaildir}, @code{nnml}, are able to locate +articles from any groups, while @code{nnfolder}, and @code{nnimap} are +only able to locate articles that have been posted to the current +group. (Anything else would be too time consuming.) @code{nnmh} does +not support this at all. @node Alternative Approaches @@ -8273,8 +9706,8 @@ thread or article and pick it. (The line number is normally displayed at the beginning of the summary pick lines.) -@item @key{SPC} -@kindex @key{SPC} (Pick) +@item SPACE +@kindex SPACE (Pick) @findex gnus-pick-next-page Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If at the end of the buffer, start reading the picked articles. @@ -8289,8 +9722,8 @@ just the article. You can give this key a numerical prefix to unpick the thread or article at that line. -@item @key{RET} -@kindex @key{RET} (Pick) +@item RET +@kindex RET (Pick) @findex gnus-pick-start-reading @vindex gnus-pick-display-summary Start reading the picked articles (@code{gnus-pick-start-reading}). If @@ -8334,7 +9767,7 @@ @findex gnus-binary-mode @kindex M-x gnus-binary-mode If you spend much time in binary groups, you may grow tired of hitting -@kbd{X u}, @kbd{n}, @key{RET} all the time. @kbd{M-x gnus-binary-mode} +@kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode} is a minor mode for summary buffers that makes all ordinary Gnus article selection functions uudecode series of articles and display the result instead of just displaying the articles the normal way. @@ -8410,9 +9843,13 @@ @item gnus-tree-brackets @vindex gnus-tree-brackets This is used for differentiating between ``real'' articles and -``sparse'' articles. The format is @code{((@var{real-open} . @var{real-close}) -(@var{sparse-open} . @var{sparse-close}) (@var{dummy-open} . @var{dummy-close}))}, and the -default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}. +``sparse'' articles. The format is +@example +((@var{real-open} . @var{real-close}) + (@var{sparse-open} . @var{sparse-close}) + (@var{dummy-open} . @var{dummy-close})) +@end example +and the default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}. @item gnus-tree-parent-child-edges @vindex gnus-tree-parent-child-edges @@ -8431,6 +9868,14 @@ buffer is one of these, minimizing the tree window will also resize all other windows displayed next to it. +You may also wish to add the following hook to keep the window minimized +at all times: + +@lisp +(add-hook 'gnus-configure-windows-hook + 'gnus-tree-perhaps-minimize) +@end lisp + @item gnus-generate-tree-function @vindex gnus-generate-tree-function @findex gnus-generate-horizontal-tree @@ -8457,6 +9902,7 @@ Here's the same thread displayed in a vertical tree buffer: @example +@group @{***@} |--------------------------\-----\-----\ (***) [Bjo] [Gun] [Gun] @@ -8466,11 +9912,12 @@ [Gun] [Eri] [Eri] [odd] | [Paa] +@end group @end example If you're using horizontal trees, it might be nice to display the trees side-by-side with the summary buffer. You could add something like the -following to your @file{.gnus.el} file: +following to your @file{~/.gnus.el} file: @lisp (setq gnus-use-trees t @@ -8485,7 +9932,7 @@ (article 1.0)))) @end lisp -@xref{Windows Configuration}. +@xref{Window Layout}. @node Mail Group Commands @@ -8501,21 +9948,23 @@ @table @kbd @item B e -@kindex B e @r{(Summary)} +@kindex B e (Summary) @findex gnus-summary-expire-articles -Expire all expirable articles in the group -(@code{gnus-summary-expire-articles}). +Run all expirable articles in the current group through the expiry +process (@code{gnus-summary-expire-articles}). That is, delete all +expirable articles in the group that have been around for a while. +(@pxref{Expiring Mail}). @item B C-M-e -@kindex B C-M-e @r{(Summary)} +@kindex B C-M-e (Summary) @findex gnus-summary-expire-articles-now Delete all the expirable articles in the group (@code{gnus-summary-expire-articles-now}). This means that @strong{all} articles eligible for expiry in the current group will disappear forever into that big @file{/dev/null} in the sky. -@item B @key{DEL} -@kindex B @key{DEL} @r{(Summary)} +@item B DEL +@kindex B DEL (Summary) @findex gnus-summary-delete-article @c @icon{gnus-summary-mail-delete} Delete the mail article. This is ``delete'' as in ``delete it from your @@ -8523,25 +9972,25 @@ (@code{gnus-summary-delete-article}). @item B m -@kindex B m @r{(Summary)} +@kindex B m (Summary) @cindex move mail @findex gnus-summary-move-article @vindex gnus-preserve-marks Move the article from one mail group to another (@code{gnus-summary-move-article}). Marks will be preserved if -@var{gnus-preserve-marks} is non-@code{nil} (which is the default). +@code{gnus-preserve-marks} is non-@code{nil} (which is the default). @item B c -@kindex B c @r{(Summary)} +@kindex B c (Summary) @cindex copy mail @findex gnus-summary-copy-article @c @icon{gnus-summary-mail-copy} Copy the article from one group (mail group or not) to a mail group (@code{gnus-summary-copy-article}). Marks will be preserved if -@var{gnus-preserve-marks} is non-@code{nil} (which is the default). +@code{gnus-preserve-marks} is non-@code{nil} (which is the default). @item B B -@kindex B B @r{(Summary)} +@kindex B B (Summary) @cindex crosspost mail @findex gnus-summary-crosspost-article Crosspost the current article to some other group @@ -8550,50 +9999,59 @@ be properly updated. @item B i -@kindex B i @r{(Summary)} +@kindex B i (Summary) @findex gnus-summary-import-article Import an arbitrary file into the current mail newsgroup (@code{gnus-summary-import-article}). You will be prompted for a file name, a @code{From} header and a @code{Subject} header. +@item B I +@kindex B I (Summary) +@findex gnus-summary-create-article +Create an empty article in the current mail newsgroups +(@code{gnus-summary-create-article}). You will be prompted for a +@code{From} header and a @code{Subject} header. + @item B r -@kindex B r @r{(Summary)} +@kindex B r (Summary) @findex gnus-summary-respool-article +@vindex gnus-summary-respool-default-method Respool the mail article (@code{gnus-summary-respool-article}). @code{gnus-summary-respool-default-method} will be used as the default select method when respooling. This variable is @code{nil} by default, which means that the current group select method will be used instead. -Marks will be preserved if @var{gnus-preserve-marks} is non-@code{nil} +Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil} (which is the default). @item B w @itemx e -@kindex B w @r{(Summary)} -@kindex e @r{(Summary)} +@kindex B w (Summary) +@kindex e (Summary) @findex gnus-summary-edit-article -@kindex C-c C-c @r{(Article)} +@kindex C-c C-c (Article) +@findex gnus-summary-edit-article-done Edit the current article (@code{gnus-summary-edit-article}). To finish editing and make the changes permanent, type @kbd{C-c C-c} -(@kbd{gnus-summary-edit-article-done}). If you give a prefix to the +(@code{gnus-summary-edit-article-done}). If you give a prefix to the @kbd{C-c C-c} command, Gnus won't re-highlight the article. @item B q -@kindex B q @r{(Summary)} +@kindex B q (Summary) @findex gnus-summary-respool-query If you want to re-spool an article, you might be curious as to what group the article will end up in before you do the re-spooling. This command will tell you (@code{gnus-summary-respool-query}). @item B t -@kindex B t @r{(Summary)} +@kindex B t (Summary) @findex gnus-summary-respool-trace Similarly, this command will display all fancy splitting patterns used -when repooling, if any (@code{gnus-summary-respool-trace}). +when respooling, if any (@code{gnus-summary-respool-trace}). @item B p -@kindex B p @r{(Summary)} +@kindex B p (Summary) @findex gnus-summary-article-posted-p -Some people have a tendency to send you "courtesy" copies when they +Some people have a tendency to send you ``courtesy'' copies when they follow up to articles you have posted. These usually have a @code{Newsgroups} header in them, but not always. This command (@code{gnus-summary-article-posted-p}) will try to fetch the current @@ -8604,6 +10062,14 @@ propagation is much faster than news propagation, and the news copy may just not have arrived yet. +@item K E +@kindex K E (Summary) +@findex gnus-article-encrypt-body +@vindex gnus-article-encrypt-protocol +Encrypt the body of an article (@code{gnus-article-encrypt-body}). +The body is encrypted with the encryption protocol specified by the +variable @code{gnus-article-encrypt-protocol}. + @end table @vindex gnus-move-split-methods @@ -8628,13 +10094,25 @@ @section Various Summary Stuff @menu -* Summary Group Information:: Information oriented commands. -* Searching for Articles:: Multiple article commands. -* Summary Generation Commands:: (Re)generating the summary buffer. -* Really Various Summary Commands:: Those pesky non-conformant commands. -@end menu - -@table @code +* Summary Group Information:: Information oriented commands. +* Searching for Articles:: Multiple article commands. +* Summary Generation Commands:: +* Really Various Summary Commands:: Those pesky non-conformant commands. +@end menu + +@table @code +@vindex gnus-summary-display-while-building +@item gnus-summary-display-while-building +If non-@code{nil}, show and update the summary buffer as it's being +built. If @code{t}, update the buffer after every line is inserted. +If the value is an integer, @var{n}, update the display every @var{n} +lines. The default is @code{nil}. + +@vindex gnus-summary-display-arrow +@item gnus-summary-display-arrow +If non-@code{nil}, display an arrow in the fringe to indicate the +current article. + @vindex gnus-summary-mode-hook @item gnus-summary-mode-hook This hook is called when creating a summary mode buffer. @@ -8685,6 +10163,22 @@ articles)) @end lisp +@vindex gnus-newsgroup-variables +@item gnus-newsgroup-variables +A list of newsgroup (summary buffer) local variables, or cons of +variables and their default values (when the default values are not +@code{nil}), that should be made global while the summary buffer is +active. These variables can be used to set variables in the group +parameters while still allowing them to affect operations done in +other buffers. For example: + +@lisp +(setq gnus-newsgroup-variables + '(message-use-followup-to + (gnus-visible-headers . + "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:"))) +@end lisp + @end table @@ -8694,32 +10188,32 @@ @table @kbd @item H f -@kindex H f @r{(Summary)} +@kindex H f (Summary) @findex gnus-summary-fetch-faq @vindex gnus-group-faq-directory -Try to fetch the FAQ (list of frequently asked questions) for the -current group (@code{gnus-summary-fetch-faq}). Gnus will try to get the -FAQ from @code{gnus-group-faq-directory}, which is usually a directory -on a remote machine. This variable can also be a list of directories. -In that case, giving a prefix to this command will allow you to choose -between the various sites. @code{ange-ftp} or @code{efs} will probably -be used for fetching the file. +Try to fetch the @acronym{FAQ} (list of frequently asked questions) +for the current group (@code{gnus-summary-fetch-faq}). Gnus will try +to get the @acronym{FAQ} from @code{gnus-group-faq-directory}, which +is usually a directory on a remote machine. This variable can also be +a list of directories. In that case, giving a prefix to this command +will allow you to choose between the various sites. @code{ange-ftp} +or @code{efs} will probably be used for fetching the file. @item H d -@kindex H d @r{(Summary)} +@kindex H d (Summary) @findex gnus-summary-describe-group Give a brief description of the current group (@code{gnus-summary-describe-group}). If given a prefix, force rereading the description from the server. @item H h -@kindex H h @r{(Summary)} +@kindex H h (Summary) @findex gnus-summary-describe-briefly Give an extremely brief description of the most important summary keystrokes (@code{gnus-summary-describe-briefly}). @item H i -@kindex H i @r{(Summary)} +@kindex H i (Summary) @findex gnus-info-find-node Go to the Gnus info node (@code{gnus-info-find-node}). @end table @@ -8731,19 +10225,19 @@ @table @kbd @item M-s -@kindex M-s @r{(Summary)} +@kindex M-s (Summary) @findex gnus-summary-search-article-forward -Search through all subsequent articles for a regexp +Search through all subsequent (raw) articles for a regexp (@code{gnus-summary-search-article-forward}). @item M-r -@kindex M-r @r{(Summary)} +@kindex M-r (Summary) @findex gnus-summary-search-article-backward -Search through all previous articles for a regexp +Search through all previous (raw) articles for a regexp (@code{gnus-summary-search-article-backward}). @item & -@kindex & @r{(Summary)} +@kindex & (Summary) @findex gnus-summary-execute-command This command will prompt you for a header, a regular expression to match on this field, and a command to be executed if the match is made @@ -8751,11 +10245,11 @@ string, the match is done on the entire article. If given a prefix, search backward instead. -For instance, @kbd{& @key{RET} some.*string #} will put the process mark on +For instance, @kbd{& RET some.*string RET #} will put the process mark on all articles that have heads or bodies that match @samp{some.*string}. @item M-& -@kindex M-& @r{(Summary)} +@kindex M-& (Summary) @findex gnus-summary-universal-argument Perform any operation on all articles that have been marked with the process mark (@code{gnus-summary-universal-argument}). @@ -8767,16 +10261,22 @@ @table @kbd @item Y g -@kindex Y g @r{(Summary)} +@kindex Y g (Summary) @findex gnus-summary-prepare Regenerate the current summary buffer (@code{gnus-summary-prepare}). @item Y c -@kindex Y c @r{(Summary)} +@kindex Y c (Summary) @findex gnus-summary-insert-cached-articles Pull all cached articles (for the current group) into the summary buffer (@code{gnus-summary-insert-cached-articles}). +@item Y d +@kindex Y d (Summary) +@findex gnus-summary-insert-dormant-articles +Pull all dormant articles (for the current group) into the summary buffer +(@code{gnus-summary-insert-dormant-articles}). + @end table @@ -8787,8 +10287,8 @@ @item A D @itemx C-d -@kindex C-d @r{(Summary)} -@kindex A D @r{(Summary)} +@kindex C-d (Summary) +@kindex A D (Summary) @findex gnus-summary-enter-digest-group If the current article is a collection of other articles (for instance, a digest), you might use this command to enter a group based on the that @@ -8800,7 +10300,7 @@ fashion. @item C-M-d -@kindex C-M-d @r{(Summary)} +@kindex C-M-d (Summary) @findex gnus-summary-read-document This command is very similar to the one above, but lets you gather several documents into one biiig group @@ -8811,7 +10311,7 @@ (@pxref{Process/Prefix}). @item C-t -@kindex C-t @r{(Summary)} +@kindex C-t (Summary) @findex gnus-summary-toggle-truncation Toggle truncation of summary lines (@code{gnus-summary-toggle-truncation}). This will probably confuse the @@ -8819,19 +10319,19 @@ to have truncation switched off while reading articles. @item = -@kindex = @r{(Summary)} +@kindex = (Summary) @findex gnus-summary-expand-window Expand the summary buffer window (@code{gnus-summary-expand-window}). If given a prefix, force an @code{article} window configuration. @item C-M-e -@kindex C-M-e @r{(Summary)} +@kindex C-M-e (Summary) @findex gnus-summary-edit-parameters Edit the group parameters (@pxref{Group Parameters}) of the current group (@code{gnus-summary-edit-parameters}). @item C-M-a -@kindex C-M-a @r{(Summary)} +@kindex C-M-a (Summary) @findex gnus-summary-customize-parameters Customize the group parameters (@pxref{Group Parameters}) of the current group (@code{gnus-summary-customize-parameters}). @@ -8850,12 +10350,15 @@ @table @kbd @item Z Z +@itemx Z Q @itemx q -@kindex Z Z @r{(Summary)} -@kindex q @r{(Summary)} +@kindex Z Z (Summary) +@kindex Z Q (Summary) +@kindex q (Summary) @findex gnus-summary-exit @vindex gnus-summary-exit-hook @vindex gnus-summary-prepare-exit-hook +@vindex gnus-group-no-more-groups-hook @c @icon{gnus-summary-exit} Exit the current group and update all information on the group (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is @@ -8867,35 +10370,37 @@ @item Z E @itemx Q -@kindex Z E @r{(Summary)} -@kindex Q @r{(Summary)} +@kindex Z E (Summary) +@kindex Q (Summary) @findex gnus-summary-exit-no-update Exit the current group without updating any information on the group (@code{gnus-summary-exit-no-update}). @item Z c @itemx c -@kindex Z c @r{(Summary)} -@kindex c @r{(Summary)} +@kindex Z c (Summary) +@kindex c (Summary) @findex gnus-summary-catchup-and-exit @c @icon{gnus-summary-catchup-and-exit} Mark all unticked articles in the group as read and then exit (@code{gnus-summary-catchup-and-exit}). @item Z C -@kindex Z C @r{(Summary)} +@kindex Z C (Summary) @findex gnus-summary-catchup-all-and-exit Mark all articles, even the ticked ones, as read and then exit (@code{gnus-summary-catchup-all-and-exit}). @item Z n -@kindex Z n @r{(Summary)} +@kindex Z n (Summary) @findex gnus-summary-catchup-and-goto-next-group Mark all articles as read and go to the next group (@code{gnus-summary-catchup-and-goto-next-group}). @item Z R -@kindex Z R @r{(Summary)} +@itemx C-x C-s +@kindex Z R (Summary) +@kindex C-x C-s (Summary) @findex gnus-summary-reselect-current-group Exit this group, and then enter it again (@code{gnus-summary-reselect-current-group}). If given a prefix, select @@ -8903,8 +10408,8 @@ @item Z G @itemx M-g -@kindex Z G @r{(Summary)} -@kindex M-g @r{(Summary)} +@kindex Z G (Summary) +@kindex M-g (Summary) @findex gnus-summary-rescan-group @c @icon{gnus-summary-mail-get} Exit the group, check for new articles in the group, and select the @@ -8912,19 +10417,19 @@ articles, both read and unread. @item Z N -@kindex Z N @r{(Summary)} +@kindex Z N (Summary) @findex gnus-summary-next-group Exit the group and go to the next group (@code{gnus-summary-next-group}). @item Z P -@kindex Z P @r{(Summary)} +@kindex Z P (Summary) @findex gnus-summary-prev-group Exit the group and go to the previous group (@code{gnus-summary-prev-group}). @item Z s -@kindex Z s @r{(Summary)} +@kindex Z s (Summary) @findex gnus-summary-save-newsrc Save the current number of read/marked articles in the dribble buffer and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If @@ -8984,11 +10489,11 @@ @cindex cross-posting @cindex Xref -@cindex @sc{nov} +@cindex @acronym{NOV} One thing that may cause Gnus to not do the cross-posting thing -correctly is if you use an @sc{nntp} server that supports @sc{xover} +correctly is if you use an @acronym{NNTP} server that supports @sc{xover} (which is very nice, because it speeds things up considerably) which -does not include the @code{Xref} header in its @sc{nov} lines. This is +does not include the @code{Xref} header in its @acronym{NOV} lines. This is Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing even with @sc{xover} by registering the @code{Xref} lines of all articles you actually read, but if you kill the articles, or just mark @@ -8998,7 +10503,7 @@ @cindex LIST overview.fmt @cindex overview.fmt -To check whether your @sc{nntp} server includes the @code{Xref} header +To check whether your @acronym{NNTP} server includes the @code{Xref} header in its overview files, try @samp{telnet your.nntp.server nntp}, @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST overview.fmt}. This may not work, but if it does, and the last line you @@ -9027,16 +10532,16 @@ @enumerate @item -The @sc{nntp} server may fail to generate the @code{Xref} header. This +The @acronym{NNTP} server may fail to generate the @code{Xref} header. This is evil and not very common. @item -The @sc{nntp} server may fail to include the @code{Xref} header in the +The @acronym{NNTP} server may fail to include the @code{Xref} header in the @file{.overview} data bases. This is evil and all too common, alas. @item You may be reading the same group (or several related groups) from -different @sc{nntp} servers. +different @acronym{NNTP} servers. @item You may be getting mail that duplicates articles posted to groups. @@ -9092,9 +10597,131 @@ @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up to you to figure out, I think. - -@node The Article Buffer -@chapter The Article Buffer +@node Security +@section Security + +Gnus is able to verify signed messages or decrypt encrypted messages. +The formats that are supported are @acronym{PGP}, @acronym{PGP/MIME} +and @acronym{S/MIME}, however you need some external programs to get +things to work: + +@enumerate +@item +To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to +install an OpenPGP implementation such as GnuPG. The Lisp interface +to GnuPG included with Gnus is called PGG (@pxref{Top, ,PGG, pgg, PGG +Manual}), but Mailcrypt and gpg.el are also supported. + +@item +To handle @acronym{S/MIME} message, you need to install OpenSSL. OpenSSL 0.9.6 +or newer is recommended. + +@end enumerate + +More information on how to set things up can be found in the message +manual (@pxref{Security, ,Security, message, Message Manual}). + +@table @code +@item mm-verify-option +@vindex mm-verify-option +Option of verifying signed parts. @code{never}, not verify; +@code{always}, always verify; @code{known}, only verify known +protocols. Otherwise, ask user. + +@item mm-decrypt-option +@vindex mm-decrypt-option +Option of decrypting encrypted parts. @code{never}, no decryption; +@code{always}, always decrypt; @code{known}, only decrypt known +protocols. Otherwise, ask user. + +@item mml1991-use +@vindex mml1991-use +Symbol indicating elisp interface to OpenPGP implementation for +@acronym{PGP} messages. The default is @code{pgg}, but +@code{mailcrypt} and @code{gpg} are also supported although +deprecated. + +@item mml2015-use +@vindex mml2015-use +Symbol indicating elisp interface to OpenPGP implementation for +@acronym{PGP/MIME} messages. The default is @code{pgg}, but +@code{mailcrypt} and @code{gpg} are also supported although +deprecated. + +@end table + +@cindex snarfing keys +@cindex importing PGP keys +@cindex PGP key ring import +Snarfing OpenPGP keys (i.e., importing keys from articles into your +key ring) is not supported explicitly through a menu item or command, +rather Gnus do detect and label keys as @samp{application/pgp-keys}, +allowing you to specify whatever action you think is appropriate +through the usual @acronym{MIME} infrastructure. You can use a +@file{~/.mailcap} entry (@pxref{mailcap, , mailcap, emacs-mime, The +Emacs MIME Manual}) such as the following to import keys using GNU +Privacy Guard when you click on the @acronym{MIME} button +(@pxref{Using MIME}). + +@example +application/pgp-keys; gpg --import --interactive --verbose; needsterminal +@end example +@noindent +This happens to also be the default action defined in +@code{mailcap-mime-data}. + +@node Mailing List +@section Mailing List +@cindex mailing list +@cindex RFC 2396 + +@kindex A M (summary) +@findex gnus-mailing-list-insinuate +Gnus understands some mailing list fields of RFC 2369. To enable it, +add a @code{to-list} group parameter (@pxref{Group Parameters}), +possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the +summary buffer. + +That enables the following commands to the summary buffer: + +@table @kbd + +@item C-c C-n h +@kindex C-c C-n h (Summary) +@findex gnus-mailing-list-help +Send a message to fetch mailing list help, if List-Help field exists. + +@item C-c C-n s +@kindex C-c C-n s (Summary) +@findex gnus-mailing-list-subscribe +Send a message to subscribe the mailing list, if List-Subscribe field exists. + +@item C-c C-n u +@kindex C-c C-n u (Summary) +@findex gnus-mailing-list-unsubscribe +Send a message to unsubscribe the mailing list, if List-Unsubscribe +field exists. + +@item C-c C-n p +@kindex C-c C-n p (Summary) +@findex gnus-mailing-list-post +Post to the mailing list, if List-Post field exists. + +@item C-c C-n o +@kindex C-c C-n o (Summary) +@findex gnus-mailing-list-owner +Send a message to the mailing list owner, if List-Owner field exists. + +@item C-c C-n a +@kindex C-c C-n a (Summary) +@findex gnus-mailing-list-owner +Browse the mailing list archive, if List-Archive field exists. + +@end table + + +@node Article Buffer +@chapter Article Buffer @cindex article buffer The articles are displayed in the article buffer, of which there is only @@ -9102,11 +10729,11 @@ tell Gnus otherwise. @menu -* Hiding Headers:: Deciding what headers should be displayed. -* Using MIME:: Pushing articles through @sc{mime} before reading them. -* Customizing Articles:: Tailoring the look of the articles. -* Article Keymap:: Keystrokes available in the article buffer. -* Misc Article:: Other stuff. +* Hiding Headers:: Deciding what headers should be displayed. +* Using MIME:: Pushing articles through @acronym{MIME} before reading them. +* Customizing Articles:: Tailoring the look of the articles. +* Article Keymap:: Keystrokes available in the article buffer. +* Misc Article:: Other stuff. @end menu @@ -9124,7 +10751,7 @@ article. That's well and nice, but there's also lots of information most people do not want to see---what systems the article has passed through before reaching you, the @code{Message-ID}, the -@code{References}, etc. ad nauseum---and you'll probably want to get rid +@code{References}, etc. ad nauseam---and you'll probably want to get rid of some of those lines. If you want to keep all those lines in the article buffer, you can set @code{gnus-show-all-headers} to @code{t}. @@ -9189,9 +10816,9 @@ @findex gnus-article-hide-boring-headers @vindex gnus-boring-article-headers You can hide further boring headers by setting -@code{gnus-treat-hide-boring-header} to @code{head}. What this function +@code{gnus-treat-hide-boring-headers} to @code{head}. What this function does depends on the @code{gnus-boring-article-headers} variable. It's a -list, but this list doesn't actually contain header names. Instead is +list, but this list doesn't actually contain header names. Instead it lists various @dfn{boring conditions} that Gnus can check and remove from sight. @@ -9203,11 +10830,21 @@ Remove the @code{Followup-To} header if it is identical to the @code{Newsgroups} header. @item reply-to -Remove the @code{Reply-To} header if it lists the same address as the -@code{From} header. +Remove the @code{Reply-To} header if it lists the same addresses as +the @code{From} header, or if the @code{broken-reply-to} group +parameter is set. @item newsgroups Remove the @code{Newsgroups} header if it only contains the current group name. +@item to-address +Remove the @code{To} header if it only contains the address identical to +the current group's @code{to-address} parameter. +@item to-list +Remove the @code{To} header if it only contains the address identical to +the current group's @code{to-list} parameter. +@item cc-list +Remove the @code{CC} header if it only contains the address identical to +the current group's @code{to-list} parameter. @item date Remove the @code{Date} header if the article is less than three days old. @@ -9217,7 +10854,7 @@ Remove all @code{To} headers if there are more than one. @end table -To include the four three elements, you could say something like; +To include these three elements, you could say something like: @lisp (setq gnus-boring-article-headers @@ -9228,84 +10865,141 @@ @node Using MIME -@section Using @sc{mime} -@cindex @sc{mime} +@section Using MIME +@cindex @acronym{MIME} Mime is a standard for waving your hands through the air, aimlessly, while people stand around yawning. -@sc{mime}, however, is a standard for encoding your articles, aimlessly, +@acronym{MIME}, however, is a standard for encoding your articles, aimlessly, while all newsreaders die of fear. -@sc{mime} may specify what character set the article uses, the encoding +@acronym{MIME} may specify what character set the article uses, the encoding of the characters, and it also makes it possible to embed pictures and other naughty stuff in innocent-looking articles. @vindex gnus-display-mime-function @findex gnus-display-mime -Gnus pushes @sc{mime} articles through @code{gnus-display-mime-function} -to display the @sc{mime} parts. This is @code{gnus-display-mime} by +Gnus pushes @acronym{MIME} articles through @code{gnus-display-mime-function} +to display the @acronym{MIME} parts. This is @code{gnus-display-mime} by default, which creates a bundle of clickable buttons that can be used to -display, save and manipulate the @sc{mime} objects. +display, save and manipulate the @acronym{MIME} objects. The following commands are available when you have placed point over a -@sc{mime} button: +@acronym{MIME} button: @table @kbd @findex gnus-article-press-button -@item @key{RET} @r{(Article)} -@itemx Mouse-2 @r{(Article)} -Toggle displaying of the @sc{mime} object -(@code{gnus-article-press-button}). +@item RET (Article) +@kindex RET (Article) +@itemx BUTTON-2 (Article) +Toggle displaying of the @acronym{MIME} object +(@code{gnus-article-press-button}). If built-in viewers can not display +the object, Gnus resorts to external viewers in the @file{mailcap} +files. If a viewer has the @samp{copiousoutput} specification, the +object is displayed inline. @findex gnus-mime-view-part -@item M-@key{RET} @r{(Article)} -@itemx v @r{(Article)} -Prompt for a method, and then view the @sc{mime} object using this +@item M-RET (Article) +@kindex M-RET (Article) +@itemx v (Article) +Prompt for a method, and then view the @acronym{MIME} object using this method (@code{gnus-mime-view-part}). +@findex gnus-mime-view-part-as-type +@item t (Article) +@kindex t (Article) +View the @acronym{MIME} object as if it were a different @acronym{MIME} media type +(@code{gnus-mime-view-part-as-type}). + +@findex gnus-mime-view-part-as-charset +@item C (Article) +@kindex C (Article) +Prompt for a charset, and then view the @acronym{MIME} object using this +charset (@code{gnus-mime-view-part-as-charset}). + @findex gnus-mime-save-part -@item o @r{(Article)} -Prompt for a file name, and then save the @sc{mime} object +@item o (Article) +@kindex o (Article) +Prompt for a file name, and then save the @acronym{MIME} object (@code{gnus-mime-save-part}). +@findex gnus-mime-save-part-and-strip +@item C-o (Article) +@kindex C-o (Article) +Prompt for a file name, then save the @acronym{MIME} object and strip it from +the article. Then proceed to article editing, where a reasonable +suggestion is being made on how the altered article should look +like. The stripped @acronym{MIME} object will be referred via the +message/external-body @acronym{MIME} type. +(@code{gnus-mime-save-part-and-strip}). + +@findex gnus-mime-delete-part +@item d (Article) +@kindex d (Article) +Delete the @acronym{MIME} object from the article and replace it with some +information about the removed @acronym{MIME} object +(@code{gnus-mime-delete-part}). + @findex gnus-mime-copy-part -@item c @r{(Article)} -Copy the @sc{mime} object to a fresh buffer and display this buffer -(@code{gnus-mime-copy-part}). - -@findex gnus-mime-view-part-as-type -@item t @r{(Article)} -View the @sc{mime} object as if it were a different @sc{mime} media type -(@code{gnus-mime-view-part-as-type}). - -@findex gnus-mime-pipe-part -@item | @r{(Article)} -Output the @sc{mime} object to a process (@code{gnus-mime-pipe-part}). +@item c (Article) +@kindex c (Article) +Copy the @acronym{MIME} object to a fresh buffer and display this buffer +(@code{gnus-mime-copy-part}). Compressed files like @file{.gz} and +@file{.bz2} are automatically decompressed if +@code{auto-compression-mode} is enabled (@pxref{Compressed Files,, +Accessing Compressed Files, emacs, The Emacs Editor}). + +@findex gnus-mime-print-part +@item p (Article) +@kindex p (Article) +Print the @acronym{MIME} object (@code{gnus-mime-print-part}). This +command respects the @samp{print=} specifications in the +@file{.mailcap} file. @findex gnus-mime-inline-part -@item i @r{(Article)} -Insert the contents of the @sc{mime} object into the buffer +@item i (Article) +@kindex i (Article) +Insert the contents of the @acronym{MIME} object into the buffer (@code{gnus-mime-inline-part}) as text/plain. If given a prefix, insert the raw contents without decoding. If given a numerical prefix, you can do semi-manual charset stuff (see -@code{gnus-summary-show-article-charset-alist} in @pxref{Paging the +@code{gnus-summary-show-article-charset-alist} in @ref{Paging the Article}). +@findex gnus-mime-view-part-internally +@item E (Article) +@kindex E (Article) +View the @acronym{MIME} object with an internal viewer. If no internal +viewer is available, use an external viewer +(@code{gnus-mime-view-part-internally}). + +@findex gnus-mime-view-part-externally +@item e (Article) +@kindex e (Article) +View the @acronym{MIME} object with an external viewer. +(@code{gnus-mime-view-part-externally}). + +@findex gnus-mime-pipe-part +@item | (Article) +@kindex | (Article) +Output the @acronym{MIME} object to a process (@code{gnus-mime-pipe-part}). + @findex gnus-mime-action-on-part -@item . @r{(Article)} -Interactively run an action on the @sc{mime} object +@item . (Article) +@kindex . (Article) +Interactively run an action on the @acronym{MIME} object (@code{gnus-mime-action-on-part}). @end table -Gnus will display some @sc{mime} objects automatically. The way Gnus -determines which parts to do this with is described in the Emacs MIME -manual. +Gnus will display some @acronym{MIME} objects automatically. The way Gnus +determines which parts to do this with is described in the Emacs +@acronym{MIME} manual. It might be best to just use the toggling functions from the article buffer to avoid getting nasty surprises. (For instance, you enter the -group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has +group @samp{alt.sing-a-long} and, before you know it, @acronym{MIME} has decoded the sound file in the article and some horrible sing-a-long song comes screaming out your speakers, and you can't find the volume button, because there isn't one, and people are starting to look at you, and you @@ -9315,7 +11009,7 @@ Any similarity to real events and people is purely coincidental. Ahem. -Also see @pxref{MIME Commands}. +Also @pxref{MIME Commands}. @node Customizing Articles @@ -9323,7 +11017,8 @@ @cindex article customization A slew of functions for customizing how the articles are to look like -exist. You can call these functions interactively, or you can have them +exist. You can call these functions interactively +(@pxref{Article Washing}), or you can have them called automatically when you select the articles. To have them called automatically, you should set the corresponding @@ -9371,7 +11066,7 @@ @end enumerate You may have noticed that the word @dfn{part} is used here. This refers -to the fact that some messages are @sc{mime} multipart articles that may +to the fact that some messages are @acronym{MIME} multipart articles that may be divided into several parts. Articles that are not multiparts are considered to contain just a single part. @@ -9389,37 +11084,89 @@ possible but those listed are probably sufficient for most people. @table @code -@item gnus-treat-highlight-signature (t, last) @item gnus-treat-buttonize (t, integer) @item gnus-treat-buttonize-head (head) + +@xref{Article Buttons}. + +@item gnus-treat-capitalize-sentences (t, integer) +@item gnus-treat-overstrike (t, integer) +@item gnus-treat-strip-cr (t, integer) +@item gnus-treat-strip-headers-in-body (t, integer) +@item gnus-treat-strip-leading-blank-lines (t, integer) +@item gnus-treat-strip-multiple-blank-lines (t, integer) +@item gnus-treat-strip-pem (t, last, integer) +@item gnus-treat-strip-trailing-blank-lines (t, last, integer) +@item gnus-treat-unsplit-urls (t, integer) +@item gnus-treat-wash-html (t, integer) + +@xref{Article Washing}. + +@item gnus-treat-date-english (head) +@item gnus-treat-date-iso8601 (head) +@item gnus-treat-date-lapsed (head) +@item gnus-treat-date-local (head) +@item gnus-treat-date-original (head) +@item gnus-treat-date-user-defined (head) +@item gnus-treat-date-ut (head) + +@xref{Article Date}. + +@item gnus-treat-from-picon (head) +@item gnus-treat-mail-picon (head) +@item gnus-treat-newsgroups-picon (head) + +@xref{Picons}. + +@item gnus-treat-display-smileys (t, integer) + +@item gnus-treat-body-boundary (head) + +@vindex gnus-body-boundary-delimiter +Adds a delimiter between header and body, the string used as delimiter +is controlled by @code{gnus-body-boundary-delimiter}. + +@xref{Smileys}. + +@item gnus-treat-display-x-face (head) + +@xref{X-Face}. + +@item gnus-treat-display-face (head) + +@xref{Face}. + @item gnus-treat-emphasize (t, head, integer) @item gnus-treat-fill-article (t, integer) -@item gnus-treat-strip-cr (t, integer) -@item gnus-treat-hide-headers (head) +@item gnus-treat-fill-long-lines (t, integer) @item gnus-treat-hide-boring-headers (head) -@item gnus-treat-hide-signature (t, last) @item gnus-treat-hide-citation (t, integer) -@item gnus-treat-strip-pgp (t, last, integer) -@item gnus-treat-strip-pem (t, last, integer) +@item gnus-treat-hide-citation-maybe (t, integer) +@item gnus-treat-hide-headers (head) +@item gnus-treat-hide-signature (t, last) +@item gnus-treat-strip-banner (t, last) +@item gnus-treat-strip-list-identifiers (head) + +@xref{Article Hiding}. + +@item gnus-treat-highlight-citation (t, integer) @item gnus-treat-highlight-headers (head) -@item gnus-treat-highlight-citation (t, integer) @item gnus-treat-highlight-signature (t, last, integer) -@item gnus-treat-date-ut (head) -@item gnus-treat-date-local (head) -@item gnus-treat-date-lapsed (head) -@item gnus-treat-date-original (head) -@item gnus-treat-strip-headers-in-body (t, integer) -@item gnus-treat-strip-trailing-blank-lines (t, last, integer) -@item gnus-treat-strip-leading-blank-lines (t, integer) -@item gnus-treat-strip-multiple-blank-lines (t, integer) -@item gnus-treat-overstrike (t, integer) -@item gnus-treat-display-xface (head) -@item gnus-treat-display-smileys (t, integer) -@item gnus-treat-display-picons (head) -@item gnus-treat-capitalize-sentences (t, integer) -@item gnus-treat-fill-long-lines (t, integer) + +@xref{Article Highlighting}. + @item gnus-treat-play-sounds @item gnus-treat-translate +@item gnus-treat-x-pgp-sig (head) + +@item gnus-treat-unfold-headers (head) +@item gnus-treat-fold-headers (head) +@item gnus-treat-fold-newsgroups (head) +@item gnus-treat-leading-whitespace (head) + +@xref{Article Header}. + + @end table @vindex gnus-part-display-hook @@ -9443,52 +11190,71 @@ @table @kbd -@item @key{SPC} -@kindex @key{SPC} @r{(Article)} +@item SPACE +@kindex SPACE (Article) @findex gnus-article-next-page Scroll forwards one page (@code{gnus-article-next-page}). - -@item @key{DEL} -@kindex @key{DEL} @r{(Article)} +This is exactly the same as @kbd{h SPACE h}. + +@item DEL +@kindex DEL (Article) @findex gnus-article-prev-page Scroll backwards one page (@code{gnus-article-prev-page}). +This is exactly the same as @kbd{h DEL h}. @item C-c ^ -@kindex C-c ^ @r{(Article)} +@kindex C-c ^ (Article) @findex gnus-article-refer-article If point is in the neighborhood of a @code{Message-ID} and you press @kbd{C-c ^}, Gnus will try to get that article from the server (@code{gnus-article-refer-article}). @item C-c C-m -@kindex C-c C-m @r{(Article)} +@kindex C-c C-m (Article) @findex gnus-article-mail Send a reply to the address near point (@code{gnus-article-mail}). If given a prefix, include the mail. @item s -@kindex s @r{(Article)} +@kindex s (Article) @findex gnus-article-show-summary Reconfigure the buffers so that the summary buffer becomes visible (@code{gnus-article-show-summary}). @item ? -@kindex ? @r{(Article)} +@kindex ? (Article) @findex gnus-article-describe-briefly Give a very brief description of the available keystrokes (@code{gnus-article-describe-briefly}). @item TAB -@kindex TAB @r{(Article)} +@kindex TAB (Article) @findex gnus-article-next-button Go to the next button, if any (@code{gnus-article-next-button}). This only makes sense if you have buttonizing turned on. @item M-TAB -@kindex M-TAB @r{(Article)} +@kindex M-TAB (Article) @findex gnus-article-prev-button Go to the previous button, if any (@code{gnus-article-prev-button}). +@item R +@kindex R (Article) +@findex gnus-article-reply-with-original +Send a reply to the current article and yank the current article +(@code{gnus-article-reply-with-original}). If given a prefix, make a +wide reply. If the region is active, only yank the text in the +region. + +@item F +@kindex F (Article) +@findex gnus-article-followup-with-original +Send a followup to the current article and yank the current article +(@code{gnus-article-followup-with-original}). If given a prefix, make +a wide reply. If the region is active, only yank the text in the +region. + + @end table @@ -9505,8 +11271,8 @@ @vindex gnus-article-decode-hook @item gnus-article-decode-hook -@cindex MIME -Hook used to decode @sc{mime} articles. The default value is +@cindex @acronym{MIME} +Hook used to decode @acronym{MIME} articles. The default value is @code{(article-decode-charset article-decode-encoded-words)} @vindex gnus-article-prepare-hook @@ -9525,6 +11291,11 @@ Syntax table used in article buffers. It is initialized from @code{text-mode-syntax-table}. +@vindex gnus-article-over-scroll +@item gnus-article-over-scroll +If non-@code{nil}, allow scrolling the article buffer even when there +no more new text to scroll in. The default is @code{nil}. + @vindex gnus-article-mode-line-format @item gnus-article-mode-line-format This variable is a format string along the same lines as @@ -9533,12 +11304,39 @@ extensions: @table @samp + @item w The @dfn{wash status} of the article. This is a short string with one character for each possible article wash operation that may have been -performed. +performed. The characters and their meaning: + +@table @samp + +@item c +Displayed when cited text may be hidden in the article buffer. + +@item h +Displayed when headers are hidden in the article buffer. + +@item p +Displayed when article is digitally signed or encrypted, and Gnus has +hidden the security headers. (N.B. does not tell anything about +security status, i.e. good or bad signature.) + +@item s +Displayed when the signature has been hidden in the Article buffer. + +@item o +Displayed when Gnus has treated overstrike characters in the article buffer. + +@item e +Displayed when Gnus has treated emphasised strings in the article buffer. + +@end table + @item m -The number of @sc{mime} parts in the article. +The number of @acronym{MIME} parts in the article. + @end table @vindex gnus-break-pages @@ -9553,6 +11351,17 @@ @vindex gnus-page-delimiter This is the delimiter mentioned above. By default, it is @samp{^L} (formfeed). + +@cindex IDNA +@cindex internationalized domain names +@vindex gnus-use-idna +@item gnus-use-idna +This variable controls whether Gnus performs IDNA decoding of +internationalized domain names inside @samp{From}, @samp{To} and +@samp{Cc} headers. This requires +@uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this +variable is only enabled if you have installed it. + @end table @@ -9565,25 +11374,29 @@ @cindex reply @cindex followup @cindex post +@cindex using gpg +@cindex using s/mime +@cindex using smime @kindex C-c C-c (Post) All commands for posting and mailing will put you in a message buffer where you can edit the article all you like, before you send the -article by pressing @kbd{C-c C-c}. @xref{Top, , Top, message, The +article by pressing @kbd{C-c C-c}. @xref{Top, , Overview, message, Message Manual}. Where the message will be posted/mailed to depends on your setup (@pxref{Posting Server}). @menu -* Mail:: Mailing and replying. -* Posting Server:: What server should you post via? -* Mail and Post:: Mailing and posting at the same time. -* Archived Messages:: Where Gnus stores the messages you've sent. -* Posting Styles:: An easier way to specify who you are. -* Drafts:: Postponing messages and rejected messages. -* Rejected Articles:: What happens if the server doesn't like your article? -@end menu - -Also see @pxref{Canceling and Superseding} for information on how to +* Mail:: Mailing and replying. +* Posting Server:: What server should you post and mail via? +* Mail and Post:: Mailing and posting at the same time. +* Archived Messages:: Where Gnus stores the messages you've sent. +* Posting Styles:: An easier way to specify who you are. +* Drafts:: Postponing messages and rejected messages. +* Rejected Articles:: What happens if the server doesn't like your article? +* Signing and encrypting:: How to compose secure messages. +@end menu + +Also @pxref{Canceling and Superseding} for information on how to remove articles you shouldn't have posted. @@ -9596,13 +11409,30 @@ @item gnus-uu-digest-headers @vindex gnus-uu-digest-headers List of regexps to match headers included in digested messages. The -headers will be included in the sequence they are matched. +headers will be included in the sequence they are matched. If +@code{nil} include all headers. @item gnus-add-to-list @vindex gnus-add-to-list If non-@code{nil}, add a @code{to-list} group parameter to mail groups that have none when you do a @kbd{a}. +@item gnus-confirm-mail-reply-to-news +@vindex gnus-confirm-mail-reply-to-news +This can also be a function receiving the group name as the only +parameter which should return non-@code{nil} if a confirmation is +needed, or a regular expression matching group names, where +confirmation is should be asked for. + +If you find yourself never wanting to reply to mail, but occasionally +press R anyway, this variable might be for you. + +@item gnus-confirm-treat-mail-like-news +@vindex gnus-confirm-treat-mail-like-news +If non-@code{nil}, Gnus also requests confirmation according to +@code{gnus-confirm-mail-reply-to-news} when replying to mail. This is +useful for treating mailing lists like newsgroups. + @end table @@ -9614,13 +11444,18 @@ Thank you for asking. I hate you. +It can be quite complicated. + @vindex gnus-post-method - -It can be quite complicated. Normally, Gnus will use the same native -server. However. If your native server doesn't allow posting, just -reading, you probably want to use some other server to post your -(extremely intelligent and fabulously interesting) articles. You can -then set the @code{gnus-post-method} to some other method: +When posting news, Message usually invokes @code{message-send-news} +(@pxref{News Variables, , News Variables, message, Message Manual}). +Normally, Gnus will post using the same select method as you're +reading from (which might be convenient if you're reading lots of +groups from different private servers). However. If the server +you're reading from doesn't allow posting, just reading, you probably +want to use some other server to post your (extremely intelligent and +fabulously interesting) articles. You can then set the +@code{gnus-post-method} to some other method: @lisp (setq gnus-post-method '(nnspool "")) @@ -9629,7 +11464,7 @@ Now, if you've done this, and then this server rejects your article, or this server is down, what do you do then? To override this variable you can use a non-zero prefix to the @kbd{C-c C-c} command to force using -the ``current'' server for posting. +the ``current'' server, to get back the default behavior, for posting. If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command, Gnus will prompt you for what method to use for posting. @@ -9638,11 +11473,31 @@ If that's the case, Gnus will always prompt you for what method to use for posting. -Finally, if you want to always post using the same select method as -you're reading from (which might be convenient if you're reading lots of -groups from different private servers), you can set this variable to -@code{current}. - +Finally, if you want to always post using the native select method, +you can set this variable to @code{native}. + +When sending mail, Message invokes @code{message-send-mail-function}. +The default function, @code{message-send-mail-with-sendmail}, pipes +your article to the @code{sendmail} binary for further queuing and +sending. When your local system is not configured for sending mail +using @code{sendmail}, and you have access to a remote @acronym{SMTP} +server, you can set @code{message-send-mail-function} to +@code{smtpmail-send-it} and make sure to setup the @code{smtpmail} +package correctly. An example: + +@lisp +(setq message-send-mail-function 'smtpmail-send-it + smtpmail-default-smtp-server "YOUR SMTP HOST") +@end lisp + +To the thing similar to this, there is +@code{message-smtpmail-send-it}. It is useful if your ISP requires +the @acronym{POP}-before-@acronym{SMTP} authentication. See the +documentation for the function @code{mail-source-touch-pop}. + +Other possible choices for @code{message-send-mail-function} includes +@code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail}, +and @code{feedmail-send-it}. @node Mail and Post @section Mail and Post @@ -9656,7 +11511,7 @@ @cindex mailing lists If your news server offers groups that are really mailing lists -gatewayed to the @sc{nntp} server, you can read those groups without +gatewayed to the @acronym{NNTP} server, you can read those groups without problems, but you can't post/followup to them without some difficulty. One solution is to add a @code{to-address} to the group parameters (@pxref{Group Parameters}). An easier thing to do is set the @@ -9665,6 +11520,18 @@ lists will work most of the time. Posting to these groups (@kbd{a}) is still a pain, though. +@item gnus-user-agent +@vindex gnus-user-agent +@cindex User-Agent + +This variable controls which information should be exposed in the +User-Agent header. It can be one of the symbols @code{gnus} (show only +Gnus version), @code{emacs-gnus} (show only Emacs and Gnus versions), +@code{emacs-gnus-config} (same as @code{emacs-gnus} plus system +configuration), @code{emacs-gnus-type} (same as @code{emacs-gnus} plus +system type) or a custom string. If you set it to a string, be sure to +use a valid format, see RFC 2616. + @end table You may want to do spell-checking on messages that you send out. Or, if @@ -9684,7 +11551,8 @@ (add-hook 'gnus-select-group-hook (lambda () (cond - ((string-match "^de\\." gnus-newsgroup-name) + ((string-match + "^de\\." (gnus-group-real-name gnus-newsgroup-name)) (ispell-change-dictionary "deutsch")) (t (ispell-change-dictionary "english"))))) @@ -9704,6 +11572,10 @@ @code{gnus-message-archive-group} variable should be @code{nil}, which is the default. +For archiving interesting messages in a group you read, see the +@kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail +Group Commands}). + @vindex gnus-message-archive-method @code{gnus-message-archive-method} says what virtual server Gnus is to use to store sent messages. The default is: @@ -9737,7 +11609,7 @@ This variable can be used to do the following: -@itemize @bullet +@table @asis @item a string Messages will be saved in that group. @@ -9750,13 +11622,16 @@ messages are stored in @samp{nnfolder+archive:foo}, but if you use the value @code{"nnml:foo"}, then outgoing messages will be stored in @samp{nnml:foo}. + @item a list of strings Messages will be saved in all those groups. + @item an alist of regexps, functions and forms When a key ``matches'', the result is used. + @item @code{nil} No message archiving will take place. This is the default. -@end itemize +@end table Let's illustrate: @@ -9796,8 +11671,8 @@ (concat "mail." (format-time-string "%Y-%m"))))) @end lisp -(XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to -use a different value for @code{gnus-message-archive-group} there.) +@c (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to +@c use a different value for @code{gnus-message-archive-group} there.) Now, when you send a message off, it will be stored in the appropriate group. (If you want to disable storing for just one particular message, @@ -9830,6 +11705,19 @@ This variable can be used instead of @code{gnus-message-archive-group}, but the latter is the preferred method. + +@item gnus-gcc-mark-as-read +@vindex gnus-gcc-mark-as-read +If non-@code{nil}, automatically mark @code{Gcc} articles as read. + +@item gnus-gcc-externalize-attachments +@vindex gnus-gcc-externalize-attachments +If @code{nil}, attach files as normal parts in Gcc copies; if a regexp +and matches the Gcc group name, attach files as external parts; if it is +@code{all}, attach local files as external parts; if it is other +non-@code{nil}, the behavior is the same as @code{all}, but it may be +changed in the future. + @end table @@ -9873,30 +11761,47 @@ The first element in each style is called the @code{match}. If it's a string, then Gnus will try to regexp match it against the group name. -If it is the symbol @code{header}, then Gnus will look for header that -match the next element in the match, and compare that to the last header -in the match. If it's a function symbol, that function will be called -with no arguments. If it's a variable symbol, then the variable will be +If it is the form @code{(header @var{match} @var{regexp})}, then Gnus +will look in the original article for a header whose name is +@var{match} and compare that @var{regexp}. @var{match} and +@var{regexp} are strings. (The original article is the one you are +replying or following up to. If you are not composing a reply or a +followup, then there is nothing to match against.) If the +@code{match} is a function symbol, that function will be called with +no arguments. If it's a variable symbol, then the variable will be referenced. If it's a list, then that list will be @code{eval}ed. In -any case, if this returns a non-@code{nil} value, then the style is said -to @dfn{match}. - -Each style may contain a arbitrary amount of @dfn{attributes}. Each -attribute consists of a @code{(@var{name} . @var{value})} pair. The -attribute name can be one of @code{signature}, @code{signature-file}, -@code{organization}, @code{address}, @code{name} or @code{body}. The -attribute name can also be a string. In that case, this will be used as -a header name, and the value will be inserted in the headers of the -article; if the value is @code{nil}, the header name will be removed. -If the attribute name is @code{eval}, the form is evaluated, and the -result is thrown away. +any case, if this returns a non-@code{nil} value, then the style is +said to @dfn{match}. + +Each style may contain an arbitrary amount of @dfn{attributes}. Each +attribute consists of a @code{(@var{name} @var{value})} pair. The +attribute name can be one of: + +@itemize @bullet +@item @code{signature} +@item @code{signature-file} +@item @code{x-face-file} +@item @code{address}, overriding @code{user-mail-address} +@item @code{name}, overriding @code{(user-full-name)} +@item @code{body} +@end itemize + +The attribute name can also be a string or a symbol. In that case, +this will be used as a header name, and the value will be inserted in +the headers of the article; if the value is @code{nil}, the header +name will be removed. If the attribute name is @code{eval}, the form +is evaluated, and the result is thrown away. The attribute value can be a string (used verbatim), a function with zero arguments (the return value will be used), a variable (its value will be used) or a list (it will be @code{eval}ed and the return value will be used). The functions and sexps are called/@code{eval}ed in the message buffer that is being set up. The headers of the current article -are available through the @code{message-reply-headers} variable. +are available through the @code{message-reply-headers} variable, which +is a vector of the following headers: number subject from date id +references chars lines xref extra. + +@vindex message-reply-headers If you wish to check whether the message you are about to compose is meant to be a news article or a mail message, you can check the values @@ -9916,13 +11821,16 @@ (organization "People's Front Against MWM")) ("^rec.humor" (signature my-funny-signature-randomizer)) - ((equal (system-name) "gnarly") + ((equal (system-name) "gnarly") ;; @r{A form} (signature my-quote-randomizer)) - ((message-news-p) + (message-news-p ;; @r{A function symbol} (signature my-news-signature)) - (header "From\\|To" "larsi.*org" - (Organization "Somewhere, Inc.")) - ((posting-from-work-p) + (window-system ;; @r{A value symbol} + ("X-Window-System" (format "%s" window-system))) + ;; @r{If I'm replying to Larsi, set the Organization header.} + ((header "from" "larsi.*org") + (Organization "Somewhere, Inc.")) + ((posting-from-work-p) ;; @r{A user defined function} (signature-file "~/.work-signature") (address "user@@bar.foo") (body "You are fired.\n\nSincerely, your boss.") @@ -9968,7 +11876,13 @@ If the group doesn't exist, it will be created and you'll be subscribed to it. The only way to make it disappear from the Group buffer is to -unsubscribe it. +unsubscribe it. The special properties of the draft group comes from +a group property (@pxref{Group Parameters}), and if lost the group +behaves like any other group. This means the commands below will not +be available. To restore the special properties of the group, the +simplest way is to kill the group, using @kbd{C-k}, and restart +Gnus. The group is automatically created again with the +correct parameters. The content of the group is not lost. @c @findex gnus-dissociate-buffer-from-draft @c @kindex C-c M-d (Mail) @@ -9999,7 +11913,9 @@ Articles}). @findex gnus-draft-send-all-messages +@kindex D s (Draft) @findex gnus-draft-send-message +@kindex D S (Draft) If you have lots of rejected messages you want to post (or mail) without doing further editing, you can use the @kbd{D s} command (@code{gnus-draft-send-message}). This command understands the @@ -10007,6 +11923,8 @@ command (@code{gnus-draft-send-all-messages}) will ship off all messages in the buffer. +@findex gnus-draft-toggle-sending +@kindex D t (Draft) If you have some messages that you wish not to send, you can use the @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message as unsendable. This is a toggling command. @@ -10031,6 +11949,78 @@ (@pxref{Drafts}). When the server comes back up again, you'd then typically enter that group and send all the articles off. +@node Signing and encrypting +@section Signing and encrypting +@cindex using gpg +@cindex using s/mime +@cindex using smime + +Gnus can digitally sign and encrypt your messages, using vanilla +@acronym{PGP} format or @acronym{PGP/MIME} or @acronym{S/MIME}. For +decoding such messages, see the @code{mm-verify-option} and +@code{mm-decrypt-option} options (@pxref{Security}). + +@vindex gnus-message-replysign +@vindex gnus-message-replyencrypt +@vindex gnus-message-replysignencrypted +Often, you would like to sign replies to people who send you signed +messages. Even more often, you might want to encrypt messages which +are in reply to encrypted messages. Gnus offers +@code{gnus-message-replysign} to enable the former, and +@code{gnus-message-replyencrypt} for the latter. In addition, setting +@code{gnus-message-replysignencrypted} (on by default) will sign +automatically encrypted messages. + +Instructing @acronym{MML} to perform security operations on a +@acronym{MIME} part is done using the @kbd{C-c C-m s} key map for +signing and the @kbd{C-c C-m c} key map for encryption, as follows. + +@table @kbd + +@item C-c C-m s s +@kindex C-c C-m s s (Message) +@findex mml-secure-message-sign-smime + +Digitally sign current message using @acronym{S/MIME}. + +@item C-c C-m s o +@kindex C-c C-m s o (Message) +@findex mml-secure-message-sign-pgp + +Digitally sign current message using @acronym{PGP}. + +@item C-c C-m s p +@kindex C-c C-m s p (Message) +@findex mml-secure-message-sign-pgp + +Digitally sign current message using @acronym{PGP/MIME}. + +@item C-c C-m c s +@kindex C-c C-m c s (Message) +@findex mml-secure-message-encrypt-smime + +Digitally encrypt current message using @acronym{S/MIME}. + +@item C-c C-m c o +@kindex C-c C-m c o (Message) +@findex mml-secure-message-encrypt-pgp + +Digitally encrypt current message using @acronym{PGP}. + +@item C-c C-m c p +@kindex C-c C-m c p (Message) +@findex mml-secure-message-encrypt-pgpmime + +Digitally encrypt current message using @acronym{PGP/MIME}. + +@item C-c C-m C-n +@kindex C-c C-m C-n (Message) +@findex mml-unsecure-message +Remove security related @acronym{MML} tags from message. + +@end table + +@xref{Security, ,Security, message, Message Manual}, for more information. @node Select Methods @chapter Select Methods @@ -10039,7 +12029,7 @@ A @dfn{foreign group} is a group not read by the usual (or default) means. It could be, for instance, a group from a different -@sc{nntp} server, it could be a virtual group, or it could be your own +@acronym{NNTP} server, it could be a virtual group, or it could be your own personal mail group. A foreign group (or any group, really) is specified by a @dfn{name} and @@ -10050,12 +12040,12 @@ value may have special meaning for the back end in question. One could say that a select method defines a @dfn{virtual server}---so -we do just that (@pxref{The Server Buffer}). +we do just that (@pxref{Server Buffer}). The @dfn{name} of the group is the name the back end will recognize the group as. -For instance, the group @samp{soc.motss} on the @sc{nntp} server +For instance, the group @samp{soc.motss} on the @acronym{NNTP} server @samp{some.where.edu} will have the name @samp{soc.motss} and select method @code{(nntp "some.where.edu")}. Gnus will call this group @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp} @@ -10064,18 +12054,19 @@ The different methods all have their peculiarities, of course. @menu -* The Server Buffer:: Making and editing virtual servers. -* Getting News:: Reading USENET news with Gnus. -* Getting Mail:: Reading your personal mail with Gnus. -* Browsing the Web:: Getting messages from a plethora of Web sources. -* Other Sources:: Reading directories, files, SOUP packets. -* Combined Groups:: Combining groups into one group. -* Gnus Unplugged:: Reading news and mail offline. -@end menu - - -@node The Server Buffer -@section The Server Buffer +* Server Buffer:: Making and editing virtual servers. +* Getting News:: Reading USENET news with Gnus. +* Getting Mail:: Reading your personal mail with Gnus. +* Browsing the Web:: Getting messages from a plethora of Web sources. +* IMAP:: Using Gnus as a @acronym{IMAP} client. +* Other Sources:: Reading directories, files, SOUP packets. +* Combined Groups:: Combining groups into one group. +* Gnus Unplugged:: Reading news and mail offline. +@end menu + + +@node Server Buffer +@section Server Buffer Traditionally, a @dfn{server} is a machine or a piece of software that one connects to, and then requests information from. Gnus does not @@ -10085,14 +12076,14 @@ back end represents a virtual server. For instance, the @code{nntp} back end may be used to connect to several -different actual @sc{nntp} servers, or, perhaps, to many different ports -on the same actual @sc{nntp} server. You tell Gnus which back end to +different actual @acronym{NNTP} servers, or, perhaps, to many different ports +on the same actual @acronym{NNTP} server. You tell Gnus which back end to use, and what parameters to set by specifying a @dfn{select method}. These select method specifications can sometimes become quite complicated---say, for instance, that you want to read from the -@sc{nntp} server @samp{news.funet.fi} on port number 13, which -hangs if queried for @sc{nov} headers and has a buggy select. Ahem. +@acronym{NNTP} server @samp{news.funet.fi} on port number 13, which +hangs if queried for @acronym{NOV} headers and has a buggy select. Ahem. Anyway, if you had to specify that for each group that used this server, that would be too much work, so Gnus offers a way of naming select methods, which is what you do in the server buffer. @@ -10101,13 +12092,13 @@ (@code{gnus-group-enter-server-mode}) command in the group buffer. @menu -* Server Buffer Format:: You can customize the look of this buffer. -* Server Commands:: Commands to manipulate servers. -* Example Methods:: Examples server specifications. -* Creating a Virtual Server:: An example session. -* Server Variables:: Which variables to set. -* Servers and Methods:: You can use server names as select methods. -* Unavailable Servers:: Some servers you try to contact may be down. +* Server Buffer Format:: You can customize the look of this buffer. +* Server Commands:: Commands to manipulate servers. +* Example Methods:: Examples server specifications. +* Creating a Virtual Server:: An example session. +* Server Variables:: Which variables to set. +* Servers and Methods:: You can use server names as select methods. +* Unavailable Servers:: Some servers you try to contact may be down. @end menu @vindex gnus-server-mode-hook @@ -10170,8 +12161,8 @@ @findex gnus-server-edit-server Edit a server (@code{gnus-server-edit-server}). -@item @key{SPC} -@kindex @key{SPC} (Server) +@item SPACE +@kindex SPACE (Server) @findex gnus-server-read-server Browse the current server (@code{gnus-server-read-server}). @@ -10273,33 +12264,40 @@ @cindex proxy @cindex firewall -If you are behind a firewall and only have access to the @sc{nntp} +If you are behind a firewall and only have access to the @acronym{NNTP} server from the firewall machine, you can instruct Gnus to @code{rlogin} -on the firewall machine and telnet from there to the @sc{nntp} server. +on the firewall machine and telnet from there to the @acronym{NNTP} server. Doing this can be rather fiddly, but your virtual server definition should probably look something like this: @lisp (nntp "firewall" - (nntp-address "the.firewall.machine") - (nntp-open-connection-function nntp-open-rlogin) - (nntp-end-of-line "\n") - (nntp-rlogin-parameters - ("telnet" "the.real.nntp.host" "nntp"))) + (nntp-open-connection-function nntp-open-via-rlogin-and-telnet) + (nntp-via-address "the.firewall.machine") + (nntp-address "the.real.nntp.host") + (nntp-end-of-line "\n")) @end lisp If you want to use the wonderful @code{ssh} program to provide a -compressed connection over the modem line, you could create a virtual -server that would look something like this: - -@lisp -(nntp "news" - (nntp-address "copper.uio.no") - (nntp-rlogin-program "ssh") - (nntp-open-connection-function nntp-open-rlogin) - (nntp-end-of-line "\n") - (nntp-rlogin-parameters - ("telnet" "news.uio.no" "nntp"))) +compressed connection over the modem line, you could add the following +configuration to the example above: + +@lisp + (nntp-via-rlogin-command "ssh") +@end lisp + +See also @code{nntp-via-rlogin-command-switches}. + +If you're behind a firewall, but have direct access to the outside world +through a wrapper command like "runsocks", you could open a socksified +telnet connection to the news server as follows: + +@lisp +(nntp "outside" + (nntp-pre-command "runsocks") + (nntp-open-connection-function nntp-open-via-telnet) + (nntp-address "the.news.server") + (nntp-end-of-line "\n")) @end lisp This means that you have to have set up @code{ssh-agent} correctly to @@ -10315,42 +12313,43 @@ articles, you may want to create a virtual server to read the cache. First you need to add a new server. The @kbd{a} command does that. It -would probably be best to use @code{nnspool} to read the cache. You -could also use @code{nnml} or @code{nnmh}, though. - -Type @kbd{a nnspool @key{RET} cache @key{RET}}. - -You should now have a brand new @code{nnspool} virtual server called +would probably be best to use @code{nnml} to read the cache. You +could also use @code{nnspool} or @code{nnmh}, though. + +Type @kbd{a nnml RET cache RET}. + +You should now have a brand new @code{nnml} virtual server called @samp{cache}. You now need to edit it to have the right definitions. Type @kbd{e} to edit the server. You'll be entered into a buffer that will contain the following: @lisp -(nnspool "cache") +(nnml "cache") @end lisp Change that to: @lisp -(nnspool "cache" - (nnspool-spool-directory "~/News/cache/") - (nnspool-nov-directory "~/News/cache/") - (nnspool-active-file "~/News/cache/active")) +(nnml "cache" + (nnml-directory "~/News/cache/") + (nnml-active-file "~/News/cache/active")) @end lisp Type @kbd{C-c C-c} to return to the server buffer. If you now press -@key{RET} over this virtual server, you should be entered into a browse +@kbd{RET} over this virtual server, you should be entered into a browse buffer, and you should be able to enter any of the groups displayed. @node Server Variables @subsection Server Variables +@cindex server variables +@cindex server parameters One sticky point when defining variables (both on back ends and in Emacs in general) is that some variables are typically initialized from other variables when the definition of the variables is being loaded. If you -change the "base" variable after the variables have been loaded, you -won't change the "derived" variables. +change the ``base'' variable after the variables have been loaded, you +won't change the ``derived'' variables. This typically affects directory and file variables. For instance, @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml} @@ -10369,6 +12368,7 @@ (nnml-newsgroups-file "~/my-mail/newsgroups")) @end lisp +Server variables are often called @dfn{server parameters}. @node Servers and Methods @subsection Servers and Methods @@ -10401,7 +12401,7 @@ So, what happens if the machine was only feeling unwell temporarily? How do you test to see whether the machine has come up again? -You jump to the server buffer (@pxref{The Server Buffer}) and poke it +You jump to the server buffer (@pxref{Server Buffer}) and poke it with the following commands: @table @kbd @@ -10442,6 +12442,11 @@ Remove all marks to whether Gnus was denied connection from any servers (@code{gnus-server-remove-denials}). +@item L +@kindex L (Server) +@findex gnus-server-offline-server +Set server status to offline (@code{gnus-server-offline-server}). + @end table @@ -10451,24 +12456,24 @@ @cindex news back ends A newsreader is normally used for reading news. Gnus currently provides -only two methods of getting news---it can read from an @sc{nntp} server, +only two methods of getting news---it can read from an @acronym{NNTP} server, or it can read from a local spool. @menu -* NNTP:: Reading news from an @sc{nntp} server. -* News Spool:: Reading news from the local spool. +* NNTP:: Reading news from an @acronym{NNTP} server. +* News Spool:: Reading news from the local spool. @end menu @node NNTP -@subsection @sc{nntp} +@subsection NNTP @cindex nntp -Subscribing to a foreign group from an @sc{nntp} server is rather easy. -You just specify @code{nntp} as method and the address of the @sc{nntp} +Subscribing to a foreign group from an @acronym{NNTP} server is rather easy. +You just specify @code{nntp} as method and the address of the @acronym{NNTP} server as the, uhm, address. -If the @sc{nntp} server is located at a non-standard port, setting the +If the @acronym{NNTP} server is located at a non-standard port, setting the third element of the select method to this port number should allow you to connect to the right port. You'll have to edit the group info for that (@pxref{Foreign Groups}). @@ -10486,12 +12491,12 @@ @vindex nntp-server-opened-hook @cindex @sc{mode reader} @cindex authinfo -@cindex authentication -@cindex nntp authentication +@cindex authentification +@cindex nntp authentification @findex nntp-send-authinfo @findex nntp-send-mode-reader is run after a connection has been made. It can be used to send -commands to the @sc{nntp} server after it has been contacted. By +commands to the @acronym{NNTP} server after it has been contacted. By default it sends the command @code{MODE READER} to the server with the @code{nntp-send-mode-reader} function. This function should always be present in this hook. @@ -10500,7 +12505,7 @@ @vindex nntp-authinfo-function @findex nntp-send-authinfo @vindex nntp-authinfo-file -This function will be used to send @samp{AUTHINFO} to the @sc{nntp} +This function will be used to send @samp{AUTHINFO} to the @acronym{NNTP} server. The default function is @code{nntp-send-authinfo}, which looks through your @file{~/.authinfo} (or whatever you've set the @code{nntp-authinfo-file} variable to) for applicable entries. If none @@ -10582,7 +12587,7 @@ @item nntp-maximum-request @vindex nntp-maximum-request -If the @sc{nntp} server doesn't support @sc{nov} headers, this back end +If the @acronym{NNTP} server doesn't support @acronym{NOV} headers, this back end will collect headers by sending a series of @code{head} commands. To speed things up, the back end sends lots of these commands without waiting for reply, and then reads all the replies. This is controlled @@ -10592,7 +12597,7 @@ @item nntp-connection-timeout @vindex nntp-connection-timeout If you have lots of foreign @code{nntp} groups that you connect to -regularly, you're sure to have problems with @sc{nntp} servers not +regularly, you're sure to have problems with @acronym{NNTP} servers not responding properly, or being too loaded to reply within reasonable time. This is can lead to awkward problems, which can be helped somewhat by setting @code{nntp-connection-timeout}. This is an integer @@ -10606,7 +12611,7 @@ @c @cindex dynamic IP addresses @c If you're running Gnus on a machine that has a dynamically assigned @c address, Gnus may become confused. If the address of your machine -@c changes after connecting to the @sc{nntp} server, Gnus will simply sit +@c changes after connecting to the @acronym{NNTP} server, Gnus will simply sit @c waiting forever for replies from the server. To help with this @c unfortunate problem, you can set this command to a number. Gnus will @c then, if it sits waiting for a reply from the server longer than that @@ -10622,154 +12627,33 @@ @item nntp-server-hook @vindex nntp-server-hook -This hook is run as the last step when connecting to an @sc{nntp} +This hook is run as the last step when connecting to an @acronym{NNTP} server. -@findex nntp-open-rlogin -@findex nntp-open-telnet -@findex nntp-open-network-stream -@item nntp-open-connection-function -@vindex nntp-open-connection-function -This function is used to connect to the remote system. Four pre-made -functions are supplied: - -@table @code -@item nntp-open-network-stream -This is the default, and simply connects to some port or other on the -remote system. - -@item nntp-open-rlogin -Does an @samp{rlogin} on the -remote system, and then does a @samp{telnet} to the @sc{nntp} server -available there. - -@code{nntp-open-rlogin}-related variables: - -@table @code - -@item nntp-rlogin-program -@vindex nntp-rlogin-program -Program used to log in on remote machines. The default is @samp{rsh}, -but @samp{ssh} is a popular alternative. - -@item nntp-rlogin-parameters -@vindex nntp-rlogin-parameters -This list will be used as the parameter list given to @code{rsh}. - -@item nntp-rlogin-user-name -@vindex nntp-rlogin-user-name -User name on the remote system. - -@end table - -@item nntp-open-telnet -Does a @samp{telnet} to the remote system and then another @samp{telnet} -to get to the @sc{nntp} server. - -@code{nntp-open-telnet}-related variables: - -@table @code -@item nntp-telnet-command -@vindex nntp-telnet-command -Command used to start @code{telnet}. - -@item nntp-telnet-switches -@vindex nntp-telnet-switches -List of strings to be used as the switches to the @code{telnet} command. - -@item nntp-telnet-user-name -@vindex nntp-telnet-user-name -User name for log in on the remote system. - -@item nntp-telnet-passwd -@vindex nntp-telnet-passwd -Password to use when logging in. - -@item nntp-telnet-parameters -@vindex nntp-telnet-parameters -A list of strings executed as a command after logging in -via @code{telnet}. - -@item nntp-telnet-shell-prompt -@vindex nntp-telnet-shell-prompt -Regexp matching the shell prompt on the remote machine. The default is -@samp{bash\\|\$ *\r?$\\|> *\r?}. - -@item nntp-open-telnet-envuser -@vindex nntp-open-telnet-envuser -If non-@code{nil}, the @code{telnet} session (client and server both) -will support the @code{ENVIRON} option and not prompt for login name. -This works for Solaris @code{telnet}, for instance. - -@end table - -@findex nntp-open-ssl-stream -@item nntp-open-ssl-stream -Opens a connection to a server over a @dfn{secure} channel. To use this -you must have SSLeay installed -(@uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need -@file{ssl.el} (from the W3 distribution, for instance). You then -define a server as follows: - -@lisp -;; Type `C-c C-c' after you've finished editing. -;; -;; "snews" is port 563 and is predefined -;; in our /etc/services -;; -(nntp "snews.bar.com" - (nntp-open-connection-function - nntp-open-ssl-stream) - (nntp-port-number "snews") - (nntp-address "snews.bar.com")) -@end lisp - -@end table - -@item nntp-end-of-line -@vindex nntp-end-of-line -String to use as end-of-line marker when talking to the @sc{nntp} -server. This is @samp{\r\n} by default, but should be @samp{\n} when -using @code{rlogin} to talk to the server. - -@item nntp-rlogin-user-name -@vindex nntp-rlogin-user-name -User name on the remote system when using the @code{rlogin} connect -function. - -@item nntp-address -@vindex nntp-address -The address of the remote system running the @sc{nntp} server. - -@item nntp-port-number -@vindex nntp-port-number -Port number to connect to when using the @code{nntp-open-network-stream} -connect function. - @item nntp-buggy-select @vindex nntp-buggy-select Set this to non-@code{nil} if your select routine is buggy. @item nntp-nov-is-evil @vindex nntp-nov-is-evil -If the @sc{nntp} server does not support @sc{nov}, you could set this -variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov} +If the @acronym{NNTP} server does not support @acronym{NOV}, you could set this +variable to @code{t}, but @code{nntp} usually checks automatically whether @acronym{NOV} can be used. @item nntp-xover-commands @vindex nntp-xover-commands -@cindex nov +@cindex @acronym{NOV} @cindex XOVER -List of strings used as commands to fetch @sc{nov} lines from a +List of strings used as commands to fetch @acronym{NOV} lines from a server. The default value of this variable is @code{("XOVER" "XOVERVIEW")}. @item nntp-nov-gap @vindex nntp-nov-gap -@code{nntp} normally sends just one big request for @sc{nov} lines to +@code{nntp} normally sends just one big request for @acronym{NOV} lines to the server. The server responds with one huge list of lines. However, if you have read articles 2-5000 in the group, and only want to read -article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov} +article 1 and 5001, that means that @code{nntp} will fetch 4999 @acronym{NOV} lines that you will not need. This variable says how big a gap between two consecutive articles is allowed to be before the @code{XOVER} request is split into several request. Note that if your @@ -10779,7 +12663,7 @@ @item nntp-prepare-server-hook @vindex nntp-prepare-server-hook -A hook run before attempting to connect to an @sc{nntp} server. +A hook run before attempting to connect to an @acronym{NNTP} server. @item nntp-warn-about-losing-connection @vindex nntp-warn-about-losing-connection @@ -10789,10 +12673,258 @@ @item nntp-record-commands @vindex nntp-record-commands If non-@code{nil}, @code{nntp} will log all commands it sends to the -@sc{nntp} server (along with a timestamp) in the @samp{*nntp-log*} -buffer. This is useful if you are debugging a Gnus/@sc{nntp} connection +@acronym{NNTP} server (along with a timestamp) in the @samp{*nntp-log*} +buffer. This is useful if you are debugging a Gnus/@acronym{NNTP} connection that doesn't seem to work. +@item nntp-open-connection-function +@vindex nntp-open-connection-function +It is possible to customize how the connection to the nntp server will +be opened. If you specify an @code{nntp-open-connection-function} +parameter, Gnus will use that function to establish the connection. +Five pre-made functions are supplied. These functions can be grouped in +two categories: direct connection functions (three pre-made), and +indirect ones (two pre-made). + +@item nntp-prepare-post-hook +@vindex nntp-prepare-post-hook +A hook run just before posting an article. If there is no +@code{Message-ID} header in the article and the news server provides the +recommended ID, it will be added to the article before running this +hook. It is useful to make @code{Cancel-Lock} headers even if you +inhibit Gnus to add a @code{Message-ID} header, you could say: + +@lisp +(add-hook 'nntp-prepare-post-hook 'canlock-insert-header) +@end lisp + +Note that not all servers support the recommended ID. This works for +INN versions 2.3.0 and later, for instance. + +@item nntp-read-timeout +@vindex nntp-read-timeout +How long nntp should wait between checking for the end of output. +Shorter values mean quicker response, but is more CPU intensive. The +default is 0.1 seconds. If you have a slow line to the server (and +don't like to see Emacs eat your available CPU power), you might set +this to, say, 1. + +@end table + +@menu +* Direct Functions:: Connecting directly to the server. +* Indirect Functions:: Connecting indirectly to the server. +* Common Variables:: Understood by several connection functions. +@end menu + + +@node Direct Functions +@subsubsection Direct Functions +@cindex direct connection functions + +These functions are called direct because they open a direct connection +between your machine and the @acronym{NNTP} server. The behavior of these +functions is also affected by commonly understood variables +(@pxref{Common Variables}). + +@table @code +@findex nntp-open-network-stream +@item nntp-open-network-stream +This is the default, and simply connects to some port or other on the +remote system. + +@findex nntp-open-tls-stream +@item nntp-open-tls-stream +Opens a connection to a server over a @dfn{secure} channel. To use +this you must have @uref{http://www.gnu.org/software/gnutls/, GNUTLS} +installed. You then define a server as follows: + +@lisp +;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}} +;; @r{however, @samp{gnutls-cli -p} doesn't like named ports.} +;; +(nntp "snews.bar.com" + (nntp-open-connection-function nntp-open-tls-stream) + (nntp-port-number ) + (nntp-address "snews.bar.com")) +@end lisp + +@findex nntp-open-ssl-stream +@item nntp-open-ssl-stream +Opens a connection to a server over a @dfn{secure} channel. To use +this you must have @uref{http://www.openssl.org, OpenSSL} or +@uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL, SSLeay} installed. You +then define a server as follows: + +@lisp +;; @r{"snews" is port 563 and is predefined in our @file{/etc/services}} +;; @r{however, @samp{openssl s_client -port} doesn't like named ports.} +;; +(nntp "snews.bar.com" + (nntp-open-connection-function nntp-open-ssl-stream) + (nntp-port-number 563) + (nntp-address "snews.bar.com")) +@end lisp + +@findex nntp-open-telnet-stream +@item nntp-open-telnet-stream +Opens a connection to an @acronym{NNTP} server by simply @samp{telnet}'ing +it. You might wonder why this function exists, since we have the +default @code{nntp-open-network-stream} which would do the job. (One +of) the reason(s) is that if you are behind a firewall but have direct +connections to the outside world thanks to a command wrapper like +@code{runsocks}, you can use it like this: + +@lisp +(nntp "socksified" + (nntp-pre-command "runsocks") + (nntp-open-connection-function nntp-open-telnet-stream) + (nntp-address "the.news.server")) +@end lisp + +With the default method, you would need to wrap your whole Emacs +session, which is not a good idea. +@end table + + +@node Indirect Functions +@subsubsection Indirect Functions +@cindex indirect connection functions + +These functions are called indirect because they connect to an +intermediate host before actually connecting to the @acronym{NNTP} server. +All of these functions and related variables are also said to belong to +the ``via'' family of connection: they're all prefixed with ``via'' to make +things cleaner. The behavior of these functions is also affected by +commonly understood variables (@pxref{Common Variables}). + +@table @code +@item nntp-open-via-rlogin-and-telnet +@findex nntp-open-via-rlogin-and-telnet +Does an @samp{rlogin} on a remote system, and then does a @samp{telnet} +to the real @acronym{NNTP} server from there. This is useful for instance if +you need to connect to a firewall machine first. + +@code{nntp-open-via-rlogin-and-telnet}-specific variables: + +@table @code +@item nntp-via-rlogin-command +@vindex nntp-via-rlogin-command +Command used to log in on the intermediate host. The default is +@samp{rsh}, but @samp{ssh} is a popular alternative. + +@item nntp-via-rlogin-command-switches +@vindex nntp-via-rlogin-command-switches +List of strings to be used as the switches to +@code{nntp-via-rlogin-command}. The default is @code{nil}. If you use +@samp{ssh} for @code{nntp-via-rlogin-command}, you may set this to +@samp{("-C")} in order to compress all data connections, otherwise set +this to @samp{("-t" "-e" "none")} or @samp{("-C" "-t" "-e" "none")} if +the telnet command requires a pseudo-tty allocation on an intermediate +host. +@end table + +@item nntp-open-via-telnet-and-telnet +@findex nntp-open-via-telnet-and-telnet +Does essentially the same, but uses @samp{telnet} instead of +@samp{rlogin} to connect to the intermediate host. + +@code{nntp-open-via-telnet-and-telnet}-specific variables: + +@table @code +@item nntp-via-telnet-command +@vindex nntp-via-telnet-command +Command used to @code{telnet} the intermediate host. The default is +@samp{telnet}. + +@item nntp-via-telnet-switches +@vindex nntp-via-telnet-switches +List of strings to be used as the switches to the +@code{nntp-via-telnet-command} command. The default is @samp{("-8")}. + +@item nntp-via-user-password +@vindex nntp-via-user-password +Password to use when logging in on the intermediate host. + +@item nntp-via-envuser +@vindex nntp-via-envuser +If non-@code{nil}, the intermediate @code{telnet} session (client and +server both) will support the @code{ENVIRON} option and not prompt for +login name. This works for Solaris @code{telnet}, for instance. + +@item nntp-via-shell-prompt +@vindex nntp-via-shell-prompt +Regexp matching the shell prompt on the intermediate host. The default +is @samp{bash\\|\$ *\r?$\\|> *\r?}. + +@end table + +@end table + + +Here are some additional variables that are understood by all the above +functions: + +@table @code + +@item nntp-via-user-name +@vindex nntp-via-user-name +User name to use when connecting to the intermediate host. + +@item nntp-via-address +@vindex nntp-via-address +Address of the intermediate host to connect to. + +@end table + + +@node Common Variables +@subsubsection Common Variables + +The following variables affect the behavior of all, or several of the +pre-made connection functions. When not specified, all functions are +affected. + +@table @code + +@item nntp-pre-command +@vindex nntp-pre-command +A command wrapper to use when connecting through a non native +connection function (all except @code{nntp-open-network-stream}, +@code{nntp-open-tls-stream}, and @code{nntp-open-ssl-stream}. This is +where you would put a @samp{SOCKS} wrapper for instance. + +@item nntp-address +@vindex nntp-address +The address of the @acronym{NNTP} server. + +@item nntp-port-number +@vindex nntp-port-number +Port number to connect to the @acronym{NNTP} server. The default is +@samp{nntp}. If you use @acronym{NNTP} over +@acronym{tls}/@acronym{ssl}, you may want to use integer ports rather +than named ports (i.e, use @samp{563} instead of @samp{snews} or +@samp{nntps}), because external @acronym{TLS}/@acronym{SSL} tools may +not work with named ports. + +@item nntp-end-of-line +@vindex nntp-end-of-line +String to use as end-of-line marker when talking to the @acronym{NNTP} +server. This is @samp{\r\n} by default, but should be @samp{\n} when +using a non native connection function. + +@item nntp-telnet-command +@vindex nntp-telnet-command +Command to use when connecting to the @acronym{NNTP} server through +@samp{telnet}. This is @emph{not} for an intermediate host. This is +just for the real @acronym{NNTP} server. The default is +@samp{telnet}. + +@item nntp-telnet-switches +@vindex nntp-telnet-switches +A list of switches to pass to @code{nntp-telnet-command}. The default +is @samp{("-8")}. + @end table @@ -10831,7 +12963,7 @@ @item nnspool-nov-directory @vindex nnspool-nov-directory -Where @code{nnspool} will look for @sc{nov} files. This is normally +Where @code{nnspool} will look for @acronym{NOV} files. This is normally@* @file{/usr/spool/news/over.view/}. @item nnspool-lib-dir @@ -10856,15 +12988,16 @@ @item nnspool-nov-is-evil @vindex nnspool-nov-is-evil -If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files +If non-@code{nil}, @code{nnspool} won't try to use any @acronym{NOV} files that it finds. @item nnspool-sift-nov-with-sed @vindex nnspool-sift-nov-with-sed @cindex sed If non-@code{nil}, which is the default, use @code{sed} to get the -relevant portion from the overview file. If nil, @code{nnspool} will -load the entire file into a buffer and process it there. +relevant portion from the overview file. If @code{nil}, +@code{nnspool} will load the entire file into a buffer and process it +there. @end table @@ -10878,19 +13011,19 @@ course. @menu -* Mail in a Newsreader:: Important introductory notes. -* Getting Started Reading Mail:: A simple cookbook example. -* Splitting Mail:: How to create mail groups. -* Mail Sources:: How to tell Gnus where to get mail from. -* Mail Back End Variables:: Variables for customizing mail handling. -* Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail. -* Group Mail Splitting:: Use group customize to drive mail splitting. -* Incorporating Old Mail:: What about the old mail you have? -* Expiring Mail:: Getting rid of unwanted mail. -* Washing Mail:: Removing gruft from the mail you get. -* Duplicates:: Dealing with duplicated mail. -* Not Reading Mail:: Using mail back ends for reading other files. -* Choosing a Mail Back End:: Gnus can read a variety of mail formats. +* Mail in a Newsreader:: Important introductory notes. +* Getting Started Reading Mail:: A simple cookbook example. +* Splitting Mail:: How to create mail groups. +* Mail Sources:: How to tell Gnus where to get mail from. +* Mail Back End Variables:: Variables for customizing mail handling. +* Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail. +* Group Mail Splitting:: Use group customize to drive mail splitting. +* Incorporating Old Mail:: What about the old mail you have? +* Expiring Mail:: Getting rid of unwanted mail. +* Washing Mail:: Removing cruft from the mail you get. +* Duplicates:: Dealing with duplicated mail. +* Not Reading Mail:: Using mail back ends for reading other files. +* Choosing a Mail Back End:: Gnus can read a variety of mail formats. @end menu @@ -10917,7 +13050,7 @@ But, no, it means that old messages are @dfn{expired} according to some scheme or other. For news messages, the expire process is controlled by the news administrator; for mail, the expire process is controlled by -you. The expire process for mail is covered in depth in @pxref{Expiring +you. The expire process for mail is covered in depth in @ref{Expiring Mail}. What many Gnus users find, after using it a while for both news and @@ -10925,13 +13058,13 @@ they want to treat a message. Many people subscribe to several mailing lists. These are transported -via SMTP, and are therefore mail. But we might go for weeks without +via @acronym{SMTP}, and are therefore mail. But we might go for weeks without answering, or even reading these messages very carefully. We may not need to save them because if we should need to read one again, they are archived somewhere else. Some people have local news groups which have only a handful of readers. -These are transported via @sc{nntp}, and are therefore news. But we may need +These are transported via @acronym{NNTP}, and are therefore news. But we may need to read and answer a large fraction of the messages very carefully in order to do our work. And there may not be an archive, so we may need to save the interesting messages the same way we would personal mail. @@ -10966,17 +13099,16 @@ mail back end of your choice into @code{gnus-secondary-select-methods}, and things will happen automatically. -For instance, if you want to use @code{nnml} (which is a "one file per -mail" back end), you could put the following in your @file{.gnus} file: - -@lisp -(setq gnus-secondary-select-methods - '((nnml "private"))) +For instance, if you want to use @code{nnml} (which is a ``one file per +mail'' back end), you could put the following in your @file{~/.gnus.el} file: + +@lisp +(setq gnus-secondary-select-methods '((nnml ""))) @end lisp Now, the next time you start Gnus, this back end will be queried for new articles, and it will move all the messages in your spool file to its -directory, which is @code{~/Mail/} by default. The new group that will +directory, which is @file{~/Mail/} by default. The new group that will be created (@samp{mail.misc}) will be subscribed, and you can read it like any other group. @@ -11003,6 +13135,7 @@ @subsection Splitting Mail @cindex splitting mail @cindex mail splitting +@cindex mail filtering (splitting) @vindex nnmail-split-methods The @code{nnmail-split-methods} variable says how the incoming mail is @@ -11033,11 +13166,11 @@ mail belongs in that group. The last of these groups should always be a general one, and the regular -expression should @emph{always} be @samp{} so that it matches any mails +expression should @emph{always} be @samp{*} so that it matches any mails that haven't been matched by any of the other regexps. (These rules are processed from the beginning of the alist toward the end. The first -rule to make a match will "win", unless you have crossposting enabled. -In that case, all matching rules will "win".) +rule to make a match will ``win'', unless you have crossposting enabled. +In that case, all matching rules will ``win''.) If you like to tinker with this yourself, you can set this variable to a function of your choice. This function will be called without any @@ -11048,13 +13181,13 @@ Note that the mail back ends are free to maul the poor, innocent, incoming headers all they want to. They all add @code{Lines} headers; some add @code{X-Gnus-Group} headers; most rename the Unix mbox -@samp{From } line to something else. +@code{From} line to something else. @vindex nnmail-crosspost The mail back ends all support cross-posting. If several regexps match, the mail will be ``cross-posted'' to all those groups. @code{nnmail-crosspost} says whether to use this mechanism or not. Note -that no articles are crossposted to the general (@samp{}) group. +that no articles are crossposted to the general (@samp{*}) group. @vindex nnmail-crosspost-link-function @cindex crosspost @@ -11066,13 +13199,36 @@ variable is @code{add-name-to-file} by default.) @kindex M-x nnmail-split-history -@kindex nnmail-split-history +@findex nnmail-split-history If you wish to see where the previous mail split put the messages, you can use the @kbd{M-x nnmail-split-history} command. If you wish to see where re-spooling messages would put the messages, you can use @code{gnus-summary-respool-trace} and related commands (@pxref{Mail Group Commands}). +@vindex nnmail-split-header-length-limit +Header lines longer than the value of +@code{nnmail-split-header-length-limit} are excluded from the split +function. + +@vindex nnmail-mail-splitting-charset +@vindex nnmail-mail-splitting-decodes +By default the splitting codes @acronym{MIME} decodes headers so you +can match on non-@acronym{ASCII} strings. The +@code{nnmail-mail-splitting-charset} variable specifies the default +charset for decoding. The behaviour can be turned off completely by +binding @code{nnmail-mail-splitting-decodes} to @code{nil}, which is +useful if you want to match articles based on the raw header data. + +@vindex nnmail-resplit-incoming +By default, splitting is performed on all incoming messages. If you +specify a @code{directory} entry for the variable @code{mail-sources} +(@pxref{Mail Source Specifiers}), however, then splitting does +@emph{not} happen by default. You can set the variable +@code{nnmail-resplit-incoming} to a non-@code{nil} value to make +splitting happen even in this case. (This variable has no effect on +other kinds of entries.) + Gnus gives you all the opportunity you could possibly want for shooting yourself in the foot. Let's say you create a group that will contain all the mail you get from your boss. And then you accidentally @@ -11087,14 +13243,14 @@ @node Mail Sources @subsection Mail Sources -Mail can be gotten from many different sources---the mail spool, from a -POP mail server, from a procmail directory, or from a maildir, for -instance. - -@menu -* Mail Source Specifiers:: How to specify what a mail source is. -* Mail Source Customization:: Some variables that influence things. -* Fetching Mail:: Using the mail source specifiers. +Mail can be gotten from many different sources---the mail spool, from +a @acronym{POP} mail server, from a procmail directory, or from a +maildir, for instance. + +@menu +* Mail Source Specifiers:: How to specify what a mail source is. +* Mail Source Customization:: Some variables that influence things. +* Fetching Mail:: Using the mail source specifiers. @end menu @@ -11130,8 +13286,13 @@ @table @code @item :path -The file name. Defaults to the value of the @code{MAIL} -environment variable or @file{/usr/mail/spool/user-name}. +The file name. Defaults to the value of the @env{MAIL} +environment variable or the value of @code{rmail-spool-directory} +(usually something like @file{/usr/mail/spool/user-name}). + +@item :prescript +@itemx :postscript +Script run before/after fetching mail. @end table An example file mail source: @@ -11146,10 +13307,10 @@ (file) @end lisp -If the mail spool file is not located on the local machine, it's best to -use POP or @sc{imap} or the like to fetch the mail. You can not use ange-ftp -file names here---it has no way to lock the mail spool while moving the -mail. +If the mail spool file is not located on the local machine, it's best +to use @acronym{POP} or @acronym{IMAP} or the like to fetch the mail. +You can not use ange-ftp file names here---it has no way to lock the +mail spool while moving the mail. If it's impossible to set up a proper server, you can use ssh instead. @@ -11174,10 +13335,21 @@ @item directory -Get mail from several files in a directory. This is typically used when -you have procmail split the incoming mail into several files. Setting -@code{nnmail-scan-directory-mail-source-once} to non-nil force Gnus to -scan the mail source only once. +@vindex nnmail-scan-directory-mail-source-once +Get mail from several files in a directory. This is typically used +when you have procmail split the incoming mail into several files. +That is, there is a one-to-one correspondence between files in that +directory and groups, so that mail from the file @file{foo.bar.spool} +will be put in the group @code{foo.bar}. (You can change the suffix +to be used instead of @code{.spool}.) Setting +@code{nnmail-scan-directory-mail-source-once} to non-@code{nil} forces +Gnus to scan the mail source only once. This is particularly useful +if you want to scan mail groups at a specified level. + +@vindex nnmail-resplit-incoming +There is also the variable @code{nnmail-resplit-incoming}, if you set +that to a non-@code{nil} value, then the normal splitting process is +applied to all the files from the directory, @ref{Splitting Mail}. Keywords: @@ -11210,33 +13382,33 @@ @end lisp @item pop -Get mail from a POP server. +Get mail from a @acronym{POP} server. Keywords: @table @code @item :server -The name of the POP server. The default is taken from the -@code{MAILHOST} environment variable. +The name of the @acronym{POP} server. The default is taken from the +@env{MAILHOST} environment variable. @item :port -The port number of the POP server. This can be a number (e.g.@: -@samp{:port 110}) or a string (e.g.@: @samp{:port "pop3"}). If it is a +The port number of the @acronym{POP} server. This can be a number (eg, +@samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a string, it should be a service name as listed in @file{/etc/services} on Unix systems. The default is @samp{"pop3"}. On some systems you might need to specify it as @samp{"pop-3"} instead. @item :user -The user name to give to the POP server. The default is the login +The user name to give to the @acronym{POP} server. The default is the login name. @item :password -The password to give to the POP server. If not specified, the user is -prompted. +The password to give to the @acronym{POP} server. If not specified, +the user is prompted. @item :program -The program to use to fetch mail from the POP server. This should be -a @code{format}-like string. Here's an example: +The program to use to fetch mail from the @acronym{POP} server. This +should be a @code{format}-like string. Here's an example: @example fetchmail %u@@%s -P %p %t @@ -11274,9 +13446,9 @@ the @code{:program} keyword. This can also be a function to be run. @item :function -The function to use to fetch mail from the POP server. The function is -called with one parameter---the name of the file where the mail should -be moved to. +The function to use to fetch mail from the @acronym{POP} server. The +function is called with one parameter---the name of the file where the +mail should be moved to. @item :authentication This can be either the symbol @code{password} or the symbol @code{apop} @@ -11288,8 +13460,8 @@ If the @code{:program} and @code{:function} keywords aren't specified, @code{pop3-movemail} will be used. -Here are some examples. Fetch from the default POP server, using the -default user name, and default fetcher: +Here are some examples. Fetch from the default @acronym{POP} server, +using the default user name, and default fetcher: @lisp (pop) @@ -11318,8 +13490,8 @@ @table @code @item :path The name of the directory where the mails are stored. The default is -taken from the @code{MAILDIR} environment variable or -@samp{~/Maildir/}. +taken from the @env{MAILDIR} environment variable or +@file{~/Maildir/}. @item :subdirs The subdirectories of the Maildir. The default is @samp{("new" "cur")}. @@ -11347,45 +13519,49 @@ @end lisp @item imap -Get mail from a @sc{imap} server. If you don't want to use @sc{imap} -as intended, as a network mail reading protocol (ie with nnimap), for -some reason or other, Gnus let you treat it similar to a POP server -and fetches articles from a given @sc{imap} mailbox. @xref{IMAP}, for -more information. +Get mail from a @acronym{IMAP} server. If you don't want to use +@acronym{IMAP} as intended, as a network mail reading protocol (ie +with nnimap), for some reason or other, Gnus let you treat it similar +to a @acronym{POP} server and fetches articles from a given +@acronym{IMAP} mailbox. @xref{IMAP}, for more information. + +Note that for the Kerberos, GSSAPI, @acronym{TLS}/@acronym{SSL} and STARTTLS support you +may need external programs and libraries, @xref{IMAP}. Keywords: @table @code @item :server -The name of the @sc{imap} server. The default is taken from the -@code{MAILHOST} environment variable. +The name of the @acronym{IMAP} server. The default is taken from the +@env{MAILHOST} environment variable. @item :port -The port number of the @sc{imap} server. The default is @samp{143}, or -@samp{993} for SSL connections. +The port number of the @acronym{IMAP} server. The default is @samp{143}, or +@samp{993} for @acronym{TLS}/@acronym{SSL} connections. @item :user -The user name to give to the @sc{imap} server. The default is the login +The user name to give to the @acronym{IMAP} server. The default is the login name. @item :password -The password to give to the @sc{imap} server. If not specified, the user is +The password to give to the @acronym{IMAP} server. If not specified, the user is prompted. @item :stream What stream to use for connecting to the server, this is one of the symbols in @code{imap-stream-alist}. Right now, this means -@samp{kerberos4}, @samp{ssl} or the default @samp{network}. +@samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{tls}, +@samp{ssl}, @samp{shell} or the default @samp{network}. @item :authentication -Which authenticator to use for authenticating to the server, this is one -of the symbols in @code{imap-authenticator-alist}. Right now, this -means @samp{kerberos4}, @samp{cram-md5}, @samp{anonymous} or the default -@samp{login}. +Which authenticator to use for authenticating to the server, this is +one of the symbols in @code{imap-authenticator-alist}. Right now, +this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5}, +@samp{cram-md5}, @samp{anonymous} or the default @samp{login}. @item :program When using the `shell' :stream, the contents of this variable is -mapped into the `imap-shell-program' variable. This should be a +mapped into the @code{imap-shell-program} variable. This should be a @code{format}-like string (or list of strings). Here's an example: @example @@ -11399,7 +13575,7 @@ The name of the server. @item l -User name from `imap-default-user'. +User name from @code{imap-default-user}. @item p The port number of the server. @@ -11415,24 +13591,24 @@ @item :predicate The predicate used to find articles to fetch. The default, @samp{UNSEEN UNDELETED}, is probably the best choice for most people, but if you -sometimes peek in your mailbox with a @sc{imap} client and mark some -articles as read (or; SEEN) you might want to set this to @samp{nil}. +sometimes peek in your mailbox with a @acronym{IMAP} client and mark some +articles as read (or; SEEN) you might want to set this to @samp{1:*}. Then all articles in the mailbox is fetched, no matter what. For a -complete list of predicates, see RFC 2060 §6.4.4. +complete list of predicates, see RFC 2060 section 6.4.4. @item :fetchflag How to flag fetched articles on the server, the default @samp{\Deleted} will mark them as deleted, an alternative would be @samp{\Seen} which would simply mark them as read. These are the two most likely choices, -but more flags are defined in RFC 2060 §2.3.2. +but more flags are defined in RFC 2060 section 2.3.2. @item :dontexpunge -If non-nil, don't remove all articles marked as deleted in the mailbox -after finishing the fetch. - -@end table - -An example @sc{imap} mail source: +If non-@code{nil}, don't remove all articles marked as deleted in the +mailbox after finishing the fetch. + +@end table + +An example @acronym{IMAP} mail source: @lisp (imap :server "mail.mycorp.com" @@ -11441,16 +13617,14 @@ @end lisp @item webmail -Get mail from a webmail server, such as www.hotmail.com, -webmail.netscape.com, www.netaddress.com, www.my-deja.com. - -NOTE: Now mail.yahoo.com provides POP3 service, so @sc{pop} mail source -is suggested. - -NOTE: Webmail largely depends cookies. A "one-line-cookie" patch is +Get mail from a webmail server, such as @uref{http://www.hotmail.com/}, +@uref{http://webmail.netscape.com/}, @uref{http://www.netaddress.com/}, +@uref{http://mail.yahoo.com/}. + +NOTE: Webmail largely depends on cookies. A "one-line-cookie" patch is required for url "4.0pre.46". -WARNING: Mails may lost. NO WARRANTY. +WARNING: Mails may be lost. NO WARRANTY. Keywords: @@ -11468,8 +13642,8 @@ prompted. @item :dontexpunge -If non-nil, only fetch unread articles and don't move them to trash -folder after finishing the fetch. +If non-@code{nil}, only fetch unread articles and don't move them to +trash folder after finishing the fetch. @end table @@ -11490,8 +13664,9 @@ @table @code @item :plugged -If non-nil, fetch the mail even when Gnus is unplugged. If you use -directory source to get mail, you can specify it as in this example: +If non-@code{nil}, fetch the mail even when Gnus is unplugged. If you +use directory source to get mail, you can specify it as in this +example: @lisp (setq mail-sources @@ -11537,12 +13712,27 @@ @table @code @item mail-source-crash-box @vindex mail-source-crash-box -File where mail will be stored while processing it. The default is +File where mail will be stored while processing it. The default is@* @file{~/.emacs-mail-crash-box}. @item mail-source-delete-incoming @vindex mail-source-delete-incoming -If non-@code{nil}, delete incoming files after handling them. +If non-@code{nil}, delete incoming files after handling them. If +@code{t}, delete the files immediately, if @code{nil}, never delete any +files. If a positive number, delete files older than number of days +(This will only happen, when receiving new mail). You may also set +@code{mail-source-delete-incoming} to @code{nil} and call +@code{mail-source-delete-old-incoming} from a hook or interactively. + +@item mail-source-delete-old-incoming-confirm +@vindex mail-source-delete-old-incoming-confirm +If non-@code{nil}, ask for for confirmation before deleting old incoming +files. This variable only applies when +@code{mail-source-delete-incoming} is a positive number. + +@item mail-source-ignore-errors +@vindex mail-source-ignore-errors +If non-@code{nil}, ignore errors when reading mail from a mail source. @item mail-source-directory @vindex mail-source-directory @@ -11562,6 +13752,11 @@ @vindex mail-source-default-file-modes All new mail files will get this file mode. The default is 384. +@item mail-source-movemail-program +@vindex mail-source-movemail-program +If non-@code{nil}, name of program for fetching new mail. If +@code{nil}, @code{movemail} in @var{exec-directory}. + @end table @@ -11578,8 +13773,8 @@ @code{nil}, the mail back ends will never attempt to fetch mail by themselves. -If you want to fetch mail both from your local spool as well as a POP -mail server, you'd say something like: +If you want to fetch mail both from your local spool as well as a +@acronym{POP} mail server, you'd say something like: @lisp (setq mail-sources @@ -11623,9 +13818,9 @@ @vindex nnmail-split-hook @item nnmail-split-hook -@findex article-decode-encoded-words -@findex RFC 1522 decoding -@findex RFC 2047 decoding +@findex gnus-article-decode-encoded-words +@cindex RFC 1522 decoding +@cindex RFC 2047 decoding Hook run in the buffer where the mail headers of each message is kept just before the splitting based on these headers is done. The hook is free to modify the buffer contents in any way it sees fit---the buffer @@ -11646,10 +13841,10 @@ default file modes the new mail files get: @lisp -(add-hook 'gnus-pre-get-new-mail-hook +(add-hook 'nnmail-pre-get-new-mail-hook (lambda () (set-default-file-modes 511))) -(add-hook 'gnus-post-get-new-mail-hook +(add-hook 'nnmail-post-get-new-mail-hook (lambda () (set-default-file-modes 551))) @end lisp @@ -11672,6 +13867,16 @@ the back end (via @code{Gcc}, for instance) into the mail duplication discovery cache. The default is @code{nil}. +@item nnmail-cache-ignore-groups +@vindex nnmail-cache-ignore-groups +This can be a regular expression or a list of regular expressions. +Group names that match any of the regular expressions will never be +recorded in the @code{Message-ID} cache. + +This can be useful, for example, when using Fancy Splitting +(@pxref{Fancy Mail Splitting}) together with the function +@code{nnmail-split-fancy-with-parent}. + @end table @@ -11690,94 +13895,100 @@ Let's look at an example value of this variable first: @lisp -;; Messages from the mailer daemon are not crossposted to any of -;; the ordinary groups. Warnings are put in a separate group -;; from real errors. +;; @r{Messages from the mailer daemon are not crossposted to any of} +;; @r{the ordinary groups. Warnings are put in a separate group} +;; @r{from real errors.} (| ("from" mail (| ("subject" "warn.*" "mail.warning") "mail.misc")) - ;; Non-error messages are crossposted to all relevant - ;; groups, but we don't crosspost between the group for the - ;; (ding) list and the group for other (ding) related mail. + ;; @r{Non-error messages are crossposted to all relevant} + ;; @r{groups, but we don't crosspost between the group for the} + ;; @r{(ding) list and the group for other (ding) related mail.} (& (| (any "ding@@ifi\\.uio\\.no" "ding.list") ("subject" "ding" "ding.misc")) - ;; Other mailing lists... + ;; @r{Other mailing lists@dots{}} (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list") (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list") - ;; Both lists below have the same suffix, so prevent - ;; cross-posting to mkpkg.list of messages posted only to - ;; the bugs- list, but allow cross-posting when the - ;; message was really cross-posted. + ;; @r{Both lists below have the same suffix, so prevent} + ;; @r{cross-posting to mkpkg.list of messages posted only to} + ;; @r{the bugs- list, but allow cross-posting when the} + ;; @r{message was really cross-posted.} (any "bugs-mypackage@@somewhere" "mypkg.bugs") (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list") - ;; People... + ;; @r{People@dots{}} (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen")) - ;; Unmatched mail goes to the catch all group. + ;; @r{Unmatched mail goes to the catch all group.} "misc.misc") @end lisp -This variable has the format of a @dfn{split}. A split is a (possibly) -recursive structure where each split may contain other splits. Here are -the five possible split syntaxes: - -@enumerate - -@item -@samp{group}: If the split is a string, that will be taken as a group -name. Normal regexp match expansion will be done. See below for -examples. - -@item -@code{(@var{field} @var{value} @code{[-} @var{restrict} -@code{[@dots{}]}@code{]} @var{split})}: If the split is a list, the -first element of which is a string, then store the message as -specified by @var{split}, if header @var{field} (a regexp) contains -@var{value} (also a regexp). If @var{restrict} (yet another regexp) -matches some string after @var{field} and before the end of the -matched @var{value}, the @var{split} is ignored. If none of the -@var{restrict} clauses match, @var{split} is processed. - -@item -@code{(| @var{split}@dots{})}: If the split is a list, and the first -element is @code{|} (vertical bar), then process each @var{split} until -one of them matches. A @var{split} is said to match if it will cause -the mail message to be stored in one or more groups. - -@item -@code{(& @var{split}@dots{})}: If the split is a list, and the first -element is @code{&}, then process all @var{split}s in the list. - -@item -@code{junk}: If the split is the symbol @code{junk}, then don't save +This variable has the format of a @dfn{split}. A split is a +(possibly) recursive structure where each split may contain other +splits. Here are the possible split syntaxes: + +@table @code + +@item group +If the split is a string, that will be taken as a group name. Normal +regexp match expansion will be done. See below for examples. + +@item (@var{field} @var{value} [- @var{restrict} [@dots{}] ] @var{split}) +If the split is a list, the first element of which is a string, then +store the message as specified by @var{split}, if header @var{field} +(a regexp) contains @var{value} (also a regexp). If @var{restrict} +(yet another regexp) matches some string after @var{field} and before +the end of the matched @var{value}, the @var{split} is ignored. If +none of the @var{restrict} clauses match, @var{split} is processed. + +@item (| @var{split} @dots{}) +If the split is a list, and the first element is @code{|} (vertical +bar), then process each @var{split} until one of them matches. A +@var{split} is said to match if it will cause the mail message to be +stored in one or more groups. + +@item (& @var{split} @dots{}) +If the split is a list, and the first element is @code{&}, then +process all @var{split}s in the list. + +@item junk +If the split is the symbol @code{junk}, then don't save (i.e., delete) this message. Use with extreme caution. -@item -@code{(: @var{function} @var{arg1} @var{arg2} @dots{})}: If the split is -a list, and the first element is @code{:}, then the second element will -be called as a function with @var{args} given as arguments. The -function should return a @var{split}. - +@item (: @var{function} @var{arg1} @var{arg2} @dots{}) +If the split is a list, and the first element is @samp{:}, then the +second element will be called as a function with @var{args} given as +arguments. The function should return a @var{split}. + +@cindex body split For instance, the following function could be used to split based on the body of the messages: @lisp (defun split-on-body () (save-excursion - (set-buffer " *nnmail incoming*") - (goto-char (point-min)) - (when (re-search-forward "Some.*string" nil t) - "string.group"))) -@end lisp - -@item -@code{(! @var{func} @var{split})}: If the split is a list, and the first -element is @code{!}, then SPLIT will be processed, and FUNC will be -called as a function with the result of SPLIT as argument. FUNC should -return a split. - -@item -@code{nil}: If the split is @code{nil}, it is ignored. - -@end enumerate + (save-restriction + (widen) + (goto-char (point-min)) + (when (re-search-forward "Some.*string" nil t) + "string.group")))) +@end lisp + +The buffer is narrowed to the message in question when @var{function} +is run. That's why @code{(widen)} needs to be called after +@code{save-excursion} and @code{save-restriction} in the example +above. Also note that with the nnimap backend, message bodies will +not be downloaded by default. You need to set +@code{nnimap-split-download-body} to t to do that (@pxref{Splitting in +IMAP}). + +@item (! @var{func} @var{split}) +If the split is a list, and the first element is @code{!}, then +@var{split} will be processed, and @var{func} will be called as a +function with the result of @var{split} as argument. @var{func} +should return a split. + +@item nil +If the split is @code{nil}, it is ignored. + +@end table In these splits, @var{field} must match a complete field name. @var{value} must match a complete word according to the fundamental mode @@ -11786,11 +13997,22 @@ @samp{\<} and @samp{\>} pairs. @vindex nnmail-split-abbrev-alist -@var{field} and @var{value} can also be lisp symbols, in that case they -are expanded as specified by the variable -@code{nnmail-split-abbrev-alist}. This is an alist of cons cells, where -the @code{car} of a cell contains the key, and the @code{cdr} contains the associated -value. +@var{field} and @var{value} can also be Lisp symbols, in that case +they are expanded as specified by the variable +@code{nnmail-split-abbrev-alist}. This is an alist of cons cells, +where the @sc{car} of a cell contains the key, and the @sc{cdr} +contains the associated value. Predefined entries in +@code{nnmail-split-abbrev-alist} include: + +@table @code +@item from +Matches the @samp{From}, @samp{Sender} and @samp{Resent-From} fields. +@item to +Matches the @samp{To}, @samp{Cc}, @samp{Apparently-To}, +@samp{Resent-To} and @samp{Resent-Cc} fields. +@item any +Is the union of the @code{from} and @code{to} entries. +@end table @vindex nnmail-split-fancy-syntax-table @code{nnmail-split-fancy-syntax-table} is the syntax table in effect @@ -11812,6 +14034,25 @@ up to @samp{\\9} will be substituted with the text matched by the groupings 1 through 9. +@vindex nnmail-split-fancy-match-partial-words +@code{nnmail-split-fancy-match-partial-words} controls whether partial +words are matched during fancy splitting. + +Normally, regular expressions given in @code{nnmail-split-fancy} are +implicitly surrounded by @code{\<...\>} markers, which are word +delimiters. If this variable is true, they are not implicitly +surrounded by anything. + +@example +(any "joe" "joemail") +@end example + +In this example, messages sent from @samp{joedavis@@foo.org} will +normally not be filed in @samp{joemail}. With +@code{nnmail-split-fancy-match-partial-words} set to t, however, the +match will happen. In effect, the requirement of a word boundary is +removed and instead the match becomes more like a grep. + @findex nnmail-split-fancy-with-parent @code{nnmail-split-fancy-with-parent} is a function which allows you to split followups into the same groups their parents are in. Sometimes @@ -11822,34 +14063,46 @@ messages into the right group. With this function, you only have to do it once per thread. -To use this feature, you have to set @code{nnmail-treat-duplicates} to a -non-nil value. And then you can include -@code{nnmail-split-fancy-with-parent} using the colon feature, like so: -@lisp -(setq nnmail-split-fancy +To use this feature, you have to set @code{nnmail-treat-duplicates} +and @code{nnmail-cache-accepted-message-ids} to a non-@code{nil} +value. And then you can include @code{nnmail-split-fancy-with-parent} +using the colon feature, like so: +@lisp +(setq nnmail-treat-duplicates 'warn ; @r{or @code{delete}} + nnmail-cache-accepted-message-ids t + nnmail-split-fancy '(| (: nnmail-split-fancy-with-parent) - ;; other splits go here + ;; @r{other splits go here} )) @end lisp This feature works as follows: when @code{nnmail-treat-duplicates} is -non-nil, Gnus records the message id of every message it sees in the -file specified by the variable @code{nnmail-message-id-cache-file}, -together with the group it is in (the group is omitted for non-mail -messages). When mail splitting is invoked, the function -@code{nnmail-split-fancy-with-parent} then looks at the References (and -In-Reply-To) header of each message to split and searches the file -specified by @code{nnmail-message-id-cache-file} for the message ids. -When it has found a parent, it returns the corresponding group name. It -is recommended that you set @code{nnmail-message-id-cache-length} to a +non-@code{nil}, Gnus records the message id of every message it sees +in the file specified by the variable +@code{nnmail-message-id-cache-file}, together with the group it is in +(the group is omitted for non-mail messages). When mail splitting is +invoked, the function @code{nnmail-split-fancy-with-parent} then looks +at the References (and In-Reply-To) header of each message to split +and searches the file specified by @code{nnmail-message-id-cache-file} +for the message ids. When it has found a parent, it returns the +corresponding group name unless the group name matches the regexp +@code{nnmail-split-fancy-with-parent-ignore-groups}. It is +recommended that you set @code{nnmail-message-id-cache-length} to a somewhat higher number than the default so that the message ids are -still in the cache. (A value of 5000 appears to create a file some 300 -kBytes in size.) +still in the cache. (A value of 5000 appears to create a file some +300 kBytes in size.) @vindex nnmail-cache-accepted-message-ids When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus also records the message ids of moved articles, so that the followup messages goes into the new group. +Also see the variable @code{nnmail-cache-ignore-groups} if you don't +want certain groups to be recorded in the cache. For example, if all +outgoing messages are written to an ``outgoing'' group, you could set +@code{nnmail-cache-ignore-groups} to match that group name. +Otherwise, answers to all your messages would end up in the +``outgoing'' group. + @node Group Mail Splitting @subsection Group Mail Splitting @@ -11859,31 +14112,31 @@ @findex gnus-group-split If you subscribe to dozens of mailing lists but you don't want to maintain mail splitting rules manually, group mail splitting is for you. -You just have to set @var{to-list} and/or @var{to-address} in group +You just have to set @code{to-list} and/or @code{to-address} in group parameters or group customization and set @code{nnmail-split-methods} to @code{gnus-group-split}. This splitting function will scan all groups for those parameters and split mail accordingly, i.e., messages posted -from or to the addresses specified in the parameters @var{to-list} or -@var{to-address} of a mail group will be stored in that group. +from or to the addresses specified in the parameters @code{to-list} or +@code{to-address} of a mail group will be stored in that group. Sometimes, mailing lists have multiple addresses, and you may want mail -splitting to recognize them all: just set the @var{extra-aliases} group +splitting to recognize them all: just set the @code{extra-aliases} group parameter to the list of additional addresses and it's done. If you'd -rather use a regular expression, set @var{split-regexp}. +rather use a regular expression, set @code{split-regexp}. All these parameters in a group will be used to create an @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any}, the @var{value} is a single regular expression that matches -@var{to-list}, @var{to-address}, all of @var{extra-aliases} and all -matches of @var{split-regexp}, and the @var{split} is the name of the +@code{to-list}, @code{to-address}, all of @code{extra-aliases} and all +matches of @code{split-regexp}, and the @var{split} is the name of the group. @var{restrict}s are also supported: just set the -@var{split-exclude} parameter to a list of regular expressions. +@code{split-exclude} parameter to a list of regular expressions. If you can't get the right split to be generated using all these parameters, or you just need something fancier, you can set the -parameter @var{split-spec} to an @code{nnmail-split-fancy} split. In +parameter @code{split-spec} to an @code{nnmail-split-fancy} split. In this case, all other aforementioned parameters will be ignored by -@code{gnus-group-split}. In particular, @var{split-spec} may be set to +@code{gnus-group-split}. In particular, @code{split-spec} may be set to @code{nil}, in which case the group will be ignored by @code{gnus-group-split}. @@ -11892,7 +14145,7 @@ by defining a single @code{&} fancy split containing one split for each group. If a message doesn't match any split, it will be stored in the group named in @code{gnus-group-split-default-catch-all-group}, unless -some group has @var{split-spec} set to @code{catch-all}, in which case +some group has @code{split-spec} set to @code{catch-all}, in which case that group is used as the catch-all group. Even though this variable is often used just to name a group, it may also be set to an arbitrarily complex fancy split (after all, a group name is a fancy split), and this @@ -11934,17 +14187,17 @@ splits like this: @lisp -(: gnus-mlsplt-fancy GROUPS NO-CROSSPOST CATCH-ALL) +(: gnus-group-split-fancy @var{groups} @var{no-crosspost} @var{catch-all}) @end lisp @var{groups} may be a regular expression or a list of group names whose parameters will be scanned to generate the output split. @var{no-crosspost} can be used to disable cross-posting; in this case, a -single @code{|} split will be output. @var{catch-all} is the fallback -fancy split, used like @var{gnus-group-split-default-catch-all-group}. -If @var{catch-all} is @code{nil}, or if @var{split-regexp} matches the +single @code{|} split will be output. @var{catch-all} is the fall back +fancy split, used like @code{gnus-group-split-default-catch-all-group}. +If @var{catch-all} is @code{nil}, or if @code{split-regexp} matches the empty string in any selected group, no catch-all split will be issued. -Otherwise, if some group has @var{split-spec} set to @code{catch-all}, +Otherwise, if some group has @code{split-spec} set to @code{catch-all}, this group will override the value of the @var{catch-all} argument. @findex gnus-group-split-setup @@ -11958,14 +14211,14 @@ scanned once, no matter how many messages are split. @findex gnus-group-split-update -However, if you change group parameters, you have to update +However, if you change group parameters, you'd have to update @code{nnmail-split-fancy} manually. You can do it by running @code{gnus-group-split-update}. If you'd rather have it updated automatically, just tell @code{gnus-group-split-setup} to do it for -you. For example, add to your @file{.gnus}: - -@lisp -(gnus-group-split-setup AUTO-UPDATE CATCH-ALL) +you. For example, add to your @file{~/.gnus.el}: + +@lisp +(gnus-group-split-setup @var{auto-update} @var{catch-all}) @end lisp If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update} @@ -11982,6 +14235,8 @@ @node Incorporating Old Mail @subsection Incorporating Old Mail +@cindex incorporating old mail +@cindex import old mail Most people have lots of old mail stored in various file formats. If you have set up Gnus to read mail using one of the spiffy Gnus mail @@ -12003,11 +14258,11 @@ Go to the group buffer. @item -Type @kbd{G f} and give the name of the mbox file when prompted to create an +Type @kbd{G f} and give the file name to the mbox file when prompted to create an @code{nndoc} group from the mbox file (@pxref{Foreign Groups}). @item -Type @key{SPC} to enter the newly created group. +Type @kbd{SPACE} to enter the newly created group. @item Type @kbd{M P b} to process-mark all articles in this group's buffer @@ -12046,26 +14301,51 @@ course. To make Gnus get rid of your unwanted mail, you have to mark the -articles as @dfn{expirable}. This does not mean that the articles will -disappear right away, however. In general, a mail article will be +articles as @dfn{expirable}. (With the default key bindings, this means +that you have to type @kbd{E}.) This does not mean that the articles +will disappear right away, however. In general, a mail article will be deleted from your system if, 1) it is marked as expirable, AND 2) it is more than one week old. If you do not mark an article as expirable, it will remain on your system until hell freezes over. This bears repeating one more time, with some spurious capitalizations: IF you do NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES. +You do not have to mark articles as expirable by hand. Gnus provides +two features, called ``auto-expire'' and ``total-expire'', that can help you +with this. In a nutshell, ``auto-expire'' means that Gnus hits @kbd{E} +for you when you select an article. And ``total-expire'' means that Gnus +considers all articles as expirable that are read. So, in addition to +the articles marked @samp{E}, also the articles marked @samp{r}, +@samp{R}, @samp{O}, @samp{K}, @samp{Y} and so on are considered +expirable. + +When should either auto-expire or total-expire be used? Most people +who are subscribed to mailing lists split each list into its own group +and then turn on auto-expire or total-expire for those groups. +(@xref{Splitting Mail}, for more information on splitting each list +into its own group.) + +Which one is better, auto-expire or total-expire? It's not easy to +answer. Generally speaking, auto-expire is probably faster. Another +advantage of auto-expire is that you get more marks to work with: for +the articles that are supposed to stick around, you can still choose +between tick and dormant and read marks. But with total-expire, you +only have dormant and ticked to choose from. The advantage of +total-expire is that it works well with adaptive scoring (@pxref{Adaptive +Scoring}). Auto-expire works with normal scoring but not with adaptive +scoring. + @vindex gnus-auto-expirable-newsgroups -You do not have to mark articles as expirable by hand. Groups that -match the regular expression @code{gnus-auto-expirable-newsgroups} will -have all articles that you read marked as expirable automatically. All -articles marked as expirable have an @samp{E} in the first -column in the summary buffer. +Groups that match the regular expression +@code{gnus-auto-expirable-newsgroups} will have all articles that you +read marked as expirable automatically. All articles marked as +expirable have an @samp{E} in the first column in the summary buffer. By default, if you have auto expiry switched on, Gnus will mark all the articles you read as expirable, no matter if they were read or unread before. To avoid having articles marked as read marked as expirable automatically, you can put something like the following in your -@file{.gnus} file: +@file{~/.gnus.el} file: @vindex gnus-mark-article-hook @lisp @@ -12077,7 +14357,7 @@ Note that making a group auto-expirable doesn't mean that all read articles are expired---only the articles marked as expirable will be expired. Also note that using the @kbd{d} command won't make -groups expirable---only semi-automatic marking of articles as read will +articles expirable---only semi-automatic marking of articles as read will mark the articles as expirable in auto-expirable groups. Let's say you subscribe to a couple of mailing lists, and you want the @@ -12134,23 +14414,43 @@ @vindex nnmail-expiry-target The normal action taken when expiring articles is to delete them. -However, in some circumstances it might make more sense to move them to -other groups instead of deleting them. The variable @code{nnmail-expiry-target} -(and the @code{expiry-target} group parameter) controls this. The -variable supplies a default value for all groups, which can be -overridden for specific groups by the group parameter. -default value is @code{delete}, but this can also be a string (which -should be the name of the group the message should be moved to), or a -function (which will be called in a buffer narrowed to the message in -question, and with the name of the group being moved from as its -parameter) which should return a target -- either a group name or -@code{delete}. +However, in some circumstances it might make more sense to move them +to other groups instead of deleting them. The variable +@code{nnmail-expiry-target} (and the @code{expiry-target} group +parameter) controls this. The variable supplies a default value for +all groups, which can be overridden for specific groups by the group +parameter. default value is @code{delete}, but this can also be a +string (which should be the name of the group the message should be +moved to), or a function (which will be called in a buffer narrowed to +the message in question, and with the name of the group being moved +from as its parameter) which should return a target---either a group +name or @code{delete}. Here's an example for specifying a group name: @lisp (setq nnmail-expiry-target "nnml:expired") @end lisp +@findex nnmail-fancy-expiry-target +@vindex nnmail-fancy-expiry-targets +Gnus provides a function @code{nnmail-fancy-expiry-target} which will +expire mail to groups according to the variable +@code{nnmail-fancy-expiry-targets}. Here's an example: + +@lisp + (setq nnmail-expiry-target 'nnmail-fancy-expiry-target + nnmail-fancy-expiry-targets + '((to-from "boss" "nnfolder:Work") + ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b") + ("from" ".*" "nnfolder:Archive-%Y"))) +@end lisp + +With this setup, any mail that has @code{IMPORTANT} in its Subject +header and was sent in the year @code{YYYY} and month @code{MMM}, will +get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its +From or To header contains the string @code{boss}, it will get expired +to @code{nnfolder:Work}. All other mail will get expired to +@code{nnfolder:Archive-YYYY}. @vindex nnmail-keep-last-article If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never @@ -12200,7 +14500,7 @@ Gnus provides a plethora of functions for washing articles while displaying them, but it might be nicer to do the filtering before -storing the mail to disc. For that purpose, we have three hooks and +storing the mail to disk. For that purpose, we have three hooks and various functions that can be put in these hooks. @table @code @@ -12229,6 +14529,12 @@ Clear leading white space that ``helpful'' listservs have added to the headers to make them look nice. Aaah. +(Note that this function works on both the header on the body of all +messages, so it is a potentially dangerous function to use (if a body +of a message contains something that looks like a header line). So +rather than fix the bug, it is of course the right solution to make it +into a feature by documenting it.) + @item nnmail-remove-list-identifiers @findex nnmail-remove-list-identifiers Some list servers add an identifier---for example, @samp{(idm)}---to the @@ -12251,7 +14557,7 @@ @item nnmail-remove-tabs @findex nnmail-remove-tabs -Translate all tab characters into space characters. +Translate all @samp{TAB} characters into @samp{SPACE} characters. @item nnmail-fix-eudora-headers @findex nnmail-fix-eudora-headers @@ -12311,19 +14617,19 @@ @lisp (setq nnmail-split-fancy - '(| ;; Messages duplicates go to a separate group. - ("gnus-warning" "duplication of message" "duplicate") - ;; Message from daemons, postmaster, and the like to another. - (any mail "mail.misc") - ;; Other rules. - [ ... ] )) -@end lisp - + '(| ;; @r{Messages duplicates go to a separate group.} + ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate") + ;; @r{Message from daemons, postmaster, and the like to another.} + (any mail "mail.misc") + ;; @r{Other rules.} + [...] )) +@end lisp +@noindent Or something like: @lisp (setq nnmail-split-methods - '(("duplicates" "^Gnus-Warning:") - ;; Other rules. + '(("duplicates" "^Gnus-Warning:.*duplicate") + ;; @r{Other rules.} [...])) @end lisp @@ -12351,7 +14657,7 @@ @vindex nnmh-get-new-mail @vindex nnfolder-get-new-mail This might be too much, if, for instance, you are reading mail quite -happily with @code{nnml} and just want to peek at some old @sc{rmail} +happily with @code{nnml} and just want to peek at some old Rmail file you have stashed away with @code{nnbabyl}. All back ends have variables called back-end-@code{get-new-mail}. If you want to disable the @code{nnbabyl} mail reading, you edit the virtual server for the @@ -12369,16 +14675,17 @@ file is first copied to your home directory. What happens after that depends on what format you want to store your mail in. -There are five different mail back ends in the standard Gnus, and more +There are six different mail back ends in the standard Gnus, and more back ends are available separately. The mail back end most people use -(because it is the fastest and most flexible) is @code{nnml} -(@pxref{Mail Spool}). +(because it is possibly the fastest) is @code{nnml} (@pxref{Mail +Spool}). @menu * Unix Mail Box:: Using the (quite) standard Un*x mbox. -* Rmail Babyl:: Emacs programs use the rmail babyl format. +* Rmail Babyl:: Emacs programs use the Rmail Babyl format. * Mail Spool:: Store your mail in a private spool? * MH Spool:: An mhspool-like back end. +* Maildir:: Another one-file-per-message format. * Mail Folders:: Having one file for each group. * Comparing Mail Back Ends:: An in-depth looks at pros and cons. @end menu @@ -12400,27 +14707,29 @@ @table @code @item nnmbox-mbox-file @vindex nnmbox-mbox-file -The name of the mail box in the user's home directory. +The name of the mail box in the user's home directory. Default is +@file{~/mbox}. @item nnmbox-active-file @vindex nnmbox-active-file -The name of the active file for the mail box. +The name of the active file for the mail box. Default is +@file{~/.mbox-active}. @item nnmbox-get-new-mail @vindex nnmbox-get-new-mail If non-@code{nil}, @code{nnmbox} will read incoming mail and split it -into groups. +into groups. Default is @code{t}. @end table @node Rmail Babyl @subsubsection Rmail Babyl @cindex nnbabyl -@cindex rmail mbox +@cindex Rmail mbox @vindex nnbabyl-active-file @vindex nnbabyl-mbox-file -The @dfn{nnbabyl} back end will use a babyl mail box (aka. @dfn{rmail +The @dfn{nnbabyl} back end will use a Babyl mail box (aka. @dfn{Rmail mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail article to say which group it belongs in. @@ -12429,22 +14738,24 @@ @table @code @item nnbabyl-mbox-file @vindex nnbabyl-mbox-file -The name of the rmail mbox file. +The name of the Rmail mbox file. The default is @file{~/RMAIL} @item nnbabyl-active-file @vindex nnbabyl-active-file -The name of the active file for the rmail box. +The name of the active file for the rmail box. The default is +@file{~/.rmail-active} @item nnbabyl-get-new-mail @vindex nnbabyl-get-new-mail -If non-@code{nil}, @code{nnbabyl} will read incoming mail. +If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is +@code{t} @end table @node Mail Spool @subsubsection Mail Spool @cindex nnml -@cindex mail @sc{nov} spool +@cindex mail @acronym{NOV} spool The @dfn{nnml} spool mail format isn't compatible with any other known format. It should be used with some caution. @@ -12469,46 +14780,81 @@ @code{nnml} is probably the slowest back end when it comes to article splitting. It has to create lots of files, and it also generates -@sc{nov} databases for the incoming mails. This makes it the fastest -back end when it comes to reading mail. +@acronym{NOV} databases for the incoming mails. This makes it possibly the +fastest back end when it comes to reading mail. + +@cindex self contained nnml servers +@cindex marks +When the marks file is used (which it is by default), @code{nnml} +servers have the property that you may backup them using @code{tar} or +similar, and later be able to restore them into Gnus (by adding the +proper @code{nnml} server) and have all your marks be preserved. Marks +for a group is usually stored in the @code{.marks} file (but see +@code{nnml-marks-file-name}) within each @code{nnml} group's directory. +Individual @code{nnml} groups are also possible to backup, use @kbd{G m} +to restore the group (after restoring the backup into the nnml +directory). + +If for some reason you believe your @file{.marks} files are screwed +up, you can just delete them all. Gnus will then correctly regenerate +them next time it starts. Virtual server settings: @table @code @item nnml-directory @vindex nnml-directory -All @code{nnml} directories will be placed under this directory. +All @code{nnml} directories will be placed under this directory. The +default is the value of @code{message-directory} (whose default value +is @file{~/Mail}). @item nnml-active-file @vindex nnml-active-file -The active file for the @code{nnml} server. +The active file for the @code{nnml} server. The default is +@file{~/Mail/active}. @item nnml-newsgroups-file @vindex nnml-newsgroups-file The @code{nnml} group descriptions file. @xref{Newsgroups File -Format}. +Format}. The default is @file{~/Mail/newsgroups}. @item nnml-get-new-mail @vindex nnml-get-new-mail -If non-@code{nil}, @code{nnml} will read incoming mail. +If non-@code{nil}, @code{nnml} will read incoming mail. The default is +@code{t}. @item nnml-nov-is-evil @vindex nnml-nov-is-evil -If non-@code{nil}, this back end will ignore any @sc{nov} files. +If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The +default is @code{nil}. @item nnml-nov-file-name @vindex nnml-nov-file-name -The name of the @sc{nov} files. The default is @file{.overview}. +The name of the @acronym{NOV} files. The default is @file{.overview}. @item nnml-prepare-save-mail-hook @vindex nnml-prepare-save-mail-hook Hook run narrowed to an article before saving. +@item nnml-marks-is-evil +@vindex nnml-marks-is-evil +If non-@code{nil}, this back end will ignore any @sc{marks} files. The +default is @code{nil}. + +@item nnml-marks-file-name +@vindex nnml-marks-file-name +The name of the @dfn{marks} files. The default is @file{.marks}. + +@item nnml-use-compressed-files +@vindex nnml-use-compressed-files +If non-@code{nil}, @code{nnml} will allow using compressed message +files. + @end table @findex nnml-generate-nov-databases -If your @code{nnml} groups and @sc{nov} files get totally out of whack, -you can do a complete update by typing @kbd{M-x +If your @code{nnml} groups and @acronym{NOV} files get totally out of +whack, you can do a complete update by typing @kbd{M-x nnml-generate-nov-databases}. This command will trawl through the entire @code{nnml} hierarchy, looking at each and every article, so it might take a while to complete. A better interface to this @@ -12522,30 +14868,298 @@ @cindex mh-e mail spool @code{nnmh} is just like @code{nnml}, except that is doesn't generate -@sc{nov} databases and it doesn't keep an active file. This makes -@code{nnmh} a @emph{much} slower back end than @code{nnml}, but it also -makes it easier to write procmail scripts for. +@acronym{NOV} databases and it doesn't keep an active file or marks +file. This makes @code{nnmh} a @emph{much} slower back end than +@code{nnml}, but it also makes it easier to write procmail scripts +for. Virtual server settings: @table @code @item nnmh-directory @vindex nnmh-directory -All @code{nnmh} directories will be located under this directory. +All @code{nnmh} directories will be located under this directory. The +default is the value of @code{message-directory} (whose default is +@file{~/Mail}) @item nnmh-get-new-mail @vindex nnmh-get-new-mail -If non-@code{nil}, @code{nnmh} will read incoming mail. +If non-@code{nil}, @code{nnmh} will read incoming mail. The default is +@code{t}. @item nnmh-be-safe @vindex nnmh-be-safe If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make -sure that the articles in the folder are actually what Gnus thinks they -are. It will check date stamps and stat everything in sight, so +sure that the articles in the folder are actually what Gnus thinks +they are. It will check date stamps and stat everything in sight, so setting this to @code{t} will mean a serious slow-down. If you never -use anything but Gnus to read the @code{nnmh} articles, you do not have -to set this variable to @code{t}. -@end table +use anything but Gnus to read the @code{nnmh} articles, you do not +have to set this variable to @code{t}. The default is @code{nil}. +@end table + + +@node Maildir +@subsubsection Maildir +@cindex nnmaildir +@cindex maildir + +@code{nnmaildir} stores mail in the maildir format, with each maildir +corresponding to a group in Gnus. This format is documented here: +@uref{http://cr.yp.to/proto/maildir.html} and here: +@uref{http://www.qmail.org/man/man5/maildir.html}. @code{nnmaildir} +also stores extra information in the @file{.nnmaildir/} directory +within a maildir. + +Maildir format was designed to allow concurrent deliveries and +reading, without needing locks. With other back ends, you would have +your mail delivered to a spool of some kind, and then you would +configure Gnus to split mail from that spool into your groups. You +can still do that with @code{nnmaildir}, but the more common +configuration is to have your mail delivered directly to the maildirs +that appear as group in Gnus. + +@code{nnmaildir} is designed to be perfectly reliable: @kbd{C-g} will +never corrupt its data in memory, and @code{SIGKILL} will never +corrupt its data in the filesystem. + +@code{nnmaildir} stores article marks and @acronym{NOV} data in each +maildir. So you can copy a whole maildir from one Gnus setup to +another, and you will keep your marks. + +Virtual server settings: + +@table @code +@item directory +For each of your @code{nnmaildir} servers (it's very unlikely that +you'd need more than one), you need to create a directory and populate +it with maildirs or symlinks to maildirs (and nothing else; do not +choose a directory already used for other purposes). Each maildir +will be represented in Gnus as a newsgroup on that server; the +filename of the symlink will be the name of the group. Any filenames +in the directory starting with @samp{.} are ignored. The directory is +scanned when you first start Gnus, and each time you type @kbd{g} in +the group buffer; if any maildirs have been removed or added, +@code{nnmaildir} notices at these times. + +The value of the @code{directory} parameter should be a Lisp form +which is processed by @code{eval} and @code{expand-file-name} to get +the path of the directory for this server. The form is @code{eval}ed +only when the server is opened; the resulting string is used until the +server is closed. (If you don't know about forms and @code{eval}, +don't worry---a simple string will work.) This parameter is not +optional; you must specify it. I don't recommend using +@code{"~/Mail"} or a subdirectory of it; several other parts of Gnus +use that directory by default for various things, and may get confused +if @code{nnmaildir} uses it too. @code{"~/.nnmaildir"} is a typical +value. + +@item target-prefix +This should be a Lisp form which is processed by @code{eval} and +@code{expand-file-name}. The form is @code{eval}ed only when the +server is opened; the resulting string is used until the server is +closed. + +When you create a group on an @code{nnmaildir} server, the maildir is +created with @code{target-prefix} prepended to its name, and a symlink +pointing to that maildir is created, named with the plain group name. +So if @code{directory} is @code{"~/.nnmaildir"} and +@code{target-prefix} is @code{"../maildirs/"}, then when you create +the group @code{foo}, @code{nnmaildir} will create +@file{~/.nnmaildir/../maildirs/foo} as a maildir, and will create +@file{~/.nnmaildir/foo} as a symlink pointing to +@file{../maildirs/foo}. + +You can set @code{target-prefix} to a string without any slashes to +create both maildirs and symlinks in the same @code{directory}; in +this case, any maildirs found in @code{directory} whose names start +with @code{target-prefix} will not be listed as groups (but the +symlinks pointing to them will be). + +As a special case, if @code{target-prefix} is @code{""} (the default), +then when you create a group, the maildir will be created in +@code{directory} without a corresponding symlink. Beware that you +cannot use @code{gnus-group-delete-group} on such groups without the +@code{force} argument. + +@item directory-files +This should be a function with the same interface as +@code{directory-files} (such as @code{directory-files} itself). It is +used to scan the server's @code{directory} for maildirs. This +parameter is optional; the default is +@code{nnheader-directory-files-safe} if +@code{nnheader-directory-files-is-safe} is @code{nil}, and +@code{directory-files} otherwise. +(@code{nnheader-directory-files-is-safe} is checked only once when the +server is opened; if you want to check it each time the directory is +scanned, you'll have to provide your own function that does that.) + +@item get-new-mail +If non-@code{nil}, then after scanning for new mail in the group +maildirs themselves as usual, this server will also incorporate mail +the conventional Gnus way, from @code{mail-sources} according to +@code{nnmail-split-methods} or @code{nnmail-split-fancy}. The default +value is @code{nil}. + +Do @emph{not} use the same maildir both in @code{mail-sources} and as +an @code{nnmaildir} group. The results might happen to be useful, but +that would be by chance, not by design, and the results might be +different in the future. If your split rules create new groups, +remember to supply a @code{create-directory} server parameter. +@end table + +@subsubsection Group parameters + +@code{nnmaildir} uses several group parameters. It's safe to ignore +all this; the default behavior for @code{nnmaildir} is the same as the +default behavior for other mail back ends: articles are deleted after +one week, etc. Except for the expiry parameters, all this +functionality is unique to @code{nnmaildir}, so you can ignore it if +you're just trying to duplicate the behavior you already have with +another back end. + +If the value of any of these parameters is a vector, the first element +is evaluated as a Lisp form and the result is used, rather than the +original value. If the value is not a vector, the value itself is +evaluated as a Lisp form. (This is why these parameters use names +different from those of other, similar parameters supported by other +back ends: they have different, though similar, meanings.) (For +numbers, strings, @code{nil}, and @code{t}, you can ignore the +@code{eval} business again; for other values, remember to use an extra +quote and wrap the value in a vector when appropriate.) + +@table @code +@item expire-age +An integer specifying the minimum age, in seconds, of an article +before it will be expired, or the symbol @code{never} to specify that +articles should never be expired. If this parameter is not set, +@code{nnmaildir} falls back to the usual +@code{nnmail-expiry-wait}(@code{-function}) variables (overrideable by +the @code{expiry-wait}(@code{-function}) group parameters. If you +wanted a value of 3 days, you could use something like @code{[(* 3 24 +60 60)]}; @code{nnmaildir} will evaluate the form and use the result. +An article's age is measured starting from the article file's +modification time. Normally, this is the same as the article's +delivery time, but editing an article makes it younger. Moving an +article (other than via expiry) may also make an article younger. + +@item expire-group +If this is set to a string such as a full Gnus group name, like +@example +"backend+server.address.string:group.name" +@end example +and if it is not the name of the same group that the parameter belongs +to, then articles will be moved to the specified group during expiry +before being deleted. @emph{If this is set to an @code{nnmaildir} +group, the article will be just as old in the destination group as it +was in the source group.} So be careful with @code{expire-age} in the +destination group. If this is set to the name of the same group that +the parameter belongs to, then the article is not expired at all. If +you use the vector form, the first element is evaluated once for each +article. So that form can refer to +@code{nnmaildir-article-file-name}, etc., to decide where to put the +article. @emph{If this parameter is not set, @code{nnmaildir} does +not fall back to the @code{expiry-target} group parameter or the +@code{nnmail-expiry-target} variable.} + +@item read-only +If this is set to @code{t}, @code{nnmaildir} will treat the articles +in this maildir as read-only. This means: articles are not renamed +from @file{new/} into @file{cur/}; articles are only found in +@file{new/}, not @file{cur/}; articles are never deleted; articles +cannot be edited. @file{new/} is expected to be a symlink to the +@file{new/} directory of another maildir---e.g., a system-wide mailbox +containing a mailing list of common interest. Everything in the +maildir outside @file{new/} is @emph{not} treated as read-only, so for +a shared mailbox, you do still need to set up your own maildir (or +have write permission to the shared mailbox); your maildir just won't +contain extra copies of the articles. + +@item directory-files +A function with the same interface as @code{directory-files}. It is +used to scan the directories in the maildir corresponding to this +group to find articles. The default is the function specified by the +server's @code{directory-files} parameter. + +@item distrust-Lines: +If non-@code{nil}, @code{nnmaildir} will always count the lines of an +article, rather than use the @code{Lines:} header field. If +@code{nil}, the header field will be used if present. + +@item always-marks +A list of mark symbols, such as @code{['(read expire)]}. Whenever +Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will +say that all articles have these marks, regardless of whether the +marks stored in the filesystem say so. This is a proof-of-concept +feature that will probably be removed eventually; it ought to be done +in Gnus proper, or abandoned if it's not worthwhile. + +@item never-marks +A list of mark symbols, such as @code{['(tick expire)]}. Whenever +Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will +say that no articles have these marks, regardless of whether the marks +stored in the filesystem say so. @code{never-marks} overrides +@code{always-marks}. This is a proof-of-concept feature that will +probably be removed eventually; it ought to be done in Gnus proper, or +abandoned if it's not worthwhile. + +@item nov-cache-size +An integer specifying the size of the @acronym{NOV} memory cache. To +speed things up, @code{nnmaildir} keeps @acronym{NOV} data in memory +for a limited number of articles in each group. (This is probably not +worthwhile, and will probably be removed in the future.) This +parameter's value is noticed only the first time a group is seen after +the server is opened---i.e., when you first start Gnus, typically. +The @acronym{NOV} cache is never resized until the server is closed +and reopened. The default is an estimate of the number of articles +that would be displayed in the summary buffer: a count of articles +that are either marked with @code{tick} or not marked with +@code{read}, plus a little extra. +@end table + +@subsubsection Article identification +Articles are stored in the @file{cur/} subdirectory of each maildir. +Each article file is named like @code{uniq:info}, where @code{uniq} +contains no colons. @code{nnmaildir} ignores, but preserves, the +@code{:info} part. (Other maildir readers typically use this part of +the filename to store marks.) The @code{uniq} part uniquely +identifies the article, and is used in various places in the +@file{.nnmaildir/} subdirectory of the maildir to store information +about the corresponding article. The full pathname of an article is +available in the variable @code{nnmaildir-article-file-name} after you +request the article in the summary buffer. + +@subsubsection NOV data +An article identified by @code{uniq} has its @acronym{NOV} data (used +to generate lines in the summary buffer) stored in +@code{.nnmaildir/nov/uniq}. There is no +@code{nnmaildir-generate-nov-databases} function. (There isn't much +need for it---an article's @acronym{NOV} data is updated automatically +when the article or @code{nnmail-extra-headers} has changed.) You can +force @code{nnmaildir} to regenerate the @acronym{NOV} data for a +single article simply by deleting the corresponding @acronym{NOV} +file, but @emph{beware}: this will also cause @code{nnmaildir} to +assign a new article number for this article, which may cause trouble +with @code{seen} marks, the Agent, and the cache. + +@subsubsection Article marks +An article identified by @code{uniq} is considered to have the mark +@code{flag} when the file @file{.nnmaildir/marks/flag/uniq} exists. +When Gnus asks @code{nnmaildir} for a group's marks, @code{nnmaildir} +looks for such files and reports the set of marks it finds. When Gnus +asks @code{nnmaildir} to store a new set of marks, @code{nnmaildir} +creates and deletes the corresponding files as needed. (Actually, +rather than create a new file for each mark, it just creates hard +links to @file{.nnmaildir/markfile}, to save inodes.) + +You can invent new marks by creating a new directory in +@file{.nnmaildir/marks/}. You can tar up a maildir and remove it from +your server, untar it later, and keep your marks. You can add and +remove marks yourself by creating and deleting mark files. If you do +this while Gnus is running and your @code{nnmaildir} server is open, +it's best to exit all summary buffers for @code{nnmaildir} groups and +type @kbd{s} in the group buffer first, and to type @kbd{g} or +@kbd{M-g} in the group buffer afterwards. Otherwise, Gnus might not +pick up the changes, and might undo them. @node Mail Folders @@ -12554,37 +15168,54 @@ @cindex mbox folders @cindex mail folders -@code{nnfolder} is a back end for storing each mail group in a separate -file. Each file is in the standard Un*x mbox format. @code{nnfolder} -will add extra headers to keep track of article numbers and arrival -dates. +@code{nnfolder} is a back end for storing each mail group in a +separate file. Each file is in the standard Un*x mbox format. +@code{nnfolder} will add extra headers to keep track of article +numbers and arrival dates. + +@cindex self contained nnfolder servers +@cindex marks +When the marks file is used (which it is by default), @code{nnfolder} +servers have the property that you may backup them using @code{tar} or +similar, and later be able to restore them into Gnus (by adding the +proper @code{nnfolder} server) and have all your marks be preserved. +Marks for a group is usually stored in a file named as the mbox file +with @code{.mrk} concatenated to it (but see +@code{nnfolder-marks-file-suffix}) within the @code{nnfolder} +directory. Individual @code{nnfolder} groups are also possible to +backup, use @kbd{G m} to restore the group (after restoring the backup +into the @code{nnfolder} directory). Virtual server settings: @table @code @item nnfolder-directory @vindex nnfolder-directory -All the @code{nnfolder} mail boxes will be stored under this directory. +All the @code{nnfolder} mail boxes will be stored under this +directory. The default is the value of @code{message-directory} +(whose default is @file{~/Mail}) @item nnfolder-active-file @vindex nnfolder-active-file -The name of the active file. +The name of the active file. The default is @file{~/Mail/active}. @item nnfolder-newsgroups-file @vindex nnfolder-newsgroups-file -The name of the group descriptions file. @xref{Newsgroups File Format}. +The name of the group descriptions file. @xref{Newsgroups File +Format}. The default is @file{~/Mail/newsgroups} @item nnfolder-get-new-mail @vindex nnfolder-get-new-mail -If non-@code{nil}, @code{nnfolder} will read incoming mail. +If non-@code{nil}, @code{nnfolder} will read incoming mail. The +default is @code{t} @item nnfolder-save-buffer-hook @vindex nnfolder-save-buffer-hook @cindex backup files Hook run before saving the folders. Note that Emacs does the normal -backup renaming of files even with the @code{nnfolder} buffers. If you -wish to switch this off, you could say something like the following in -your @file{.emacs} file: +backup renaming of files even with the @code{nnfolder} buffers. If +you wish to switch this off, you could say something like the +following in your @file{.emacs} file: @lisp (defun turn-off-backup () @@ -12599,6 +15230,34 @@ This function can be used to copy the message to somewhere else, or to extract some information from it before removing it. +@item nnfolder-nov-is-evil +@vindex nnfolder-nov-is-evil +If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The +default is @code{nil}. + +@item nnfolder-nov-file-suffix +@vindex nnfolder-nov-file-suffix +The extension for @acronym{NOV} files. The default is @file{.nov}. + +@item nnfolder-nov-directory +@vindex nnfolder-nov-directory +The directory where the @acronym{NOV} files should be stored. If +@code{nil}, @code{nnfolder-directory} is used. + +@item nnfolder-marks-is-evil +@vindex nnfolder-marks-is-evil +If non-@code{nil}, this back end will ignore any @sc{marks} files. The +default is @code{nil}. + +@item nnfolder-marks-file-suffix +@vindex nnfolder-marks-file-suffix +The extension for @sc{marks} files. The default is @file{.mrk}. + +@item nnfolder-marks-directory +@vindex nnfolder-marks-directory +The directory where the @sc{marks} files should be stored. If +@code{nil}, @code{nnfolder-directory} is used. + @end table @@ -12620,9 +15279,9 @@ mail within spitting distance of Gnus. The same concept exists for Usenet itself: Though access to articles is -typically done by @sc{nntp} these days, once upon a midnight dreary, everyone +typically done by @acronym{NNTP} these days, once upon a midnight dreary, everyone in the world got at Usenet by running a reader on the machine where the -articles lay (the machine which today we call an @sc{nntp} server), and +articles lay (the machine which today we call an @acronym{NNTP} server), and access was by the reader stepping into the articles' directory spool area directly. One can still select between either the @code{nntp} or @code{nnspool} back ends, to select between these methods, if one happens @@ -12661,16 +15320,16 @@ format to which mail was converted, primarily involving creating a spool-file-like entity with a scheme for inserting Babyl-specific headers and status bits above the top of each message in the file. -RMAIL was Emacs' first mail reader, it was written by Richard Stallman, -and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL +Rmail was Emacs' first mail reader, it was written by Richard Stallman, +and Stallman came out of that TOPS/Babyl environment, so he wrote Rmail to understand the mail files folks already had in existence. Gnus (and VM, for that matter) continue to support this format because it's perceived as having some good qualities in those mailer-specific -headers/status bits stuff. RMAIL itself still exists as well, of +headers/status bits stuff. Rmail itself still exists as well, of course, and is still maintained by Stallman. Both of the above forms leave your mail in a single file on your -filesystem, and they must parse that entire file each time you take a +file system, and they must parse that entire file each time you take a look at your mail. @item nnml @@ -12684,17 +15343,17 @@ CNews-based news system in (for instance) @file{/var/lib/news/active}, or what is returned via the @samp{NNTP LIST} verb) and also creates @dfn{overview} files for efficient group entry, as has been defined for -@sc{nntp} servers for some years now. It is slower in mail-splitting, +@acronym{NNTP} servers for some years now. It is slower in mail-splitting, due to the creation of lots of files, updates to the @code{nnml} active file, and additions to overview files on a per-message basis, but it is extremely fast on access because of what amounts to the indexing support provided by the active file and overviews. @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the -resource which defines available places in the filesystem to put new +resource which defines available places in the file system to put new files. Sysadmins take a dim view of heavy inode occupation within -tight, shared filesystems. But if you live on a personal machine where -the filesystem is your own and space is not at a premium, @code{nnml} +tight, shared file systems. But if you live on a personal machine where +the file system is your own and space is not at a premium, @code{nnml} wins big. It is also problematic using this back end if you are living in a @@ -12705,7 +15364,7 @@ The Rand MH mail-reading system has been around UNIX systems for a very long time; it operates by splitting one's spool file of messages into -individual files, but with little or no indexing support -- @code{nnmh} +individual files, but with little or no indexing support---@code{nnmh} is considered to be semantically equivalent to ``@code{nnml} without active file or overviews''. This is arguably the worst choice, because one gets the slowness of individual file creation married to the @@ -12715,7 +15374,7 @@ Basically the effect of @code{nnfolder} is @code{nnmbox} (the first method described above) on a per-group basis. That is, @code{nnmbox} -itself puts *all* one's mail in one file; @code{nnfolder} provides a +itself puts @emph{all} one's mail in one file; @code{nnfolder} provides a little bit of optimization to this so that each of one's mail groups has a Unix mail box file. It's faster than @code{nnmbox} because each group can be parsed separately, and still provides the simple Unix mail box @@ -12728,6 +15387,56 @@ only a moderate amount of mail, @code{nnfolder} is probably the most friendly mail back end all over. +@item nnmaildir + +For configuring expiry and other things, @code{nnmaildir} uses +incompatible group parameters, slightly different from those of other +mail back ends. + +@code{nnmaildir} is largely similar to @code{nnml}, with some notable +differences. Each message is stored in a separate file, but the +filename is unrelated to the article number in Gnus. @code{nnmaildir} +also stores the equivalent of @code{nnml}'s overview files in one file +per article, so it uses about twice as many inodes as @code{nnml}. (Use +@code{df -i} to see how plentiful your inode supply is.) If this slows +you down or takes up very much space, consider switching to +@uref{http://www.namesys.com/, ReiserFS} or another non-block-structured +file system. + +Since maildirs don't require locking for delivery, the maildirs you use +as groups can also be the maildirs your mail is directly delivered to. +This means you can skip Gnus' mail splitting if your mail is already +organized into different mailboxes during delivery. A @code{directory} +entry in @code{mail-sources} would have a similar effect, but would +require one set of mailboxes for spooling deliveries (in mbox format, +thus damaging message bodies), and another set to be used as groups (in +whatever format you like). A maildir has a built-in spool, in the +@code{new/} subdirectory. Beware that currently, mail moved from +@code{new/} to @code{cur/} instead of via mail splitting will not +undergo treatment such as duplicate checking. + +@code{nnmaildir} stores article marks for a given group in the +corresponding maildir, in a way designed so that it's easy to manipulate +them from outside Gnus. You can tar up a maildir, unpack it somewhere +else, and still have your marks. @code{nnml} also stores marks, but +it's not as easy to work with them from outside Gnus as with +@code{nnmaildir}. + +@code{nnmaildir} uses a significant amount of memory to speed things up. +(It keeps in memory some of the things that @code{nnml} stores in files +and that @code{nnmh} repeatedly parses out of message files.) If this +is a problem for you, you can set the @code{nov-cache-size} group +parameter to something small (0 would probably not work, but 1 probably +would) to make it use less memory. This caching will probably be +removed in the future. + +Startup is likely to be slower with @code{nnmaildir} than with other +back ends. Everything else is likely to be faster, depending in part +on your file system. + +@code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo} +to write an @code{nnmaildir}-derived back end. + @end table @@ -12759,17 +15468,19 @@ interfaces to these sources. @menu -* Web Searches:: Creating groups from articles that match a string. -* Slashdot:: Reading the Slashdot comments. -* Ultimate:: The Ultimate Bulletin Board systems. -* Web Archive:: Reading mailing list archived on web. -* Customizing w3:: Doing stuff to Emacs/w3 from Gnus. +* Archiving Mail:: +* Web Searches:: Creating groups from articles that match a string. +* Slashdot:: Reading the Slashdot comments. +* Ultimate:: The Ultimate Bulletin Board systems. +* Web Archive:: Reading mailing list archived on web. +* RSS:: Reading RDF site summary. +* Customizing w3:: Doing stuff to Emacs/w3 from Gnus. @end menu All the web sources require Emacs/w3 and the url library to work. The main caveat with all these web sources is that they probably won't -work for a very long time. Gleaning information from the @sc{html} data +work for a very long time. Gleaning information from the @acronym{HTML} data is guesswork at best, and when the layout is altered, the Gnus back end will fail. If you have reasonably new versions of these back ends, though, you should be ok. @@ -12780,13 +15491,45 @@ Unplugged}) handle downloading articles, and then you can read them at leisure from your local disk. No more World Wide Wait for you. +@node Archiving Mail +@subsection Archiving Mail +@cindex archiving mail +@cindex backup of mail + +Some of the back ends, notably @code{nnml}, @code{nnfolder}, and +@code{nnmaildir}, now actually store the article marks with each group. +For these servers, archiving and restoring a group while preserving +marks is fairly simple. + +(Preserving the group level and group parameters as well still +requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity +though.) + +To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir} +server, take a recursive copy of the server directory. There is no need +to shut down Gnus, so archiving may be invoked by @code{cron} or +similar. You restore the data by restoring the directory tree, and +adding a server definition pointing to that directory in Gnus. The +@ref{Article Backlog}, @ref{Asynchronous Fetching} and other things +might interfere with overwriting data, so you may want to shut down Gnus +before you restore the data. + +It is also possible to archive individual @code{nnml}, +@code{nnfolder}, or @code{nnmaildir} groups, while preserving marks. +For @code{nnml} or @code{nnmaildir}, you copy all files in the group's +directory. For @code{nnfolder} you need to copy both the base folder +file itself (@file{FOO}, say), and the marks file (@file{FOO.mrk} in +this example). Restoring the group is done with @kbd{G m} from the Group +buffer. The last step makes Gnus notice the new directory. +@code{nnmaildir} notices the new directory automatically, so @kbd{G m} +is unnecessary in that case. @node Web Searches @subsection Web Searches @cindex nnweb -@cindex DejaNews -@cindex Alta Vista -@cindex InReference +@cindex Google +@cindex dejanews +@cindex gmane @cindex Usenet searches @cindex searching the Usenet @@ -12809,7 +15552,7 @@ manner. Not even using duplicate suppression (@pxref{Duplicate Suppression}) will help, since @code{nnweb} doesn't even know the @code{Message-ID} of the articles before reading them using some search -engines (DejaNews, for instance). The only possible way to keep track +engines (Google, for instance). The only possible way to keep track of which articles you've read is by scoring on the @code{Date} header---mark all articles posted before the last date you read the group as read. @@ -12830,8 +15573,8 @@ @item nnweb-type @vindex nnweb-type What search engine type is being used. The currently supported types -are @code{dejanews}, @code{dejanewsold}, @code{altavista} and -@code{reference}. +are @code{google}, @code{dejanews}, and @code{gmane}. Note that +@code{dejanews} is an alias to @code{google}. @item nnweb-search @vindex nnweb-search @@ -12840,7 +15583,7 @@ @item nnweb-max-hits @vindex nnweb-max-hits Advisory maximum number of hits per search to display. The default is -100. +999. @item nnweb-type-definition @vindex nnweb-type-definition @@ -12875,12 +15618,12 @@ @cindex Slashdot @cindex nnslashdot -Slashdot (@uref{http://slashdot.org/}) is a popular news site, with +@uref{http://slashdot.org/, Slashdot} is a popular news site, with lively discussion following the news articles. @code{nnslashdot} will let you read this forum in a convenient manner. The easiest way to read this source is to put something like the -following in your @file{.gnus.el} file: +following in your @file{~/.gnus.el} file: @lisp (setq gnus-secondary-select-methods @@ -12894,16 +15637,16 @@ groups as zombies. Other methods are available (@pxref{Subscription Methods}). -If you want to remove an old @code{nnslashdot} group, the @kbd{G @key{DEL}} +If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL} command is the most handy tool (@pxref{Foreign Groups}). When following up to @code{nnslashdot} comments (or posting new -comments), some light @sc{html}izations will be performed. In +comments), some light @acronym{HTML}izations will be performed. In particular, text quoted with @samp{> } will be quoted with -@code{blockquote} instead, and signatures will have @code{br} added to -the end of each line. Other than that, you can just write @sc{html} +@samp{blockquote} instead, and signatures will have @samp{br} added to +the end of each line. Other than that, you can just write @acronym{HTML} directly into the message buffer. Note that Slashdot filters out some -@sc{html} forms. +@acronym{HTML} forms. The following variables can be altered to change its behavior: @@ -12914,7 +15657,7 @@ has to retrieve absolutely all comments in a group upon entry. If a threaded display is not required, @code{nnslashdot} will only retrieve the comments that are actually wanted by the user. Threading is nicer, -but much, much slower than untreaded. +but much, much slower than unthreaded. @item nnslashdot-login-name @vindex nnslashdot-login-name @@ -12927,24 +15670,22 @@ @item nnslashdot-directory @vindex nnslashdot-directory Where @code{nnslashdot} will store its files. The default is -@samp{~/News/slashdot/}. +@file{~/News/slashdot/}. @item nnslashdot-active-url @vindex nnslashdot-active-url -The @sc{url} format string that will be used to fetch the information on -news articles and comments. Default: +The @acronym{URL} format string that will be used to fetch the +information on news articles and comments. The default is@* @samp{http://slashdot.org/search.pl?section=&min=%d}. @item nnslashdot-comments-url @vindex nnslashdot-comments-url -The @sc{url} format string that will be used to fetch comments. The -default is -@samp{http://slashdot.org/comments.pl?sid=%s&threshold=%d&commentsort=%d&mode=flat&startat=%d}. +The @acronym{URL} format string that will be used to fetch comments. @item nnslashdot-article-url @vindex nnslashdot-article-url -The @sc{url} format string that will be used to fetch the news article. The -default is +The @acronym{URL} format string that will be used to fetch the news +article. The default is @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}. @item nnslashdot-threshold @@ -12965,14 +15706,14 @@ @cindex nnultimate @cindex Ultimate Bulletin Board -The Ultimate Bulletin Board (@uref{http://www.ultimatebb.com/}) is +@uref{http://www.ultimatebb.com/, The Ultimate Bulletin Board} is probably the most popular Web bulletin board system used. It has a quite regular and nice interface, and it's possible to get the information Gnus needs to keep groups updated. The easiest way to get started with @code{nnultimate} is to say -something like the following in the group buffer: @kbd{B nnultimate @key{RET} -http://www.tcj.com/messboard/ubbcgi/ @key{RET}}. (Substitute the @sc{url} +something like the following in the group buffer: @kbd{B nnultimate RET +http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @acronym{URL} (not including @samp{Ultimate.cgi} or the like at the end) for a forum you're interested in; there's quite a list of them on the Ultimate web site.) Then subscribe to the groups you're interested in from the @@ -12983,8 +15724,8 @@ @table @code @item nnultimate-directory @vindex nnultimate-directory -The directory where @code{nnultimate} stores its files. The default is -@samp{~/News/ultimate/}. +The directory where @code{nnultimate} stores its files. The default is@* +@file{~/News/ultimate/}. @end table @@ -12999,21 +15740,22 @@ interface, and it's possible to get the information Gnus needs to keep groups updated. +@findex gnus-group-make-warchive-group The easiest way to get started with @code{nnwarchive} is to say something like the following in the group buffer: @kbd{M-x -gnus-group-make-warchive-group @key{RET} an_egroup @key{RET} egroups @key{RET} -www.egroups.com @key{RET} your@@email.address @key{RET}}. (Substitute the -@sc{an_egroup} with the mailing list you subscribed, the -@sc{your@@email.address} with your email address.), or to browse the -back end by @kbd{B nnwarchive @key{RET} mail-archive @key{RET}}. +gnus-group-make-warchive-group RET @var{an_egroup} RET egroups RET +www.egroups.com RET @var{your@@email.address} RET}. (Substitute the +@var{an_egroup} with the mailing list you subscribed, the +@var{your@@email.address} with your email address.), or to browse the +back end by @kbd{B nnwarchive RET mail-archive RET}. The following @code{nnwarchive} variables can be altered: @table @code @item nnwarchive-directory @vindex nnwarchive-directory -The directory where @code{nnwarchive} stores its files. The default is -@samp{~/News/warchive/}. +The directory where @code{nnwarchive} stores its files. The default is@* +@file{~/News/warchive/}. @item nnwarchive-login @vindex nnwarchive-login @@ -13024,6 +15766,81 @@ The password for your account on the web server. @end table +@node RSS +@subsection RSS +@cindex nnrss +@cindex RSS + +Some web sites have an RDF Site Summary (@acronym{RSS}). +@acronym{RSS} is a format for summarizing headlines from news related +sites (such as BBC or CNN). But basically anything list-like can be +presented as an @acronym{RSS} feed: weblogs, changelogs or recent +changes to a wiki (e.g. @url{http://cliki.net/recent-changes.rdf}). + +@acronym{RSS} has a quite regular and nice interface, and it's +possible to get the information Gnus needs to keep groups updated. + +@kindex G R (Summary) +Use @kbd{G R} from the summary buffer to subscribe to a feed---you +will be prompted for the location of the feed. + +An easy way to get started with @code{nnrss} is to say something like +the following in the group buffer: @kbd{B nnrss RET y}, then +subscribe to groups. + +The following @code{nnrss} variables can be altered: + +@table @code +@item nnrss-directory +@vindex nnrss-directory +The directory where @code{nnrss} stores its files. The default is +@file{~/News/rss/}. + +@item nnrss-use-local +@vindex nnrss-use-local +@findex nnrss-generate-download-script +If you set @code{nnrss-use-local} to @code{t}, @code{nnrss} will read +the feeds from local files in @code{nnrss-directory}. You can use +the command @code{nnrss-generate-download-script} to generate a +download script using @command{wget}. +@end table + +The following code may be helpful, if you want to show the description in +the summary buffer. + +@lisp +(add-to-list 'nnmail-extra-headers nnrss-description-field) +(setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n") + +(defun gnus-user-format-function-X (header) + (let ((descr + (assq nnrss-description-field (mail-header-extra header)))) + (if descr (concat "\n\t" (cdr descr)) ""))) +@end lisp + +The following code may be useful to open an nnrss url directly from the +summary buffer. +@lisp +(require 'browse-url) + +(defun browse-nnrss-url( arg ) + (interactive "p") + (let ((url (assq nnrss-url-field + (mail-header-extra + (gnus-data-header + (assq (gnus-summary-article-number) + gnus-newsgroup-data)))))) + (if url + (progn + (browse-url (cdr url)) + (gnus-summary-mark-as-read-forward 1)) + (gnus-summary-scroll-up arg)))) + +(eval-after-load "gnus" + #'(define-key gnus-summary-mode-map + (kbd "") 'browse-nnrss-url)) +(add-to-list 'nnmail-extra-headers nnrss-url-field) +@end lisp @node Customizing w3 @subsection Customizing w3 @@ -13052,10 +15869,658 @@ @end lisp Put that in your @file{.emacs} file, and hitting links in w3-rendered -@sc{html} in the Gnus article buffers will use @code{browse-url} to +@acronym{HTML} in the Gnus article buffers will use @code{browse-url} to follow the link. +@node IMAP +@section IMAP +@cindex nnimap +@cindex @acronym{IMAP} + +@acronym{IMAP} is a network protocol for reading mail (or news, or @dots{}), +think of it as a modernized @acronym{NNTP}. Connecting to a @acronym{IMAP} +server is much similar to connecting to a news server, you just +specify the network address of the server. + +@acronym{IMAP} has two properties. First, @acronym{IMAP} can do +everything that @acronym{POP} can, it can hence be viewed as a +@acronym{POP++}. Secondly, @acronym{IMAP} is a mail storage protocol, +similar to @acronym{NNTP} being a news storage protocol---however, +@acronym{IMAP} offers more features than @acronym{NNTP} because news +is more or less read-only whereas mail is read-write. + +If you want to use @acronym{IMAP} as a @acronym{POP++}, use an imap +entry in @code{mail-sources}. With this, Gnus will fetch mails from +the @acronym{IMAP} server and store them on the local disk. This is +not the usage described in this section---@xref{Mail Sources}. + +If you want to use @acronym{IMAP} as a mail storage protocol, use an nnimap +entry in @code{gnus-secondary-select-methods}. With this, Gnus will +manipulate mails stored on the @acronym{IMAP} server. This is the kind of +usage explained in this section. + +A server configuration in @file{~/.gnus.el} with a few @acronym{IMAP} +servers might look something like the following. (Note that for +@acronym{TLS}/@acronym{SSL}, you need external programs and libraries, +see below.) + +@lisp +(setq gnus-secondary-select-methods + '((nnimap "simpleserver") ; @r{no special configuration} + ; @r{perhaps a ssh port forwarded server:} + (nnimap "dolk" + (nnimap-address "localhost") + (nnimap-server-port 1430)) + ; @r{a UW server running on localhost} + (nnimap "barbar" + (nnimap-server-port 143) + (nnimap-address "localhost") + (nnimap-list-pattern ("INBOX" "mail/*"))) + ; @r{anonymous public cyrus server:} + (nnimap "cyrus.andrew.cmu.edu" + (nnimap-authenticator anonymous) + (nnimap-list-pattern "archive.*") + (nnimap-stream network)) + ; @r{a ssl server on a non-standard port:} + (nnimap "vic20" + (nnimap-address "vic20.somewhere.com") + (nnimap-server-port 9930) + (nnimap-stream ssl)))) +@end lisp + +After defining the new server, you can subscribe to groups on the +server using normal Gnus commands such as @kbd{U} in the Group Buffer +(@pxref{Subscription Commands}) or via the Server Buffer +(@pxref{Server Buffer}). + +The following variables can be used to create a virtual @code{nnimap} +server: + +@table @code + +@item nnimap-address +@vindex nnimap-address + +The address of the remote @acronym{IMAP} server. Defaults to the virtual +server name if not specified. + +@item nnimap-server-port +@vindex nnimap-server-port +Port on server to contact. Defaults to port 143, or 993 for @acronym{TLS}/@acronym{SSL}. + +Note that this should be an integer, example server specification: + +@lisp +(nnimap "mail.server.com" + (nnimap-server-port 4711)) +@end lisp + +@item nnimap-list-pattern +@vindex nnimap-list-pattern +String or list of strings of mailboxes to limit available groups to. +This is used when the server has very many mailboxes and you're only +interested in a few---some servers export your home directory via +@acronym{IMAP}, you'll probably want to limit the mailboxes to those in +@file{~/Mail/*} then. + +The string can also be a cons of REFERENCE and the string as above, what +REFERENCE is used for is server specific, but on the University of +Washington server it's a directory that will be concatenated with the +mailbox. + +Example server specification: + +@lisp +(nnimap "mail.server.com" + (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*" + ("~friend/Mail/" . "list/*")))) +@end lisp + +@item nnimap-stream +@vindex nnimap-stream +The type of stream used to connect to your server. By default, nnimap +will detect and automatically use all of the below, with the exception +of @acronym{TLS}/@acronym{SSL}. (@acronym{IMAP} over +@acronym{TLS}/@acronym{SSL} is being replaced by STARTTLS, which can +be automatically detected, but it's not widely deployed yet.) + +Example server specification: + +@lisp +(nnimap "mail.server.com" + (nnimap-stream ssl)) +@end lisp + +Please note that the value of @code{nnimap-stream} is a symbol! + +@itemize @bullet +@item +@dfn{gssapi:} Connect with GSSAPI (usually Kerberos 5). Requires the +@samp{gsasl} or @samp{imtest} program. +@item +@dfn{kerberos4:} Connect with Kerberos 4. Requires the @samp{imtest} program. +@item +@dfn{starttls:} Connect via the STARTTLS extension (similar to +@acronym{TLS}/@acronym{SSL}). Requires the external library @samp{starttls.el} and program +@samp{starttls}. +@item +@dfn{tls:} Connect through @acronym{TLS}. Requires GNUTLS (the program +@samp{gnutls-cli}). +@item +@dfn{ssl:} Connect through @acronym{SSL}. Requires OpenSSL (the program +@samp{openssl}) or SSLeay (@samp{s_client}). +@item +@dfn{shell:} Use a shell command to start @acronym{IMAP} connection. +@item +@dfn{network:} Plain, TCP/IP network connection. +@end itemize + +@vindex imap-kerberos4-program +The @samp{imtest} program is shipped with Cyrus IMAPD. If you're +using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version +1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type} +to make @code{imap.el} use a pty instead of a pipe when communicating +with @samp{imtest}. You will then suffer from a line length +restrictions on @acronym{IMAP} commands, which might make Gnus seem to hang +indefinitely if you have many articles in a mailbox. The variable +@code{imap-kerberos4-program} contain parameters to pass to the imtest +program. + +For @acronym{TLS} connection, the @code{gnutls-cli} program from GNUTLS is +needed. It is available from +@uref{http://www.gnu.org/software/gnutls/}. + +@vindex imap-gssapi-program +This parameter specifies a list of command lines that invoke a GSSAPI +authenticated @acronym{IMAP} stream in a subshell. They are tried +sequentially until a connection is made, or the list has been +exhausted. By default, @samp{gsasl} from GNU SASL, available from +@uref{http://www.gnu.org/software/gsasl/}, and the @samp{imtest} +program from Cyrus IMAPD (see @code{imap-kerberos4-program}), are +tried. + +@vindex imap-ssl-program +For @acronym{SSL} connections, the OpenSSL program is available from +@uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay, +and nnimap support it too---although the most recent versions of +SSLeay, 0.9.x, are known to have serious bugs making it +useless. Earlier versions, especially 0.8.x, of SSLeay are known to +work. The variable @code{imap-ssl-program} contain parameters to pass +to OpenSSL/SSLeay. + +@vindex imap-shell-program +@vindex imap-shell-host +For @acronym{IMAP} connections using the @code{shell} stream, the variable +@code{imap-shell-program} specify what program to call. + +@item nnimap-authenticator +@vindex nnimap-authenticator + +The authenticator used to connect to the server. By default, nnimap +will use the most secure authenticator your server is capable of. + +Example server specification: + +@lisp +(nnimap "mail.server.com" + (nnimap-authenticator anonymous)) +@end lisp + +Please note that the value of @code{nnimap-authenticator} is a symbol! + +@itemize @bullet +@item +@dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Requires +external program @code{gsasl} or @code{imtest}. +@item +@dfn{kerberos4:} Kerberos 4 authentication. Requires external program +@code{imtest}. +@item +@dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Requires +external library @code{digest-md5.el}. +@item +@dfn{cram-md5:} Encrypted username/password via CRAM-MD5. +@item +@dfn{login:} Plain-text username/password via LOGIN. +@item +@dfn{anonymous:} Login as ``anonymous'', supplying your email address as password. +@end itemize + +@item nnimap-expunge-on-close +@cindex expunging +@vindex nnimap-expunge-on-close +Unlike Parmenides the @acronym{IMAP} designers have decided things that +don't exist actually do exist. More specifically, @acronym{IMAP} has +this concept of marking articles @code{Deleted} which doesn't actually +delete them, and this (marking them @code{Deleted}, that is) is what +nnimap does when you delete an article in Gnus (with @kbd{B DEL} or +similar). + +Since the articles aren't really removed when we mark them with the +@code{Deleted} flag we'll need a way to actually delete them. Feel like +running in circles yet? + +Traditionally, nnimap has removed all articles marked as @code{Deleted} +when closing a mailbox but this is now configurable by this server +variable. + +The possible options are: + +@table @code + +@item always +The default behavior, delete all articles marked as ``Deleted'' when +closing a mailbox. +@item never +Never actually delete articles. Currently there is no way of showing +the articles marked for deletion in nnimap, but other @acronym{IMAP} clients +may allow you to do this. If you ever want to run the EXPUNGE command +manually, @xref{Expunging mailboxes}. +@item ask +When closing mailboxes, nnimap will ask if you wish to expunge deleted +articles or not. + +@end table + +@item nnimap-importantize-dormant +@vindex nnimap-importantize-dormant + +If non-@code{nil} (the default), marks dormant articles as ticked (as +well), for other @acronym{IMAP} clients. Within Gnus, dormant articles will +naturally still (only) be marked as dormant. This is to make dormant +articles stand out, just like ticked articles, in other @acronym{IMAP} +clients. (In other words, Gnus has two ``Tick'' marks and @acronym{IMAP} +has only one.) + +Probably the only reason for frobing this would be if you're trying +enable per-user persistent dormant flags, using something like: + +@lisp +(setcdr (assq 'dormant nnimap-mark-to-flag-alist) + (format "gnus-dormant-%s" (user-login-name))) +(setcdr (assq 'dormant nnimap-mark-to-predicate-alist) + (format "KEYWORD gnus-dormant-%s" (user-login-name))) +@end lisp + +In this case, you would not want the per-user dormant flag showing up +as ticked for other users. + +@item nnimap-expunge-search-string +@cindex expunging +@vindex nnimap-expunge-search-string + +This variable contain the @acronym{IMAP} search command sent to server when +searching for articles eligible for expiring. The default is +@code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by +UID set and the second @code{%s} is replaced by a date. + +Probably the only useful value to change this to is +@code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in +messages instead of the internal article date. See section 6.4.4 of +RFC 2060 for more information on valid strings. + +@item nnimap-authinfo-file +@vindex nnimap-authinfo-file + +A file containing credentials used to log in on servers. The format is +(almost) the same as the @code{ftp} @file{~/.netrc} file. See the +variable @code{nntp-authinfo-file} for exact syntax; also see +@ref{NNTP}. + +@item nnimap-need-unselect-to-notice-new-mail +@vindex nnimap-need-unselect-to-notice-new-mail + +Unselect mailboxes before looking for new mail in them. Some servers +seem to need this under some circumstances; it was reported that +Courier 1.7.1 did. + +@end table + +@menu +* Splitting in IMAP:: Splitting mail with nnimap. +* Expiring in IMAP:: Expiring mail with nnimap. +* Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox. +* Expunging mailboxes:: Equivalent of a ``compress mailbox'' button. +* A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus. +* Debugging IMAP:: What to do when things don't work. +@end menu + + + +@node Splitting in IMAP +@subsection Splitting in IMAP +@cindex splitting imap mail + +Splitting is something Gnus users have loved and used for years, and now +the rest of the world is catching up. Yeah, dream on, not many +@acronym{IMAP} servers have server side splitting and those that have +splitting seem to use some non-standard protocol. This means that +@acronym{IMAP} support for Gnus has to do its own splitting. + +And it does. + +(Incidentally, people seem to have been dreaming on, and Sieve has +gaining a market share and is supported by several IMAP servers. +Fortunately, Gnus support it too, @xref{Sieve Commands}.) + +Here are the variables of interest: + +@table @code + +@item nnimap-split-crosspost +@cindex splitting, crosspost +@cindex crosspost +@vindex nnimap-split-crosspost + +If non-@code{nil}, do crossposting if several split methods match the +mail. If @code{nil}, the first match in @code{nnimap-split-rule} +found will be used. + +Nnmail equivalent: @code{nnmail-crosspost}. + +@item nnimap-split-inbox +@cindex splitting, inbox +@cindex inbox +@vindex nnimap-split-inbox + +A string or a list of strings that gives the name(s) of @acronym{IMAP} +mailboxes to split from. Defaults to @code{nil}, which means that +splitting is disabled! + +@lisp +(setq nnimap-split-inbox + '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap")) +@end lisp + +No nnmail equivalent. + +@item nnimap-split-rule +@cindex splitting, rules +@vindex nnimap-split-rule + +New mail found in @code{nnimap-split-inbox} will be split according to +this variable. + +This variable contains a list of lists, where the first element in the +sublist gives the name of the @acronym{IMAP} mailbox to move articles +matching the regexp in the second element in the sublist. Got that? +Neither did I, we need examples. + +@lisp +(setq nnimap-split-rule + '(("INBOX.nnimap" + "^Sender: owner-nnimap@@vic20.globalcom.se") + ("INBOX.junk" "^Subject:.*MAKE MONEY") + ("INBOX.private" ""))) +@end lisp + +This will put all articles from the nnimap mailing list into mailbox +INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line +into INBOX.junk and everything else in INBOX.private. + +The first string may contain @samp{\\1} forms, like the ones used by +replace-match to insert sub-expressions from the matched text. For +instance: + +@lisp +("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@") +@end lisp + +The first element can also be the symbol @code{junk} to indicate that +matching messages should simply be deleted. Use with care. + +The second element can also be a function. In that case, it will be +called with the first element of the rule as the argument, in a buffer +containing the headers of the article. It should return a +non-@code{nil} value if it thinks that the mail belongs in that group. + +Nnmail users might recollect that the last regexp had to be empty to +match all articles (like in the example above). This is not required in +nnimap. Articles not matching any of the regexps will not be moved out +of your inbox. (This might affect performance if you keep lots of +unread articles in your inbox, since the splitting code would go over +them every time you fetch new mail.) + +These rules are processed from the beginning of the alist toward the +end. The first rule to make a match will ``win'', unless you have +crossposting enabled. In that case, all matching rules will ``win''. + +This variable can also have a function as its value, the function will +be called with the headers narrowed and should return a group where it +thinks the article should be split to. See @code{nnimap-split-fancy}. + +The splitting code tries to create mailboxes if it needs to. + +To allow for different split rules on different virtual servers, and +even different split rules in different inboxes on the same server, +the syntax of this variable have been extended along the lines of: + +@lisp +(setq nnimap-split-rule + '(("my1server" (".*" (("ding" "ding@@gnus.org") + ("junk" "From:.*Simon")))) + ("my2server" ("INBOX" nnimap-split-fancy)) + ("my[34]server" (".*" (("private" "To:.*Simon") + ("junk" my-junk-func)))))) +@end lisp + +The virtual server name is in fact a regexp, so that the same rules +may apply to several servers. In the example, the servers +@code{my3server} and @code{my4server} both use the same rules. +Similarly, the inbox string is also a regexp. The actual splitting +rules are as before, either a function, or a list with group/regexp or +group/function elements. + +Nnmail equivalent: @code{nnmail-split-methods}. + +@item nnimap-split-predicate +@cindex splitting +@vindex nnimap-split-predicate + +Mail matching this predicate in @code{nnimap-split-inbox} will be +split, it is a string and the default is @samp{UNSEEN UNDELETED}. + +This might be useful if you use another @acronym{IMAP} client to read mail in +your inbox but would like Gnus to split all articles in the inbox +regardless of readedness. Then you might change this to +@samp{UNDELETED}. + +@item nnimap-split-fancy +@cindex splitting, fancy +@findex nnimap-split-fancy +@vindex nnimap-split-fancy + +It's possible to set @code{nnimap-split-rule} to +@code{nnmail-split-fancy} if you want to use fancy +splitting. @xref{Fancy Mail Splitting}. + +However, to be able to have different fancy split rules for nnmail and +nnimap back ends you can set @code{nnimap-split-rule} to +@code{nnimap-split-fancy} and define the nnimap specific fancy split +rule in @code{nnimap-split-fancy}. + +Example: + +@lisp +(setq nnimap-split-rule 'nnimap-split-fancy + nnimap-split-fancy ...) +@end lisp + +Nnmail equivalent: @code{nnmail-split-fancy}. + +@item nnimap-split-download-body +@findex nnimap-split-download-body +@vindex nnimap-split-download-body + +Set to non-@code{nil} to download entire articles during splitting. +This is generally not required, and will slow things down +considerably. You may need it if you want to use an advanced +splitting function that analyses the body to split the article. + +@end table + +@node Expiring in IMAP +@subsection Expiring in IMAP +@cindex expiring imap mail + +Even though @code{nnimap} is not a proper @code{nnmail} derived back +end, it supports most features in regular expiring (@pxref{Expiring +Mail}). Unlike splitting in @acronym{IMAP} (@pxref{Splitting in +IMAP}) it does not clone the @code{nnmail} variables (i.e., creating +@var{nnimap-expiry-wait}) but reuse the @code{nnmail} variables. What +follows below are the variables used by the @code{nnimap} expiry +process. + +A note on how the expire mark is stored on the @acronym{IMAP} server is +appropriate here as well. The expire mark is translated into a +@code{imap} client specific mark, @code{gnus-expire}, and stored on the +message. This means that likely only Gnus will understand and treat +the @code{gnus-expire} mark properly, although other clients may allow +you to view client specific flags on the message. It also means that +your server must support permanent storage of client specific flags on +messages. Most do, fortunately. + +@table @code + +@item nnmail-expiry-wait +@item nnmail-expiry-wait-function + +These variables are fully supported. The expire value can be a +number, the symbol @code{immediate} or @code{never}. + +@item nnmail-expiry-target + +This variable is supported, and internally implemented by calling the +@code{nnmail} functions that handle this. It contains an optimization +that if the destination is a @acronym{IMAP} group on the same server, the +article is copied instead of appended (that is, uploaded again). + +@end table + +@node Editing IMAP ACLs +@subsection Editing IMAP ACLs +@cindex editing imap acls +@cindex Access Control Lists +@cindex Editing @acronym{IMAP} ACLs +@kindex G l (Group) +@findex gnus-group-nnimap-edit-acl + +ACL stands for Access Control List. ACLs are used in @acronym{IMAP} for +limiting (or enabling) other users access to your mail boxes. Not all +@acronym{IMAP} servers support this, this function will give an error if it +doesn't. + +To edit an ACL for a mailbox, type @kbd{G l} +(@code{gnus-group-edit-nnimap-acl}) and you'll be presented with an ACL +editing window with detailed instructions. + +Some possible uses: + +@itemize @bullet +@item +Giving ``anyone'' the ``lrs'' rights (lookup, read, keep seen/unseen flags) +on your mailing list mailboxes enables other users on the same server to +follow the list without subscribing to it. +@item +At least with the Cyrus server, you are required to give the user +``anyone'' posting ("p") capabilities to have ``plussing'' work (that is, +mail sent to user+mailbox@@domain ending up in the @acronym{IMAP} mailbox +INBOX.mailbox). +@end itemize + +@node Expunging mailboxes +@subsection Expunging mailboxes +@cindex expunging + +@cindex expunge +@cindex manual expunging +@kindex G x (Group) +@findex gnus-group-nnimap-expunge + +If you're using the @code{never} setting of @code{nnimap-expunge-on-close}, +you may want the option of expunging all deleted articles in a mailbox +manually. This is exactly what @kbd{G x} does. + +Currently there is no way of showing deleted articles, you can just +delete them. + +@node A note on namespaces +@subsection A note on namespaces +@cindex IMAP namespace +@cindex namespaces + +The @acronym{IMAP} protocol has a concept called namespaces, described +by the following text in the RFC: + +@display +5.1.2. Mailbox Namespace Naming Convention + + By convention, the first hierarchical element of any mailbox name + which begins with "#" identifies the "namespace" of the remainder of + the name. This makes it possible to disambiguate between different + types of mailbox stores, each of which have their own namespaces. + + For example, implementations which offer access to USENET + newsgroups MAY use the "#news" namespace to partition the USENET + newsgroup namespace from that of other mailboxes. Thus, the + comp.mail.misc newsgroup would have an mailbox name of + "#news.comp.mail.misc", and the name "comp.mail.misc" could refer + to a different object (e.g. a user's private mailbox). +@end display + +While there is nothing in this text that warrants concern for the +@acronym{IMAP} implementation in Gnus, some servers use namespace +prefixes in a way that does not work with how Gnus uses mailbox names. + +Specifically, University of Washington's @acronym{IMAP} server uses +mailbox names like @code{#driver.mbx/read-mail} which are valid only +in the @sc{create} and @sc{append} commands. After the mailbox is +created (or a messages is appended to a mailbox), it must be accessed +without the namespace prefix, i.e. @code{read-mail}. Since Gnus do +not make it possible for the user to guarantee that user entered +mailbox names will only be used with the CREATE and APPEND commands, +you should simply not use the namespace prefixed mailbox names in +Gnus. + +See the UoW IMAPD documentation for the @code{#driver.*/} prefix +for more information on how to use the prefixes. They are a power +tool and should be used only if you are sure what the effects are. + +@node Debugging IMAP +@subsection Debugging IMAP +@cindex IMAP debugging +@cindex protocol dump (IMAP) + +@acronym{IMAP} is a complex protocol, more so than @acronym{NNTP} or +@acronym{POP3}. Implementation bugs are not unlikely, and we do our +best to fix them right away. If you encounter odd behaviour, chances +are that either the server or Gnus is buggy. + +If you are familiar with network protocols in general, you will +probably be able to extract some clues from the protocol dump of the +exchanges between Gnus and the server. Even if you are not familiar +with network protocols, when you include the protocol dump in +@acronym{IMAP}-related bug reports you are helping us with data +critical to solving the problem. Therefore, we strongly encourage you +to include the protocol dump when reporting IMAP bugs in Gnus. + + +@vindex imap-log +Because the protocol dump, when enabled, generates lots of data, it is +disabled by default. You can enable it by setting @code{imap-log} as +follows: + +@lisp +(setq imap-log t) +@end lisp + +This instructs the @code{imap.el} package to log any exchanges with +the server. The log is stored in the buffer @samp{*imap-log*}. Look +for error messages, which sometimes are tagged with the keyword +@code{BAD} - but when submitting a bug, make sure to include all the +data. + @node Other Sources @section Other Sources @@ -13064,12 +16529,11 @@ newsgroups. @menu -* Directory Groups:: You can read a directory as if it was a newsgroup. -* Anything Groups:: Dired? Who needs dired? -* Document Groups:: Single files can be the basis of a group. -* SOUP:: Reading @sc{soup} packets ``offline''. -* Mail-To-News Gateways:: Posting articles via mail-to-news gateways. -* IMAP:: Using Gnus as a @sc{imap} client. +* Directory Groups:: You can read a directory as if it was a newsgroup. +* Anything Groups:: Dired? Who needs dired? +* Document Groups:: Single files can be the basis of a group. +* SOUP:: Reading @sc{soup} packets ``offline''. +* Mail-To-News Gateways:: Posting articles via mail-to-news gateways. @end menu @@ -13093,7 +16557,7 @@ @code{ange-ftp} or @code{efs} will actually allow you to read this directory over at @samp{sina} as a newsgroup. Distributed news ahoy! -@code{nndir} will use @sc{nov} files if they are present. +@code{nndir} will use @acronym{NOV} files if they are present. @code{nndir} is a ``read-only'' back end---you can't delete or expire articles with this method. You can use @code{nnmh} or @code{nnml} for @@ -13175,11 +16639,11 @@ as a newsgroup. Several files types are supported: @table @code -@cindex babyl -@cindex rmail mbox +@cindex Babyl +@cindex Rmail mbox @item babyl -The babyl (rmail) mail box. +The Babyl (Rmail) mail box. @cindex mbox @cindex Unix mbox @@ -13205,13 +16669,46 @@ Netscape mail boxes. @item mime-parts -MIME multipart messages. +@acronym{MIME} multipart messages. @item standard-digest The standard (RFC 1153) digest format. +@item mime-digest +A @acronym{MIME} digest of messages. + +@item lanl-gov-announce +Announcement messages from LANL Gov Announce. + +@item rfc822-forward +A message forwarded according to RFC822. + +@item outlook +The Outlook mail box. + +@item oe-dbx +The Outlook Express dbx mail box. + +@item exim-bounce +A bounce message from the Exim MTA. + +@item forward +A message forwarded according to informal rules. + +@item rfc934 +An RFC934-forwarded message. + +@item mailman +A mailman digest. + +@item clari-briefs +A digest of Clarinet brief news items. + @item slack-digest Non-standard digest format---matches most things, but does it badly. + +@item mail-in-mail +The last resort. @end table You can also use the special ``file type'' @code{guess}, which means @@ -13242,7 +16739,8 @@ This should be one of @code{mbox}, @code{babyl}, @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934}, @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest}, -@code{slack-digest}, @code{clari-briefs}, @code{nsmail} or @code{guess}. +@code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook}, +@code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}. @item nndoc-post-type @vindex nndoc-post-type @@ -13367,15 +16865,17 @@ run through @code{nndoc-unquote-dashes} before being delivered. To hook your own document definition into @code{nndoc}, use the -@code{nndoc-add-type} function. It takes two parameters---the first is -the definition itself and the second (optional) parameter says where in -the document type definition alist to put this definition. The alist is -traversed sequentially, and @code{nndoc-TYPE-type-p} is called for a given type @code{TYPE}. So @code{nndoc-mmdf-type-p} is called to see whether a document -is of @code{mmdf} type, and so on. These type predicates should return -@code{nil} if the document is not of the correct type; @code{t} if it is -of the correct type; and a number if the document might be of the -correct type. A high number means high probability; a low number means -low probability with @samp{0} being the lowest valid number. +@code{nndoc-add-type} function. It takes two parameters---the first +is the definition itself and the second (optional) parameter says +where in the document type definition alist to put this definition. +The alist is traversed sequentially, and +@code{nndoc-@var{type}-type-p} is called for a given type @var{type}. +So @code{nndoc-mmdf-type-p} is called to see whether a document is of +@code{mmdf} type, and so on. These type predicates should return +@code{nil} if the document is not of the correct type; @code{t} if it +is of the correct type; and a number if the document might be of the +correct type. A high number means high probability; a low number +means low probability with @samp{0} being the lowest valid number. @node SOUP @@ -13473,9 +16973,9 @@ reading and Gnus for packing/sending these @sc{soup} packets. @menu -* SOUP Commands:: Commands for creating and sending @sc{soup} packets -* SOUP Groups:: A back end for reading @sc{soup} packets. -* SOUP Replies:: How to enable @code{nnsoup} to take over mail and news. +* SOUP Commands:: Commands for creating and sending @sc{soup} packets +* SOUP Groups:: A back end for reading @sc{soup} packets. +* SOUP Replies:: How to enable @code{nnsoup} to take over mail and news. @end menu @@ -13486,35 +16986,35 @@ @table @kbd @item G s b -@kindex G s b @r{(Group)} +@kindex G s b (Group) @findex gnus-group-brew-soup Pack all unread articles in the current group (@code{gnus-group-brew-soup}). This command understands the process/prefix convention. @item G s w -@kindex G s w @r{(Group)} +@kindex G s w (Group) @findex gnus-soup-save-areas Save all @sc{soup} data files (@code{gnus-soup-save-areas}). @item G s s -@kindex G s s @r{(Group)} +@kindex G s s (Group) @findex gnus-soup-send-replies Send all replies from the replies packet (@code{gnus-soup-send-replies}). @item G s p -@kindex G s p @r{(Group)} +@kindex G s p (Group) @findex gnus-soup-pack-packet Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}). @item G s r -@kindex G s r @r{(Group)} +@kindex G s r (Group) @findex nnsoup-pack-replies Pack all replies into a replies packet (@code{nnsoup-pack-replies}). @item O s -@kindex O s @r{(Summary)} +@kindex O s (Summary) @findex gnus-soup-add-article This summary-mode command adds the current article to a @sc{soup} packet (@code{gnus-soup-add-article}). It understands the process/prefix @@ -13566,7 +17066,7 @@ @node SOUP Groups -@subsubsection @sc{soup} Groups +@subsubsection SOUP Groups @cindex nnsoup @code{nnsoup} is the back end for reading @sc{soup} packets. It will @@ -13590,7 +17090,7 @@ @item nnsoup-replies-directory @vindex nnsoup-replies-directory All replies will be stored in this directory before being packed into a -reply packet. The default is @file{~/SOUP/replies/"}. +reply packet. The default is @file{~/SOUP/replies/}. @item nnsoup-replies-format-type @vindex nnsoup-replies-format-type @@ -13697,7 +17197,7 @@ Newsgroups: alt.religion.emacs @end example -will get this @code{From} header inserted: +will get this @code{To} header inserted: @example To: alt-religion-emacs@@GATEWAY @@ -13717,6 +17217,9 @@ @item nngateway-mail2news-header-transformation Creates a @code{To} header that looks like @code{nngateway-address}. +@end table + +@end table Here's an example: @@ -13728,11 +17231,6 @@ nngateway-mail2news-header-transformation))) @end lisp -@end table - - -@end table - So, to use this, simply say something like: @lisp @@ -13741,454 +17239,6 @@ -@node IMAP -@subsection @sc{imap} -@cindex nnimap -@cindex @sc{imap} - -@sc{imap} is a network protocol for reading mail (or news, or@dots{}), -think of it as a modernized @sc{nntp}. Connecting to a @sc{imap} -server is much similar to connecting to a news server, you just -specify the network address of the server. - -@sc{imap} has two properties. First, @sc{imap} can do everything that -POP can, it can hence be viewed as POP++. Secondly, @sc{imap} is a -mail storage protocol, similar to @sc{nntp} being a news storage -protocol. (@sc{imap} offers more features than @sc{nntp} because news -is more or less read-only whereas mail is read-write.) - -If you want to use @sc{imap} as POP++, use an imap entry in -mail-sources. With this, Gnus will fetch mails from the @sc{imap} -server and store them on the local disk. This is not the usage -described in this section. @xref{Mail Sources}. - -If you want to use @sc{imap} as a mail storage protocol, use an nnimap -entry in gnus-secondary-select-methods. With this, Gnus will -manipulate mails stored on the @sc{imap} server. This is the kind of -usage explained in this section. - -A server configuration in @code{~/.gnus} with a few @sc{imap} servers -might look something like this: - -@lisp -(setq gnus-secondary-select-methods - '((nnimap "simpleserver") ; no special configuration - ; perhaps a ssh port forwarded server: - (nnimap "dolk" - (nnimap-address "localhost") - (nnimap-server-port 1430)) - ; a UW server running on localhost - (nnimap "barbar" - (nnimap-server-port 143) - (nnimap-address "localhost") - (nnimap-list-pattern ("INBOX" "mail/*"))) - ; anonymous public cyrus server: - (nnimap "cyrus.andrew.cmu.edu" - (nnimap-authenticator anonymous) - (nnimap-list-pattern "archive.*") - (nnimap-stream network)) - ; a ssl server on a non-standard port: - (nnimap "vic20" - (nnimap-address "vic20.somewhere.com") - (nnimap-server-port 9930) - (nnimap-stream ssl)))) -@end lisp - -The following variables can be used to create a virtual @code{nnimap} -server: - -@table @code - -@item nnimap-address -@vindex nnimap-address - -The address of the remote @sc{imap} server. Defaults to the virtual -server name if not specified. - -@item nnimap-server-port -@vindex nnimap-server-port -Port on server to contact. Defaults to port 143, or 993 for SSL. - -Note that this should be a integer, example server specification: - -@lisp -(nnimap "mail.server.com" - (nnimap-server-port 4711)) -@end lisp - -@item nnimap-list-pattern -@vindex nnimap-list-pattern -String or list of strings of mailboxes to limit available groups to. -This is used when the server has very many mailboxes and you're only -interested in a few -- some servers export your home directory via -@sc{imap}, you'll probably want to limit the mailboxes to those in -@file{~/Mail/*} then. - -The string can also be a cons of REFERENCE and the string as above, what -REFERENCE is used for is server specific, but on the University of -Washington server it's a directory that will be concatenated with the -mailbox. - -Example server specification: - -@lisp -(nnimap "mail.server.com" - (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*" - ("~friend/Mail/" . "list/*")))) -@end lisp - -@item nnimap-stream -@vindex nnimap-stream -The type of stream used to connect to your server. By default, nnimap -will detect and automatically use all of the below, with the exception -of SSL. (SSL is being replaced by STARTTLS, which can be automatically -detected, but it's not widely deployed yet). - -Example server specification: - -@lisp -(nnimap "mail.server.com" - (nnimap-stream ssl)) -@end lisp - -Please note that the value of @code{nnimap-stream} is a symbol! - -@itemize @bullet -@item -@dfn{gssapi:} Connect with GSSAPI (usually Kerberos 5). Requires the -@command{imtest} program. -@item -@dfn{kerberos4:} Connect with Kerberos 4. Requires the -@command{imtest} program. -@item -@dfn{starttls:} Connect via the STARTTLS extension (similar to -SSL)@. Requires the library @file{starttls.el} and program -@command{starttls}. -@item -@dfn{ssl:} Connect through SSL@. Requires OpenSSL (the -program @command{openssl}) or SSLeay (@command{s_client}). -@item -@dfn{shell:} Use a shell command to start an @sc{imap} connection. -@item -@dfn{network:} Plain, TCP/IP network connection. -@end itemize - -@vindex imap-kerberos4-program -The @command{imtest} program is shipped with Cyrus IMAPD@. Nnimap supports -both @command{imtest} version 1.5.x and version 1.6.x. The variable -@code{imap-kerberos4-program} contains parameters to pass to the -@command{imtest} program. - -@vindex imap-ssl-program -For SSL connections, the OpenSSL program is available from -@uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay, -and nnimap supports it too. However, the most recent versions of -SSLeay, 0.9.x, are known to have serious bugs making it -useless. Earlier versions, especially 0.8.x, of SSLeay are known to -work. The variable @code{imap-ssl-program} contains parameters to pass -to OpenSSL/SSLeay. - -@vindex imap-shell-program -@vindex imap-shell-host -For @sc{imap} connections using the @code{shell} stream, the variable -@code{imap-shell-program} specifies what program to call. - -@item nnimap-authenticator -@vindex nnimap-authenticator - -The authenticator used to connect to the server. By default, nnimap -will use the most secure authenticator your server supports. - -Example server specification: - -@lisp -(nnimap "mail.server.com" - (nnimap-authenticator anonymous)) -@end lisp - -Please note that the value of @code{nnimap-authenticator} is a symbol! - -@itemize @bullet -@item -@dfn{gssapi:} GSSAPI (usually Kerberos 5) authentication. Requires the -external program @command{imtest}. -@item -@dfn{kerberos4:} Kerberos authentication. Requires the external program -@command{imtest}. -@item -@dfn{digest-md5:} Encrypted username/password via DIGEST-MD5@. Requires -external library @command{digest-md5.el}. -@item -@dfn{cram-md5:} Encrypted username/password via CRAM-MD5. -@item -@dfn{login:} Plain-text username/password via LOGIN. -@item -@dfn{anonymous:} Login as `anonymous', supplying your email address as -password. -@end itemize - -@item nnimap-expunge-on-close -@cindex Expunging -@vindex nnimap-expunge-on-close -Unlike Parmenides, the @sc{imap} designers decided that things that -don't exist actually do exist. More specifically, @sc{imap} has -the concept of marking articles @code{Deleted} which doesn't actually -delete them, and this (marking them @code{Deleted}, that is) is what -nnimap does when you delete a article in Gnus (with @kbd{G @key{DEL}} or -similar). - -Since the articles aren't really removed when we mark them with the -@code{Deleted} flag we'll need a way to actually delete them. Feel like -running in circles yet? - -Traditionally, nnimap has removed all articles marked as @code{Deleted} -when closing a mailbox but this is now configurable by this server -variable. - -The possible options are: - -@table @code - -@item always -The default behavior, delete all articles marked as "Deleted" when -closing a mailbox. -@item never -Never actually delete articles. Currently there is no way of showing -the articles marked for deletion in nnimap, but other @sc{imap} clients -may allow you to do this. If you ever want to run the EXPUNGE command -manually, @xref{Expunging mailboxes}. -@item ask -When closing mailboxes, nnimap will ask if you wish to expunge deleted -articles or not. - -@end table - -@item nnimap-authinfo-file -@vindex nnimap-authinfo-file - -A file containing credentials used to log in on servers. The format -is (almost) the same as the @code{ftp} @file{~/.netrc} file. See -`nntp-authinfo-file' for exact syntax. - -A file containing credentials used to log in on servers. The format is -(almost) the same as the @code{ftp} @file{~/.netrc} file. See the -variable @code{nntp-authinfo-file} for exact syntax; also see -@xref{NNTP}. - -@end table - -@menu -* Splitting in IMAP:: Splitting mail with nnimap. -* Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox. -* Expunging mailboxes:: Equivalent of a "compress mailbox" button. -@end menu - - - -@node Splitting in IMAP -@subsubsection Splitting in @sc{imap} -@cindex splitting imap mail - -Splitting is something Gnus users have loved and used for years, and now -the rest of the world is catching up. Yeah, dream on; not many -@sc{imap} servers have server side splitting and those that have splitting -seem to use some non-standard protocol. This means that @sc{imap} -support for Gnus has to do its own splitting. - -And it does. - -Here are the variables of interest: - -@table @code - -@item nnimap-split-crosspost -@cindex splitting, crosspost -@cindex crosspost -@vindex nnimap-split-crosspost - -If non-nil, do crossposting if several split methods match the mail. If -nil, the first match in @code{nnimap-split-rule} found will be used. - -Nnmail equivalent: @code{nnmail-crosspost}. - -@item nnimap-split-inbox -@cindex splitting, inbox -@cindex inbox -@vindex nnimap-split-inbox - -A string or a list of strings that gives the name(s) of @sc{imap} -mailboxes to split from. Defaults to @code{nil}, which means that -splitting is disabled! - -@lisp -(setq nnimap-split-inbox - '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap")) -@end lisp - -No nnmail equivalent. - -@item nnimap-split-rule -@cindex Splitting, rules -@vindex nnimap-split-rule - -New mail found in @code{nnimap-split-inbox} will be split according to -this variable. - -This variable contains a list of lists, where the first element in the -sublist gives the name of the @sc{imap} mailbox to move articles -matching the regexp in the second element in the sublist. Got that? -Neither did I, we need examples. - -@lisp -(setq nnimap-split-rule - '(("INBOX.nnimap" - "^Sender: owner-nnimap@@vic20.globalcom.se") - ("INBOX.junk" "^Subject:.*MAKE MONEY") - ("INBOX.private" ""))) -@end lisp - -This will put all articles from the nnimap mailing list into mailbox -INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line -into INBOX.spam and everything else in INBOX.private. - -The first string may contain @samp{\\@var{digit}} forms, like the ones used by -replace-match to insert sub-expressions from the matched text. For -instance: - -@lisp -("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@") -@end lisp - -The second element can also be a function. In that case, it will be -called with the first element of the rule as the argument, in a buffer -containing the headers of the article. It should return a non-nil value -if it thinks that the mail belongs in that group. - -Nnmail users might recollect that the last regexp had to be empty to -match all articles (like in the example above). This is not required in -nnimap. Articles not matching any of the regexps will not be moved out -of your inbox. (This might affect performance if you keep lots of -unread articles in your inbox, since the splitting code would go over -them every time you fetch new mail.) - -These rules are processed from the beginning of the alist toward the -end. The first rule to make a match will `win', unless you have -crossposting enabled. In that case, all matching rules will `win'. - -This variable can also have a function as its value, the function will -be called with the headers narrowed and should return a group to where -it thinks the article should be split. See @code{nnimap-split-fancy}. - -The splitting code tries to create mailboxes if it needs too. - -To allow for different split rules on different virtual servers, and -even different split rules in different inboxes on the same server, -the syntax of this variable has been extended along the lines of: - -@lisp -(setq nnimap-split-rule - '(("my1server" (".*" (("ding" "ding@@gnus.org") - ("junk" "From:.*Simon"))) - ("my2server" ("INBOX" nnimap-split-fancy)) - ("my[34]server" (".*" (("private" "To:.*Simon") - ("junk" my-junk-func))))) -@end lisp - -The virtual server name is in fact a regexp, so that the same rules -may apply to several servers. In the example, the servers -@code{my3server} and @code{my4server} both use the same rules. -Similarly, the inbox string is also a regexp. The actual splitting -rules are as before, either a function, or a list with group/regexp or -group/function elements. - -Nnmail equivalent: @code{nnmail-split-methods}. - -@item nnimap-split-predicate -@cindex splitting -@vindex nnimap-split-predicate - -Mail matching this predicate in @code{nnimap-split-inbox} will be -split; it is a string and the default is @samp{UNSEEN UNDELETED}. - -This might be useful if you use another @sc{imap} client to read mail in -your inbox but would like Gnus to split all articles in the inbox -regardless of readedness. Then you might change this to -@samp{UNDELETED}. - -@item nnimap-split-fancy -@cindex splitting, fancy -@findex nnimap-split-fancy -@vindex nnimap-split-fancy - -It's possible to set @code{nnimap-split-rule} to -@code{nnmail-split-fancy} if you want to use fancy -splitting. @xref{Fancy Mail Splitting}. - -However, to be able to have different fancy split rules for nnmail and -nnimap back ends you can set @code{nnimap-split-rule} to -@code{nnimap-split-fancy} and define the nnimap specific fancy split -rule in @code{nnimap-split-fancy}. - -Example: - -@lisp -(setq nnimap-split-rule 'nnimap-split-fancy - nnimap-split-fancy ...) -@end lisp - -Nnmail equivalent: @code{nnmail-split-fancy}. - -@end table - -@node Editing IMAP ACLs -@subsubsection Editing @sc{imap} ACLs -@cindex editing imap acls -@cindex Access Control Lists -@cindex Editing @sc{imap} ACLs -@kindex G l -@findex gnus-group-nnimap-edit-acl - -ACL stands for Access Control List. ACLs are used in @sc{imap} for -limiting (or enabling) other users access to your mail boxes. Not all -@sc{imap} servers support this, this function will give an error if it -doesn't. - -To edit a ACL for a mailbox, type @kbd{G l} -(@code{gnus-group-edit-nnimap-acl}) and you'll be presented with a ACL -editing window with detailed instructions. - -Some possible uses: - -@itemize @bullet -@item -Giving "anyone" the "lrs" rights (lookup, read, keep seen/unseen flags) -on your mailing list mailboxes enables other users on the same server to -follow the list without subscribing to it. -@item -At least with the Cyrus server, you are required to give the user -"anyone" posting ("p") capabilities to have "plussing" work (that is, -mail sent to user+mailbox@@domain ending up in the @sc{imap} mailbox -INBOX.mailbox). -@end itemize - -@node Expunging mailboxes -@subsubsection Expunging mailboxes -@cindex expunging - -@cindex Expunge -@cindex Manual expunging -@kindex G x -@findex gnus-group-nnimap-expunge - -If you're using the @code{never} setting of @code{nnimap-expunge-close}, -you may want the option of expunging all deleted articles in a mailbox -manually. This is exactly what @kbd{G x} does. - -Currently there is no way of showing deleted articles, you can just -delete them. - - - @node Combined Groups @section Combined Groups @@ -14196,8 +17246,8 @@ groups. @menu -* Virtual Groups:: Combining articles from many groups. -* Kibozed Groups:: Looking through parts of the newsfeed for articles. +* Virtual Groups:: Combining articles from many groups. +* Kibozed Groups:: Looking through parts of the newsfeed for articles. @end menu @@ -14219,9 +17269,12 @@ All marks in the virtual group will stick to the articles in the component groups. So if you tick an article in a virtual group, the -article will also be ticked in the component group from whence it came. -(And vice versa---marks from the component groups will also be shown in -the virtual group.) +article will also be ticked in the component group from whence it +came. (And vice versa---marks from the component groups will also be +shown in the virtual group.). To create an empty virtual group, run +@kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer +and edit the method regexp with @kbd{M-e} +(@code{gnus-group-edit-group-method}) Here's an example @code{nnvirtual} method that collects all Andrea Dworkin newsgroups into one, big, happy newsgroup: @@ -14276,9 +17329,12 @@ and in that case @code{nnvirtual} tells Gnus that the article came from a not-news back end. (Just to be on the safe side.) -@kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups} +@kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups} line from the article you respond to in these cases. +@code{nnvirtual} groups do not inherit anything but articles and marks +from component groups---group parameters, for instance, are not +inherited. @node Kibozed Groups @@ -14286,36 +17342,36 @@ @cindex nnkiboze @cindex kibozing -@dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of) -the news feed''. @code{nnkiboze} is a back end that will do this for -you. Oh joy! Now you can grind any @sc{nntp} server down to a halt -with useless requests! Oh happiness! - -@kindex G k @r{(Group)} +@dfn{Kibozing} is defined by the @acronym{OED} as ``grepping through +(parts of) the news feed''. @code{nnkiboze} is a back end that will +do this for you. Oh joy! Now you can grind any @acronym{NNTP} server +down to a halt with useless requests! Oh happiness! + +@kindex G k (Group) To create a kibozed group, use the @kbd{G k} command in the group buffer. The address field of the @code{nnkiboze} method is, as with @code{nnvirtual}, a regexp to match groups to be ``included'' in the -@code{nnkiboze} group. That's where most similarities between @code{nnkiboze} -and @code{nnvirtual} end. - -In addition to this regexp detailing component groups, an @code{nnkiboze} group -must have a score file to say what articles are to be included in -the group (@pxref{Scoring}). +@code{nnkiboze} group. That's where most similarities between +@code{nnkiboze} and @code{nnvirtual} end. + +In addition to this regexp detailing component groups, an +@code{nnkiboze} group must have a score file to say what articles are +to be included in the group (@pxref{Scoring}). @kindex M-x nnkiboze-generate-groups @findex nnkiboze-generate-groups You must run @kbd{M-x nnkiboze-generate-groups} after creating the -@code{nnkiboze} groups you want to have. This command will take time. Lots of -time. Oodles and oodles of time. Gnus has to fetch the headers from -all the articles in all the component groups and run them through the -scoring process to determine if there are any articles in the groups -that are to be part of the @code{nnkiboze} groups. +@code{nnkiboze} groups you want to have. This command will take time. +Lots of time. Oodles and oodles of time. Gnus has to fetch the +headers from all the articles in all the component groups and run them +through the scoring process to determine if there are any articles in +the groups that are to be part of the @code{nnkiboze} groups. Please limit the number of component groups by using restrictive regexps. Otherwise your sysadmin may become annoyed with you, and the -@sc{nntp} site may throw you off and never let you back in again. +@acronym{NNTP} site may throw you off and never let you back in again. Stranger things have happened. @code{nnkiboze} component groups do not have to be alive---they can be dead, @@ -14323,22 +17379,23 @@ @vindex nnkiboze-directory The generation of an @code{nnkiboze} group means writing two files in -@code{nnkiboze-directory}, which is @file{~/News/} by default. One -contains the @sc{nov} header lines for all the articles in the group, -and the other is an additional @file{.newsrc} file to store information -on what groups have been searched through to find component articles. +@code{nnkiboze-directory}, which is @file{~/News/kiboze/} by default. +One contains the @acronym{NOV} header lines for all the articles in +the group, and the other is an additional @file{.newsrc} file to store +information on what groups have been searched through to find +component articles. Articles marked as read in the @code{nnkiboze} group will have -their @sc{nov} lines removed from the @sc{nov} file. +their @acronym{NOV} lines removed from the @acronym{NOV} file. @node Gnus Unplugged @section Gnus Unplugged @cindex offline @cindex unplugged -@cindex Agent -@cindex Gnus Agent -@cindex Gnus Unplugged +@cindex agent +@cindex Gnus agent +@cindex Gnus unplugged In olden times (ca. February '88), people used to run their newsreaders on big machines with permanent connections to the net. News transport @@ -14357,38 +17414,25 @@ functionality up to the newsreader makes sense if you're the only person reading news on a machine. -Using Gnus as an ``offline'' newsreader is quite simple. - -@itemize @bullet -@item -First, set up Gnus as you would do if you were running it on a machine -that has full connection to the net. Go ahead. I'll still be waiting -here. - -@item -Then, put the following magical incantation at the end of your -@file{.gnus.el} file: - -@lisp -(gnus-agentize) -@end lisp -@end itemize - -That's it. Gnus is now an ``offline'' newsreader. +Setting up Gnus as an ``offline'' newsreader is quite simple. In +fact, you don't even have to configure anything. Of course, to use it as such, you have to learn a few new commands. @menu -* Agent Basics:: How it all is supposed to work. -* Agent Categories:: How to tell the Gnus Agent what to download. -* Agent Commands:: New commands for all the buffers. -* Agent Expiry:: How to make old articles go away. -* Agent and IMAP:: How to use the Agent with IMAP. -* Outgoing Messages:: What happens when you post/mail something? -* Agent Variables:: Customizing is fun. -* Example Setup:: An example @file{.gnus.el} file for offline people. -* Batching Agents:: How to fetch news from a @code{cron} job. -* Agent Caveats:: What you think it'll do and what it does. +* Agent Basics:: How it all is supposed to work. +* Agent Categories:: How to tell the Gnus Agent what to download. +* Agent Commands:: New commands for all the buffers. +* Agent Visuals:: Ways that the agent may effect your summary buffer. +* Agent as Cache:: The Agent is a big cache too. +* Agent Expiry:: How to make old articles go away. +* Agent Regeneration:: How to recover from lost connections and other accidents. +* Agent and IMAP:: How to use the Agent with @acronym{IMAP}. +* Outgoing Messages:: What happens when you post/mail something? +* Agent Variables:: Customizing is fun. +* Example Setup:: An example @file{~/.gnus.el} file for offline people. +* Batching Agents:: How to fetch news from a @code{cron} job. +* Agent Caveats:: What you think it'll do and what it does. @end menu @@ -14408,11 +17452,35 @@ @dfn{Downloading} means fetching things from the net to your local machine. @dfn{Uploading} is doing the opposite. +You know that Gnus gives you all the opportunity you'd ever want for +shooting yourself in the foot. Some people call it flexibility. Gnus +is also customizable to a great extent, which means that the user has a +say on how Gnus behaves. Other newsreaders might unconditionally shoot +you in your foot, but with Gnus, you have a choice! + +Gnus is never really in plugged or unplugged state. Rather, it applies +that state to each server individually. This means that some servers +can be plugged while others can be unplugged. Additionally, some +servers can be ignored by the Agent altogether (which means that +they're kinda like plugged always). + +So when you unplug the Agent and then wonder why is Gnus opening a +connection to the Net, the next step to do is to look whether all +servers are agentized. If there is an unagentized server, you found +the culprit. + +Another thing is the @dfn{offline} state. Sometimes, servers aren't +reachable. When Gnus notices this, it asks you whether you want the +server to be switched to offline state. If you say yes, then the +server will behave somewhat as if it was unplugged, except that Gnus +will ask you whether you want to switch it back online again. + Let's take a typical Gnus session using the Agent. @itemize @bullet @item +@findex gnus-unplugged You start Gnus with @code{gnus-unplugged}. This brings up the Gnus Agent in a disconnected state. You can read all the news that you have already fetched while in this mode. @@ -14421,15 +17489,15 @@ You then decide to see whether any new news has arrived. You connect your machine to the net (using PPP or whatever), and then hit @kbd{J j} to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail -as usual. To check for new mail in unplugged mode, see (@pxref{Mail +as usual. To check for new mail in unplugged mode (@pxref{Mail Source Specifiers}). @item -You can then read the new news immediately, or you can download the news -onto your local machine. If you want to do the latter, you press @kbd{g} -to check if there are any new news and then @kbd{J -s} to fetch all the eligible articles in all the groups. (To let Gnus -know which articles you want to download, @pxref{Agent Categories}.) +You can then read the new news immediately, or you can download the +news onto your local machine. If you want to do the latter, you press +@kbd{g} to check if there are any new news and then @kbd{J s} to fetch +all the eligible articles in all the groups. (To let Gnus know which +articles you want to download, @pxref{Agent Categories}). @item After fetching the articles, you press @kbd{J j} to make Gnus become @@ -14449,15 +17517,28 @@ Decide which servers should be covered by the Agent. If you have a mail back end, it would probably be nonsensical to have it covered by the Agent. Go to the server buffer (@kbd{^} in the group buffer) and press -@kbd{J a} the server (or servers) that you wish to have covered by the -Agent (@pxref{Server Agent Commands}). This will typically be only the -primary select method, which is listed on the bottom in the buffer. - -@item -Decide on download policy. @xref{Agent Categories}. - -@item -Uhm... that's it. +@kbd{J a} on the server (or servers) that you wish to have covered by the +Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically +added servers you do not wish to have covered by the Agent. By default, +all @code{nntp} and @code{nnimap} servers in @code{gnus-select-method} and +@code{gnus-secondary-select-methods} are agentized. + +@item +Decide on download policy. It's fairly simple once you decide whether +you are going to use agent categories, topic parameters, and/or group +parameters to implement your policy. If you're new to gnus, it +is probably best to start with a category, @xref{Agent Categories}. + +Both topic parameters (@pxref{Topic Parameters}) and agent categories +(@pxref{Agent Categories}) provide for setting a policy that applies +to multiple groups. Which you use is entirely up to you. Topic +parameters do override categories so, if you mix the two, you'll have +to take that into account. If you have a few groups that deviate from +your policy, you can use group parameters (@pxref{Group Parameters}) to +configure them. + +@item +Uhm@dots{} that's it. @end itemize @@ -14472,34 +17553,102 @@ mark the articles for downloading manually if it should turn out that you're interested in the articles anyway. -The main way to control what is to be downloaded is to create a -@dfn{category} and then assign some (or all) groups to this category. -Groups that do not belong in any other category belong to the -@code{default} category. Gnus has its own buffer for creating and -managing categories. - -@menu -* Category Syntax:: What a category looks like. -* The Category Buffer:: A buffer for maintaining categories. -* Category Variables:: Customize'r'Us. +One of the more effective methods for controlling what is to be +downloaded is to create a @dfn{category} and then assign some (or all) +groups to this category. Groups that do not belong in any other +category belong to the @code{default} category. Gnus has its own +buffer for creating and managing categories. + +If you prefer, you can also use group parameters (@pxref{Group +Parameters}) and topic parameters (@pxref{Topic Parameters}) for an +alternative approach to controlling the agent. The only real +difference is that categories are specific to the agent (so there is +less to learn) while group and topic parameters include the kitchen +sink. + +Since you can set agent parameters in several different places we have +a rule to decide which source to believe. This rule specifies that +the parameter sources are checked in the following order: group +parameters, topic parameters, agent category, and finally customizable +variables. So you can mix all of these sources to produce a wide range +of behavior, just don't blame me if you don't remember where you put +your settings. + +@menu +* Category Syntax:: What a category looks like. +* Category Buffer:: A buffer for maintaining categories. +* Category Variables:: Customize'r'Us. @end menu @node Category Syntax @subsubsection Category Syntax -A category consists of two things. - -@enumerate -@item +A category consists of a name, the list of groups belonging to the +category, and a number of optional parameters that override the +customizable variables. The complete list of agent parameters are +listed below. + +@cindex Agent Parameters +@table @code +@item gnus-agent-cat-name +The name of the category. + +@item gnus-agent-cat-groups +The list of groups that are in this category. + +@item gnus-agent-cat-predicate A predicate which (generally) gives a rough outline of which articles are eligible for downloading; and -@item +@item gnus-agent-cat-score-file a score rule which (generally) gives you a finer granularity when deciding what articles to download. (Note that this @dfn{download score} is not necessarily related to normal scores.) -@end enumerate + +@item gnus-agent-cat-enable-expiration +a boolean indicating whether the agent should expire old articles in +this group. Most groups should be expired to conserve disk space. In +fact, its probably safe to say that the gnus.* hierarchy contains the +only groups that should not be expired. + +@item gnus-agent-cat-days-until-old +an integer indicating the number of days that the agent should wait +before deciding that a read article is safe to expire. + +@item gnus-agent-cat-low-score +an integer that overrides the value of @code{gnus-agent-low-score}. + +@item gnus-agent-cat-high-score +an integer that overrides the value of @code{gnus-agent-high-score}. + +@item gnus-agent-cat-length-when-short +an integer that overrides the value of +@code{gnus-agent-short-article}. + +@item gnus-agent-cat-length-when-long +an integer that overrides the value of @code{gnus-agent-long-article}. + +@c @item gnus-agent-cat-disable-undownloaded-faces +@c a symbol indicating whether the summary buffer should @emph{not} display +@c undownloaded articles using the gnus-summary-*-undownloaded-face +@c faces. The symbol nil will enable the use of undownloaded faces while +@c all other symbols disable them. + +@item gnus-agent-cat-enable-undownloaded-faces +a symbol indicating whether the summary buffer should display +undownloaded articles using the gnus-summary-*-undownloaded-face +faces. The symbol nil will disable the use of undownloaded faces while +all other symbols enable them. +@end table + +The name of a category can not be changed once the category has been +created. + +Each category maintains a list of groups that are exclusive members of +that category. The exclusivity rule is automatically enforced, add a +group to a new category and it is automatically removed from its old +category. A predicate in its simplest form can be a single predicate such as @code{true} or @code{false}. These two will download every available @@ -14546,6 +17695,14 @@ The following predicates are pre-defined, but if none of these fit what you want to do, you can write your own. +When evaluating each of these predicates, the named constant will be +bound to the value determined by calling +@code{gnus-agent-find-parameter} on the appropriate parameter. For +example, gnus-agent-short-article will be bound to +@code{(gnus-agent-find-parameter group 'agent-short-article)}. This +means that you can specify a predicate in your category then tune that +predicate to individual groups. + @table @code @item short True iff the article is shorter than @code{gnus-agent-short-article} @@ -14600,13 +17757,13 @@ or you could append your predicate to the predefined @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or -wherever. (Note: this would have to be at a point *after* -@code{gnus-agent} has been loaded via @code{(gnus-agentize)}) - -@lisp +wherever. + +@lisp +(require 'gnus-agent) (setq gnus-category-predicate-alist (append gnus-category-predicate-alist - '((old . my-article-old-p)))) + '((old . my-article-old-p)))) @end lisp and simply specify your predicate as: @@ -14620,17 +17777,17 @@ always a reliable indication of when it was posted. Hell, some people just don't give a damn. -The above predicates apply to *all* the groups which belong to the +The above predicates apply to @emph{all} the groups which belong to the category. However, if you wish to have a specific predicate for an individual group within a category, or you're just too lazy to set up a -new category, you can enter a group's individual predicate in it's group +new category, you can enter a group's individual predicate in its group parameters like so: @lisp (agent-predicate . short) @end lisp -This is the group parameter equivalent of the agent category default. +This is the group/topic parameter equivalent of the agent category default. Note that when specifying a single word predicate like this, the @code{agent-predicate} specification must be in dotted pair notation. @@ -14664,7 +17821,7 @@ @item Score rule -This has the same syntax as a normal gnus score file except only a +This has the same syntax as a normal Gnus score file except only a subset of scoring keywords are available as mentioned above. example: @@ -14681,7 +17838,7 @@ @end lisp @item -Group Parameter specification +Group/Topic Parameter specification @lisp (agent-score ("from" @@ -14696,8 +17853,8 @@ @item Agent score file -These score files must *only* contain the permitted scoring keywords -stated above. +These score files must @emph{only} contain the permitted scoring +keywords stated above. example: @@ -14736,7 +17893,7 @@ These directives in either the category definition or a group's parameters will cause the agent to read in all the applicable score -files for a group, *filtering out* those sections that do not +files for a group, @emph{filtering out} those sections that do not relate to one of the permitted subset of scoring keywords. @itemize @bullet @@ -14756,8 +17913,8 @@ @end itemize @end enumerate -@node The Category Buffer -@subsubsection The Category Buffer +@node Category Buffer +@subsubsection Category Buffer You'd normally do all category maintenance from the category buffer. When you enter it for the first time (with the @kbd{J c} command from @@ -14771,6 +17928,12 @@ @findex gnus-category-exit Return to the group buffer (@code{gnus-category-exit}). +@item e +@kindex e (Category) +@findex gnus-category-customize-category +Use a customization buffer to set all of the selected category's +parameters at one time (@code{gnus-category-customize-category}). + @item k @kindex k (Category) @findex gnus-category-kill @@ -14854,30 +18017,44 @@ Articles that have a score higher than this have a high score. Default 0. +@item gnus-agent-expire-days +@vindex gnus-agent-expire-days +The number of days that a @samp{read} article must stay in the agent's +local disk before becoming eligible for expiration (While the name is +the same, this doesn't mean expiring the article on the server. It +just means deleting the local copy of the article). What is also +important to understand is that the counter starts with the time the +article was written to the local disk and not the time the article was +read. +Default 7. + +@item gnus-agent-enable-expiration +@vindex gnus-agent-enable-expiration +Determines whether articles in a group are, by default, expired or +retained indefinitely. The default is @code{ENABLE} which means that +you'll have to disable expiration when desired. On the other hand, +you could set this to @code{DISABLE}. In that case, you would then +have to enable expiration in selected groups. + @end table @node Agent Commands @subsection Agent Commands +@findex gnus-agent-toggle-plugged +@kindex J j (Agent) All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j} -(@code{gnus-agent-toggle-plugged} command works in all modes, and +(@code{gnus-agent-toggle-plugged}) command works in all modes, and toggles the plugged/unplugged state of the Gnus Agent. @menu -* Group Agent Commands:: -* Summary Agent Commands:: -* Server Agent Commands:: -@end menu - -You can run a complete batch fetch from the command line with the -following incantation: - -@cindex gnus-agent-batch-fetch -@example -$ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch -@end example +* Group Agent Commands:: Configure groups and fetch their contents. +* Summary Agent Commands:: Manually select then fetch specific articles. +* Server Agent Commands:: Select the servers that are supported by the agent. +@end menu + @@ -14904,9 +18081,9 @@ @item J S @kindex J S (Agent Group) -@findex gnus-group-send-drafts -Send all sendable messages in the draft group -(@code{gnus-group-send-drafts}). @xref{Drafts}. +@findex gnus-group-send-queue +Send all sendable messages in the queue group +(@code{gnus-group-send-queue}). @xref{Drafts}. @item J a @kindex J a (Agent Group) @@ -14946,15 +18123,36 @@ Remove the downloading mark from the article (@code{gnus-agent-unmark-article}). +@cindex % @item @@ @kindex @@ (Agent Summary) @findex gnus-agent-toggle-mark -Toggle whether to download the article (@code{gnus-agent-toggle-mark}). +Toggle whether to download the article +(@code{gnus-agent-toggle-mark}). The download mark is @samp{%} by +default. @item J c @kindex J c (Agent Summary) @findex gnus-agent-catchup -Mark all undownloaded articles as read (@code{gnus-agent-catchup}). +Mark all articles as read (@code{gnus-agent-catchup}) that are neither cached, downloaded, nor downloadable. + +@item J S +@kindex J S (Agent Summary) +@findex gnus-agent-fetch-group +Download all eligible (@pxref{Agent Categories}) articles in this group. +(@code{gnus-agent-fetch-group}). + +@item J s +@kindex J s (Agent Summary) +@findex gnus-agent-fetch-series +Download all processable articles in this group. +(@code{gnus-agent-fetch-series}). + +@item J u +@kindex J u (Agent Summary) +@findex gnus-agent-summary-fetch-group +Download all downloadable articles in the current group +(@code{gnus-agent-summary-fetch-group}). @end table @@ -14978,63 +18176,194 @@ @end table +@node Agent Visuals +@subsection Agent Visuals + +If you open a summary while unplugged and, Gnus knows from the group's +active range that there are more articles than the headers currently +stored in the Agent, you may see some articles whose subject looks +something like @samp{[Undownloaded article #####]}. These are +placeholders for the missing headers. Aside from setting a mark, +there is not much that can be done with one of these placeholders. +When Gnus finally gets a chance to fetch the group's headers, the +placeholders will automatically be replaced by the actual headers. +You can configure the summary buffer's maneuvering to skip over the +placeholders if you care (See @code{gnus-auto-goto-ignores}). + +While it may be obvious to all, the only headers and articles +available while unplugged are those headers and articles that were +fetched into the Agent while previously plugged. To put it another +way, "If you forget to fetch something while plugged, you might have a +less than satisfying unplugged session". For this reason, the Agent +adds two visual effects to your summary buffer. These effects display +the download status of each article so that you always know which +articles will be available when unplugged. + +The first visual effect is the @samp{%O} spec. If you customize +@code{gnus-summary-line-format} to include this specifier, you will add +a single character field that indicates an article's download status. +Articles that have been fetched into either the Agent or the Cache, +will display @code{gnus-downloaded-mark} (defaults to @samp{+}). All +other articles will display @code{gnus-undownloaded-mark} (defaults to +@samp{-}). If you open a group that has not been agentized, a space +(@samp{ }) will be displayed. + +The second visual effect are the undownloaded faces. The faces, there +are three indicating the article's score (low, normal, high), seem to +result in a love/hate response from many Gnus users. The problem is +that the face selection is controlled by a list of condition tests and +face names (See @code{gnus-summary-highlight}). Each condition is +tested in the order in which it appears in the list so early +conditions have precedence over later conditions. All of this means +that, if you tick an undownloaded article, the article will continue +to be displayed in the undownloaded face rather than the ticked face. + +If you use the Agent as a cache (to avoid downloading the same article +each time you visit it or to minimize your connection time), the +undownloaded face will probably seem like a good idea. The reason +being that you do all of our work (marking, reading, deleting) with +downloaded articles so the normal faces always appear. + +For occasional Agent users, the undownloaded faces may appear to be an +absolutely horrible idea. The issue being that, since most of their +articles have not been fetched into the Agent, most of the normal +faces will be obscured by the undownloaded faces. If this is your +situation, you have two choices available. First, you can completely +disable the undownload faces by customizing +@code{gnus-summary-highlight} to delete the three cons-cells that +refer to the @code{gnus-summary-*-undownloaded-face} faces. Second, if +you prefer to take a more fine-grained approach, you may set the +@code{agent-disable-undownloaded-faces} group parameter to t. This +parameter, like all other agent parameters, may be set on an Agent +Category (@pxref{Agent Categories}), a Group Topic (@pxref{Topic +Parameters}), or an individual group (@pxref{Group Parameters}). + +@node Agent as Cache +@subsection Agent as Cache + +When Gnus is plugged, it is not efficient to download headers or +articles from the server again, if they are already stored in the +Agent. So, Gnus normally only downloads headers once, and stores them +in the Agent. These headers are later used when generating the summary +buffer, regardless of whether you are plugged or unplugged. Articles +are not cached in the Agent by default though (that would potentially +consume lots of disk space), but if you have already downloaded an +article into the Agent, Gnus will not download the article from the +server again but use the locally stored copy instead. + +If you so desire, you can configure the agent (see @code{gnus-agent-cache} +@pxref{Agent Variables}) to always download headers and articles while +plugged. Gnus will almost certainly be slower, but it will be kept +synchronized with the server. That last point probably won't make any +sense if you are using a nntp or nnimap back end. + @node Agent Expiry @subsection Agent Expiry @vindex gnus-agent-expire-days @findex gnus-agent-expire @kindex M-x gnus-agent-expire -@cindex Agent expiry -@cindex Gnus Agent expiry +@kindex M-x gnus-agent-expire-group +@findex gnus-agent-expire-group +@cindex agent expiry +@cindex Gnus agent expiry @cindex expiry -@code{nnagent} doesn't handle expiry. Instead, there's a special -@code{gnus-agent-expire} command that will expire all read articles that -are older than @code{gnus-agent-expire-days} days. It can be run -whenever you feel that you're running out of space. It's not -particularly fast or efficient, and it's not a particularly good idea to -interrupt it (with @kbd{C-g} or anything else) once you've started it. +The Agent back end, @code{nnagent}, doesn't handle expiry. Well, at +least it doesn't handle it like other back ends. Instead, there are +special @code{gnus-agent-expire} and @code{gnus-agent-expire-group} +commands that will expire all read articles that are older than +@code{gnus-agent-expire-days} days. They can be run whenever you feel +that you're running out of space. Neither are particularly fast or +efficient, and it's not a particularly good idea to interrupt them (with +@kbd{C-g} or anything else) once you've started one of them. + +Note that other functions, e.g. @code{gnus-request-expire-articles}, +might run @code{gnus-agent-expire} for you to keep the agent +synchronized with the group. + +The agent parameter @code{agent-enable-expiration} may be used to +prevent expiration in selected groups. @vindex gnus-agent-expire-all -if @code{gnus-agent-expire-all} is non-@code{nil}, this command will -expire all articles---unread, read, ticked and dormant. If @code{nil} -(which is the default), only read articles are eligible for expiry, and -unread, ticked and dormant articles will be kept indefinitely. - +If @code{gnus-agent-expire-all} is non-@code{nil}, the agent +expiration commands will expire all articles---unread, read, ticked +and dormant. If @code{nil} (which is the default), only read articles +are eligible for expiry, and unread, ticked and dormant articles will +be kept indefinitely. + +If you find that some articles eligible for expiry are never expired, +perhaps some Gnus Agent files are corrupted. There's are special +commands, @code{gnus-agent-regenerate} and +@code{gnus-agent-regenerate-group}, to fix possible problems. + +@node Agent Regeneration +@subsection Agent Regeneration + +@cindex agent regeneration +@cindex Gnus agent regeneration +@cindex regeneration + +The local data structures used by @code{nnagent} may become corrupted +due to certain exceptional conditions. When this happens, +@code{nnagent} functionality may degrade or even fail. The solution +to this problem is to repair the local data structures by removing all +internal inconsistencies. + +For example, if your connection to your server is lost while +downloaded articles into the agent, the local data structures will not +know about articles successfully downloaded prior to the connection +failure. Running @code{gnus-agent-regenerate} or +@code{gnus-agent-regenerate-group} will update the data structures +such that you don't need to download these articles a second time. + +@findex gnus-agent-regenerate +@kindex M-x gnus-agent-regenerate +The command @code{gnus-agent-regenerate} will perform +@code{gnus-agent-regenerate-group} on every agentized group. While +you can run @code{gnus-agent-regenerate} in any buffer, it is strongly +recommended that you first close all summary buffers. + +@findex gnus-agent-regenerate-group +@kindex M-x gnus-agent-regenerate-group +The command @code{gnus-agent-regenerate-group} uses the local copies +of individual articles to repair the local @acronym{NOV}(header) database. It +then updates the internal data structures that document which articles +are stored locally. An optional argument will mark articles in the +agent as unread. @node Agent and IMAP @subsection Agent and IMAP -The Agent work with any Gnus back end, including nnimap. However, -since there are some conceptual differences between @sc{nntp} and -@sc{imap}, this section (should) provide you with some information to -make Gnus Agent work smoother as a @sc{imap} Disconnected Mode client. +The Agent works with any Gnus back end, including nnimap. However, +since there are some conceptual differences between @acronym{NNTP} and +@acronym{IMAP}, this section (should) provide you with some information to +make Gnus Agent work smoother as a @acronym{IMAP} Disconnected Mode client. The first thing to keep in mind is that all flags (read, ticked, etc) -are kept on the @sc{imap} server, rather than in @file{.newsrc} as is the +are kept on the @acronym{IMAP} server, rather than in @file{.newsrc} as is the case for nntp. Thus Gnus need to remember flag changes when disconnected, and synchronize these flags when you plug back in. -Gnus keep track of flag changes when reading nnimap groups under the -Agent by default. When you plug back in, by default Gnus will check if -you have any changed any flags and ask if you wish to synchronize these -with the server. This behavior is customizable with -@code{gnus-agent-synchronize-flags}. +Gnus keeps track of flag changes when reading nnimap groups under the +Agent. When you plug back in, Gnus will check if you have any changed +any flags and ask if you wish to synchronize these with the server. +The behavior is customizable by @code{gnus-agent-synchronize-flags}. @vindex gnus-agent-synchronize-flags If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will -never automatically synchronize flags. If it is @code{ask}, the -default, the Agent will check if you made any changes and if so ask if -you wish to synchronize these when you re-connect. If it has any other -value, all flags will be synchronized automatically. - -If you do not wish to automatically synchronize flags when you -re-connect, this can be done manually with the +never automatically synchronize flags. If it is @code{ask}, which is +the default, the Agent will check if you made any changes and if so +ask if you wish to synchronize these when you re-connect. If it has +any other value, all flags will be synchronized automatically. + +If you do not wish to synchronize flags automatically when you +re-connect, you can do it manually with the @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y} -in the group buffer by default. +in the group buffer. Some things are currently not implemented in the Agent that you'd might -expect from a disconnected @sc{imap} client, including: +expect from a disconnected @acronym{IMAP} client, including: @itemize @bullet @@ -15046,12 +18375,12 @@ @end itemize -Technical note: the synchronization algorithm does not work by "pushing" +Technical note: the synchronization algorithm does not work by ``pushing'' all local flags to the server, but rather incrementally update the server view of flags by changing only those flags that were changed by -the user. Thus, if you set one flag on a article, quit the group and +the user. Thus, if you set one flag on an article, quit the group and re-select the group and remove the flag; the flag will be set and -removed from the server when you "synchronize". The queued flag +removed from the server when you ``synchronize''. The queued flag operations can be found in the per-server @code{flags} file in the Agent directory. It's emptied when you synchronize flags. @@ -15060,8 +18389,8 @@ @subsection Outgoing Messages When Gnus is unplugged, all outgoing messages (both mail and news) are -stored in the draft groups (@pxref{Drafts}). You can view them there -after posting, and edit them at will. +stored in the draft group ``queue'' (@pxref{Drafts}). You can view +them there after posting, and edit them at will. When Gnus is plugged again, you can send the messages either from the draft group with the special commands available there, or you can use @@ -15094,6 +18423,92 @@ @vindex gnus-agent-unplugged-hook Hook run when disconnecting from the network. +@item gnus-agent-fetched-hook +@vindex gnus-agent-fetched-hook +Hook run when finished fetching articles. + +@item gnus-agent-cache +@vindex gnus-agent-cache +Variable to control whether use the locally stored @acronym{NOV} and +articles when plugged, e.g. essentially using the Agent as a cache. +The default is non-@code{nil}, which means to use the Agent as a cache. + +@item gnus-agent-go-online +@vindex gnus-agent-go-online +If @code{gnus-agent-go-online} is @code{nil}, the Agent will never +automatically switch offline servers into online status. If it is +@code{ask}, the default, the Agent will ask if you wish to switch +offline servers into online status when you re-connect. If it has any +other value, all offline servers will be automatically switched into +online status. + +@item gnus-agent-mark-unread-after-downloaded +@vindex gnus-agent-mark-unread-after-downloaded +If @code{gnus-agent-mark-unread-after-downloaded} is non-@code{nil}, +mark articles as unread after downloading. This is usually a safe +thing to do as the newly downloaded article has obviously not been +read. The default is t. + +@item gnus-agent-consider-all-articles +@vindex gnus-agent-consider-all-articles +If @code{gnus-agent-consider-all-articles} is non-@code{nil}, the +agent will let the agent predicate decide whether articles need to be +downloaded or not, for all articles. When @code{nil}, the default, +the agent will only let the predicate decide whether unread articles +are downloaded or not. If you enable this, you may also want to look +into the agent expiry settings (@pxref{Category Variables}), so that +the agent doesn't download articles which the agent will later expire, +over and over again. + +@item gnus-agent-max-fetch-size +@vindex gnus-agent-max-fetch-size +The agent fetches articles into a temporary buffer prior to parsing +them into individual files. To avoid exceeding the max. buffer size, +the agent alternates between fetching and parsing until all articles +have been fetched. @code{gnus-agent-max-fetch-size} provides a size +limit to control how often the cycling occurs. A large value improves +performance. A small value minimizes the time lost should the +connection be lost while fetching (You may need to run +@code{gnus-agent-regenerate-group} to update the group's state. +However, all articles parsed prior to loosing the connection will be +available while unplugged). The default is 10M so it is unusual to +see any cycling. + +@item gnus-server-unopen-status +@vindex gnus-server-unopen-status +Perhaps not an Agent variable, but closely related to the Agent, this +variable says what will happen if Gnus cannot open a server. If the +Agent is enabled, the default, @code{nil}, makes Gnus ask the user +whether to deny the server or whether to unplug the agent. If the +Agent is disabled, Gnus always simply deny the server. Other choices +for this variable include @code{denied} and @code{offline} the latter +is only valid if the Agent is used. + +@item gnus-auto-goto-ignores +@vindex gnus-auto-goto-ignores +Another variable that isn't an Agent variable, yet so closely related +that most will look for it here, this variable tells the summary +buffer how to maneuver around undownloaded (only headers stored in the +agent) and unfetched (neither article nor headers stored) articles. + +The legal values are @code{nil} (maneuver to any article), +@code{undownloaded} (maneuvering while unplugged ignores articles that +have not been fetched), @code{always-undownloaded} (maneuvering always +ignores articles that have not been fetched), @code{unfetched} +(maneuvering ignores articles whose headers have not been fetched). + +@item gnus-agent-auto-agentize-methods +@vindex gnus-agent-auto-agentize-methods +If you have never used the Agent before (or more technically, if +@file{~/News/agent/lib/servers} does not exist), Gnus will +automatically agentize a few servers for you. This variable control +which backends should be auto-agentized. It is typically only useful +to agentize remote backends. The auto-agentizing has the same effect +as running @kbd{J a} on the servers (@pxref{Server Agent Commands}). +If the file exist, you must manage the servers manually by adding or +removing them, this variable is only applicable the first time you +start Gnus. The default is @samp{(nntp nnimap)}. + @end table @@ -15102,22 +18517,23 @@ If you don't want to read this manual, and you have a fairly standard setup, you may be able to use something like the following as your -@file{.gnus.el} file to get started. - -@lisp -;;; Define how Gnus is to fetch news. We do this over @sc{nntp} -;;; from your ISP's server. +@file{~/.gnus.el} file to get started. + +@lisp +;;; @r{Define how Gnus is to fetch news. We do this over @acronym{NNTP}} +;;; @r{from your ISP's server.} (setq gnus-select-method '(nntp "news.your-isp.com")) -;;; Define how Gnus is to read your mail. We read mail from -;;; your ISP's POP server. +;;; @r{Define how Gnus is to read your mail. We read mail from} +;;; @r{your ISP's @acronym{POP} server.} (setq mail-sources '((pop :server "pop.your-isp.com"))) -;;; Say how Gnus is to store the mail. We use nnml groups. +;;; @r{Say how Gnus is to store the mail. We use nnml groups.} (setq gnus-secondary-select-methods '((nnml ""))) -;;; Make Gnus into an offline newsreader. -(gnus-agentize) +;;; @r{Make Gnus into an offline newsreader.} +;;; (gnus-agentize) ; @r{The obsolete setting.} +;;; (setq gnus-agent t) ; @r{Now the default.} @end lisp That should be it, basically. Put that in your @file{~/.gnus.el} file, @@ -15127,7 +18543,7 @@ If this is the first time you've run Gnus, you will be subscribed automatically to a few default newsgroups. You'll probably want to subscribe to more groups, and to do that, you have to query the -@sc{nntp} server for a complete list of groups with the @kbd{A A} +@acronym{NNTP} server for a complete list of groups with the @kbd{A A} command. This usually takes quite a while, but you only have to do it once. @@ -15144,14 +18560,18 @@ @node Batching Agents @subsection Batching Agents +@findex gnus-agent-batch Having the Gnus Agent fetch articles (and post whatever messages you've written) is quite easy once you've gotten things set up properly. The following shell script will do everything that is necessary: +You can run a complete batch command from the command line with the +following incantation: + @example #!/bin/sh -emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null +emacs -batch -l ~/.emacs -f -l ~/.gnus.el gnus-agent-batch >/dev/null 2>&1 @end example @@ -15163,20 +18583,22 @@ may ask: @table @dfn -@item If I read an article while plugged, do they get entered into the -Agent? - -@strong{No.} - -@item If I read an article while plugged, and the article already exists -in the Agent, will it get downloaded once more? - -@strong{Yes.} +@item If I read an article while plugged, do they get entered into the Agent? + +@strong{No}. If you want this behaviour, add +@code{gnus-agent-fetch-selected-article} to +@code{gnus-select-article-hook}. + +@item If I read an article while plugged, and the article already exists in +the Agent, will it get downloaded once more? + +@strong{No}, unless @code{gnus-agent-cache} is @code{nil}. @end table In short, when Gnus is unplugged, it only looks into the locally stored -articles; when it's plugged, it only talks to your ISP. +articles; when it's plugged, it talks to your ISP and may also use the +locally stored articles. @node Scoring @@ -15207,22 +18629,23 @@ silently to help keep the sizes of the score files down. @menu -* Summary Score Commands:: Adding score entries for the current group. -* Group Score Commands:: General score commands. -* Score Variables:: Customize your scoring. (My, what terminology). -* Score File Format:: What a score file may contain. -* Score File Editing:: You can edit score files by hand as well. -* Adaptive Scoring:: Big Sister Gnus knows what you read. -* Home Score File:: How to say where new score entries are to go. -* Followups To Yourself:: Having Gnus notice when people answer you. -* Scoring Tips:: How to score effectively. -* Reverse Scoring:: That problem child of old is not problem. -* Global Score Files:: Earth-spanning, ear-splitting score files. -* Kill Files:: They are still here, but they can be ignored. -* Converting Kill Files:: Translating kill files to score files. -* GroupLens:: Getting predictions on what you like to read. -* Advanced Scoring:: Using logical expressions to build score rules. -* Score Decays:: It can be useful to let scores wither away. +* Summary Score Commands:: Adding score entries for the current group. +* Group Score Commands:: General score commands. +* Score Variables:: Customize your scoring. (My, what terminology). +* Score File Format:: What a score file may contain. +* Score File Editing:: You can edit score files by hand as well. +* Adaptive Scoring:: Big Sister Gnus knows what you read. +* Home Score File:: How to say where new score entries are to go. +* Followups To Yourself:: Having Gnus notice when people answer you. +* Scoring On Other Headers:: Scoring on non-standard headers. +* Scoring Tips:: How to score effectively. +* Reverse Scoring:: That problem child of old is not problem. +* Global Score Files:: Earth-spanning, ear-splitting score files. +* Kill Files:: They are still here, but they can be ignored. +* Converting Kill Files:: Translating kill files to score files. +* GroupLens:: Getting predictions on what you like to read. +* Advanced Scoring:: Using logical expressions to build score rules. +* Score Decays:: It can be useful to let scores wither away. @end menu @@ -15246,24 +18669,32 @@ @table @kbd @item V s -@kindex V s @r{(Summary)} +@kindex V s (Summary) @findex gnus-summary-set-score Set the score of the current article (@code{gnus-summary-set-score}). @item V S -@kindex V S @r{(Summary)} +@kindex V S (Summary) @findex gnus-summary-current-score Display the score of the current article (@code{gnus-summary-current-score}). @item V t -@kindex V t @r{(Summary)} +@kindex V t (Summary) @findex gnus-score-find-trace Display all score rules that have been used on the current article -(@code{gnus-score-find-trace}). +(@code{gnus-score-find-trace}). In the @code{*Score Trace*} buffer, you +may type @kbd{e} to edit score file corresponding to the score rule on +current line and @kbd{f} to format (@code{gnus-score-pretty-print}) the +score file and edit it. + +@item V w +@kindex V w (Summary) +@findex gnus-score-find-favourite-words +List words used in scoring (@code{gnus-score-find-favourite-words}). @item V R -@kindex V R @r{(Summary)} +@kindex V R (Summary) @findex gnus-summary-rescore Run the current summary through the scoring process (@code{gnus-summary-rescore}). This might be useful if you're playing @@ -15271,32 +18702,32 @@ effect you're having. @item V c -@kindex V c @r{(Summary)} +@kindex V c (Summary) @findex gnus-score-change-score-file Make a different score file the current (@code{gnus-score-change-score-file}). @item V e -@kindex V e @r{(Summary)} +@kindex V e (Summary) @findex gnus-score-edit-current-scores Edit the current score file (@code{gnus-score-edit-current-scores}). You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score File Editing}). @item V f -@kindex V f @r{(Summary)} +@kindex V f (Summary) @findex gnus-score-edit-file Edit a score file and make this score file the current one (@code{gnus-score-edit-file}). @item V F -@kindex V F @r{(Summary)} +@kindex V F (Summary) @findex gnus-score-flush-cache Flush the score cache (@code{gnus-score-flush-cache}). This is useful after editing score files. @item V C -@kindex V C @r{(Summary)} +@kindex V C (Summary) @findex gnus-score-customize Customize a score file in a visually pleasing manner (@code{gnus-score-customize}). @@ -15308,13 +18739,13 @@ @table @kbd @item V m -@kindex V m @r{(Summary)} +@kindex V m (Summary) @findex gnus-score-set-mark-below Prompt for a score, and mark all articles with a score below this as read (@code{gnus-score-set-mark-below}). @item V x -@kindex V x @r{(Summary)} +@kindex V x (Summary) @findex gnus-score-set-expunge-below Prompt for a score, and add a score rule to the current score file to expunge all articles below this score @@ -15358,9 +18789,14 @@ @item i Score on the @code{Message-ID} header. +@item e +Score on an ``extra'' header, that is, one of those in gnus-extra-headers, +if your @acronym{NNTP} server tracks additional header data in overviews. + @item f Score on followups---this matches the author name, and adds scores to -the followups to this author. +the followups to this author. (Using this key leads to the creation of +@file{ADAPT} files.) @item b Score on the body. @@ -15369,7 +18805,8 @@ Score on the head. @item t -Score on thread. +Score on thread. (Using this key leads to the creation of @file{ADAPT} +files.) @end table @@ -15424,9 +18861,10 @@ @end table @item -The fourth and final key says whether this is a temporary (i.e., expiring) -score entry, or a permanent (i.e., non-expiring) score entry, or whether -it is to be done immediately, without adding to the score file. +The fourth and usually final key says whether this is a temporary (i.e., +expiring) score entry, or a permanent (i.e., non-expiring) score entry, +or whether it is to be done immediately, without adding to the score +file. @table @kbd @item t @@ -15439,6 +18877,11 @@ Immediately scoring. @end table +@item +If you are scoring on `e' (extra) headers, you will then be prompted for +the header name on which you wish to score. This must be a header named +in gnus-extra-headers, and @samp{TAB} completion is available. + @end enumerate So, let's say you want to increase the score on the current author with @@ -15472,7 +18915,7 @@ @table @kbd @item W f -@kindex W f @r{(Group)} +@kindex W f (Group) @findex gnus-score-flush-cache Gnus maintains a cache of score alists to avoid having to reload them all the time. This command will flush the cache @@ -15512,20 +18955,21 @@ @item gnus-kill-files-directory @vindex gnus-kill-files-directory All kill and score files will be stored in this directory, which is -initialized from the @code{SAVEDIR} environment variable by default. +initialized from the @env{SAVEDIR} environment variable by default. This is @file{~/News/} by default. @item gnus-score-file-suffix @vindex gnus-score-file-suffix Suffix to add to the group name to arrive at the score file name -(@samp{SCORE} by default.) +(@file{SCORE} by default.) @item gnus-score-uncacheable-files @vindex gnus-score-uncacheable-files @cindex score cache All score files are normally cached to avoid excessive re-loading of score files. However, if this might make your Emacs grow big and -bloated, so this regexp can be used to weed out score files unlikely to be needed again. It would be a bad idea to deny caching of +bloated, so this regexp can be used to weed out score files unlikely +to be needed again. It would be a bad idea to deny caching of @file{all.SCORE}, while it might be a good idea to not cache @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this variable is @samp{ADAPT$} by default, so no adaptive score files will @@ -15607,13 +19051,14 @@ server. @end table -This variable can also be a list of functions. In that case, all these -functions will be called with the group name as argument, and all the -returned lists of score files will be applied. These functions can also -return lists of score alists directly. In that case, the functions that -return these non-file score alists should probably be placed before the -``real'' score file functions, to ensure that the last score file -returned is the local score file. Phu. +This variable can also be a list of functions. In that case, all +these functions will be called with the group name as argument, and +all the returned lists of score files will be applied. These +functions can also return lists of lists of score alists directly. In +that case, the functions that return these non-file score alists +should probably be placed before the ``real'' score file functions, to +ensure that the last score file returned is the local score file. +Phu. For example, to do hierarchical scoring but use a non-server-specific overall score file, you could use the value @@ -15630,12 +19075,12 @@ @item gnus-update-score-entry-dates @vindex gnus-update-score-entry-dates -If this variable is non-@code{nil}, matching score entries will have -their dates updated. (This is how Gnus controls expiry---all -non-matching entries will become too old while matching entries will -stay fresh and young.) However, if you set this variable to @code{nil}, -even matching entries will grow old and will have to face that oh-so -grim reaper. +If this variable is non-@code{nil}, temporary score entries that have +been triggered (matched) will have their dates updated. (This is how Gnus +controls expiry---all non-matched-entries will become too old while +matched entries will stay fresh and young.) However, if you set this +variable to @code{nil}, even matched entries will grow old and will +have to face that oh-so grim reaper. @item gnus-score-after-write-file-function @vindex gnus-score-after-write-file-function @@ -15643,10 +19088,10 @@ @item gnus-score-thread-simplify @vindex gnus-score-thread-simplify -If this variable is non-@code{nil}, article subjects will be simplified -for subject scoring purposes in the same manner as with +If this variable is non-@code{nil}, article subjects will be +simplified for subject scoring purposes in the same manner as with threading---according to the current value of -gnus-simplify-subject-functions. If the scoring entry uses +@code{gnus-simplify-subject-functions}. If the scoring entry uses @code{substring} or @code{exact} matching, the match will also be simplified in this manner. @@ -15687,11 +19132,11 @@ (eval (ding))) @end lisp -This example demonstrates most score file elements. For a different -approach, see @pxref{Advanced Scoring}. - -Even though this looks much like lisp code, nothing here is actually -@code{eval}ed. The lisp reader is used to read this form, though, so it +This example demonstrates most score file elements. @xref{Advanced +Scoring}, for a different approach. + +Even though this looks much like Lisp code, nothing here is actually +@code{eval}ed. The Lisp reader is used to read this form, though, so it has to be valid syntactically, if not semantically. Six keys are supported by this alist: @@ -15713,7 +19158,7 @@ entries will result in new score entries being added for all follow-ups to articles that matches these score entries. -Following this key is a arbitrary number of score entries, where each +Following this key is an arbitrary number of score entries, where each score entry has one to four elements. @enumerate @@ -15755,6 +19200,20 @@ @code{string}, @code{exact}, and @code{word} types, which you can use instead, if you feel like. +@item Extra +Just as for the standard string overview headers, if you are using +gnus-extra-headers, you can score on these headers' values. In this +case, there is a 5th element in the score entry, being the name of the +header to be scored. The following entry is useful in your +@file{all.SCORE} file in case of spam attacks from a single origin +host, if your @acronym{NNTP} server tracks @samp{NNTP-Posting-Host} in +overviews: + +@lisp +("111.222.333.444" -1000 nil s + "NNTP-Posting-Host") +@end lisp + @item Lines, Chars These two headers use different match types: @code{<}, @code{>}, @code{=}, @code{>=} and @code{<=}. @@ -15833,7 +19292,7 @@ @end table @end enumerate -@cindex Score File Atoms +@cindex score file atoms @item mark The value of this entry should be a number. Any articles with a score lower than this number will be marked as read. @@ -15892,9 +19351,9 @@ rest. Next time you enter the group, you will see new articles in the interesting threads, plus any new threads. -I.e.---the orphan score atom is for high-volume groups where there -exist a few interesting threads which can't be found automatically by -ordinary scoring rules. +I.e.---the orphan score atom is for high-volume groups where a few +interesting threads which can't be found automatically by ordinary +scoring rules exist. @item adapt This entry controls the adaptive scoring. If it is @code{t}, the @@ -15918,11 +19377,12 @@ @item local @cindex local variables -The value of this entry should be a list of @code{(VAR VALUE)} pairs. -Each @var{var} will be made buffer-local to the current summary buffer, -and set to the value specified. This is a convenient, if somewhat -strange, way of setting variables in some groups if you don't like hooks -much. Note that the @var{value} won't be evaluated. +The value of this entry should be a list of @code{(@var{var} +@var{value})} pairs. Each @var{var} will be made buffer-local to the +current summary buffer, and set to the value specified. This is a +convenient, if somewhat strange, way of setting variables in some +groups if you don't like hooks much. Note that the @var{value} won't +be evaluated. @end table @@ -15966,8 +19426,8 @@ @vindex gnus-score-mode-hook @code{gnus-score-menu-hook} is run in score mode buffers. -In the summary buffer you can use commands like @kbd{V f} and @kbd{V -e} to begin editing score files. +In the summary buffer you can use commands like @kbd{V f}, @kbd{V e} and +@kbd{V t} to begin editing score files. @node Adaptive Scoring @@ -16020,7 +19480,7 @@ will be applied to each article. To take @code{gnus-del-mark} as an example---this alist says that all -articles that have that mark (i.e., are marked with @samp{D}) will have a +articles that have that mark (i.e., are marked with @samp{e}) will have a score entry added to lower based on the @code{From} header by -4, and lowered by @code{Subject} by -1. Change this to fit your prejudices. @@ -16041,13 +19501,6 @@ on the @code{References} header using the @code{Message-ID} of the current article, thereby matching the following thread. -You can also score on @code{thread}, which will try to score all -articles that appear in a thread. @code{thread} matches uses a -@code{Message-ID} to match on the @code{References} header of the -article. If the match is made, the @code{Message-ID} of the article is -added to the @code{thread} rule. (Think about it. I'd recommend two -aspirins afterwards.) - If you use this scheme, you should set the score file atom @code{mark} to something small---like -300, perhaps, to avoid having small random changes result in articles getting marked as read. @@ -16063,7 +19516,7 @@ @vindex gnus-adaptive-file-suffix The adaptive score entries will be put into a file where the name is the group name with @code{gnus-adaptive-file-suffix} appended. The default -is @samp{ADAPT}. +is @file{ADAPT}. @vindex gnus-score-exact-adapt-limit When doing adaptive scoring, substring or fuzzy matching would probably @@ -16088,7 +19541,7 @@ (,gnus-del-mark . -15))) @end lisp -This is the default value. If you adapt on words, every +This is the default value. If you have adaption on words enabled, every word that appears in subjects of articles marked with @code{gnus-read-mark} will result in a score rule that increase the score with 30 points. @@ -16099,6 +19552,12 @@ will be ignored. If you wish to add more words to be ignored, use the @code{gnus-ignored-adaptive-words} list instead. +@vindex gnus-adaptive-word-length-limit +Some may feel that short words shouldn't count when doing adaptive +scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to +an integer. Words shorter than this number will be ignored. This +variable defaults to @code{nil}. + @vindex gnus-adaptive-word-syntax-table When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the syntax table in effect. It is similar to the standard syntax table, but @@ -16160,8 +19619,8 @@ group name, the @var{file-name} will be used as the home score file. @item -A function. If the function returns non-nil, the result will be used as -the home score file. +A function. If the function returns non-@code{nil}, the result will +be used as the home score file. @item A string. Use the string as the home score file. @@ -16205,9 +19664,9 @@ @lisp (setq gnus-home-score-file - ;; All groups that match the regexp "\\.emacs" + ;; @r{All groups that match the regexp @code{"\\.emacs"}} '(("\\.emacs" "emacs.SCORE") - ;; All the comp groups in one score file + ;; @r{All the comp groups in one score file} ("^comp" "comp.SCORE"))) @end lisp @@ -16278,6 +19737,39 @@ is system-dependent. +@node Scoring On Other Headers +@section Scoring On Other Headers +@cindex scoring on other headers + +Gnus is quite fast when scoring the ``traditional'' +headers---@samp{From}, @samp{Subject} and so on. However, scoring +other headers requires writing a @code{head} scoring rule, which means +that Gnus has to request every single article from the back end to find +matches. This takes a long time in big groups. + +Now, there's not much you can do about this for news groups, but for +mail groups, you have greater control. In @ref{To From Newsgroups}, +it's explained in greater detail what this mechanism does, but here's +a cookbook example for @code{nnml} on how to allow scoring on the +@samp{To} and @samp{Cc} headers. + +Put the following in your @file{~/.gnus.el} file. + +@lisp +(setq gnus-extra-headers '(To Cc Newsgroups Keywords) + nnmail-extra-headers gnus-extra-headers) +@end lisp + +Restart Gnus and rebuild your @code{nnml} overview files with the +@kbd{M-x nnml-generate-nov-databases} command. This will take a long +time if you have much mail. + +Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like +so: @kbd{I e s p To RET RET}. + +See? Simple. + + @node Scoring Tips @section Scoring Tips @cindex scoring tips @@ -16417,7 +19909,7 @@ old articles for a long time. @end itemize -... I wonder whether other newsreaders will support global score files +@dots{} I wonder whether other newsreaders will support global score files in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue Wave, xrn and 1stReader are bound to implement scoring. Should we start holding our breath yet? @@ -16455,17 +19947,17 @@ encounters what looks like a @code{rn} kill file, it will take a stab at interpreting it. -Two summary functions for editing a GNUS kill file: +Two summary functions for editing a @sc{gnus} kill file: @table @kbd @item M-k -@kindex M-k @r{(Summary)} +@kindex M-k (Summary) @findex gnus-summary-edit-local-kill Edit this group's kill file (@code{gnus-summary-edit-local-kill}). @item M-K -@kindex M-K @r{(Summary)} +@kindex M-K (Summary) @findex gnus-summary-edit-global-kill Edit the general kill file (@code{gnus-summary-edit-global-kill}). @end table @@ -16475,12 +19967,12 @@ @table @kbd @item M-k -@kindex M-k @r{(Group)} +@kindex M-k (Group) @findex gnus-group-edit-local-kill Edit this group's kill file (@code{gnus-group-edit-local-kill}). @item M-K -@kindex M-K @r{(Group)} +@kindex M-K (Group) @findex gnus-group-edit-global-kill Edit the general kill file (@code{gnus-group-edit-global-kill}). @end table @@ -16543,9 +20035,13 @@ @section GroupLens @cindex GroupLens -GroupLens is a collaborative filtering system that helps you work -together with other people to find the quality news articles out of the -huge volume of news articles generated every day. +@sc{Note:} Unfortunately the GroupLens system seems to have shut down, +so this section is mostly of historical interest. + +@uref{http://www.cs.umn.edu/Research/GroupLens/, GroupLens} is a +collaborative filtering system that helps you work together with other +people to find the quality news articles out of the huge volume of +news articles generated every day. To accomplish this the GroupLens system combines your opinions about articles you have already read with the opinions of others who have done @@ -16558,20 +20054,19 @@ article. @menu -* Using GroupLens:: How to make Gnus use GroupLens. -* Rating Articles:: Letting GroupLens know how you rate articles. -* Displaying Predictions:: Displaying predictions given by GroupLens. -* GroupLens Variables:: Customizing GroupLens. +* Using GroupLens:: How to make Gnus use GroupLens. +* Rating Articles:: Letting GroupLens know how you rate articles. +* Displaying Predictions:: Displaying predictions given by GroupLens. +* GroupLens Variables:: Customizing GroupLens. @end menu @node Using GroupLens @subsection Using GroupLens -To use GroupLens you must register a pseudonym with your local Better -Bit Bureau (BBB). -@uref{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only -better bit in town at the moment. +To use GroupLens you must register a pseudonym with your local +@uref{http://www.cs.umn.edu/Research/GroupLens/bbb.html, Better Bit +Bureau (BBB)} is the only better bit in town at the moment. Once you have registered you'll need to set a couple of variables. @@ -16607,8 +20102,8 @@ In GroupLens, an article is rated on a scale from 1 to 5, inclusive. Where 1 means something like this article is a waste of bandwidth and 5 means that the article was really good. The basic question to ask -yourself is, "on a scale from 1 to 5 would I like to see more articles -like this one?" +yourself is, ``on a scale from 1 to 5 would I like to see more articles +like this one?'' There are four ways to enter a rating for an article in GroupLens. @@ -16661,7 +20156,7 @@ @vindex gnus-grouplens-override-scoring There are three ways to display predictions in grouplens. You may choose to have the GroupLens scores contribute to, or override the -regular gnus scoring mechanism. override is the default; however, some +regular Gnus scoring mechanism. override is the default; however, some people prefer to see the Gnus scores plus the grouplens scores. To get the separate scoring behavior you need to set @code{gnus-grouplens-override-scoring} to @code{'separate}. To have the @@ -16713,7 +20208,7 @@ @item gnus-summary-grouplens-line-format The summary line format used in GroupLens-enhanced summary buffers. It accepts the same specs as the normal summary line format (@pxref{Summary -Buffer Lines}). The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%) +Buffer Lines}). The default is @samp{%U%R%z%l%I%(%[%4L: %-23,23n%]%) %s\n}. @item grouplens-bbb-host @@ -16807,14 +20302,20 @@ @node Advanced Scoring Examples @subsection Advanced Scoring Examples +Please note that the following examples are score file rules. To +make a complete score file from them, surround them with another pair +of parentheses. + Let's say you want to increase the score of articles written by Lars when he's talking about Gnus: @example +@group ((& ("from" "Lars Ingebrigtsen") ("subject" "Gnus")) 1000) +@end group @end example Quite simple, huh? @@ -16924,16 +20425,21 @@ @lisp (defun gnus-decay-score (score) - "Decay SCORE. -This is done according to `gnus-score-decay-constant' + "Decay SCORE according to `gnus-score-decay-constant' and `gnus-score-decay-scale'." - (floor - (- score - (* (if (< score 0) 1 -1) - (min (abs score) - (max gnus-score-decay-constant - (* (abs score) - gnus-score-decay-scale))))))) + (let ((n (- score + (* (if (< score 0) -1 1) + (min (abs score) + (max gnus-score-decay-constant + (* (abs score) + gnus-score-decay-scale))))))) + (if (and (featurep 'xemacs) + ;; XEmacs' floor can handle only the floating point + ;; number below the half of the maximum integer. + (> (abs n) (lsh -1 -2))) + (string-to-number + (car (split-string (number-to-string n) "\\."))) + (floor n)))) @end lisp @vindex gnus-score-decay-scale @@ -16960,31 +20466,43 @@ Gnus will try to decay scores once a day. If you haven't run Gnus for four days, Gnus will decay the scores four times, for instance. +@iftex +@iflatex +@chapter Message +@include message.texi +@chapter Emacs MIME +@include emacs-mime.texi +@chapter Sieve +@include sieve.texi +@chapter PGG +@include pgg.texi +@end iflatex +@end iftex @node Various @chapter Various @menu -* Process/Prefix:: A convention used by many treatment commands. -* Interactive:: Making Gnus ask you many questions. -* Symbolic Prefixes:: How to supply some Gnus functions with options. -* Formatting Variables:: You can specify what buffers should look like. -* Windows Configuration:: Configuring the Gnus buffer windows. -* Faces and Fonts:: How to change how faces look. -* Compilation:: How to speed Gnus up. -* Mode Lines:: Displaying information in the mode lines. -* Highlighting and Menus:: Making buffers look all nice and cozy. -* Buttons:: Get tendinitis in ten easy steps! -* Daemons:: Gnus can do things behind your back. -* NoCeM:: How to avoid spam and other fatty foods. -* Undo:: Some actions can be undone. -* Moderation:: What to do if you're a moderator. -* Emacs Enhancements:: There can be more pictures and stuff under - Emacs 21. -* XEmacs Enhancements:: There are more pictures and stuff under XEmacs. -* Fuzzy Matching:: What's the big fuzz? -* Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email. -* Various Various:: Things that are really various. +* Process/Prefix:: A convention used by many treatment commands. +* Interactive:: Making Gnus ask you many questions. +* Symbolic Prefixes:: How to supply some Gnus functions with options. +* Formatting Variables:: You can specify what buffers should look like. +* Window Layout:: Configuring the Gnus buffer windows. +* Faces and Fonts:: How to change how faces look. +* Compilation:: How to speed Gnus up. +* Mode Lines:: Displaying information in the mode lines. +* Highlighting and Menus:: Making buffers look all nice and cozy. +* Buttons:: Get tendinitis in ten easy steps! +* Daemons:: Gnus can do things behind your back. +* NoCeM:: How to avoid spam and other fatty foods. +* Undo:: Some actions can be undone. +* Predicate Specifiers:: Specifying predicates. +* Moderation:: What to do if you're a moderator. +* Image Enhancements:: Modern versions of Emacs/XEmacs can display images. +* Fuzzy Matching:: What's the big fuzz? +* Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email. +* Other modes:: Interaction with other modes. +* Various Various:: Things that are really various. @end menu @@ -17089,7 +20607,7 @@ file, and you want Emacs to flash lights and play a nice tune at the same time? You can't, and you're probably perfectly happy that way. -@kindex M-i @r{(Summary)} +@kindex M-i (Summary) @findex gnus-symbolic-argument I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next @@ -17123,11 +20641,14 @@ lots of percentages everywhere. @menu -* Formatting Basics:: A formatting variable is basically a format string. -* Mode Line Formatting:: Some rules about mode line formatting variables. -* Advanced Formatting:: Modifying output in various ways. -* User-Defined Specs:: Having Gnus call your own functions. -* Formatting Fonts:: Making the formatting look colorful and nice. +* Formatting Basics:: A formatting variable is basically a format string. +* Mode Line Formatting:: Some rules about mode line formatting variables. +* Advanced Formatting:: Modifying output in various ways. +* User-Defined Specs:: Having Gnus call your own functions. +* Formatting Fonts:: Making the formatting look colorful and nice. +* Positioning Point:: Moving point to a position after an operation. +* Tabulation:: Tabulating your output. +* Wide Characters:: Dealing with wide characters. @end menu Currently Gnus uses the following formatting variables: @@ -17147,7 +20668,7 @@ Gnus includes a command to help you while creating your own format specs. @kbd{M-x gnus-update-format} will @code{eval} the current form, update the spec in question and pop you to a buffer where you can -examine the resulting lisp code to be run to generate the line. +examine the resulting Lisp code to be run to generate the line. @@ -17170,6 +20691,9 @@ means that the field will never be more than 6 characters wide and never less than 4 characters wide. +Also Gnus supports some extended format specifications, such as +@samp{%&user-date;}. + @node Mode Line Formatting @subsection Mode Line Formatting @@ -17237,6 +20761,13 @@ @item form Use the specified form as the field value when the @samp{@@} spec is used. + +Here's an example: + +@lisp +"~(form (current-time-string))@@" +@end lisp + @end table Let's take an example. The @samp{%o} spec in the summary mode lines @@ -17269,6 +20800,9 @@ specifier. This function may also be called with dummy values, so it should protect against that. +Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}. +Gnus will call the function @code{gnus-user-format-function-}@samp{foo}. + You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve much the same without defining new functions. Here's an example: @samp{%~(form (count-lines (point-min) (point)))@@}. The form @@ -17292,31 +20826,35 @@ @code{mouse-face} specs---you can say @samp{%3(hello%)} to have @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}. -Text inside the @samp{%<} and @samp{%>} specifiers will get the special -@code{balloon-help} property set to @code{gnus-balloon-face-0}. If you -say @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on. The -@code{gnus-balloon-face-*} variables should be either strings or symbols -naming functions that return a string. Under @code{balloon-help-mode}, -when the mouse passes over text with this property set, a balloon window -will appear and display the string. Please refer to the doc string of -@code{balloon-help-mode} for more information on this. +Text inside the @samp{%<<} and @samp{%>>} specifiers will get the +special @code{balloon-help} property set to +@code{gnus-balloon-face-0}. If you say @samp{%1<<}, you'll get +@code{gnus-balloon-face-1} and so on. The @code{gnus-balloon-face-*} +variables should be either strings or symbols naming functions that +return a string. When the mouse passes over text with this property +set, a balloon window will appear and display the string. Please +refer to @ref{Tooltips, ,Tooltips, emacs, The Emacs Manual}, +(in GNU Emacs) or the doc string of @code{balloon-help-mode} (in +XEmacs) for more information on this. (For technical reasons, the +guillemets have been approximated as @samp{<<} and @samp{>>} in this +paragraph.) Here's an alternative recipe for the group buffer: @lisp -;; Create three face types. +;; @r{Create three face types.} (setq gnus-face-1 'bold) (setq gnus-face-3 'italic) -;; We want the article count to be in -;; a bold and green face. So we create -;; a new face called `my-green-bold'. +;; @r{We want the article count to be in} +;; @r{a bold and green face. So we create} +;; @r{a new face called @code{my-green-bold}.} (copy-face 'bold 'my-green-bold) -;; Set the color. +;; @r{Set the color.} (set-face-foreground 'my-green-bold "ForestGreen") (setq gnus-face-2 'my-green-bold) -;; Set the new & fancy format. +;; @r{Set the new & fancy format.} (setq gnus-group-line-format "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n") @end lisp @@ -17327,10 +20865,66 @@ Note that the @samp{%(} specs (and friends) do not make any sense on the mode-line variables. - -@node Windows Configuration -@section Windows Configuration -@cindex windows configuration +@node Positioning Point +@subsection Positioning Point + +Gnus usually moves point to a pre-defined place on each line in most +buffers. By default, point move to the first colon character on the +line. You can customize this behaviour in three different ways. + +You can move the colon character to somewhere else on the line. + +@findex gnus-goto-colon +You can redefine the function that moves the point to the colon. The +function is called @code{gnus-goto-colon}. + +But perhaps the most convenient way to deal with this, if you don't want +to have a colon in your line, is to use the @samp{%*} specifier. If you +put a @samp{%*} somewhere in your format line definition, Gnus will +place point there. + + +@node Tabulation +@subsection Tabulation + +You can usually line up your displays by padding and cutting your +strings. However, when combining various strings of different size, it +can often be more convenient to just output the strings, and then worry +about lining up the following text afterwards. + +To do that, Gnus supplies tabulator specs---@samp{%=}. There are two +different types---@dfn{hard tabulators} and @dfn{soft tabulators}. + +@samp{%50=} will insert space characters to pad the line up to column +50. If the text is already past column 50, nothing will be inserted. +This is the soft tabulator. + +@samp{%-50=} will insert space characters to pad the line up to column +50. If the text is already past column 50, the excess text past column +50 will be removed. This is the hard tabulator. + + +@node Wide Characters +@subsection Wide Characters + +Fixed width fonts in most countries have characters of the same width. +Some countries, however, use Latin characters mixed with wider +characters---most notable East Asian countries. + +The problem is that when formatting, Gnus assumes that if a string is 10 +characters wide, it'll be 10 Latin characters wide on the screen. In +these countries, that's not true. + +@vindex gnus-use-correct-string-widths +To help fix this, you can set @code{gnus-use-correct-string-widths} to +@code{t}. This makes buffer generation slower, but the results will be +prettier. The default value under XEmacs is @code{t} but @code{nil} +for Emacs. + + +@node Window Layout +@section Window Layout +@cindex window layout No, there's nothing here about X, so be quiet. @@ -17431,6 +21025,7 @@ may look like: @example +@group split = frame | horizontal | vertical | buffer | form frame = "(frame " size *split ")" horizontal = "(horizontal " size *split ")" @@ -17438,6 +21033,7 @@ buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")" size = number | frame-params buf-name = group | article | summary ... +@end group @end example The limitations are that the @code{frame} split can only appear as the @@ -17525,7 +21121,7 @@ (vertical 0.24 (if (buffer-live-p gnus-summary-buffer) '(summary 0.5)) - (group 1.0))))) + (group 1.0)))) @end lisp One common desire for a multiple frame split is to have a separate frame @@ -17558,7 +21154,7 @@ @end lisp You'd typically stick these @code{gnus-add-configuration} calls in your -@file{.gnus.el} file or in some startup hook---they should be run after +@file{~/.gnus.el} file or in some startup hook---they should be run after Gnus has been loaded. @vindex gnus-always-force-window-configuration @@ -17643,7 +21239,7 @@ you'll get top speed again. Gnus will save these compiled specs in the @file{.newsrc.eld} file. (User-defined functions aren't compiled by this function, though---you should compile them yourself by sticking -them into the @code{.gnus.el} file and byte-compiling that file.) +them into the @file{~/.gnus.el} file and byte-compiling that file.) @node Mode Lines @@ -17791,7 +21387,7 @@ @cindex mouse @cindex click -Those new-fangled @dfn{mouse} contraptions are very popular with the +Those new-fangled @dfn{mouse} contraptions is very popular with the young, hep kids who don't want to learn the proper way to do things these days. Why, I remember way back in the summer of '89, when I was using Emacs on a Tops 20 system. Three hundred users on one single @@ -17800,7 +21396,7 @@ Right. @vindex gnus-carpal -Well, you can make Gnus display buffers full of buttons you can click to +Well, you can make Gnus display bufferfuls of buttons you can click to do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple, really. Tell the chiropractor I sent you. @@ -17863,14 +21459,14 @@ (gnus-demon-close-connections nil 30) @end lisp -Here's a handler that scans for PGP headers every hour when Emacs is -idle: +Here's a handler that scans for @acronym{PGP} headers every hour when +Emacs is idle: @lisp (gnus-demon-scan-pgp 60 t) @end lisp -This @var{time} parameter and than @var{idle} parameter work together +This @var{time} parameter and that @var{idle} parameter work together in a strange, but wonderful fashion. Basically, if @var{idle} is @code{nil}, then the function will be called every @var{time} minutes. @@ -17897,7 +21493,7 @@ all the timings in the handlers will be affected.) So, if you want to add a handler, you could put something like this in -your @file{.gnus} file: +your @file{~/.gnus.el} file: @findex gnus-demon-add-handler @lisp @@ -17914,7 +21510,7 @@ @code{gnus-demon-add-nntp-close-connection}, @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and @code{gnus-demon-add-scanmail}. Just put those functions in your -@file{.gnus} if you want those abilities. +@file{~/.gnus.el} if you want those abilities. @findex gnus-demon-init @findex gnus-demon-cancel @@ -17962,17 +21558,23 @@ @item gnus-nocem-groups @vindex gnus-nocem-groups Gnus will look for NoCeM messages in the groups in this list. The -default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins" -"alt.nocem.misc" "news.admin.net-abuse.announce")}. +default is +@lisp +("news.lists.filters" "news.admin.net-abuse.bulletins" + "alt.nocem.misc" "news.admin.net-abuse.announce") +@end lisp @item gnus-nocem-issuers @vindex gnus-nocem-issuers There are many people issuing NoCeM messages. This list says what -people you want to listen to. The default is @code{("Automoose-1" -"clewis@@ferret.ocunix.on.ca" "cosmo.roadkill" "SpamHippo" -"hweede@@snafu.de")}; fine, upstanding citizens all of them. - -Known despammers that you can put in this list are listed at +people you want to listen to. The default is +@lisp +("Automoose-1" "clewis@@ferret.ocunix.on.ca" + "cosmo.roadkill" "SpamHippo" "hweede@@snafu.de") +@end lisp +fine, upstanding citizens all of them. + +Known despammers that you can put in this list are listed at@* @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}. You do not have to heed NoCeM messages from all these people---just the @@ -18029,7 +21631,7 @@ @item gnus-nocem-directory @vindex gnus-nocem-directory -This is where Gnus will store its NoCeM cache files. The default is +This is where Gnus will store its NoCeM cache files. The default is@* @file{~/News/NoCeM/}. @item gnus-nocem-expiry-wait @@ -18095,6 +21697,33 @@ command. +@node Predicate Specifiers +@section Predicate Specifiers +@cindex predicate specifiers + +Some Gnus variables are @dfn{predicate specifiers}. This is a special +form that allows flexible specification of predicates without having +to type all that much. + +These specifiers are lists consisting of functions, symbols and lists. + +Here's an example: + +@lisp +(or gnus-article-unseen-p + gnus-article-unread-p) +@end lisp + +The available symbols are @code{or}, @code{and} and @code{not}. The +functions all take one parameter. + +@findex gnus-make-predicate +Internally, Gnus calls @code{gnus-make-predicate} on these specifiers +to create a function that can be called. This input parameter to this +function will be passed along to all the functions in the predicate +specifier. + + @node Moderation @section Moderation @cindex moderation @@ -18111,7 +21740,7 @@ (add-hook 'gnus-summary-mode-hook 'gnus-moderate) @end lisp -in your @file{.gnus.el} file. +in your @file{~/.gnus.el} file. If you are the moderator of @samp{rec.zoofle}, this is how it's supposed to work: @@ -18139,49 +21768,204 @@ "^nnml:rec.zoofle$\\|^rec.zoofle$") @end lisp -@node Emacs Enhancements -@section Emacs Enhancements -@cindex Emacs 21 - -Starting with version 21, Emacs is able to display pictures and stuff, -so Gnus has taken advantage of that. - -Gnus-specific tool bars will be used if Tool Bar mode is on. Currently -the group, summary and message buffers have tool bars defined. - -MIME image types may be displayed internally if Emacs was built with -appropriate support (see variable @code{image-types}). `X-Face' headers -may be rendered as images internally if you have appropriate support -programs (@pxref{X-Face}). You can play sounds internally if Emacs was -built with suitable audio support; otherwise Gnus will attempt to play -sounds externally. - -@vindex gnus-treat-display-smileys -A simplified version of the XEmacs Smiley support for @dfn{emoticons} -(@pxref{Smileys}) is available on graphical displays under the control -of @code{gnus-treat-display-smileys}. Text `smiley' faces---@samp{:-)}, -@samp{:-/}, @samp{:-(} and the like---are mapped to pictures which are -displayed instead. The mapping is controlled by a list of regexps + +@node Image Enhancements +@section Image Enhancements + +XEmacs, as well as Emacs 21@footnote{Emacs 21 on MS Windows doesn't +support images yet.}, is able to display pictures and stuff, so Gnus has +taken advantage of that. + +@menu +* X-Face:: Display a funky, teensy black-and-white image. +* Face:: Display a funkier, teensier colored image. +* Smileys:: Show all those happy faces the way they were meant to be shown. +* Picons:: How to display pictures of what you're reading. +* XVarious:: Other XEmacsy Gnusey variables. +@end menu + + +@node X-Face +@subsection X-Face +@cindex x-face + +@code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit +depth) image that's supposed to represent the author of the message. +It seems to be supported by an ever-growing number of mail and news +readers. + +@cindex x-face +@findex gnus-article-display-x-face +@vindex gnus-article-x-face-command +@vindex gnus-article-x-face-too-ugly +@iftex +@iflatex +\include{xface} +@end iflatex +@end iftex +@c @anchor{X-Face} + +Decoding an @code{X-Face} header either requires an Emacs that has +@samp{compface} support (which most XEmacs versions has), or that you +have @samp{compface} installed on your system. If either is true, +Gnus will default to displaying @code{X-Face} headers. + +The variable that controls this is the +@code{gnus-article-x-face-command} variable. If this variable is a +string, this string will be executed in a sub-shell. If it is a +function, this function will be called with the face as the argument. +If the @code{gnus-article-x-face-too-ugly} (which is a regexp) matches +the @code{From} header, the face will not be shown. + +The default action under Emacs 20 is to fork off the @code{display} +program@footnote{@code{display} is from the ImageMagick package. For +the @code{uncompface} and @code{icontopbm} programs look for a package +like @code{compface} or @code{faces-xface} on a GNU/Linux system.} to +view the face. + +Under XEmacs or Emacs 21+ with suitable image support, the default +action is to display the face before the @code{From} header. (It's +nicer if XEmacs has been compiled with @code{X-Face} support---that +will make display somewhat faster. If there's no native @code{X-Face} +support, Gnus will try to convert the @code{X-Face} header using +external programs from the @code{pbmplus} package and +friends.@footnote{On a GNU/Linux system look for packages with names +like @code{netpbm}, @code{libgr-progs} and @code{compface}.}) + +(Note: @code{x-face} is used in the variable/function names, not +@code{xface}). + +Gnus provides a few convenience functions and variables to allow +easier insertion of X-Face headers in outgoing messages. + +@findex gnus-random-x-face +@vindex gnus-convert-pbm-to-x-face-command +@vindex gnus-x-face-directory +@code{gnus-random-x-face} goes through all the @samp{pbm} files in +@code{gnus-x-face-directory} and picks one at random, and then +converts it to the X-Face format by using the +@code{gnus-convert-pbm-to-x-face-command} shell command. The +@samp{pbm} files should be 48x48 pixels big. It returns the X-Face +header data as a string. + +@findex gnus-insert-random-x-face-header +@code{gnus-insert-random-x-face-header} calls +@code{gnus-random-x-face} and inserts a @samp{X-Face} header with the +randomly generated data. + +@findex gnus-x-face-from-file +@vindex gnus-convert-image-to-x-face-command +@code{gnus-x-face-from-file} takes a GIF file as the parameter, and then +converts the file to X-Face format by using the +@code{gnus-convert-image-to-x-face-command} shell command. + +Here's how you would typically use the first function. Put something +like the following in your @file{~/.gnus.el} file: + +@lisp +(setq message-required-news-headers + (nconc message-required-news-headers + (list '(X-Face . gnus-random-x-face)))) +@end lisp + +Using the last function would be something like this: + +@lisp +(setq message-required-news-headers + (nconc message-required-news-headers + (list '(X-Face . (lambda () + (gnus-x-face-from-file + "~/My-face.gif")))))) +@end lisp + + +@node Face +@subsection Face +@cindex face + +@c #### FIXME: faces and x-faces'implementations should really be harmonized. + +@code{Face} headers are essentially a funkier version of @code{X-Face} +ones. They describe a 48x48 pixel colored image that's supposed to +represent the author of the message. + +@cindex face +@findex gnus-article-display-face +The contents of a @code{Face} header must be a base64 encoded PNG image. +See @uref{http://quimby.gnus.org/circus/face/} for the precise +specifications. + +Gnus provides a few convenience functions and variables to allow +easier insertion of Face headers in outgoing messages. + +@findex gnus-convert-png-to-face +@code{gnus-convert-png-to-face} takes a 48x48 PNG image, no longer than +726 bytes long, and converts it to a face. + +@findex gnus-face-from-file +@vindex gnus-convert-image-to-face-command +@code{gnus-face-from-file} takes a JPEG file as the parameter, and then +converts the file to Face format by using the +@code{gnus-convert-image-to-face-command} shell command. + +Here's how you would typically use this function. Put something like the +following in your @file{~/.gnus.el} file: + +@lisp +(setq message-required-news-headers + (nconc message-required-news-headers + (list '(Face . (lambda () + (gnus-face-from-file "~/face.jpg")))))) +@end lisp + + +@node Smileys +@subsection Smileys +@cindex smileys + +@iftex +@iflatex +\gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}} +\input{smiley} +@end iflatex +@end iftex + +@dfn{Smiley} is a package separate from Gnus, but since Gnus is +currently the only package that uses Smiley, it is documented here. + +In short---to use Smiley in Gnus, put the following in your +@file{~/.gnus.el} file: + +@lisp +(setq gnus-treat-display-smileys t) +@end lisp + +Smiley maps text smiley faces---@samp{:-)}, @samp{8-)}, @samp{:-(} and +the like---to pictures and displays those instead of the text smiley +faces. The conversion is controlled by a list of regexps that matches +text and maps that to file names. + @vindex smiley-regexp-alist -@code{smiley-regexp-alist} mapping matched text to image file names. It -contains matches for `smiley', `wry' and `frowny' by default. - -There is currently no Emacs support for `Picons' (@pxref{Picons}), but -there is no reason why it couldn't be added. - -@node XEmacs Enhancements -@section XEmacs Enhancements -@cindex XEmacs - -XEmacs is able to display pictures and stuff, so Gnus has taken -advantage of that. - -@menu -* Picons:: How to display pictures of what your reading. -* Smileys:: Show all those happy faces the way they were meant to be shown. -* Toolbar:: Click'n'drool. -* XVarious:: Other XEmacsy Gnusey variables. -@end menu +The alist used is specified by the @code{smiley-regexp-alist} +variable. The first item in each element is the regexp to be matched; +the second element is the regexp match group that is to be replaced by +the picture; and the third element is the name of the file to be +displayed. + +The following variables customize where Smiley will look for these +files: + +@table @code + +@item smiley-data-directory +@vindex smiley-data-directory +Where Smiley will look for smiley faces files. + +@item gnus-smiley-file-types +@vindex gnus-smiley-file-types +List of suffixes on smiley file names to try. + +@end table @node Picons @@ -18194,21 +21978,9 @@ @end iftex So@dots{} You want to slow down your news reader even more! This is a -good way to do so. Its also a great way to impress people staring +good way to do so. It's also a great way to impress people staring over your shoulder as you read news. -@menu -* Picon Basics:: What are picons and How do I get them. -* Picon Requirements:: Don't go further if you aren't using XEmacs. -* Easy Picons:: Displaying Picons---the easy way. -* Hard Picons:: The way you should do it. You'll learn something. -* Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with. -@end menu - - -@node Picon Basics -@subsubsection Picon Basics - What are Picons? To quote directly from the Picons Web site: @iftex @@ -18227,328 +21999,49 @@ @code{GIF} formats. @end quotation -@vindex gnus-picons-piconsearch-url -If you have a permanent connection to the Internet you can use Steve -Kinzler's Picons Search engine by setting -@code{gnus-picons-piconsearch-url} to the string @* -@uref{http://www.cs.indiana.edu/picons/search.html}. - -@vindex gnus-picons-database -Otherwise you need a local copy of his database. For instructions on -obtaining and installing the picons databases, point your Web browser at @* -@uref{http://www.cs.indiana.edu/picons/ftp/index.html}. Gnus expects -picons to be installed into a location pointed to by -@code{gnus-picons-database}. - - -@node Picon Requirements -@subsubsection Picon Requirements - -To have Gnus display Picons for you, you must be running XEmacs -19.13 or greater since all other versions of Emacs aren't yet able to -display images. - -Additionally, you must have @code{x} support compiled into XEmacs. To -display color picons which are much nicer than the black & white one, -you also need one of @code{xpm} or @code{gif} compiled into XEmacs. - -@vindex gnus-picons-convert-x-face -If you want to display faces from @code{X-Face} headers, you should have -the @code{xface} support compiled into XEmacs. Otherwise you must have -the @code{netpbm} utilities installed, or munge the -@code{gnus-picons-convert-x-face} variable to use something else. - - -@node Easy Picons -@subsubsection Easy Picons - -To enable displaying picons, simply put the following line in your -@file{~/.gnus} file and start Gnus. - -@lisp -(setq gnus-use-picons t) -(setq gnus-treat-display-picons t) -@end lisp - -and make sure @code{gnus-picons-database} points to the directory -containing the Picons databases. - -Alternatively if you want to use the web piconsearch engine add this: - -@lisp -(setq gnus-picons-piconsearch-url - "http://www.cs.indiana.edu:800/piconsearch") -@end lisp - - -@node Hard Picons -@subsubsection Hard Picons - -@iftex -@iflatex -\margindex{} -@end iflatex -@end iftex - -Gnus can display picons for you as you enter and leave groups and -articles. It knows how to interact with three sections of the picons -database. Namely, it can display the picons newsgroup pictures, -author's face picture(s), and the authors domain. To enable this -feature, you need to select where to get the picons from, and where to -display them. - -@table @code - -@item gnus-picons-database -@vindex gnus-picons-database -The location of the picons database. Should point to a directory +@vindex gnus-picon-databases +For instructions on obtaining and installing the picons databases, +point your Web browser at +@uref{http://www.cs.indiana.edu/picons/ftp/index.html}. + +If you are using Debian GNU/Linux, saying @samp{apt-get install +picons.*} will install the picons where Gnus can find them. + +To enable displaying picons, simply make sure that +@code{gnus-picon-databases} points to the directory containing the +Picons databases. + +The following variables offer control over where things are located. + +@table @code + +@item gnus-picon-databases +@vindex gnus-picon-databases +The location of the picons database. This is a list of directories containing the @file{news}, @file{domains}, @file{users} (and so on) -subdirectories. This is only useful if -@code{gnus-picons-piconsearch-url} is @code{nil}. Defaults to -@file{/usr/local/faces/}. - -@item gnus-picons-piconsearch-url -@vindex gnus-picons-piconsearch-url -The URL for the web picons search engine. The only currently known -engine is @uref{http://www.cs.indiana.edu:800/piconsearch}. To -workaround network delays, icons will be fetched in the background. If -this is @code{nil} 'the default), then picons are fetched from local -database indicated by @code{gnus-picons-database}. - -@item gnus-picons-display-where -@vindex gnus-picons-display-where -Where the picon images should be displayed. It is @code{picons} by -default (which by default maps to the buffer @samp{*Picons*}). Other -valid places could be @code{article}, @code{summary}, or -@samp{*scratch*} for all I care. Just make sure that you've made the -buffer visible using the standard Gnus window configuration -routines---@pxref{Windows Configuration}. - -@item gnus-picons-group-excluded-groups -@vindex gnus-picons-group-excluded-groups -Groups that are matched by this regexp won't have their group icons -displayed. - -@end table - -Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your -window configuration for you to include the @code{picons} buffer. - -Now that you've made those decision, you need to add the following -functions to the appropriate hooks so these pictures will get displayed -at the right time. - -@vindex gnus-picons-display-where -@table @code -@item gnus-article-display-picons -@findex gnus-article-display-picons -Looks up and displays the picons for the author and the author's domain -in the @code{gnus-picons-display-where} buffer. - -@item gnus-picons-article-display-x-face -@findex gnus-article-display-picons -Decodes and displays the X-Face header if present. - -@end table - - - -@node Picon Useless Configuration -@subsubsection Picon Useless Configuration - -@iftex -@iflatex -\margindex{} -@end iflatex -@end iftex - -The following variables offer further control over how things are -done, where things are located, and other useless stuff you really -don't need to worry about. - -@table @code - -@item gnus-picons-news-directories -@vindex gnus-picons-news-directories -List of subdirectories to search in @code{gnus-picons-database} for +subdirectories. Defaults to @code{("/usr/lib/picon" +"/usr/local/faces")}. + +@item gnus-picon-news-directories +@vindex gnus-picon-news-directories +List of subdirectories to search in @code{gnus-picon-databases} for newsgroups faces. @code{("news")} is the default. -@item gnus-picons-user-directories -@vindex gnus-picons-user-directories -List of subdirectories to search in @code{gnus-picons-database} for user -faces. @code{("local" "users" "usenix" "misc")} is the default. - -@item gnus-picons-domain-directories -@vindex gnus-picons-domain-directories -List of subdirectories to search in @code{gnus-picons-database} for +@item gnus-picon-user-directories +@vindex gnus-picon-user-directories +List of subdirectories to search in @code{gnus-picon-databases} for user +faces. @code{("users" "usenix" "local" "misc")} is the default. + +@item gnus-picon-domain-directories +@vindex gnus-picon-domain-directories +List of subdirectories to search in @code{gnus-picon-databases} for domain name faces. Defaults to @code{("domains")}. Some people may want to add @samp{"unknown"} to this list. -@item gnus-picons-convert-x-face -@vindex gnus-picons-convert-x-face -If you don't have @code{xface} support builtin XEmacs, this is the -command to use to convert the @code{X-Face} header to an X bitmap -(@code{xbm}). Defaults to @code{(format "@{ echo '/* Width=48, -Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s" -gnus-picons-x-face-file-name)} - -@item gnus-picons-x-face-file-name -@vindex gnus-picons-x-face-file-name -Names a temporary file to store the @code{X-Face} bitmap in. Defaults -to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}. - -@item gnus-picons-has-modeline-p -@vindex gnus-picons-has-modeline-p -If you have set @code{gnus-picons-display-where} to @code{picons}, your -XEmacs frame will become really cluttered. To alleviate this a bit you -can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will -remove the mode line from the Picons buffer. This is only useful if -@code{gnus-picons-display-where} is @code{picons}. - -@item gnus-picons-refresh-before-display -@vindex gnus-picons-refresh-before-display -If non-nil, display the article buffer before computing the picons. -Defaults to @code{nil}. - -@item gnus-picons-display-as-address -@vindex gnus-picons-display-as-address -If @code{t} display textual email addresses along with pictures. -Defaults to @code{t}. - -@item gnus-picons-file-suffixes -@vindex gnus-picons-file-suffixes +@item gnus-picon-file-types +@vindex gnus-picon-file-types Ordered list of suffixes on picon file names to try. Defaults to -@code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs. - -@item gnus-picons-setup-hook -@vindex gnus-picons-setup-hook -Hook run in the picon buffer, if that is displayed. - -@item gnus-picons-display-article-move-p -@vindex gnus-picons-display-article-move-p -Whether to move point to first empty line when displaying picons. This -has only an effect if `gnus-picons-display-where' has value `article'. - -If @code{nil}, display the picons in the @code{From} and -@code{Newsgroups} lines. This is the default. - -@item gnus-picons-clear-cache-on-shutdown -@vindex gnus-picons-clear-cache-on-shutdown -Whether to clear the picons cache when exiting gnus. Gnus caches every -picons it finds while it is running. This saves some time in the search -process but eats some memory. If this variable is set to @code{nil}, -Gnus will never clear the cache itself; you will have to manually call -@code{gnus-picons-clear-cache} to clear it. Otherwise the cache will be -cleared every time you exit Gnus. Defaults to @code{t}. - -@iftex -@iflatex -\margindex{} -@end iflatex -@end iftex - -@end table - -@node Smileys -@subsection Smileys -@cindex smileys - -@iftex -@iflatex -\gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}} -\input{smiley} -@end iflatex -@end iftex - -@dfn{Smiley} is a package separate from Gnus, but since Gnus is -currently the only package that uses Smiley, it is documented here. - -In short---to use Smiley in Gnus, put the following in your -@file{.gnus.el} file: - -@lisp -(setq gnus-treat-display-smileys t) -@end lisp - -Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and -the like---to pictures and displays those instead of the text smiley -faces. The conversion is controlled by a list of regexps that matches -text and maps that to file names. - -@vindex smiley-nosey-regexp-alist -@vindex smiley-deformed-regexp-alist -Smiley supplies two example conversion alists by default: -@code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(} -and so on), and @code{smiley-nosey-regexp-alist} (which matches -@samp{:-)}, @samp{:-(} and so on). - -The alist used is specified by the @code{smiley-regexp-alist} variable, -which defaults to the value of @code{smiley-deformed-regexp-alist}. - -The first item in each element is the regexp to be matched; the second -element is the regexp match group that is to be replaced by the picture; -and the third element is the name of the file to be displayed. - -The following variables customize where Smiley will look for these -files, as well as the color to be used and stuff: - -@table @code - -@item smiley-data-directory -@vindex smiley-data-directory -Where Smiley will look for smiley faces files. - -@item smiley-flesh-color -@vindex smiley-flesh-color -Skin color. The default is @samp{yellow}, which is really racist. - -@item smiley-features-color -@vindex smiley-features-color -Color of the features of the face. The default is @samp{black}. - -@item smiley-tongue-color -@vindex smiley-tongue-color -Color of the tongue. The default is @samp{red}. - -@item smiley-circle-color -@vindex smiley-circle-color -Color of the circle around the face. The default is @samp{black}. - -@item smiley-mouse-face -@vindex smiley-mouse-face -Face used for mouse highlighting over the smiley face. - -@end table - - -@node Toolbar -@subsection Toolbar - -@table @code - -@iftex -@iflatex -\margindex{} -@end iflatex -@end iftex - -@item gnus-use-toolbar -@vindex gnus-use-toolbar -If @code{nil}, don't display toolbars. If non-@code{nil}, it should be -one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar}, -@code{right-toolbar}, or @code{left-toolbar}. - -@item gnus-group-toolbar -@vindex gnus-group-toolbar -The toolbar in the group buffer. - -@item gnus-summary-toolbar -@vindex gnus-summary-toolbar -The toolbar in the summary buffer. - -@item gnus-summary-mail-toolbar -@vindex gnus-summary-mail-toolbar -The toolbar in the summary buffer of mail groups. +@code{("xpm" "gif" "xbm")} minus those not built-in your Emacs. @end table @@ -18580,16 +22073,38 @@ A glyph displayed in all Gnus mode lines. It is a tiny gnu head by default. +@end table + +@subsubsection Toolbar + +@table @code + +@item gnus-use-toolbar +@vindex gnus-use-toolbar +If @code{nil}, don't display toolbars. If non-@code{nil}, it should be +one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar}, +@code{right-toolbar}, or @code{left-toolbar}. + +@item gnus-group-toolbar +@vindex gnus-group-toolbar +The toolbar in the group buffer. + +@item gnus-summary-toolbar +@vindex gnus-summary-toolbar +The toolbar in the summary buffer. + +@item gnus-summary-mail-toolbar +@vindex gnus-summary-mail-toolbar +The toolbar in the summary buffer of mail groups. + +@end table + @iftex @iflatex \margindex{} @end iflatex @end iftex -@end table - - - @node Fuzzy Matching @section Fuzzy Matching @@ -18633,9 +22148,111 @@ (``New! Miracle tonic for growing full, lustrous hair on your toes!'') and one mail asking me to repent and find some god. -This is annoying. - -The way to deal with this is having Gnus split out all spam into a +This is annoying. Here's what you can do about it. + +@menu +* The problem of spam:: Some background, and some solutions +* Anti-Spam Basics:: Simple steps to reduce the amount of spam. +* SpamAssassin:: How to use external anti-spam tools. +* Hashcash:: Reduce spam by burning CPU time. +* Filtering Spam Using The Spam ELisp Package:: +* Filtering Spam Using Statistics with spam-stat:: +@end menu + +@node The problem of spam +@subsection The problem of spam +@cindex email spam +@cindex spam filtering approaches +@cindex filtering approaches, spam +@cindex UCE +@cindex unsolicited commercial email + +First, some background on spam. + +If you have access to e-mail, you are familiar with spam (technically +termed @acronym{UCE}, Unsolicited Commercial E-mail). Simply put, it +exists because e-mail delivery is very cheap compared to paper mail, +so only a very small percentage of people need to respond to an UCE to +make it worthwhile to the advertiser. Ironically, one of the most +common spams is the one offering a database of e-mail addresses for +further spamming. Senders of spam are usually called @emph{spammers}, +but terms like @emph{vermin}, @emph{scum}, @emph{sociopaths}, and +@emph{morons} are in common use as well. + +Spam comes from a wide variety of sources. It is simply impossible to +dispose of all spam without discarding useful messages. A good +example is the TMDA system, which requires senders +unknown to you to confirm themselves as legitimate senders before +their e-mail can reach you. Without getting into the technical side +of TMDA, a downside is clearly that e-mail from legitimate sources may +be discarded if those sources can't or won't confirm themselves +through the TMDA system. Another problem with TMDA is that it +requires its users to have a basic understanding of e-mail delivery +and processing. + +The simplest approach to filtering spam is filtering, at the mail +server or when you sort through incoming mail. If you get 200 spam +messages per day from @samp{random-address@@vmadmin.com}, you block +@samp{vmadmin.com}. If you get 200 messages about @samp{VIAGRA}, you +discard all messages with @samp{VIAGRA} in the message. If you get +lots of spam from China, for example, you try to filter all mail from +Chinese IPs. + +This, unfortunately, is a great way to discard legitimate e-mail. For +instance, the very informative and useful RISKS digest has been +blocked by overzealous mail filters because it @strong{contained} +words that were common in spam messages. The risks of blocking a +whole country from contacting you should also be obvious, so don't do +it if you have the choice. Nevertheless, in isolated cases, with +great care, direct filtering of mail can be useful. + +Another approach to filtering e-mail is the distributed spam +processing, for instance DCC implements such a system. In essence, +@var{N} systems around the world agree that a machine @var{X} in +Ghana, Estonia, or California is sending out spam e-mail, and these +@var{N} systems enter @var{X} or the spam e-mail from @var{X} into a +database. The criteria for spam detection vary---it may be the number +of messages sent, the content of the messages, and so on. When a user +of the distributed processing system wants to find out if a message is +spam, he consults one of those @var{N} systems. + +Distributed spam processing works very well against spammers that send +a large number of messages at once, but it requires the user to set up +fairly complicated checks. There are commercial and free distributed +spam processing systems. Distributed spam processing has its risks as +well. For instance legitimate e-mail senders have been accused of +sending spam, and their web sites and mailing lists have been shut +down for some time because of the incident. + +The statistical approach to spam filtering is also popular. It is +based on a statistical analysis of previous spam messages. Usually +the analysis is a simple word frequency count, with perhaps pairs of +words or 3-word combinations thrown into the mix. Statistical +analysis of spam works very well in most of the cases, but it can +classify legitimate e-mail as spam in some cases. It takes time to +run the analysis, the full message must be analyzed, and the user has +to store the database of spam analyses. Statistical analysis on the +server is gaining popularity. This has the advantage of letting the +user Just Read Mail, but has the disadvantage that it's harder to tell +the server that it has misclassified mail. + +Fighting spam is not easy, no matter what anyone says. There is no +magic switch that will distinguish Viagra ads from Mom's e-mails. +Even people are having a hard time telling spam apart from non-spam, +because spammers are actively looking to fool us into thinking they +are Mom, essentially. Spamming is irritating, irresponsible, and +idiotic behavior from a bunch of people who think the world owes them +a favor. We hope the following sections will help you in fighting the +spam plague. + +@node Anti-Spam Basics +@subsection Anti-Spam Basics +@cindex email spam +@cindex spam +@cindex UCE +@cindex unsolicited commercial email + +One way of dealing with spam is having Gnus split out all spam into a @samp{spam} mail group (@pxref{Splitting Mail}). First, pick one (1) valid mail address that you can be reached at, and @@ -18654,14 +22271,12 @@ (@pxref{Fancy Mail Splitting}): @lisp -( - ... +(... (to "larsi@@trym.ifi.uio.no" - (| ("subject" "re:.*" "misc") - ("references" ".*@@.*" "misc") - "spam")) - ... -) + (| ("subject" "re:.*" "misc") + ("references" ".*@@.*" "misc") + "spam")) + ...) @end lisp This says that all mail to this address is suspect, but if it has a @@ -18669,7 +22284,7 @@ header, it's probably ok. All the rest goes to the @samp{spam} group. (This idea probably comes from Tim Pierce.) -In addition, many mail spammers talk directly to your @code{smtp} server +In addition, many mail spammers talk directly to your @acronym{SMTP} server and do not include your email address explicitly in the @code{To} header. Why they do this is unknown---perhaps it's to thwart this thwarting scheme? In any case, this is trivial to deal with---you just @@ -18689,18 +22304,1787 @@ citizen, you can even send off complaints to the proper authorities on each unsolicited commercial email---at your leisure. -If you are also a lazy net citizen, you will probably prefer -complaining automatically with the @file{gnus-junk.el} package, -available as free software at @* -@uref{http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html}. Since most -e-mail spam is sent automatically, this may reconcile the cosmic -balance somewhat. - This works for me. It allows people an easy way to contact me (they can just press @kbd{r} in the usual way), and I'm not bothered at all with spam. It's a win-win situation. Forging @code{From} headers to point to non-existent domains is yucky, in my opinion. +Be careful with this approach. Spammers are wise to it. + + +@node SpamAssassin +@subsection SpamAssassin, Vipul's Razor, DCC, etc +@cindex SpamAssassin +@cindex Vipul's Razor +@cindex DCC + +The days where the hints in the previous section were sufficient in +avoiding spam are coming to an end. There are many tools out there +that claim to reduce the amount of spam you get. This section could +easily become outdated fast, as new products replace old, but +fortunately most of these tools seem to have similar interfaces. Even +though this section will use SpamAssassin as an example, it should be +easy to adapt it to most other tools. + +Note that this section does not involve the @code{spam.el} package, +which is discussed in the next section. If you don't care for all +the features of @code{spam.el}, you can make do with these simple +recipes. + +If the tool you are using is not installed on the mail server, you +need to invoke it yourself. Ideas on how to use the +@code{:postscript} mail source parameter (@pxref{Mail Source +Specifiers}) follow. + +@lisp +(setq mail-sources + '((file :prescript "formail -bs spamassassin < /var/mail/%u") + (pop :user "jrl" + :server "pophost" + :postscript + "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t"))) +@end lisp + +Once you manage to process your incoming spool somehow, thus making +the mail contain e.g.@: a header indicating it is spam, you are ready to +filter it out. Using normal split methods (@pxref{Splitting Mail}): + +@lisp +(setq nnmail-split-methods '(("spam" "^X-Spam-Flag: YES") + ...)) +@end lisp + +Or using fancy split methods (@pxref{Fancy Mail Splitting}): + +@lisp +(setq nnmail-split-methods 'nnmail-split-fancy + nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam") + ...)) +@end lisp + +Some people might not like the idea of piping the mail through various +programs using a @code{:prescript} (if some program is buggy, you +might lose all mail). If you are one of them, another solution is to +call the external tools during splitting. Example fancy split method: + +@lisp +(setq nnmail-split-fancy '(| (: kevin-spamassassin) + ...)) +(defun kevin-spamassassin () + (save-excursion + (save-restriction + (widen) + (if (eq 1 (call-process-region (point-min) (point-max) + "spamc" nil nil nil "-c")) + "spam")))) +@end lisp + +Note that with the nnimap backend, message bodies will not be +downloaded by default. You need to set +@code{nnimap-split-download-body} to t to do that (@pxref{Splitting in +IMAP}). + +That is about it. As some spam is likely to get through anyway, you +might want to have a nifty function to call when you happen to read +spam. And here is the nifty function: + +@lisp + (defun my-gnus-raze-spam () + "Submit SPAM to Vipul's Razor, then mark it as expirable." + (interactive) + (gnus-summary-show-raw-article) + (gnus-summary-save-in-pipe "razor-report -f -d") + (gnus-summary-mark-as-expirable 1)) +@end lisp + +@node Hashcash +@subsection Hashcash +@cindex hashcash + +A novel technique to fight spam is to require senders to do something +costly for each message they send. This has the obvious drawback that +you cannot rely on everyone in the world using this technique, +since it is not part of the Internet standards, but it may be useful +in smaller communities. + +While the tools in the previous section work well in practice, they +work only because the tools are constantly maintained and updated as +new form of spam appears. This means that a small percentage of spam +will always get through. It also means that somewhere, someone needs +to read lots of spam to update these tools. Hashcash avoids that, but +instead prefers that everyone you contact through e-mail supports the +scheme. You can view the two approaches as pragmatic vs dogmatic. +The approaches have their own advantages and disadvantages, but as +often in the real world, a combination of them is stronger than either +one of them separately. + +@cindex X-Hashcash +The ``something costly'' is to burn CPU time, more specifically to +compute a hash collision up to a certain number of bits. The +resulting hashcash cookie is inserted in a @samp{X-Hashcash:} +header. For more details, and for the external application +@code{hashcash} you need to install to use this feature, see +@uref{http://www.cypherspace.org/~adam/hashcash/}. Even more +information can be found at @uref{http://www.camram.org/}. + +If you wish to call hashcash for each message you send, say something +like: + +@lisp +(require 'hashcash) +(add-hook 'message-send-hook 'mail-add-payment) +@end lisp + +The @file{hashcash.el} library can be found in the Gnus development +contrib directory or at +@uref{http://users.actrix.gen.nz/mycroft/hashcash.el}. + +You will need to set up some additional variables as well: + +@table @code + +@item hashcash-default-payment +@vindex hashcash-default-payment +This variable indicates the default number of bits the hash collision +should consist of. By default this is 0, meaning nothing will be +done. Suggested useful values include 17 to 29. + +@item hashcash-payment-alist +@vindex hashcash-payment-alist +Some receivers may require you to spend burn more CPU time than the +default. This variable contains a list of @samp{(@var{addr} +@var{amount})} cells, where @var{addr} is the receiver (email address +or newsgroup) and @var{amount} is the number of bits in the collision +that is needed. It can also contain @samp{(@var{addr} @var{string} +@var{amount})} cells, where the @var{string} is the string to use +(normally the email address or newsgroup name is used). + +@item hashcash +@vindex hashcash +Where the @code{hashcash} binary is installed. + +@end table + +Currently there is no built in functionality in Gnus to verify +hashcash cookies, it is expected that this is performed by your hand +customized mail filtering scripts. Improvements in this area would be +a useful contribution, however. + +@node Filtering Spam Using The Spam ELisp Package +@subsection Filtering Spam Using The Spam ELisp Package +@cindex spam filtering +@cindex spam + +The idea behind @file{spam.el} is to have a control center for spam detection +and filtering in Gnus. To that end, @file{spam.el} does two things: it +filters new mail, and it analyzes mail known to be spam or ham. +@dfn{Ham} is the name used throughout @file{spam.el} to indicate +non-spam messages. + +First of all, you @strong{must} run the function +@code{spam-initialize} to autoload @code{spam.el} and to install the +@code{spam.el} hooks. There is one exception: if you use the +@code{spam-use-stat} (@pxref{spam-stat spam filtering}) setting, you +should turn it on before @code{spam-initialize}: + +@example +(setq spam-use-stat t) ;; if needed +(spam-initialize) +@end example + +So, what happens when you load @file{spam.el}? + +First, some hooks will get installed by @code{spam-initialize}. There +are some hooks for @code{spam-stat} so it can save its databases, and +there are hooks so interesting things will happen when you enter and +leave a group. More on the sequence of events later (@pxref{Spam +ELisp Package Sequence of Events}). + +You get the following keyboard commands: + +@table @kbd + +@item M-d +@itemx M s x +@itemx S x +@kindex M-d +@kindex S x +@kindex M s x +@findex gnus-summary-mark-as-spam +@code{gnus-summary-mark-as-spam}. + +Mark current article as spam, showing it with the @samp{$} mark. +Whenever you see a spam article, make sure to mark its summary line +with @kbd{M-d} before leaving the group. This is done automatically +for unread articles in @emph{spam} groups. + +@item M s t +@itemx S t +@kindex M s t +@kindex S t +@findex spam-bogofilter-score +@code{spam-bogofilter-score}. + +You must have Bogofilter installed for that command to work properly. + +@xref{Bogofilter}. + +@end table + +Also, when you load @file{spam.el}, you will be able to customize its +variables. Try @code{customize-group} on the @samp{spam} variable +group. + +@menu +* Spam ELisp Package Sequence of Events:: +* Spam ELisp Package Filtering of Incoming Mail:: +* Spam ELisp Package Global Variables:: +* Spam ELisp Package Configuration Examples:: +* Blacklists and Whitelists:: +* BBDB Whitelists:: +* Gmane Spam Reporting:: +* Anti-spam Hashcash Payments:: +* Blackholes:: +* Regular Expressions Header Matching:: +* Bogofilter:: +* ifile spam filtering:: +* spam-stat spam filtering:: +* SpamOracle:: +* Extending the Spam ELisp package:: +@end menu + +@node Spam ELisp Package Sequence of Events +@subsubsection Spam ELisp Package Sequence of Events +@cindex spam filtering +@cindex spam filtering sequence of events +@cindex spam + +You must read this section to understand how @code{spam.el} works. +Do not skip, speed-read, or glance through this section. + +There are two @emph{contact points}, if you will, between +@code{spam.el} and the rest of Gnus: checking new mail for spam, and +leaving a group. + +Getting new mail is done in one of two ways. You can either split +your incoming mail or you can classify new articles as ham or spam +when you enter the group. + +Splitting incoming mail is better suited to mail backends such as +@code{nnml} or @code{nnimap} where new mail appears in a single file +called a @dfn{Spool File}. See @xref{Spam ELisp Package Filtering of +Incoming Mail}. + +For backends such as @code{nntp} there is no incoming mail spool, so +an alternate mechanism must be used. This may also happen for +backends where the server is in charge of splitting incoming mail, and +Gnus does not do further splitting. The @code{spam-autodetect} and +@code{spam-autodetect-methods} group parameters (accessible with +@kbd{G c} and @kbd{G p} as usual), and the corresponding variables +@code{gnus-spam-autodetect-methods} and +@code{gnus-spam-autodetect-methods} (accessible with @kbd{M-x +customize-variable} as usual). + +When @code{spam-autodetect} is used, it hooks into the process of +entering a group. Thus, entering a group with unseen or unread +articles becomes the substitute for checking incoming mail. Whether +only unseen articles or all unread articles will be processed is +determined by the @code{spam-autodetect-recheck-messages}. When set +to t, unread messages will be rechecked. + +@code{spam-autodetect} grants the user at once more and less control +of spam filtering. The user will have more control over each group's +spam methods, so for instance the @samp{ding} group may have +@code{spam-use-BBDB} as the autodetection method, while the +@samp{suspect} group may have the @code{spam-use-blacklist} and +@code{spam-use-bogofilter} methods enabled. Every article detected to +be spam will be marked with the spam mark @samp{$} and processed on +exit from the group as normal spam. The user has less control over +the @emph{sequence} of checks, as he might with @code{spam-split}. + +When the newly split mail goes into groups, or messages are +autodetected to be ham or spam, those groups must be exited (after +entering, if needed) for further spam processing to happen. It +matters whether the group is considered a ham group, a spam group, or +is unclassified, based on its @code{spam-content} parameter +(@pxref{Spam ELisp Package Global Variables}). Spam groups have the +additional characteristic that, when entered, any unseen or unread +articles (depending on the @code{spam-mark-only-unseen-as-spam} +variable) will be marked as spam. Thus, mail split into a spam group +gets automatically marked as spam when you enter the group. + +So, when you exit a group, the @code{spam-processors} are applied, if +any are set, and the processed mail is moved to the +@code{ham-process-destination} or the @code{spam-process-destination} +depending on the article's classification. If the +@code{ham-process-destination} or the @code{spam-process-destination}, +whichever is appropriate, are nil, the article is left in the current +group. + +If a spam is found in any group (this can be changed to only non-spam +groups with @code{spam-move-spam-nonspam-groups-only}), it is +processed by the active @code{spam-processors} (@pxref{Spam ELisp +Package Global Variables}) when the group is exited. Furthermore, the +spam is moved to the @code{spam-process-destination} (@pxref{Spam +ELisp Package Global Variables}) for further training or deletion. +You have to load the @code{gnus-registry.el} package and enable the +@code{spam-log-to-registry} variable if you want spam to be processed +no more than once. Thus, spam is detected and processed everywhere, +which is what most people want. If the +@code{spam-process-destination} is nil, the spam is marked as +expired, which is usually the right thing to do. + +If spam can not be moved - because of a read-only backend such as NNTP, +for example, it will be copied. + +If a ham mail is found in a ham group, as determined by the +@code{ham-marks} parameter, it is processed as ham by the active ham +@code{spam-processor} when the group is exited. With the variables +@code{spam-process-ham-in-spam-groups} and +@code{spam-process-ham-in-nonham-groups} the behavior can be further +altered so ham found anywhere can be processed. You have to load the +@code{gnus-registry.el} package and enable the +@code{spam-log-to-registry} variable if you want ham to be processed +no more than once. Thus, ham is detected and processed only when +necessary, which is what most people want. More on this in +@xref{Spam ELisp Package Configuration Examples}. + +If ham can not be moved - because of a read-only backend such as NNTP, +for example, it will be copied. + +If all this seems confusing, don't worry. Soon it will be as natural +as typing Lisp one-liners on a neural interface... err, sorry, that's +50 years in the future yet. Just trust us, it's not so bad. + +@node Spam ELisp Package Filtering of Incoming Mail +@subsubsection Spam ELisp Package Filtering of Incoming Mail +@cindex spam filtering +@cindex spam filtering incoming mail +@cindex spam + +To use the @file{spam.el} facilities for incoming mail filtering, you +must add the following to your fancy split list +@code{nnmail-split-fancy} or @code{nnimap-split-fancy}: + +@example +(: spam-split) +@end example + +Note that the fancy split may be called @code{nnmail-split-fancy} or +@code{nnimap-split-fancy}, depending on whether you use the nnmail or +nnimap back ends to retrieve your mail. + +The @code{spam-split} function will process incoming mail and send the +mail considered to be spam into the group name given by the variable +@code{spam-split-group}. By default that group name is @samp{spam}, +but you can customize @code{spam-split-group}. Make sure the contents +of @code{spam-split-group} are an @emph{unqualified} group name, for +instance in an @code{nnimap} server @samp{your-server} the value +@samp{spam} will turn out to be @samp{nnimap+your-server:spam}. The +value @samp{nnimap+server:spam}, therefore, is wrong and will +actually give you the group +@samp{nnimap+your-server:nnimap+server:spam} which may or may not +work depending on your server's tolerance for strange group names. + +You can also give @code{spam-split} a parameter, +e.g. @samp{'spam-use-regex-headers} or @samp{"maybe-spam"}. Why is +this useful? + +Take these split rules (with @code{spam-use-regex-headers} and +@code{spam-use-blackholes} set): + +@example + nnimap-split-fancy '(| + (any "ding" "ding") + (: spam-split) + ;; default mailbox + "mail") +@end example + +Now, the problem is that you want all ding messages to make it to the +ding folder. But that will let obvious spam (for example, spam +detected by SpamAssassin, and @code{spam-use-regex-headers}) through, +when it's sent to the ding list. On the other hand, some messages to +the ding list are from a mail server in the blackhole list, so the +invocation of @code{spam-split} can't be before the ding rule. + +You can let SpamAssassin headers supersede ding rules, but all other +@code{spam-split} rules (including a second invocation of the +regex-headers check) will be after the ding rule: + +@example + nnimap-split-fancy '(| +;;; all spam detected by spam-use-regex-headers goes to "regex-spam" + (: spam-split "regex-spam" 'spam-use-regex-headers) + (any "ding" "ding") +;;; all other spam detected by spam-split goes to spam-split-group + (: spam-split) + ;; default mailbox + "mail") +@end example + +This lets you invoke specific @code{spam-split} checks depending on +your particular needs, and to target the results of those checks to a +particular spam group. You don't have to throw all mail into all the +spam tests. Another reason why this is nice is that messages to +mailing lists you have rules for don't have to have resource-intensive +blackhole checks performed on them. You could also specify different +spam checks for your nnmail split vs. your nnimap split. Go crazy. + +You should still have specific checks such as +@code{spam-use-regex-headers} set to @code{t}, even if you +specifically invoke @code{spam-split} with the check. The reason is +that when loading @file{spam.el}, some conditional loading is done +depending on what @code{spam-use-xyz} variables you have set. This +is usually not critical, though. + +@emph{Note for IMAP users} + +The boolean variable @code{nnimap-split-download-body} needs to be +set, if you want to split based on the whole message instead of just +the headers. By default, the nnimap back end will only retrieve the +message headers. If you use @code{spam-check-bogofilter}, +@code{spam-check-ifile}, or @code{spam-check-stat} (the splitters that +can benefit from the full message body), you should set this variable. +It is not set by default because it will slow @acronym{IMAP} down, and +that is not an appropriate decision to make on behalf of the user. + +@xref{Splitting in IMAP}. + +@emph{TODO: spam.el needs to provide a uniform way of training all the +statistical databases. Some have that functionality built-in, others +don't.} + +@node Spam ELisp Package Global Variables +@subsubsection Spam ELisp Package Global Variables +@cindex spam filtering +@cindex spam filtering variables +@cindex spam variables +@cindex spam + +@vindex gnus-spam-process-newsgroups +The concepts of ham processors and spam processors are very important. +Ham processors and spam processors for a group can be set with the +@code{spam-process} group parameter, or the +@code{gnus-spam-process-newsgroups} variable. Ham processors take +mail known to be non-spam (@emph{ham}) and process it in some way so +that later similar mail will also be considered non-spam. Spam +processors take mail known to be spam and process it so similar spam +will be detected later. + +The format of the spam or ham processor entry used to be a symbol, +but now it is a cons cell. See the individual spam processor entries +for more information. + +@vindex gnus-spam-newsgroup-contents +Gnus learns from the spam you get. You have to collect your spam in +one or more spam groups, and set or customize the variable +@code{spam-junk-mailgroups} as appropriate. You can also declare +groups to contain spam by setting their group parameter +@code{spam-contents} to @code{gnus-group-spam-classification-spam}, or +by customizing the corresponding variable +@code{gnus-spam-newsgroup-contents}. The @code{spam-contents} group +parameter and the @code{gnus-spam-newsgroup-contents} variable can +also be used to declare groups as @emph{ham} groups if you set their +classification to @code{gnus-group-spam-classification-ham}. If +groups are not classified by means of @code{spam-junk-mailgroups}, +@code{spam-contents}, or @code{gnus-spam-newsgroup-contents}, they are +considered @emph{unclassified}. All groups are unclassified by +default. + +@vindex gnus-spam-mark +@cindex $ +In spam groups, all messages are considered to be spam by default: +they get the @samp{$} mark (@code{gnus-spam-mark}) when you enter the +group. If you have seen a message, had it marked as spam, then +unmarked it, it won't be marked as spam when you enter the group +thereafter. You can disable that behavior, so all unread messages +will get the @samp{$} mark, if you set the +@code{spam-mark-only-unseen-as-spam} parameter to @code{nil}. You +should remove the @samp{$} mark when you are in the group summary +buffer for every message that is not spam after all. To remove the +@samp{$} mark, you can use @kbd{M-u} to ``unread'' the article, or +@kbd{d} for declaring it read the non-spam way. When you leave a +group, all spam-marked (@samp{$}) articles are sent to a spam +processor which will study them as spam samples. + +Messages may also be deleted in various other ways, and unless +@code{ham-marks} group parameter gets overridden below, marks @samp{R} +and @samp{r} for default read or explicit delete, marks @samp{X} and +@samp{K} for automatic or explicit kills, as well as mark @samp{Y} for +low scores, are all considered to be associated with articles which +are not spam. This assumption might be false, in particular if you +use kill files or score files as means for detecting genuine spam, you +should then adjust the @code{ham-marks} group parameter. + +@defvar ham-marks +You can customize this group or topic parameter to be the list of +marks you want to consider ham. By default, the list contains the +deleted, read, killed, kill-filed, and low-score marks (the idea is +that these articles have been read, but are not spam). It can be +useful to also include the tick mark in the ham marks. It is not +recommended to make the unread mark a ham mark, because it normally +indicates a lack of classification. But you can do it, and we'll be +happy for you. +@end defvar + +@defvar spam-marks +You can customize this group or topic parameter to be the list of +marks you want to consider spam. By default, the list contains only +the spam mark. It is not recommended to change that, but you can if +you really want to. +@end defvar + +When you leave @emph{any} group, regardless of its +@code{spam-contents} classification, all spam-marked articles are sent +to a spam processor, which will study these as spam samples. If you +explicit kill a lot, you might sometimes end up with articles marked +@samp{K} which you never saw, and which might accidentally contain +spam. Best is to make sure that real spam is marked with @samp{$}, +and nothing else. + +@vindex gnus-ham-process-destinations +When you leave a @emph{spam} group, all spam-marked articles are +marked as expired after processing with the spam processor. This is +not done for @emph{unclassified} or @emph{ham} groups. Also, any +@strong{ham} articles in a spam group will be moved to a location +determined by either the @code{ham-process-destination} group +parameter or a match in the @code{gnus-ham-process-destinations} +variable, which is a list of regular expressions matched with group +names (it's easiest to customize this variable with +@code{customize-variable gnus-ham-process-destinations}). Each +newsgroup specification has the format (REGEXP PROCESSOR) in a +standard Lisp list, if you prefer to customize the variable manually. +The ultimate location is a group name or names. If the +@code{ham-process-destination} parameter is not set, ham articles are +left in place. If the +@code{spam-mark-ham-unread-before-move-from-spam-group} parameter is +set, the ham articles are marked as unread before being moved. + +If ham can not be moved - because of a read-only backend such as NNTP, +for example, it will be copied. + +Note that you can use multiples destinations per group or regular +expression! This enables you to send your ham to a regular mail +group and to a @emph{ham training} group. + +When you leave a @emph{ham} group, all ham-marked articles are sent to +a ham processor, which will study these as non-spam samples. + +@vindex spam-process-ham-in-spam-groups +By default the variable @code{spam-process-ham-in-spam-groups} is +@code{nil}. Set it to @code{t} if you want ham found in spam groups +to be processed. Normally this is not done, you are expected instead +to send your ham to a ham group and process it there. + +@vindex spam-process-ham-in-nonham-groups +By default the variable @code{spam-process-ham-in-nonham-groups} is +@code{nil}. Set it to @code{t} if you want ham found in non-ham (spam +or unclassified) groups to be processed. Normally this is not done, +you are expected instead to send your ham to a ham group and process +it there. + +@vindex gnus-spam-process-destinations +When you leave a @emph{ham} or @emph{unclassified} group, all +@strong{spam} articles are moved to a location determined by either +the @code{spam-process-destination} group parameter or a match in the +@code{gnus-spam-process-destinations} variable, which is a list of +regular expressions matched with group names (it's easiest to +customize this variable with @code{customize-variable +gnus-spam-process-destinations}). Each newsgroup specification has +the repeated format (REGEXP GROUP) and they are all in a standard Lisp +list, if you prefer to customize the variable manually. The ultimate +location is a group name or names. If the +@code{spam-process-destination} parameter is not set, the spam +articles are only expired. The group name is fully qualified, meaning +that if you see @samp{nntp:servername} before the group name in the +group buffer then you need it here as well. + +If spam can not be moved - because of a read-only backend such as NNTP, +for example, it will be copied. + +Note that you can use multiples destinations per group or regular +expression! This enables you to send your spam to multiple @emph{spam +training} groups. + +@vindex spam-log-to-registry +The problem with processing ham and spam is that Gnus doesn't track +this processing by default. Enable the @code{spam-log-to-registry} +variable so @code{spam.el} will use @code{gnus-registry.el} to track +what articles have been processed, and avoid processing articles +multiple times. Keep in mind that if you limit the number of registry +entries, this won't work as well as it does without a limit. + +@vindex spam-mark-only-unseen-as-spam +Set this variable if you want only unseen articles in spam groups to +be marked as spam. By default, it is set. If you set it to nil, +unread articles will also be marked as spam. + +@vindex spam-mark-ham-unread-before-move-from-spam-group +Set this variable if you want ham to be unmarked before it is moved +out of the spam group. This is very useful when you use something +like the tick mark @samp{!} to mark ham - the article will be placed +in your ham-process-destination, unmarked as if it came fresh from +the mail server. + +@vindex spam-autodetect-recheck-messages +When autodetecting spam, this variable tells @code{spam.el} whether +only unseen articles or all unread articles should be checked for +spam. It is recommended that you leave it off. + +@node Spam ELisp Package Configuration Examples +@subsubsection Spam ELisp Package Configuration Examples +@cindex spam filtering +@cindex spam filtering configuration examples +@cindex spam configuration examples +@cindex spam + +@subsubheading Ted's setup + +From Ted Zlatanov . +@example + +;; for gnus-registry-split-fancy-with-parent and spam autodetection +;; see gnus-registry.el for more information +(gnus-registry-initialize) +(spam-initialize) + +;; I like control-S for marking spam +(define-key gnus-summary-mode-map "\C-s" 'gnus-summary-mark-as-spam) + +(setq + spam-log-to-registry t ;; for spam autodetection + spam-use-BBDB t + spam-use-regex-headers t ; catch X-Spam-Flag (SpamAssassin) + ;; all groups with "spam" in the name contain spam + gnus-spam-newsgroup-contents '(("spam" gnus-group-spam-classification-spam)) + ;; see documentation for these + spam-move-spam-nonspam-groups-only nil + spam-mark-only-unseen-as-spam t + spam-mark-ham-unread-before-move-from-spam-group t + nnimap-split-rule 'nnimap-split-fancy + ;; understand what this does before you copy it to your own setup! + nnimap-split-fancy '(| + ;; trace references to parents and put in their group + (: gnus-registry-split-fancy-with-parent) + ;; this will catch server-side SpamAssassin tags + (: spam-split 'spam-use-regex-headers) + (any "ding" "ding") + ;; note that spam by default will go to "spam" + (: spam-split) + ;; default mailbox + "mail")) + +;; my parameters, set with `G p' + +;; all nnml groups, and all nnimap groups except +;; "nnimap+mail.lifelogs.com:train" and +;; "nnimap+mail.lifelogs.com:spam": any spam goes to nnimap training, +;; because it must have been detected manually + +((spam-process-destination . "nnimap+mail.lifelogs.com:train")) + +;; all NNTP groups +;; autodetect spam with the blacklist and ham with the BBDB +((spam-autodetect-methods spam-use-blacklist spam-use-BBDB) +;; send all spam to the training group + (spam-process-destination . "nnimap+mail.lifelogs.com:train")) + +;; only some NNTP groups, where I want to autodetect spam +((spam-autodetect . t)) + +;; my nnimap "nnimap+mail.lifelogs.com:spam" group + +;; this is a spam group +((spam-contents gnus-group-spam-classification-spam) + + ;; any spam (which happens when I enter for all unseen messages, + ;; because of the gnus-spam-newsgroup-contents setting above), goes to + ;; "nnimap+mail.lifelogs.com:train" unless I mark it as ham + + (spam-process-destination "nnimap+mail.lifelogs.com:train") + + ;; any ham goes to my "nnimap+mail.lifelogs.com:mail" folder, but + ;; also to my "nnimap+mail.lifelogs.com:trainham" folder for training + + (ham-process-destination "nnimap+mail.lifelogs.com:mail" + "nnimap+mail.lifelogs.com:trainham") + ;; in this group, only '!' marks are ham + (ham-marks + (gnus-ticked-mark)) + ;; remembers senders in the blacklist on the way out - this is + ;; definitely not needed, it just makes me feel better + (spam-process (gnus-group-spam-exit-processor-blacklist))) + +;; Later, on the IMAP server I use the "train" group for training +;; SpamAssassin to recognize spam, and the "trainham" group for +;; recognizing ham - but Gnus has nothing to do with it. + +@end example + +@subsubheading Using @file{spam.el} on an IMAP server with a statistical filter on the server + +From Reiner Steib . + +My provider has set up bogofilter (in combination with @acronym{DCC}) on +the mail server (@acronym{IMAP}). Recognized spam goes to +@samp{spam.detected}, the rest goes through the normal filter rules, +i.e. to @samp{some.folder} or to @samp{INBOX}. Training on false +positives or negatives is done by copying or moving the article to +@samp{training.ham} or @samp{training.spam} respectively. A cron job on +the server feeds those to bogofilter with the suitable ham or spam +options and deletes them from the @samp{training.ham} and +@samp{training.spam} folders. + +With the following entries in @code{gnus-parameters}, @code{spam.el} +does most of the job for me: + +@lisp + ("nnimap:spam\\.detected" + (gnus-article-sort-functions '(gnus-article-sort-by-chars)) + (ham-process-destination "nnimap:INBOX" "nnimap:training.ham") + (spam-contents gnus-group-spam-classification-spam)) + ("nnimap:\\(INBOX\\|other-folders\\)" + (spam-process-destination . "nnimap:training.spam") + (spam-contents gnus-group-spam-classification-ham)) +@end lisp + +@itemize + +@item @b{The Spam folder:} + +In the folder @samp{spam.detected}, I have to check for false positives +(i.e. legitimate mails, that were wrongly judged as spam by +bogofilter or DCC). + +Because of the @code{gnus-group-spam-classification-spam} entry, all +messages are marked as spam (with @code{$}). When I find a false +positive, I mark the message with some other ham mark (@code{ham-marks}, +@ref{Spam ELisp Package Global Variables}). On group exit, those +messages are copied to both groups, @samp{INBOX} (were I want to have +the article) and @samp{training.ham} (for training bogofilter) and +deleted from the @samp{spam.detected} folder. + +The @code{gnus-article-sort-by-chars} entry simplifies detection of +false positives for me. I receive lots of worms (sweN, @dots{}), that all +have a similar size. Grouping them by size (i.e. chars) makes finding +other false positives easier. (Of course worms aren't @i{spam} +(@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is +an excellent tool for filtering those unwanted mails for me.) + +@item @b{Ham folders:} + +In my ham folders, I just hit @kbd{S x} +(@code{gnus-summary-mark-as-spam}) whenever I see an unrecognized spam +mail (false negative). On group exit, those messages are moved to +@samp{training.ham}. +@end itemize + +@subsubheading Reporting spam articles in Gmane groups with @code{spam-report.el} + +From Reiner Steib . + +With following entry in @code{gnus-parameters}, @kbd{S x} +(@code{gnus-summary-mark-as-spam}) marks articles in @code{gmane.*} +groups as spam and reports the to Gmane at group exit: + +@lisp + ("^gmane\\." + (spam-process (gnus-group-spam-exit-processor-report-gmane))) +@end lisp + +Additionally, I use `(setq spam-report-gmane-use-article-number nil)' +because I don't read the groups directly from news.gmane.org, but +through my local news server (leafnode). I.e. the article numbers are +not the same as on news.gmane.org, thus @code{spam-report.el} has to check +the @code{X-Report-Spam} header to find the correct number. + +@node Blacklists and Whitelists +@subsubsection Blacklists and Whitelists +@cindex spam filtering +@cindex whitelists, spam filtering +@cindex blacklists, spam filtering +@cindex spam + +@defvar spam-use-blacklist + +Set this variable to @code{t} if you want to use blacklists when +splitting incoming mail. Messages whose senders are in the blacklist +will be sent to the @code{spam-split-group}. This is an explicit +filter, meaning that it acts only on mail senders @emph{declared} to +be spammers. + +@end defvar + +@defvar spam-use-whitelist + +Set this variable to @code{t} if you want to use whitelists when +splitting incoming mail. Messages whose senders are not in the +whitelist will be sent to the next spam-split rule. This is an +explicit filter, meaning that unless someone is in the whitelist, their +messages are not assumed to be spam or ham. + +@end defvar + +@defvar spam-use-whitelist-exclusive + +Set this variable to @code{t} if you want to use whitelists as an +implicit filter, meaning that every message will be considered spam +unless the sender is in the whitelist. Use with care. + +@end defvar + +@defvar gnus-group-spam-exit-processor-blacklist + +Add this symbol to a group's @code{spam-process} parameter by +customizing the group parameters or the +@code{gnus-spam-process-newsgroups} variable. When this symbol is +added to a group's @code{spam-process} parameter, the senders of +spam-marked articles will be added to the blacklist. + +@emph{WARNING} + +Instead of the obsolete +@code{gnus-group-spam-exit-processor-blacklist}, it is recommended +that you use @code{'(spam spam-use-blacklist)}. Everything will work +the same way, we promise. + +@end defvar + +@defvar gnus-group-ham-exit-processor-whitelist + +Add this symbol to a group's @code{spam-process} parameter by +customizing the group parameters or the +@code{gnus-spam-process-newsgroups} variable. When this symbol is +added to a group's @code{spam-process} parameter, the senders of +ham-marked articles in @emph{ham} groups will be added to the +whitelist. Note that this ham processor has no effect in @emph{spam} +or @emph{unclassified} groups. + +@emph{WARNING} + +Instead of the obsolete +@code{gnus-group-ham-exit-processor-whitelist}, it is recommended +that you use @code{'(ham spam-use-whitelist)}. Everything will work +the same way, we promise. + +@end defvar + +Blacklists are lists of regular expressions matching addresses you +consider to be spam senders. For instance, to block mail from any +sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your +blacklist. You start out with an empty blacklist. Blacklist entries +use the Emacs regular expression syntax. + +Conversely, whitelists tell Gnus what addresses are considered +legitimate. All messages from whitelisted addresses are considered +non-spam. Also see @ref{BBDB Whitelists}. Whitelist entries use the +Emacs regular expression syntax. + +The blacklist and whitelist file locations can be customized with the +@code{spam-directory} variable (@file{~/News/spam} by default), or +the @code{spam-whitelist} and @code{spam-blacklist} variables +directly. The whitelist and blacklist files will by default be in the +@code{spam-directory} directory, named @file{whitelist} and +@file{blacklist} respectively. + +@node BBDB Whitelists +@subsubsection BBDB Whitelists +@cindex spam filtering +@cindex BBDB whitelists, spam filtering +@cindex BBDB, spam filtering +@cindex spam + +@defvar spam-use-BBDB + +Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and +Whitelists}), but uses the BBDB as the source of whitelisted +addresses, without regular expressions. You must have the BBDB loaded +for @code{spam-use-BBDB} to work properly. Messages whose senders are +not in the BBDB will be sent to the next spam-split rule. This is an +explicit filter, meaning that unless someone is in the BBDB, their +messages are not assumed to be spam or ham. + +@end defvar + +@defvar spam-use-BBDB-exclusive + +Set this variable to @code{t} if you want to use the BBDB as an +implicit filter, meaning that every message will be considered spam +unless the sender is in the BBDB. Use with care. Only sender +addresses in the BBDB will be allowed through; all others will be +classified as spammers. + +@end defvar + +@defvar gnus-group-ham-exit-processor-BBDB + +Add this symbol to a group's @code{spam-process} parameter by +customizing the group parameters or the +@code{gnus-spam-process-newsgroups} variable. When this symbol is +added to a group's @code{spam-process} parameter, the senders of +ham-marked articles in @emph{ham} groups will be added to the +BBDB. Note that this ham processor has no effect in @emph{spam} +or @emph{unclassified} groups. + +@emph{WARNING} + +Instead of the obsolete +@code{gnus-group-ham-exit-processor-BBDB}, it is recommended +that you use @code{'(ham spam-use-BBDB)}. Everything will work +the same way, we promise. + +@end defvar + +@node Gmane Spam Reporting +@subsubsection Gmane Spam Reporting +@cindex spam reporting +@cindex Gmane, spam reporting +@cindex Gmane, spam reporting +@cindex spam + +@defvar gnus-group-spam-exit-processor-report-gmane + +Add this symbol to a group's @code{spam-process} parameter by +customizing the group parameters or the +@code{gnus-spam-process-newsgroups} variable. When this symbol is +added to a group's @code{spam-process} parameter, the spam-marked +articles groups will be reported to the Gmane administrators via a +HTTP request. + +Gmane can be found at @uref{http://gmane.org}. + +@emph{WARNING} + +Instead of the obsolete +@code{gnus-group-spam-exit-processor-report-gmane}, it is recommended +that you use @code{'(spam spam-use-gmane)}. Everything will work the +same way, we promise. + +@end defvar + +@defvar spam-report-gmane-use-article-number + +This variable is @code{t} by default. Set it to @code{nil} if you are +running your own news server, for instance, and the local article +numbers don't correspond to the Gmane article numbers. When +@code{spam-report-gmane-use-article-number} is @code{nil}, +@code{spam-report.el} will use the @code{X-Report-Spam} header that +Gmane provides. + +@end defvar + +@node Anti-spam Hashcash Payments +@subsubsection Anti-spam Hashcash Payments +@cindex spam filtering +@cindex hashcash, spam filtering +@cindex spam + +@defvar spam-use-hashcash + +Similar to @code{spam-use-whitelist} (@pxref{Blacklists and +Whitelists}), but uses hashcash tokens for whitelisting messages +instead of the sender address. You must have the @code{hashcash.el} +package loaded for @code{spam-use-hashcash} to work properly. +Messages without a hashcash payment token will be sent to the next +spam-split rule. This is an explicit filter, meaning that unless a +hashcash token is found, the messages are not assumed to be spam or +ham. + +@end defvar + +@node Blackholes +@subsubsection Blackholes +@cindex spam filtering +@cindex blackholes, spam filtering +@cindex spam + +@defvar spam-use-blackholes + +This option is disabled by default. You can let Gnus consult the +blackhole-type distributed spam processing systems (DCC, for instance) +when you set this option. The variable @code{spam-blackhole-servers} +holds the list of blackhole servers Gnus will consult. The current +list is fairly comprehensive, but make sure to let us know if it +contains outdated servers. + +The blackhole check uses the @code{dig.el} package, but you can tell +@file{spam.el} to use @code{dns.el} instead for better performance if +you set @code{spam-use-dig} to @code{nil}. It is not recommended at +this time to set @code{spam-use-dig} to @code{nil} despite the +possible performance improvements, because some users may be unable to +use it, but you can try it and see if it works for you. + +@end defvar + +@defvar spam-blackhole-servers + +The list of servers to consult for blackhole checks. + +@end defvar + +@defvar spam-blackhole-good-server-regex + +A regular expression for IPs that should not be checked against the +blackhole server list. When set to @code{nil}, it has no effect. + +@end defvar + +@defvar spam-use-dig + +Use the @code{dig.el} package instead of the @code{dns.el} package. +The default setting of @code{t} is recommended. + +@end defvar + +Blackhole checks are done only on incoming mail. There is no spam or +ham processor for blackholes. + +@node Regular Expressions Header Matching +@subsubsection Regular Expressions Header Matching +@cindex spam filtering +@cindex regular expressions header matching, spam filtering +@cindex spam + +@defvar spam-use-regex-headers + +This option is disabled by default. You can let Gnus check the +message headers against lists of regular expressions when you set this +option. The variables @code{spam-regex-headers-spam} and +@code{spam-regex-headers-ham} hold the list of regular expressions. +Gnus will check against the message headers to determine if the +message is spam or ham, respectively. + +@end defvar + +@defvar spam-regex-headers-spam + +The list of regular expressions that, when matched in the headers of +the message, positively identify it as spam. + +@end defvar + +@defvar spam-regex-headers-ham + +The list of regular expressions that, when matched in the headers of +the message, positively identify it as ham. + +@end defvar + +Regular expression header checks are done only on incoming mail. +There is no specific spam or ham processor for regular expressions. + +@node Bogofilter +@subsubsection Bogofilter +@cindex spam filtering +@cindex bogofilter, spam filtering +@cindex spam + +@defvar spam-use-bogofilter + +Set this variable if you want @code{spam-split} to use Eric Raymond's +speedy Bogofilter. + +With a minimum of care for associating the @samp{$} mark for spam +articles only, Bogofilter training all gets fairly automatic. You +should do this until you get a few hundreds of articles in each +category, spam or not. The command @kbd{S t} in summary mode, either +for debugging or for curiosity, shows the @emph{spamicity} score of +the current article (between 0.0 and 1.0). + +Bogofilter determines if a message is spam based on a specific +threshold. That threshold can be customized, consult the Bogofilter +documentation. + +If the @code{bogofilter} executable is not in your path, Bogofilter +processing will be turned off. + +You should not enable this if you use @code{spam-use-bogofilter-headers}. + +@end defvar + +@defvar spam-use-bogofilter-headers + +Set this variable if you want @code{spam-split} to use Eric Raymond's +speedy Bogofilter, looking only at the message headers. It works +similarly to @code{spam-use-bogofilter}, but the @code{X-Bogosity} header +must be in the message already. Normally you would do this with a +procmail recipe or something similar; consult the Bogofilter +installation documents for details. + +You should not enable this if you use @code{spam-use-bogofilter}. + +@end defvar + +@defvar gnus-group-spam-exit-processor-bogofilter +Add this symbol to a group's @code{spam-process} parameter by +customizing the group parameters or the +@code{gnus-spam-process-newsgroups} variable. When this symbol is +added to a group's @code{spam-process} parameter, spam-marked articles +will be added to the Bogofilter spam database. + +@emph{WARNING} + +Instead of the obsolete +@code{gnus-group-spam-exit-processor-bogofilter}, it is recommended +that you use @code{'(spam spam-use-bogofilter)}. Everything will work +the same way, we promise. +@end defvar + +@defvar gnus-group-ham-exit-processor-bogofilter +Add this symbol to a group's @code{spam-process} parameter by +customizing the group parameters or the +@code{gnus-spam-process-newsgroups} variable. When this symbol is +added to a group's @code{spam-process} parameter, the ham-marked +articles in @emph{ham} groups will be added to the Bogofilter database +of non-spam messages. Note that this ham processor has no effect in +@emph{spam} or @emph{unclassified} groups. + +@emph{WARNING} + +Instead of the obsolete +@code{gnus-group-ham-exit-processor-bogofilter}, it is recommended +that you use @code{'(ham spam-use-bogofilter)}. Everything will work +the same way, we promise. +@end defvar + +@defvar spam-bogofilter-database-directory + +This is the directory where Bogofilter will store its databases. It +is not specified by default, so Bogofilter will use its own default +database directory. + +@end defvar + +The Bogofilter mail classifier is similar to @command{ifile} in intent and +purpose. A ham and a spam processor are provided, plus the +@code{spam-use-bogofilter} and @code{spam-use-bogofilter-headers} +variables to indicate to spam-split that Bogofilter should either be +used, or has already been used on the article. The 0.9.2.1 version of +Bogofilter was used to test this functionality. + +@node ifile spam filtering +@subsubsection ifile spam filtering +@cindex spam filtering +@cindex ifile, spam filtering +@cindex spam + +@defvar spam-use-ifile + +Enable this variable if you want @code{spam-split} to use @command{ifile}, a +statistical analyzer similar to Bogofilter. + +@end defvar + +@defvar spam-ifile-all-categories + +Enable this variable if you want @code{spam-use-ifile} to give you all +the ifile categories, not just spam/non-spam. If you use this, make +sure you train ifile as described in its documentation. + +@end defvar + +@defvar spam-ifile-spam-category + +This is the category of spam messages as far as ifile is concerned. +The actual string used is irrelevant, but you probably want to leave +the default value of @samp{spam}. +@end defvar + +@defvar spam-ifile-database-path + +This is the filename for the ifile database. It is not specified by +default, so ifile will use its own default database name. + +@end defvar + +The ifile mail classifier is similar to Bogofilter in intent and +purpose. A ham and a spam processor are provided, plus the +@code{spam-use-ifile} variable to indicate to spam-split that ifile +should be used. The 1.2.1 version of ifile was used to test this +functionality. + +@node spam-stat spam filtering +@subsubsection spam-stat spam filtering +@cindex spam filtering +@cindex spam-stat, spam filtering +@cindex spam-stat +@cindex spam + +@xref{Filtering Spam Using Statistics with spam-stat}. + +@defvar spam-use-stat + +Enable this variable if you want @code{spam-split} to use +spam-stat.el, an Emacs Lisp statistical analyzer. + +@end defvar + +@defvar gnus-group-spam-exit-processor-stat +Add this symbol to a group's @code{spam-process} parameter by +customizing the group parameters or the +@code{gnus-spam-process-newsgroups} variable. When this symbol is +added to a group's @code{spam-process} parameter, the spam-marked +articles will be added to the spam-stat database of spam messages. + +@emph{WARNING} + +Instead of the obsolete +@code{gnus-group-spam-exit-processor-stat}, it is recommended +that you use @code{'(spam spam-use-stat)}. Everything will work +the same way, we promise. +@end defvar + +@defvar gnus-group-ham-exit-processor-stat +Add this symbol to a group's @code{spam-process} parameter by +customizing the group parameters or the +@code{gnus-spam-process-newsgroups} variable. When this symbol is +added to a group's @code{spam-process} parameter, the ham-marked +articles in @emph{ham} groups will be added to the spam-stat database +of non-spam messages. Note that this ham processor has no effect in +@emph{spam} or @emph{unclassified} groups. + +@emph{WARNING} + +Instead of the obsolete +@code{gnus-group-ham-exit-processor-stat}, it is recommended +that you use @code{'(ham spam-use-stat)}. Everything will work +the same way, we promise. +@end defvar + +This enables @file{spam.el} to cooperate with @file{spam-stat.el}. +@file{spam-stat.el} provides an internal (Lisp-only) spam database, +which unlike ifile or Bogofilter does not require external programs. +A spam and a ham processor, and the @code{spam-use-stat} variable for +@code{spam-split} are provided. + +@node SpamOracle +@subsubsection Using SpamOracle with Gnus +@cindex spam filtering +@cindex SpamOracle +@cindex spam + +An easy way to filter out spam is to use SpamOracle. SpamOracle is an +statistical mail filtering tool written by Xavier Leroy and needs to be +installed separately. + +There are several ways to use SpamOracle with Gnus. In all cases, your +mail is piped through SpamOracle in its @emph{mark} mode. SpamOracle will +then enter an @samp{X-Spam} header indicating whether it regards the +mail as a spam mail or not. + +One possibility is to run SpamOracle as a @code{:prescript} from the +@xref{Mail Source Specifiers}, (@pxref{SpamAssassin}). This method has +the advantage that the user can see the @emph{X-Spam} headers. + +The easiest method is to make @file{spam.el} (@pxref{Filtering Spam +Using The Spam ELisp Package}) call SpamOracle. + +@vindex spam-use-spamoracle +To enable SpamOracle usage by @file{spam.el}, set the variable +@code{spam-use-spamoracle} to @code{t} and configure the +@code{nnmail-split-fancy} or @code{nnimap-split-fancy} as described in +the section @xref{Filtering Spam Using The Spam ELisp Package}. In +this example the @samp{INBOX} of an nnimap server is filtered using +SpamOracle. Mails recognized as spam mails will be moved to +@code{spam-split-group}, @samp{Junk} in this case. Ham messages stay +in @samp{INBOX}: + +@example +(setq spam-use-spamoracle t + spam-split-group "Junk" + nnimap-split-inbox '("INBOX") + nnimap-split-rule 'nnimap-split-fancy + nnimap-split-fancy '(| (: spam-split) "INBOX")) +@end example + +@defvar spam-use-spamoracle +Set to @code{t} if you want Gnus to enable spam filtering using +SpamOracle. +@end defvar + +@defvar spam-spamoracle-binary +Gnus uses the SpamOracle binary called @file{spamoracle} found in the +user's PATH. Using the variable @code{spam-spamoracle-binary}, this +can be customized. +@end defvar + +@defvar spam-spamoracle-database +By default, SpamOracle uses the file @file{~/.spamoracle.db} as a database to +store its analyses. This is controlled by the variable +@code{spam-spamoracle-database} which defaults to @code{nil}. That means +the default SpamOracle database will be used. In case you want your +database to live somewhere special, set +@code{spam-spamoracle-database} to this path. +@end defvar + +SpamOracle employs a statistical algorithm to determine whether a +message is spam or ham. In order to get good results, meaning few +false hits or misses, SpamOracle needs training. SpamOracle learns the +characteristics of your spam mails. Using the @emph{add} mode +(training mode) one has to feed good (ham) and spam mails to +SpamOracle. This can be done by pressing @kbd{|} in the Summary buffer +and pipe the mail to a SpamOracle process or using @file{spam.el}'s +spam- and ham-processors, which is much more convenient. For a +detailed description of spam- and ham-processors, @xref{Filtering Spam +Using The Spam ELisp Package}. + +@defvar gnus-group-spam-exit-processor-spamoracle +Add this symbol to a group's @code{spam-process} parameter by +customizing the group parameter or the +@code{gnus-spam-process-newsgroups} variable. When this symbol is added +to a group's @code{spam-process} parameter, spam-marked articles will be +sent to SpamOracle as spam samples. + +@emph{WARNING} + +Instead of the obsolete +@code{gnus-group-spam-exit-processor-spamoracle}, it is recommended +that you use @code{'(spam spam-use-spamoracle)}. Everything will work +the same way, we promise. +@end defvar + +@defvar gnus-group-ham-exit-processor-spamoracle +Add this symbol to a group's @code{spam-process} parameter by +customizing the group parameter or the +@code{gnus-spam-process-newsgroups} variable. When this symbol is added +to a grup's @code{spam-process} parameter, the ham-marked articles in +@emph{ham} groups will be sent to the SpamOracle as samples of ham +messages. Note that this ham processor has no effect in @emph{spam} or +@emph{unclassified} groups. + +@emph{WARNING} + +Instead of the obsolete +@code{gnus-group-ham-exit-processor-spamoracle}, it is recommended +that you use @code{'(ham spam-use-spamoracle)}. Everything will work +the same way, we promise. +@end defvar + +@emph{Example:} These are the Group Parameters of a group that has been +classified as a ham group, meaning that it should only contain ham +messages. +@example + ((spam-contents gnus-group-spam-classification-ham) + (spam-process ((ham spam-use-spamoracle) + (spam spam-use-spamoracle)))) +@end example +For this group the @code{spam-use-spamoracle} is installed for both +ham and spam processing. If the group contains spam message +(e.g. because SpamOracle has not had enough sample messages yet) and +the user marks some messages as spam messages, these messages will be +processed by SpamOracle. The processor sends the messages to +SpamOracle as new samples for spam. + +@node Extending the Spam ELisp package +@subsubsection Extending the Spam ELisp package +@cindex spam filtering +@cindex spam elisp package, extending +@cindex extending the spam elisp package + +Say you want to add a new back end called blackbox. For filtering +incoming mail, provide the following: + +@enumerate + +@item +code + +@lisp +(defvar spam-use-blackbox nil + "True if blackbox should be used.") +@end lisp + +Add +@example + (spam-use-blackbox . spam-check-blackbox) +@end example +to @code{spam-list-of-checks}. + +Add +@example + (gnus-group-ham-exit-processor-blackbox ham spam-use-blackbox) + (gnus-group-spam-exit-processor-blackbox spam spam-use-blackbox) +@end example +to @code{spam-list-of-processors}. + +Add +@example + (spam-use-blackbox spam-blackbox-register-routine + nil + spam-blackbox-unregister-routine + nil) +@end example +to @code{spam-registration-functions}. Write the register/unregister +routines using the bogofilter register/unregister routines as a +start, or other restister/unregister routines more appropriate to +Blackbox. + +@item +functionality + +Write the @code{spam-check-blackbox} function. It should return +@samp{nil} or @code{spam-split-group}, observing the other +conventions. See the existing @code{spam-check-*} functions for +examples of what you can do, and stick to the template unless you +fully understand the reasons why you aren't. + +Make sure to add @code{spam-use-blackbox} to +@code{spam-list-of-statistical-checks} if Blackbox is a statistical +mail analyzer that needs the full message body to operate. + +@end enumerate + +For processing spam and ham messages, provide the following: + +@enumerate + +@item +code + +Note you don't have to provide a spam or a ham processor. Only +provide them if Blackbox supports spam or ham processing. + +Also, ham and spam processors are being phased out as single +variables. Instead the form @code{'(spam spam-use-blackbox)} or +@code{'(ham spam-use-blackbox)} is favored. For now, spam/ham +processor variables are still around but they won't be for long. + +@lisp +(defvar gnus-group-spam-exit-processor-blackbox "blackbox-spam" + "The Blackbox summary exit spam processor. +Only applicable to spam groups.") + +(defvar gnus-group-ham-exit-processor-blackbox "blackbox-ham" + "The whitelist summary exit ham processor. +Only applicable to non-spam (unclassified and ham) groups.") + +@end lisp + +@item +Gnus parameters + +Add +@example + (const :tag "Spam: Blackbox" (spam spam-use-blackbox)) + (const :tag "Ham: Blackbox" (ham spam-use-blackbox)) +@end example +to the @code{spam-process} group parameter in @code{gnus.el}. Make +sure you do it twice, once for the parameter and once for the +variable customization. + +Add +@example + (variable-item spam-use-blackbox) +@end example +to the @code{spam-autodetect-methods} group parameter in +@code{gnus.el}. + +@end enumerate + + +@node Filtering Spam Using Statistics with spam-stat +@subsection Filtering Spam Using Statistics with spam-stat +@cindex Paul Graham +@cindex Graham, Paul +@cindex naive Bayesian spam filtering +@cindex Bayesian spam filtering, naive +@cindex spam filtering, naive Bayesian + +Paul Graham has written an excellent essay about spam filtering using +statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for +Spam}. In it he describes the inherent deficiency of rule-based +filtering as used by SpamAssassin, for example: Somebody has to write +the rules, and everybody else has to install these rules. You are +always late. It would be much better, he argues, to filter mail based +on whether it somehow resembles spam or non-spam. One way to measure +this is word distribution. He then goes on to describe a solution +that checks whether a new mail resembles any of your other spam mails +or not. + +The basic idea is this: Create a two collections of your mail, one +with spam, one with non-spam. Count how often each word appears in +either collection, weight this by the total number of mails in the +collections, and store this information in a dictionary. For every +word in a new mail, determine its probability to belong to a spam or a +non-spam mail. Use the 15 most conspicuous words, compute the total +probability of the mail being spam. If this probability is higher +than a certain threshold, the mail is considered to be spam. + +Gnus supports this kind of filtering. But it needs some setting up. +First, you need two collections of your mail, one with spam, one with +non-spam. Then you need to create a dictionary using these two +collections, and save it. And last but not least, you need to use +this dictionary in your fancy mail splitting rules. + +@menu +* Creating a spam-stat dictionary:: +* Splitting mail using spam-stat:: +* Low-level interface to the spam-stat dictionary:: +@end menu + +@node Creating a spam-stat dictionary +@subsubsection Creating a spam-stat dictionary + +Before you can begin to filter spam based on statistics, you must +create these statistics based on two mail collections, one with spam, +one with non-spam. These statistics are then stored in a dictionary +for later use. In order for these statistics to be meaningful, you +need several hundred emails in both collections. + +Gnus currently supports only the nnml back end for automated dictionary +creation. The nnml back end stores all mails in a directory, one file +per mail. Use the following: + +@defun spam-stat-process-spam-directory +Create spam statistics for every file in this directory. Every file +is treated as one spam mail. +@end defun + +@defun spam-stat-process-non-spam-directory +Create non-spam statistics for every file in this directory. Every +file is treated as one non-spam mail. +@end defun + +Usually you would call @code{spam-stat-process-spam-directory} on a +directory such as @file{~/Mail/mail/spam} (this usually corresponds +the the group @samp{nnml:mail.spam}), and you would call +@code{spam-stat-process-non-spam-directory} on a directory such as +@file{~/Mail/mail/misc} (this usually corresponds the the group +@samp{nnml:mail.misc}). + +When you are using @acronym{IMAP}, you won't have the mails available +locally, so that will not work. One solution is to use the Gnus Agent +to cache the articles. Then you can use directories such as +@file{"~/News/agent/nnimap/mail.yourisp.com/personal_spam"} for +@code{spam-stat-process-spam-directory}. @xref{Agent as Cache}. + +@defvar spam-stat +This variable holds the hash-table with all the statistics---the +dictionary we have been talking about. For every word in either +collection, this hash-table stores a vector describing how often the +word appeared in spam and often it appeared in non-spam mails. +@end defvar + +If you want to regenerate the statistics from scratch, you need to +reset the dictionary. + +@defun spam-stat-reset +Reset the @code{spam-stat} hash-table, deleting all the statistics. +@end defun + +When you are done, you must save the dictionary. The dictionary may +be rather large. If you will not update the dictionary incrementally +(instead, you will recreate it once a month, for example), then you +can reduce the size of the dictionary by deleting all words that did +not appear often enough or that do not clearly belong to only spam or +only non-spam mails. + +@defun spam-stat-reduce-size +Reduce the size of the dictionary. Use this only if you do not want +to update the dictionary incrementally. +@end defun + +@defun spam-stat-save +Save the dictionary. +@end defun + +@defvar spam-stat-file +The filename used to store the dictionary. This defaults to +@file{~/.spam-stat.el}. +@end defvar + +@node Splitting mail using spam-stat +@subsubsection Splitting mail using spam-stat + +In order to use @code{spam-stat} to split your mail, you need to add the +following to your @file{~/.gnus.el} file: + +@lisp +(require 'spam-stat) +(spam-stat-load) +@end lisp + +This will load the necessary Gnus code, and the dictionary you +created. + +Next, you need to adapt your fancy splitting rules: You need to +determine how to use @code{spam-stat}. The following examples are for +the nnml back end. Using the nnimap back end works just as well. Just +use @code{nnimap-split-fancy} instead of @code{nnmail-split-fancy}. + +In the simplest case, you only have two groups, @samp{mail.misc} and +@samp{mail.spam}. The following expression says that mail is either +spam or it should go into @samp{mail.misc}. If it is spam, then +@code{spam-stat-split-fancy} will return @samp{mail.spam}. + +@lisp +(setq nnmail-split-fancy + `(| (: spam-stat-split-fancy) + "mail.misc")) +@end lisp + +@defvar spam-stat-split-fancy-spam-group +The group to use for spam. Default is @samp{mail.spam}. +@end defvar + +If you also filter mail with specific subjects into other groups, use +the following expression. Only mails not matching the regular +expression are considered potential spam. + +@lisp +(setq nnmail-split-fancy + `(| ("Subject" "\\bspam-stat\\b" "mail.emacs") + (: spam-stat-split-fancy) + "mail.misc")) +@end lisp + +If you want to filter for spam first, then you must be careful when +creating the dictionary. Note that @code{spam-stat-split-fancy} must +consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as +non-spam, therefore both should be in your collection of non-spam +mails, when creating the dictionary! + +@lisp +(setq nnmail-split-fancy + `(| (: spam-stat-split-fancy) + ("Subject" "\\bspam-stat\\b" "mail.emacs") + "mail.misc")) +@end lisp + +You can combine this with traditional filtering. Here, we move all +HTML-only mails into the @samp{mail.spam.filtered} group. Note that since +@code{spam-stat-split-fancy} will never see them, the mails in +@samp{mail.spam.filtered} should be neither in your collection of spam mails, +nor in your collection of non-spam mails, when creating the +dictionary! + +@lisp +(setq nnmail-split-fancy + `(| ("Content-Type" "text/html" "mail.spam.filtered") + (: spam-stat-split-fancy) + ("Subject" "\\bspam-stat\\b" "mail.emacs") + "mail.misc")) +@end lisp + + +@node Low-level interface to the spam-stat dictionary +@subsubsection Low-level interface to the spam-stat dictionary + +The main interface to using @code{spam-stat}, are the following functions: + +@defun spam-stat-buffer-is-spam +Called in a buffer, that buffer is considered to be a new spam mail. +Use this for new mail that has not been processed before. +@end defun + +@defun spam-stat-buffer-is-no-spam +Called in a buffer, that buffer is considered to be a new non-spam +mail. Use this for new mail that has not been processed before. +@end defun + +@defun spam-stat-buffer-change-to-spam +Called in a buffer, that buffer is no longer considered to be normal +mail but spam. Use this to change the status of a mail that has +already been processed as non-spam. +@end defun + +@defun spam-stat-buffer-change-to-non-spam +Called in a buffer, that buffer is no longer considered to be spam but +normal mail. Use this to change the status of a mail that has already +been processed as spam. +@end defun + +@defun spam-stat-save +Save the hash table to the file. The filename used is stored in the +variable @code{spam-stat-file}. +@end defun + +@defun spam-stat-load +Load the hash table from a file. The filename used is stored in the +variable @code{spam-stat-file}. +@end defun + +@defun spam-stat-score-word +Return the spam score for a word. +@end defun + +@defun spam-stat-score-buffer +Return the spam score for a buffer. +@end defun + +@defun spam-stat-split-fancy +Use this function for fancy mail splitting. Add the rule @samp{(: +spam-stat-split-fancy)} to @code{nnmail-split-fancy} +@end defun + +Make sure you load the dictionary before using it. This requires the +following in your @file{~/.gnus.el} file: + +@lisp +(require 'spam-stat) +(spam-stat-load) +@end lisp + +Typical test will involve calls to the following functions: + +@smallexample +Reset: (setq spam-stat (make-hash-table :test 'equal)) +Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam") +Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc") +Save table: (spam-stat-save) +File size: (nth 7 (file-attributes spam-stat-file)) +Number of words: (hash-table-count spam-stat) +Test spam: (spam-stat-test-directory "~/Mail/mail/spam") +Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc") +Reduce table size: (spam-stat-reduce-size) +Save table: (spam-stat-save) +File size: (nth 7 (file-attributes spam-stat-file)) +Number of words: (hash-table-count spam-stat) +Test spam: (spam-stat-test-directory "~/Mail/mail/spam") +Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc") +@end smallexample + +Here is how you would create your dictionary: + +@smallexample +Reset: (setq spam-stat (make-hash-table :test 'equal)) +Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam") +Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc") +Repeat for any other non-spam group you need... +Reduce table size: (spam-stat-reduce-size) +Save table: (spam-stat-save) +@end smallexample + +@node Other modes +@section Interaction with other modes + +@subsection Dired +@cindex dired + +@code{gnus-dired-minor-mode} provided some useful functions for dired +buffers. It is enabled with +@lisp +(add-hook 'dired-mode-hook 'turn-on-gnus-dired-mode) +@end lisp + +@table @kbd +@item C-c C-m C-a +@findex gnus-dired-attach +Send dired's marked files as an attachment (@code{gnus-dired-attach}). +You will be prompted for a message buffer. + +@item C-c C-m C-l +@findex gnus-dired-find-file-mailcap +Visit a file according to the appropriate mailcap entry +(@code{gnus-dired-find-file-mailcap}). With prefix, open file in a new +buffer. + +@item C-c C-m C-p +@findex gnus-dired-print +Print file according to the mailcap entry (@code{gnus-dired-print}). If +there is no print command, print in a PostScript image. +@end table @node Various Various @section Various Various @@ -18710,19 +24094,20 @@ @table @code @item gnus-home-directory +@vindex gnus-home-directory All Gnus file and directory variables will be initialized from this variable, which defaults to @file{~/}. @item gnus-directory @vindex gnus-directory Most Gnus storage file and directory variables will be initialized from -this variable, which defaults to the @samp{SAVEDIR} environment +this variable, which defaults to the @env{SAVEDIR} environment variable, or @file{~/News/} if that variable isn't set. -Note that Gnus is mostly loaded when the @file{.gnus.el} file is read. +Note that Gnus is mostly loaded when the @file{~/.gnus.el} file is read. This means that other directory variables that are initialized from this variable won't be set properly if you set this variable in -@file{.gnus.el}. Set this variable in @file{.emacs} instead. +@file{~/.gnus.el}. Set this variable in @file{.emacs} instead. @item gnus-default-directory @vindex gnus-default-directory @@ -18772,8 +24157,10 @@ on your system (you OS/2 user you), you could say something like: @lisp +@group (setq nnheader-file-name-translation-alist '((?: . ?_))) +@end group @end lisp In fact, this is the default value for this variable on OS/2 and MS @@ -18804,11 +24191,10 @@ @samp{:} in a group name, which is normally used to delimit method and group). -@sc{imap} users might want to allow @samp{/} in group names though. - - -@end table - +@acronym{IMAP} users might want to allow @samp{/} in group names though. + + +@end table @node The End @chapter The End @@ -18844,15 +24230,29 @@ @chapter Appendices @menu -* History:: How Gnus got where it is today. -* On Writing Manuals:: Why this is not a beginner's guide. -* Terminology:: We use really difficult, like, words here. -* Customization:: Tailoring Gnus to your needs. -* Troubleshooting:: What you might try if things do not work. -* Gnus Reference Guide:: Rilly, rilly technical stuff. -* Emacs for Heathens:: A short introduction to Emacsian terms. -* Frequently Asked Questions:: A question-and-answer session. -@end menu +* XEmacs:: Requirements for installing under XEmacs. +* History:: How Gnus got where it is today. +* On Writing Manuals:: Why this is not a beginner's guide. +* Terminology:: We use really difficult, like, words here. +* Customization:: Tailoring Gnus to your needs. +* Troubleshooting:: What you might try if things do not work. +* Gnus Reference Guide:: Rilly, rilly technical stuff. +* Emacs for Heathens:: A short introduction to Emacsian terms. +* Frequently Asked Questions:: The Gnus FAQ +@end menu + + +@node XEmacs +@section XEmacs +@cindex XEmacs +@cindex installing under XEmacs + +XEmacs is distributed as a collection of packages. You should install +whatever packages the Gnus XEmacs package requires. The current +requirements are @samp{gnus}, @samp{mail-lib}, @samp{xemacs-base}, +@samp{eterm}, @samp{sh-script}, @samp{net-utils}, @samp{os-utils}, +@samp{dired}, @samp{mh-e}, @samp{sieve}, @samp{ps-print}, @samp{w3}, +@samp{pgg}, @samp{mailcrypt}, @samp{ecrypto}, and @samp{sasl}. @node History @@ -18881,24 +24281,28 @@ ``@sc{gnus}''. New vs. old. @menu -* Gnus Versions:: What Gnus versions have been released. -* Other Gnus Versions:: Other Gnus versions that also have been released. -* Why?:: What's the point of Gnus? -* Compatibility:: Just how compatible is Gnus with @sc{gnus}? -* Conformity:: Gnus tries to conform to all standards. -* Emacsen:: Gnus can be run on a few modern Emacsen. -* Gnus Development:: How Gnus is developed. -* Contributors:: Oodles of people. -* New Features:: Pointers to some of the new stuff in Gnus. +* Gnus Versions:: What Gnus versions have been released. +* Other Gnus Versions:: Other Gnus versions that also have been released. +* Why?:: What's the point of Gnus? +* Compatibility:: Just how compatible is Gnus with @sc{gnus}? +* Conformity:: Gnus tries to conform to all standards. +* Emacsen:: Gnus can be run on a few modern Emacsen. +* Gnus Development:: How Gnus is developed. +* Contributors:: Oodles of people. +* New Features:: Pointers to some of the new stuff in Gnus. @end menu @node Gnus Versions @subsection Gnus Versions -@cindex Pterodactyl Gnus @cindex ding Gnus @cindex September Gnus +@cindex Red Gnus @cindex Quassia Gnus +@cindex Pterodactyl Gnus +@cindex Oort Gnus +@cindex No Gnus +@cindex Gnus versions The first ``proper'' release of Gnus 5 was done in November 1995 when it was included in the Emacs 19.30 distribution (132 (ding) Gnus releases @@ -18917,12 +24321,14 @@ ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd 1999. +On the 26th of October 2000, Oort Gnus was begun. + If you happen upon a version of Gnus that has a prefixed name -- -``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' -- -don't panic. Don't let it know that you're frightened. Back away. -Slowly. Whatever you do, don't run. Walk away, calmly, until you're -out of its reach. Find a proper released version of Gnus and snuggle up -to that instead. +``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'', +``Pterodactyl Gnus'', ``Oort Gnus'' -- don't panic. Don't let it know +that you're frightened. Back away. Slowly. Whatever you do, don't +run. Walk away, calmly, until you're out of its reach. Find a proper +released version of Gnus and snuggle up to that instead. @node Other Gnus Versions @@ -18931,13 +24337,13 @@ In addition to the versions of Gnus which have had their releases coordinated by Lars, one major development has been Semi-gnus from -Japan. It's based on a library called @sc{semi}, which provides -@sc{mime} capabilities. +Japan. It's based on a library called @acronym{SEMI}, which provides +@acronym{MIME} capabilities. These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus. Collectively, they are called ``Semi-gnus'', and different strains are called T-gnus, ET-gnus, Nana-gnus and Chaos. These provide powerful -@sc{mime} and multilingualization things, especially important for +@acronym{MIME} and multilingualization things, especially important for Japanese users. @@ -19050,8 +24456,9 @@ @table @strong -@item RFC 822 +@item RFC (2)822 @cindex RFC 822 +@cindex RFC 2822 There are no known breaches of this standard. @item RFC 1036 @@ -19080,6 +24487,40 @@ various changes to the format of news articles. The Gnus towers will look into implementing the changes when the draft is accepted as an RFC. +@item MIME - RFC 2045-2049 etc +@cindex @acronym{MIME} +All the various @acronym{MIME} RFCs are supported. + +@item Disposition Notifications - RFC 2298 +Message Mode is able to request notifications from the receiver. + +@item PGP - RFC 1991 and RFC 2440 +@cindex RFC 1991 +@cindex RFC 2440 +RFC 1991 is the original @acronym{PGP} message specification, +published as an informational RFC. RFC 2440 was the follow-up, now +called Open PGP, and put on the Standards Track. Both document a +non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both +encoding (signing and encryption) and decoding (verification and +decryption). + +@item PGP/MIME - RFC 2015/3156 +RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC +1991) describes the @acronym{MIME}-wrapping around the RF 1991/2440 format. +Gnus supports both encoding and decoding. + +@item S/MIME - RFC 2633 +RFC 2633 describes the @acronym{S/MIME} format. + +@item IMAP - RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731 +RFC 1730 is @acronym{IMAP} version 4, updated somewhat by RFC 2060 +(@acronym{IMAP} 4 revision 1). RFC 2195 describes CRAM-MD5 +authentication for @acronym{IMAP}. RFC 2086 describes access control +lists (ACLs) for @acronym{IMAP}. RFC 2359 describes a @acronym{IMAP} +protocol enhancement. RFC 2595 describes the proper @acronym{TLS} +integration (STARTTLS) with @acronym{IMAP}. RFC 1731 describes the +GSSAPI/Kerberos4 mechanisms for @acronym{IMAP}. + @end table If you ever notice Gnus acting non-compliant with regards to the texts @@ -19094,15 +24535,15 @@ @cindex Mule @cindex Emacs -Gnus should work on : +Gnus should work on: @itemize @bullet @item -Emacs 20.3 and up. - -@item -XEmacs 20.4 and up. +Emacs 20.7 and up. + +@item +XEmacs 21.1 and up. @end itemize @@ -19169,7 +24610,7 @@ Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that ``worser''? ``much worser''? ``worsest''?) -I would like to take this opportunity to thank the Academy for... oops, +I would like to take this opportunity to thank the Academy for@dots{} oops, wrong show. @itemize @bullet @@ -19179,7 +24620,7 @@ @item Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el, -nnwarchive and many, many other things connected with @sc{mime} and +nnwarchive and many, many other things connected with @acronym{MIME} and other types of en/decoding, as well as general bug fixing, new functionality and stuff. @@ -19191,7 +24632,10 @@ Luis Fernandes---design and graphics. @item -Justin Sheehy--the FAQ maintainer. +Joe Reiss---creator of the smiley faces. + +@item +Justin Sheehy---the @acronym{FAQ} maintainer. @item Erik Naggum---help, ideas, support, code and stuff. @@ -19259,13 +24703,21 @@ Christopher Davis, Andrew Eskilsson, Kai Grossjohann, +Kevin Greiner, +Jesper Harder, +Paul Jarc, +Simon Josefsson, David Kågedal, Richard Pieri, Fabrice Popineau, Daniel Quinlan, +Michael Shields, +Reiner Steib, Jason L. Tibbitts, III, +Jack Vinson, +Katsumi Yamaoka, @c Yamaoka and -Jack Vinson. +Teodor Zlatanov. Also thanks to the following for patches and stuff: @@ -19336,7 +24788,7 @@ Magnus Hammerin, Kenichi Handa, @c Handa Raja R. Harinath, -Yoshiki Hayashi, @c ? +Yoshiki Hayashi, @c Hayashi P. E. Jareth Hein, Hisashige Kenji, @c Hisashige Scott Hofmann, @@ -19346,7 +24798,7 @@ Brad Howes, Miguel de Icaza, François Felix Ingrand, -Tatsuya Ichikawa, @c ? +Tatsuya Ichikawa, @c Ichikawa Ishikawa Ichiro, @c Ishikawa Lee Iverson, Iwamuro Motonori, @c Iwamuro @@ -19356,7 +24808,6 @@ Randell Jesup, Fred Johansen, Gareth Jones, -Simon Josefsson, Greg Klanderman, Karl Kleinpaste, Michael Klingbeil, @@ -19460,7 +24911,6 @@ Christoph Wedler, Joe Wells, Lee Willis, -Katsumi Yamaoka @c Yamaoka and Lloyd Zusman. @@ -19481,11 +24931,12 @@ @cindex new features @menu -* ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus. -* September Gnus:: The Thing Formally Known As Gnus 5.2/5.3. -* Red Gnus:: Third time best---Gnus 5.4/5.5. -* Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7. -* Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9. +* ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus. +* September Gnus:: The Thing Formally Known As Gnus 5.2/5.3. +* Red Gnus:: Third time best---Gnus 5.4/5.5. +* Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7. +* Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9. +* Oort Gnus:: It's big. It's far out. Gnus 5.10. @end menu These lists are, of course, just @emph{short} overviews of the @@ -19504,7 +24955,7 @@ (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}). @item -Local spool and several @sc{nntp} servers can be used at once +Local spool and several @acronym{NNTP} servers can be used at once (@pxref{Select Methods}). @item @@ -19545,8 +24996,8 @@ read if your machine should go down (@pxref{Auto Save}). @item -Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up -the @file{.emacs} file. +Gnus now has its own startup file (@file{~/.gnus.el}) to avoid +cluttering up the @file{.emacs} file. @item You can set the process mark on both groups and articles and perform @@ -19584,7 +25035,7 @@ glitches (@pxref{Finding the Parent}). @item -Gnus can fetch FAQs and group descriptions (@pxref{Group Information}). +Gnus can fetch @acronym{FAQ}s and group descriptions (@pxref{Group Information}). @item Digests (and other files) can be used as the basis for groups @@ -19600,7 +25051,7 @@ @item You can do lots of strange stuff with the Gnus window & frame -configuration (@pxref{Windows Configuration}). +configuration (@pxref{Window Layout}). @item You can click on buttons instead of using the keyboard @@ -19614,7 +25065,7 @@ @iftex @iflatex -\gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}} +\gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}} @end iflatex @end iftex @@ -19749,14 +25200,14 @@ buffer (@pxref{Article Keymap}). @item -Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows -Configuration}). +Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window +Layout}). @item Mail can be re-scanned by a daemonic process (@pxref{Daemons}). @iftex @iflatex -\marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}} +\marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}} @end iflatex @end iftex @@ -19851,7 +25302,7 @@ @iftex @iflatex -\gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}} +\gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}} @end iflatex @end iftex @@ -19890,7 +25341,7 @@ been added. @item -@code{nndoc} was rewritten to be easily extensible (@pxref{Document +@code{nndoc} was rewritten to be easily extendable (@pxref{Document Server Internals}). @item @@ -19958,7 +25409,7 @@ Marks}). @item -A new mail-to-news back end makes it possible to post even when the @sc{nntp} +A new mail-to-news back end makes it possible to post even when the @acronym{NNTP} server doesn't allow posting (@pxref{Mail-To-News Gateways}). @item @@ -19980,7 +25431,7 @@ Commands}). @iftex @iflatex -\marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}} +\marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}} @end iflatex @end iftex @@ -19997,7 +25448,7 @@ mail before saving the mail (@pxref{Washing Mail}). @item -Emphasized text can be properly fontified: +Emphasized text can be properly fontisized: @end itemize @@ -20011,11 +25462,11 @@ @item New functionality for using Gnus as an offline newsreader has been -added. A plethora of new commands and modes have been added. See -@pxref{Gnus Unplugged} for the full story. - -@item - The @code{nndraft} back end has returned, but works differently than +added. A plethora of new commands and modes have been added. +@xref{Gnus Unplugged}, for the full story. + +@item +The @code{nndraft} back end has returned, but works differently than before. All Message buffers are now also articles in the @code{nndraft} group, which is created automatically. @@ -20024,110 +25475,110 @@ values. @item - @code{gnus-summary-goto-article} now accept Message-ID's. - -@item - A new Message command for deleting text in the body of a message +@code{gnus-summary-goto-article} now accept Message-ID's. + +@item +A new Message command for deleting text in the body of a message outside the region: @kbd{C-c C-v}. @item - You can now post to component group in @code{nnvirtual} groups with +You can now post to component group in @code{nnvirtual} groups with @kbd{C-u C-c C-c}. @item @code{nntp-rlogin-program}---new variable to ease customization. @item - @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit +@code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit re-highlighting of the article buffer. @item - New element in @code{gnus-boring-article-headers}---@code{long-to}. - -@item - @kbd{M-i} symbolic prefix command. See the section "Symbolic -Prefixes" in the Gnus manual for details. - -@item - @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix -@kbd{a} to add the score rule to the "all.SCORE" file. - -@item - @code{gnus-simplify-subject-functions} variable to allow greater +New element in @code{gnus-boring-article-headers}---@code{long-to}. + +@item +@kbd{M-i} symbolic prefix command. @xref{Symbolic Prefixes}, for +details. + +@item +@kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix +@kbd{a} to add the score rule to the @file{all.SCORE} file. + +@item +@code{gnus-simplify-subject-functions} variable to allow greater control over simplification. @item - @kbd{A T}---new command for fetching the current thread. - -@item - @kbd{/ T}---new command for including the current thread in the +@kbd{A T}---new command for fetching the current thread. + +@item +@kbd{/ T}---new command for including the current thread in the limit. @item - @kbd{M-@key{RET}} is a new Message command for breaking cited text. - -@item - @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}. - -@item - The @code{custom-face-lookup} function has been removed. +@kbd{M-RET} is a new Message command for breaking cited text. + +@item +@samp{\\1}-expressions are now valid in @code{nnmail-split-methods}. + +@item +The @code{custom-face-lookup} function has been removed. If you used this function in your initialization files, you must rewrite them to use @code{face-spec-set} instead. @item - Canceling now uses the current select method. Symbolic prefix +Canceling now uses the current select method. Symbolic prefix @kbd{a} forces normal posting method. @item - New command to translate M******** sm*rtq**t*s into proper +New command to translate M******** sm*rtq**t*s into proper text---@kbd{W d}. @item - For easier debugging of @code{nntp}, you can set +For easier debugging of @code{nntp}, you can set @code{nntp-record-commands} to a non-@code{nil} value. @item - @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for -controlling where and how to send @sc{authinfo} to @sc{nntp} servers. - -@item - A command for editing group parameters from the summary buffer +@code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for +controlling where and how to send @sc{authinfo} to @acronym{NNTP} servers. + +@item +A command for editing group parameters from the summary buffer has been added. @item - A history of where mails have been split is available. - -@item - A new article date command has been added---@code{article-date-iso8601}. - -@item - Subjects can be simplified when threading by setting +A history of where mails have been split is available. + +@item +A new article date command has been added---@code{article-date-iso8601}. + +@item +Subjects can be simplified when threading by setting @code{gnus-score-thread-simplify}. @item - A new function for citing in Message has been +A new function for citing in Message has been added---@code{message-cite-original-without-signature}. @item - @code{article-strip-all-blank-lines}---new article command. - -@item - A new Message command to kill to the end of the article has +@code{article-strip-all-blank-lines}---new article command. + +@item +A new Message command to kill to the end of the article has been added. @item - A minimum adaptive score can be specified by using the +A minimum adaptive score can be specified by using the @code{gnus-adaptive-word-minimum} variable. @item - The "lapsed date" article header can be kept continually +The ``lapsed date'' article header can be kept continually updated by the @code{gnus-start-date-timer} command. @item - Web listserv archives can be read with the @code{nnlistserv} back end. - -@item - Old dejanews archives can now be read by @code{nnweb}. +Web listserv archives can be read with the @code{nnlistserv} back end. + +@item +Old dejanews archives can now be read by @code{nnweb}. @end itemize @@ -20138,7 +25589,8 @@ @itemize @bullet -@item The mail-fetching functions have changed. See the manual for the +@item +The mail-fetching functions have changed. See the manual for the many details. In particular, all procmail fetching variables are gone. If you used procmail like in @@ -20155,36 +25607,615 @@ @lisp (setq mail-sources '((directory :path "~/mail/incoming/" - :suffix ".in"))) -@end lisp - -More information is available in the info doc at Select Methods -> -Getting Mail -> Mail Sources - -@item Gnus is now a MIME-capable reader. This affects many parts of + :suffix ".in"))) +@end lisp + +@xref{Mail Source Specifiers}. + +@item +Gnus is now a @acronym{MIME}-capable reader. This affects many parts of Gnus, and adds a slew of new commands. See the manual for details. -@item Gnus has also been multilingualized. This also affects too +@item +Gnus has also been multilingualized. This also affects too many parts of Gnus to summarize here, and adds many new variables. -@item @code{gnus-auto-select-first} can now be a function to be +@item +@code{gnus-auto-select-first} can now be a function to be called to position point. -@item The user can now decide which extra headers should be included in -summary buffers and NOV files. - -@item @code{gnus-article-display-hook} has been removed. Instead, a number +@item +The user can now decide which extra headers should be included in +summary buffers and @acronym{NOV} files. + +@item +@code{gnus-article-display-hook} has been removed. Instead, a number of variables starting with @code{gnus-treat-} have been added. -@item The Gnus posting styles have been redone again and now works in a +@item +The Gnus posting styles have been redone again and now works in a subtly different manner. -@item New web-based back ends have been added: @code{nnslashdot}, +@item +New web-based back ends have been added: @code{nnslashdot}, @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped, again, to keep up with ever-changing layouts. -@item Gnus can now read IMAP mail via @code{nnimap}. - +@item +Gnus can now read @acronym{IMAP} mail via @code{nnimap}. + +@end itemize + +@node Oort Gnus +@subsubsection Oort Gnus +@cindex Oort Gnus + +New features in Gnus 5.10: + +@itemize @bullet + +@item +@kbd{F} (@code{gnus-article-followup-with-original}) and @kbd{R} +(@code{gnus-article-reply-with-original}) only yank the text in the +region if the region is active. + +@item +@code{gnus-group-read-ephemeral-group} can be called interactively, +using @kbd{G M}. + +@item +In draft groups, @kbd{e} is now bound to @code{gnus-draft-edit-message}. +Use @kbd{B w} for @code{gnus-summary-edit-article} instead. + +@item +The revised Gnus @acronym{FAQ} is included in the manual, +@xref{Frequently Asked Questions}. + +@item +Upgrading from previous (stable) version if you have used Oort. + +If you have tried Oort (the unstable Gnus branch leading to this +release) but went back to a stable version, be careful when upgrading to +this version. In particular, you will probably want to remove all +@file{.marks} (nnml) and @file{.mrk} (nnfolder) files, so that flags are +read from your @file{.newsrc.eld} instead of from the +@file{.marks}/@file{.mrk} file where this release store flags. See a +later entry for more information about marks. Note that downgrading +isn't save in general. + +@item +Article Buttons + +More buttons for URLs, mail addresses, Message-IDs, Info links, man +pages and Emacs or Gnus related references. @xref{Article Buttons}. The +variables @code{gnus-button-@var{*}-level} can be used to control the +appearance of all article buttons. @xref{Article Button Levels}. + +@item +Dired integration + +@code{gnus-dired-minor-mode} (see @ref{Other modes}) installs key +bindings in dired buffers to send a file as an attachment, open a file +using the appropriate mailcap entry, and print a file using the mailcap +entry. + +@item +Gnus can display RSS newsfeeds as a newsgroup. @xref{RSS}. + +@item +Single-part yenc encoded attachments can be decoded. + +@item +Picons + +The picons code has been reimplemented to work in GNU Emacs---some of +the previous options have been removed or renamed. + +Picons are small ``personal icons'' representing users, domain and +newsgroups, which can be displayed in the Article buffer. +@xref{Picons}. + +@item +If the new option @code{gnus-treat-body-boundary} is non-@code{nil}, a +boundary line is drawn at the end of the headers. + +@item +Retrieval of charters and control messages + +There are new commands for fetching newsgroup charters (@kbd{H c}) and +control messages (@kbd{H C}). + +@item +Delayed articles + +You can delay the sending of a message with @kbd{C-c C-j} in the Message +buffer. The messages are delivered at specified time. This is useful +for sending yourself reminders. @xref{Delayed Articles}. + +@item +If @code{auto-compression-mode} is enabled, attachments are automatically +decompressed when activated. + +@item +If the new option @code{nnml-use-compressed-files} is non-@code{nil}, +the nnml back end allows compressed message files. + +@item +Signed article headers (X-PGP-Sig) can be verified with @kbd{W p}. + +@item +The Summary Buffer uses an arrow in the fringe to indicate the current +article. Use @code{(setq gnus-summary-display-arrow nil)} to disable it. + +@item +Warn about email replies to news + +Do you often find yourself replying to news by email by mistake? Then +the new option @code{gnus-confirm-mail-reply-to-news} is just the thing for +you. + +@item +If the new option @code{gnus-summary-display-while-building} is +non-@code{nil}, the summary buffer is shown and updated as it's being +built. + +@item +The new @code{recent} mark @samp{.} indicates newly arrived messages (as +opposed to old but unread messages). + +@item +The new option @code{gnus-gcc-mark-as-read} automatically marks +Gcc articles as read. + +@item +The nndoc back end now supports mailman digests and exim bounces. + +@item +Gnus supports RFC 2369 mailing list headers, and adds a number of +related commands in mailing list groups. @xref{Mailing List}. + +@item +The Date header can be displayed in a format that can be read aloud +in English. @xref{Article Date}. + +@item +The envelope sender address can be customized when using Sendmail. +@xref{Mail Variables, Mail Variables,, message, Message Manual}. + +@item +diffs are automatically highlighted in groups matching +@code{mm-uu-diff-groups-regexp} + +@item +@acronym{TLS} wrapper shipped with Gnus + +@acronym{TLS}/@acronym{SSL} is now supported in @acronym{IMAP} and +@acronym{NNTP} via @file{tls.el} and GNUTLS. The old +@acronym{TLS}/@acronym{SSL} support via (external third party) +@file{ssl.el} and OpenSSL still works. + +@item +New @file{make.bat} for compiling and installing Gnus under MS Windows + +Use @file{make.bat} if you want to install Gnus under MS Windows, the +first argument to the batch-program should be the directory where +@file{xemacs.exe} respectively @file{emacs.exe} is located, iff you want +to install Gnus after compiling it, give @file{make.bat} @code{/copy} as +the second parameter. + +@file{make.bat} has been rewritten from scratch, it now features +automatic recognition of XEmacs and GNU Emacs, generates +@file{gnus-load.el}, checks if errors occur while compilation and +generation of info files and reports them at the end of the build +process. It now uses @code{makeinfo} if it is available and falls +back to @file{infohack.el} otherwise. @file{make.bat} should now +install all files which are necessary to run Gnus and be generally a +complete replacement for the @code{configure; make; make install} +cycle used under Unix systems. + +The new @file{make.bat} makes @file{make-x.bat} superfluous, so it has +been removed. + +@item +Support for non-@acronym{ASCII} domain names + +Message supports non-@acronym{ASCII} domain names in From:, To: and +Cc: and will query you whether to perform encoding when you try to +send a message. The variable @code{message-use-idna} controls this. +Gnus will also decode non-@acronym{ASCII} domain names in From:, To: +and Cc: when you view a message. The variable @code{gnus-use-idna} +controls this. + +@item +Better handling of Microsoft citation styles + +Gnus now tries to recognize the mangled header block that some Microsoft +mailers use to indicate that the rest of the message is a citation, even +though it is not quoted in any way. The variable +@code{gnus-cite-unsightly-citation-regexp} matches the start of these +citations. + +@item +@code{gnus-article-skip-boring} + +If you set @code{gnus-article-skip-boring} to @code{t}, then Gnus will +not scroll down to show you a page that contains only boring text, +which by default means cited text and signature. You can customize +what is skippable using @code{gnus-article-boring-faces}. + +This feature is especially useful if you read many articles that +consist of a little new content at the top with a long, untrimmed +message cited below. + +@item +The format spec @code{%C} for positioning point has changed to @code{%*}. + +@item +The new variable @code{gnus-parameters} can be used to set group parameters. + +Earlier this was done only via @kbd{G p} (or @kbd{G c}), which stored +the parameters in @file{~/.newsrc.eld}, but via this variable you can +enjoy the powers of customize, and simplified backups since you set the +variable in @file{~/.emacs} instead of @file{~/.newsrc.eld}. The +variable maps regular expressions matching group names to group +parameters, a'la: +@lisp +(setq gnus-parameters + '(("mail\\..*" + (gnus-show-threads nil) + (gnus-use-scoring nil)) + ("^nnimap:\\(foo.bar\\)$" + (to-group . "\\1")))) +@end lisp + +@item +Smileys (@samp{:-)}, @samp{;-)} etc) are now iconized for Emacs too. + +Put @code{(setq gnus-treat-display-smileys nil)} in @file{~/.emacs} to +disable it. + +@item +Gnus no longer generate the Sender: header automatically. + +Earlier it was generated iff the user configurable email address was +different from the Gnus guessed default user address. As the guessing +algorithm is rarely correct these days, and (more controversially) the +only use of the Sender: header was to check if you are entitled to +cancel/supersede news (which is now solved by Cancel Locks instead, +see another entry), generation of the header has been disabled by +default. See the variables @code{message-required-headers}, +@code{message-required-news-headers}, and +@code{message-required-mail-headers}. + +@item +Features from third party @file{message-utils.el} added to @file{message.el}. + +Message now asks if you wish to remove @samp{(was: )} from +subject lines (see @code{message-subject-trailing-was-query}). @kbd{C-c +M-m} and @kbd{C-c M-f} inserts markers indicating included text. +@kbd{C-c C-f a} adds a X-No-Archive: header. @kbd{C-c C-f x} inserts +appropriate headers and a note in the body for cross-postings and +followups (see the variables @code{message-cross-post-@var{*}}). + +@item +References and X-Draft-Headers are no longer generated when you start +composing messages and @code{message-generate-headers-first} is +@code{nil}. + +@item +Improved anti-spam features. + +Gnus is now able to take out spam from your mail and news streams +using a wide variety of programs and filter rules. Among the supported +methods are RBL blocklists, bogofilter and white/blacklists. Hooks +for easy use of external packages such as SpamAssassin and Hashcash +are also new. @xref{Thwarting Email Spam}. + +@item +Easy inclusion of X-Faces headers. + +@item +Face headers handling. + +@item +In the summary buffer, the new command @kbd{/ N} inserts new messages +and @kbd{/ o} inserts old messages. + +@item +Gnus decodes morse encoded messages if you press @kbd{W m}. + +@item +Unread count correct in nnimap groups. + +The estimated number of unread articles in the group buffer should now +be correct for nnimap groups. This is achieved by calling +@code{nnimap-fixup-unread-after-getting-new-news} from the +@code{gnus-setup-news-hook} (called on startup) and +@code{gnus-after-getting-new-news-hook}. (called after getting new +mail). If you have modified those variables from the default, you may +want to add @code{nnimap-fixup-unread-after-getting-new-news} again. If +you were happy with the estimate and want to save some (minimal) time +when getting new mail, remove the function. + +@item +Group Carbon Copy (GCC) quoting + +To support groups that contains SPC and other weird characters, groups +are quoted before they are placed in the Gcc: header. This means +variables such as @code{gnus-message-archive-group} should no longer +contain quote characters to make groups containing SPC work. Also, if +you are using the string @samp{nnml:foo, nnml:bar} (indicating Gcc +into two groups) you must change it to return the list +@code{("nnml:foo" "nnml:bar")}, otherwise the Gcc: line will be quoted +incorrectly. Note that returning the string @samp{nnml:foo, nnml:bar} +was incorrect earlier, it just didn't generate any problems since it +was inserted directly. + +@item +@file{~/News/overview/} not used. + +As a result of the following change, the @file{~/News/overview/} +directory is not used any more. You can safely delete the entire +hierarchy. + +@item +@code{gnus-agent} + +The Gnus Agent has seen a major updated and is now enabled by default, +and all nntp and nnimap servers from @code{gnus-select-method} and +@code{gnus-secondary-select-method} are agentized by default. Earlier +only the server in @code{gnus-select-method} was agentized by the +default, and the agent was disabled by default. When the agent is +enabled, headers are now also retrieved from the Agent cache instead +of the back ends when possible. Earlier this only happened in the +unplugged state. You can enroll or remove servers with @kbd{J a} and +@kbd{J r} in the server buffer. Gnus will not download articles into +the Agent cache, unless you instruct it to do so, though, by using +@kbd{J u} or @kbd{J s} from the Group buffer. You revert to the old +behaviour of having the Agent disabled with @code{(setq gnus-agent +nil)}. Note that putting @code{(gnus-agentize)} in @file{~/.gnus.el} +is not needed any more. + +@item +@code{gnus-summary-line-format} + +The default value changed to @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) +%s\n}. Moreover @code{gnus-extra-headers}, +@code{nnmail-extra-headers} and @code{gnus-ignored-from-addresses} +changed their default so that the users name will be replaced by the +recipient's name or the group name posting to for @acronym{NNTP} +groups. + +@item +@file{deuglify.el} (@code{gnus-article-outlook-deuglify-article}) + +A new file from Raymond Scholz @email{rscholz@@zonix.de} for deuglifying +broken Outlook (Express) articles. + +@item +@code{(require 'gnus-load)} + +If you use a stand-alone Gnus distribution, you'd better add +@code{(require 'gnus-load)} into your @file{~/.emacs} after adding the Gnus +lisp directory into load-path. + +File @file{gnus-load.el} contains autoload commands, functions and variables, +some of which may not be included in distributions of Emacsen. + +@item +@code{gnus-slave-unplugged} + +A new command which starts Gnus offline in slave mode. + +@item +@code{message-insinuate-rmail} + +Adding @code{(message-insinuate-rmail)} and @code{(setq +mail-user-agent 'gnus-user-agent)} in @file{.emacs} convinces Rmail to +compose, reply and forward messages in message-mode, where you can +enjoy the power of @acronym{MML}. + +@item +@code{message-minibuffer-local-map} + +The line below enables BBDB in resending a message: +@lisp +(define-key message-minibuffer-local-map [(tab)] + 'bbdb-complete-name) +@end lisp + +@item +Externalizing and deleting of attachments. + +If @code{gnus-gcc-externalize-attachments} or +@code{message-fcc-externalize-attachments} is non-@code{nil}, attach +local files as external parts. + +The command @code{gnus-mime-save-part-and-strip} (bound to @kbd{C-o} +on @acronym{MIME} buttons) saves a part and replaces the part with an +external one. @code{gnus-mime-delete-part} (bound to @kbd{d} on +@acronym{MIME} buttons) removes a part. It works only on back ends +that support editing. + +@item +@code{gnus-default-charset} + +The default value is determined from the +@code{current-language-environment} variable, instead of +@code{iso-8859-1}. Also the @samp{.*} item in +@code{gnus-group-charset-alist} is removed. + +@item +@code{gnus-posting-styles} + +Add a new format of match like +@lisp +((header "to" "larsi.*org") + (Organization "Somewhere, Inc.")) +@end lisp +The old format like the lines below is obsolete, but still accepted. +@lisp +(header "to" "larsi.*org" + (Organization "Somewhere, Inc.")) +@end lisp + +@item +@code{message-ignored-news-headers} and @code{message-ignored-mail-headers} + +@samp{X-Draft-From} and @samp{X-Gnus-Agent-Meta-Information} have been +added into these two variables. If you customized those, perhaps you +need add those two headers too. + +@item +Gnus reads the @acronym{NOV} and articles in the Agent if plugged. + +If one reads an article while plugged, and the article already exists +in the Agent, it won't get downloaded once more. @code{(setq +gnus-agent-cache nil)} reverts to the old behavior. + +@item +Gnus supports the ``format=flowed'' (RFC 2646) parameter. On +composing messages, it is enabled by @code{use-hard-newlines}. +Decoding format=flowed was present but not documented in earlier +versions. + +@item +Gnus supports the generation of RFC 2298 Disposition Notification requests. + +This is invoked with the @kbd{C-c M-n} key binding from message mode. + +@item +Gnus supports Maildir groups. + +Gnus includes a new back end @file{nnmaildir.el}. @xref{Maildir}. + +@item +Printing capabilities are enhanced. + +Gnus supports Muttprint natively with @kbd{O P} from the Summary and +Article buffers. Also, each individual @acronym{MIME} part can be +printed using @kbd{p} on the @acronym{MIME} button. + +@item +Message supports the Importance: (RFC 2156) header. + +In the message buffer, @kbd{C-c C-f C-i} or @kbd{C-c C-u} cycles through +the valid values. + +@item +Gnus supports Cancel Locks in News. + +This means a header @samp{Cancel-Lock} is inserted in news posting. It is +used to determine if you wrote an article or not (for canceling and +superseding). Gnus generates a random password string the first time +you post a message, and saves it in your @file{~/.emacs} using the Custom +system. While the variable is called @code{canlock-password}, it is not +security sensitive data. Publishing your canlock string on the web +will not allow anyone to be able to anything she could not already do. +The behaviour can be changed by customizing @code{message-insert-canlock}. + +@item +Gnus supports server-side mail filtering using Sieve. + +Sieve rules can be added as Group Parameters for groups, and the +complete Sieve script is generated using @kbd{D g} from the Group +buffer, and then uploaded to the server using @kbd{C-c C-l} in the +generated Sieve buffer. @xref{Sieve Commands}, and the new Sieve +manual @ref{Top, , Top, sieve, Emacs Sieve}. + +@item +Extended format specs. + +Format spec @samp{%&user-date;} is added into +@code{gnus-summary-line-format-alist}. Also, user defined extended +format specs are supported. The extended format specs look like +@samp{%u&foo;}, which invokes function +@code{gnus-user-format-function-@var{foo}}. Because @samp{&} is used as the +escape character, old user defined format @samp{%u&} is no longer supported. + +@item +@kbd{/ *} (@code{gnus-summary-limit-include-cached}) is rewritten. + +It was aliased to @kbd{Y c} +(@code{gnus-summary-insert-cached-articles}). The new function filters +out other articles. + +@item Some limiting commands accept a @kbd{C-u} prefix to negate the match. + +If @kbd{C-u} is used on subject, author or extra headers, i.e., @kbd{/ +s}, @kbd{/ a}, and @kbd{/ x} +(@code{gnus-summary-limit-to-@{subject,author,extra@}}) respectively, the +result will be to display all articles that do not match the expression. + +@item +Group names are treated as UTF-8 by default. + +This is supposedly what USEFOR wanted to migrate to. See +@code{gnus-group-name-charset-group-alist} and +@code{gnus-group-name-charset-method-alist} for customization. + +@item +The nnml and nnfolder back ends store marks for each groups. + +This makes it possible to take backup of nnml/nnfolder servers/groups +separately of @file{~/.newsrc.eld}, while preserving marks. It also +makes it possible to share articles and marks between users (without +sharing the @file{~/.newsrc.eld} file) within e.g. a department. It +works by storing the marks stored in @file{~/.newsrc.eld} in a per-group +file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for +nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to +another machine, Gnus will automatically use the @file{.marks} or +@file{.mrk} file instead of the information in @file{~/.newsrc.eld}. +The new server variables @code{nnml-marks-is-evil} and +@code{nnfolder-marks-is-evil} can be used to disable this feature. + +@item +The menu bar item (in Group and Summary buffer) named ``Misc'' has +been renamed to ``Gnus''. + +@item +The menu bar item (in Message mode) named ``@acronym{MML}'' has been +renamed to ``Attachments''. Note that this menu also contains security +related stuff, like signing and encryption (@pxref{Security, Security,, +message, Message Manual}). + +@item +@code{gnus-group-charset-alist} and +@code{gnus-group-ignored-charsets-alist}. + +The regexps in these variables are compared with full group names +instead of real group names in 5.8. Users who customize these +variables should change those regexps accordingly. For example: +@lisp +("^han\\>" euc-kr) -> ("\\(^\\|:\\)han\\>" euc-kr) +@end lisp + +@item +Gnus supports @acronym{PGP} (RFC 1991/2440), @acronym{PGP/MIME} (RFC +2015/3156) and @acronym{S/MIME} (RFC 2630-2633). + +It needs an external @acronym{S/MIME} and OpenPGP implementation, but no +additional Lisp libraries. This add several menu items to the +Attachments menu, and @kbd{C-c RET} key bindings, when composing +messages. This also obsoletes @code{gnus-article-hide-pgp-hook}. + +@item +Gnus inlines external parts (message/external). + +@item +@acronym{MML} (Mime compose) prefix changed from @kbd{M-m} to @kbd{C-c +C-m}. + +This change was made to avoid conflict with the standard binding of +@code{back-to-indentation}, which is also useful in message mode. + +@item +The default for @code{message-forward-show-mml} changed to symbol @code{best}. + +The behaviour for the @code{best} value is to show @acronym{MML} (i.e., +convert to @acronym{MIME}) when appropriate. @acronym{MML} will not be +used when forwarding signed or encrypted messages, as the conversion +invalidate the digital signature. @end itemize @iftex @@ -20281,7 +26312,7 @@ @item news @cindex news This is what you are supposed to use this thing for---reading news. -News is generally fetched from a nearby @sc{nntp} server, and is +News is generally fetched from a nearby @acronym{NNTP} server, and is generally publicly available to everybody. If you post news, the entire world is likely to read just what you have written, and they'll all snigger mischievously. Behind your back. @@ -20304,9 +26335,32 @@ @item back end @cindex back end -Gnus gets fed articles from a number of back ends, both news and mail -back ends. Gnus does not handle the underlying media, so to speak---this -is all done by the back ends. +Gnus considers mail and news to be mostly the same, really. The only +difference is how to access the actual articles. News articles are +commonly fetched via the protocol @acronym{NNTP}, whereas mail +messages could be read from a file on the local disk. The internal +architecture of Gnus thus comprises a ``front end'' and a number of +``back ends''. Internally, when you enter a group (by hitting +@key{RET}, say), you thereby invoke a function in the front end in +Gnus. The front end then ``talks'' to a back end and says things like +``Give me the list of articles in the foo group'' or ``Show me article +number 4711''. + +So a back end mainly defines either a protocol (the @code{nntp} back +end accesses news via @acronym{NNTP}, the @code{nnimap} back end +accesses mail via @acronym{IMAP}) or a file format and directory +layout (the @code{nnspool} back end accesses news via the common +``spool directory'' format, the @code{nnml} back end access mail via a +file format and directory layout that's quite similar). + +Gnus does not handle the underlying media, so to speak---this is all +done by the back ends. A back end is a collection of functions to +access the articles. + +However, sometimes the term ``back end'' is also used where ``server'' +would have been more appropriate. And then there is the term ``select +method'' which can mean either. The Gnus terminology can be quite +confusing. @item native @cindex native @@ -20353,10 +26407,10 @@ @item headers @cindex headers A collection of such lines, or a collection of heads. Or even a -collection of @sc{nov} lines. - -@item @sc{nov} -@cindex nov +collection of @acronym{NOV} lines. + +@item @acronym{NOV} +@cindex @acronym{NOV} When Gnus enters a group, it asks the back end for the headers of all unread articles in the group. Most servers support the News OverView format, which is more compact and much faster to read and parse than the @@ -20421,9 +26475,10 @@ @item ephemeral groups @cindex ephemeral groups +@cindex temporary groups Most groups store data on what articles you have read. @dfn{Ephemeral} groups are groups that will have no data stored---when you exit the -group, it'll disappear into the ether. +group, it'll disappear into the aether. @item solid groups @cindex solid groups @@ -20459,6 +26514,13 @@ A collection of messages in one file. The most common digest format is specified by RFC 1153. +@item splitting +@cindex splitting, terminolgy +@cindex mail sorting +@cindex mail filtering (splitting) +The action of sorting your emails according to certain rules. Sometimes +incorrectly called mail filtering. + @end table @@ -20472,32 +26534,32 @@ for some quite common situations. @menu -* Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere. -* Slow Terminal Connection:: You run a remote Emacs. -* Little Disk Space:: You feel that having large setup files is icky. -* Slow Machine:: You feel like buying a faster machine. +* Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere. +* Slow Terminal Connection:: You run a remote Emacs. +* Little Disk Space:: You feel that having large setup files is icky. +* Slow Machine:: You feel like buying a faster machine. @end menu @node Slow/Expensive Connection -@subsection Slow/Expensive @sc{nntp} Connection +@subsection Slow/Expensive NNTP Connection If you run Emacs on a machine locally, and get your news from a machine over some very thin strings, you want to cut down on the amount of data -Gnus has to get from the @sc{nntp} server. +Gnus has to get from the @acronym{NNTP} server. @table @code @item gnus-read-active-file Set this to @code{nil}, which will inhibit Gnus from requesting the -entire active file from the server. This file is often very large. You +entire active file from the server. This file is often v. large. You also have to set @code{gnus-check-new-newsgroups} and @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus doesn't suddenly decide to fetch the active file anyway. @item gnus-nov-is-evil This one has to be @code{nil}. If not, grabbing article headers from -the @sc{nntp} server will not be very fast. Not all @sc{nntp} servers +the @acronym{NNTP} server will not be very fast. Not all @acronym{NNTP} servers support @sc{xover}; Gnus will detect this by itself. @end table @@ -20540,6 +26602,7 @@ If this is non-@code{nil}, all threads in the summary buffer will be hidden initially. + @item gnus-updated-mode-lines If this is @code{nil}, Gnus will not put information in the buffer mode lines, which might save some time. @@ -20613,13 +26676,12 @@ @item Try doing an @kbd{M-x gnus-version}. If you get something that looks -like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded. If, -on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp -flee}, you have some old @file{.el} files lying around. Delete these. - -@item -Read the help group (@kbd{G h} in the group buffer) for a FAQ and a -how-to. +like @samp{Gnus v5.10.6} you have the right files loaded. Otherwise +you have some old @file{.el} files lying around. Delete these. + +@item +Read the help group (@kbd{G h} in the group buffer) for a +@acronym{FAQ} and a how-to. @item @vindex max-lisp-eval-depth @@ -20637,7 +26699,7 @@ @kindex M-x gnus-bug @findex gnus-bug If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug} -command. @kbd{M-x set-variable @key{RET} debug-on-error @key{RET} t @key{RET}}, and send +command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send me the backtrace. I will fix bugs, but I can only fix them if you send me a precise description as to how to reproduce the bug. @@ -20659,13 +26721,56 @@ it somewhere it can be reached, and include the URL of the picture in the bug report. -If you just need help, you are better off asking on -@samp{gnu.emacs.gnus}. I'm not very helpful. +@cindex patches +If you would like to contribute a patch to fix bugs or make +improvements, please produce the patch using @samp{diff -u}. + +@cindex edebug +If you want to debug your problem further before reporting, possibly +in order to solve the problem yourself and send a patch, you can use +edebug. Debugging Lisp code is documented in the Elisp manual +(@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs +Lisp Reference Manual}). To get you started with edebug, consider if +you discover some weird behaviour when pressing @kbd{c}, the first +step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in +the documentation buffer that leads you to the function definition, +then press @kbd{M-x edebug-defun RET} with point inside that function, +return to Gnus and press @kbd{c} to invoke the code. You will be +placed in the lisp buffer and can single step using @kbd{SPC} and +evaluate expressions using @kbd{M-:} or inspect variables using +@kbd{C-h v}, abort execution with @kbd{q}, and resume execution with +@kbd{c} or @kbd{g}. + +@cindex elp +@cindex profile +@cindex slow +Sometimes, a problem do not directly generate an elisp error but +manifests itself by causing Gnus to be very slow. In these cases, you +can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are +slow, and then try to analyze the backtrace (repeating the procedure +helps isolating the real problem areas). + +A fancier approach is to use the elisp profiler, ELP. The profiler is +(or should be) fully documented elsewhere, but to get you started +there are a few steps that need to be followed. First, instrument the +part of Gnus you are interested in for profiling, e.g. @kbd{M-x +elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package +RET message}. Then perform the operation that is slow and press +@kbd{M-x elp-results}. You will then see which operations that takes +time, and can debug them further. If the entire operation takes much +longer than the time spent in the slowest function in the profiler +output, you probably profiled the wrong part of Gnus. To reset +profiling statistics, use @kbd{M-x elp-reset-all}. @kbd{M-x +elp-restore-all} is supposed to remove profiling, but given the +complexities and dynamic code generation in Gnus, it might not always +work perfectly. @cindex gnu.emacs.gnus @cindex ding mailing list -You can also ask on the ding mailing list---@samp{ding@@gnus.org}. -Write to @samp{ding-request@@gnus.org} to subscribe. +If you just need help, you are better off asking on +@samp{gnu.emacs.gnus}. I'm not very helpful. You can also ask on +@email{ding@@gnus.org, the ding mailing list}. Write to +@email{ding-request@@gnus.org} to subscribe. @page @@ -20685,15 +26790,15 @@ and general methods of operation. @menu -* Gnus Utility Functions:: Common functions and variable to use. -* Back End Interface:: How Gnus communicates with the servers. -* Score File Syntax:: A BNF definition of the score file standard. -* Headers:: How Gnus stores headers internally. -* Ranges:: A handy format for storing mucho numbers. -* Group Info:: The group info format. -* Extended Interactive:: Symbolic prefixes and stuff. -* Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen. -* Various File Formats:: Formats of files that Gnus use. +* Gnus Utility Functions:: Common functions and variable to use. +* Back End Interface:: How Gnus communicates with the servers. +* Score File Syntax:: A BNF definition of the score file standard. +* Headers:: How Gnus stores headers internally. +* Ranges:: A handy format for storing mucho numbers. +* Group Info:: The group info format. +* Extended Interactive:: Symbolic prefixes and stuff. +* Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen. +* Various File Formats:: Formats of files that Gnus use. @end menu @@ -20788,8 +26893,8 @@ @findex gnus-group-foreign-p Says whether @var{group} is foreign or not. -@item group-group-find-parameter -@findex group-group-find-parameter +@item gnus-group-find-parameter +@findex gnus-group-find-parameter Returns the parameter list of @var{group}. If given a second parameter, returns the value of that parameter for @var{group}. @@ -20821,7 +26926,7 @@ @node Back End Interface @subsection Back End Interface -Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual +Gnus doesn't know anything about @acronym{NNTP}, spools, mail or virtual groups. It only knows how to talk to @dfn{virtual servers}. A virtual server is a @dfn{back end} and some @dfn{back end variables}. As examples of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As @@ -20866,21 +26971,44 @@ Some back ends could be said to be @dfn{server-forming} back ends, and some might be said not to be. The latter are back ends that generally only operate on one group at a time, and have no concept of ``server'' --- they have a group, and they deliver info on that group and nothing +---they have a group, and they deliver info on that group and nothing more. +Gnus identifies each message by way of group name and article number. A +few remarks about these article numbers might be useful. First of all, +the numbers are positive integers. Secondly, it is normally not +possible for later articles to ``re-use'' older article numbers without +confusing Gnus. That is, if a group has ever contained a message +numbered 42, then no other message may get that number, or Gnus will get +mightily confused.@footnote{See the function +@code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.} +Third, article numbers must be assigned in order of arrival in the +group; this is not necessarily the same as the date of the message. + +The previous paragraph already mentions all the ``hard'' restrictions that +article numbers must fulfill. But it seems that it might be useful to +assign @emph{consecutive} article numbers, for Gnus gets quite confused +if there are holes in the article numbering sequence. However, due to +the ``no-reuse'' restriction, holes cannot be avoided altogether. It's +also useful for the article numbers to start at 1 to avoid running out +of numbers as long as possible. + +Note that by convention, back ends are named @code{nnsomething}, but +Gnus also comes with some @code{nnnotbackends}, such as +@file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}. + In the examples and definitions I will refer to the imaginary back end @code{nnchoke}. @cindex @code{nnchoke} @menu -* Required Back End Functions:: Functions that must be implemented. -* Optional Back End Functions:: Functions that need not be implemented. -* Error Messaging:: How to get messages and report errors. -* Writing New Back Ends:: Extending old back ends. -* Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end. -* Mail-like Back Ends:: Some tips on mail back ends. +* Required Back End Functions:: Functions that must be implemented. +* Optional Back End Functions:: Functions that need not be implemented. +* Error Messaging:: How to get messages and report errors. +* Writing New Back Ends:: Extending old back ends. +* Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end. +* Mail-like Back Ends:: Some tips on mail back ends. @end menu @@ -20896,13 +27024,13 @@ sequences (lists) of article numbers, and most back ends do not support retrieval of @code{Message-ID}s. But they should try for both. -The result data should either be HEADs or NOV lines, and the result +The result data should either be HEADs or @acronym{NOV} lines, and the result value should either be @code{headers} or @code{nov} to reflect this. This might later be expanded to @code{various}, which will be a mixture -of HEADs and NOV lines, but this is currently not supported by Gnus. - -If @var{fetch-old} is non-@code{nil} it says to try fetching "extra -headers", in some meaning of the word. This is generally done by +of HEADs and @acronym{NOV} lines, but this is currently not supported by Gnus. + +If @var{fetch-old} is non-@code{nil} it says to try fetching ``extra +headers'', in some meaning of the word. This is generally done by fetching (at most) @var{fetch-old} extra headers less than the smallest article number in @code{articles}, and filling the gaps as well. The presence of this parameter can be ignored if the back end finds it @@ -20940,13 +27068,16 @@ header = eol @end example +@cindex BNF +(The version of BNF used here is the one used in RFC822.) + If the return value is @code{nov}, the data buffer should contain @dfn{network overview database} lines. These are basically fields separated by tabs. @example nov-buffer = *nov-line -nov-line = 8*9 [ field ] eol +nov-line = field 7*8[ field ] eol field = @end example @@ -20990,7 +27121,7 @@ If @var{server} is the current virtual server, and the connection to the physical server is alive, then this function should return a -non-@code{nil} vlue. This function should under no circumstances +non-@code{nil} value. This function should under no circumstances attempt to reconnect to a server we have lost connection to. There should be no data returned. @@ -21045,7 +27176,9 @@ considering the highest and lowest article numbers, but some articles may have been canceled. Gnus just discards the total-number, so whether one should take the bother to generate it properly (if that is a -problem) is left as an exercise to the reader. +problem) is left as an exercise to the reader. If the group contains no +articles, the lowest article number should be reported as 1 and the +highest as 0. @example group-status = [ error / info ] eol @@ -21075,7 +27208,9 @@ @end example On each line we have a group name, then the highest article number in -that group, the lowest article number, and finally a flag. +that group, the lowest article number, and finally a flag. If the group +contains no articles, the lowest article number should be reported as 1 +and the highest as 0. @example active-file = *active-line @@ -21128,10 +27263,10 @@ @item (nnchoke-request-update-info GROUP INFO &optional SERVER) A Gnus group info (@pxref{Group Info}) is handed to the back end for -alterations. This comes in handy if the back end really carries all the -information (as is the case with virtual and imap groups). This +alterations. This comes in handy if the back end really carries all +the information (as is the case with virtual and imap groups). This function should destructively alter the info to suit its needs, and -should return the (altered) group info. +should return a non-@code{nil} value. There should be no result data from this function. @@ -21154,25 +27289,24 @@ Set/remove/add marks on articles. Normally Gnus handles the article marks (such as read, ticked, expired etc) internally, and store them in -@code{~/.newsrc.eld}. Some back ends (such as @sc{imap}) however carry +@file{~/.newsrc.eld}. Some back ends (such as @acronym{IMAP}) however carry all information about the articles on the server, so Gnus need to propagate the mark information to the server. -ACTION is a list of mark setting requests, having this format: +@var{action} is a list of mark setting requests, having this format: @example (RANGE ACTION MARK) @end example -Range is a range of articles you wish to update marks on. Action is -@code{set}, @code{add} or @code{del}, respectively used for removing all -existing marks and setting them as specified, adding (preserving the -marks not mentioned) mark and removing (preserving the marks not -mentioned) marks. Mark is a list of marks; where each mark is a symbol. -Currently used marks are @code{read}, @code{tick}, @code{reply}, -@code{expire}, @code{killed}, @code{dormant}, @code{save}, -@code{download} and @code{unsend}, but your back end should, if possible, -not limit itself to these. +@var{range} is a range of articles you wish to update marks on. +@var{action} is @code{add} or @code{del}, used to add marks or remove +marks (preserving all marks not mentioned). @var{mark} is a list of +marks; where each mark is a symbol. Currently used marks are +@code{read}, @code{tick}, @code{reply}, @code{expire}, @code{killed}, +@code{dormant}, @code{save}, @code{download}, @code{unsend}, +@code{forward} and @code{recent}, but your back end should, if +possible, not limit itself to these. Given contradictory actions, the last action in the list should be the effective one. That is, if your action contains a request to add the @@ -21212,11 +27346,12 @@ This function may be called at any time (by Gnus or anything else) to request that the back end check for incoming articles, in one way or -another. A mail back end will typically read the spool file or query the -POP server when this function is invoked. The @var{group} doesn't have -to be heeded---if the back end decides that it is too much work just -scanning for a single group, it may do a total scan of all groups. It -would be nice, however, to keep things local if that's practical. +another. A mail back end will typically read the spool file or query +the @acronym{POP} server when this function is invoked. The +@var{group} doesn't have to be heeded---if the back end decides that +it is too much work just scanning for a single group, it may do a +total scan of all groups. It would be nice, however, to keep things +local if that's practical. There should be no result data from this function. @@ -21245,8 +27380,18 @@ @item (nnchoke-request-newgroups DATE &optional SERVER) The result data from this function should be all groups that were -created after @samp{date}, which is in normal human-readable date -format. The data should be in the active buffer format. +created after @samp{date}, which is in normal human-readable date format +(i.e., the date format used in mail and news headers, and returned by +the function @code{message-make-date} by default). The data should be +in the active buffer format. + +It is okay for this function to return ``too many'' groups; some back ends +might find it cheaper to return the full list of groups, rather than +just the new groups. But don't do this for back ends with many groups. +Normally, if the user creates the groups herself, there won't be too +many groups, so @code{nnml} and the like are probably safe. But for +back ends like @code{nntp}, where the groups have been created by the +server, it is quite likely that there can be many groups. @item (nnchoke-request-create-group GROUP &optional SERVER) @@ -21271,8 +27416,7 @@ There should be no result data returned. -@item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM -&optional LAST) +@item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM &optional LAST) This function should move @var{article} (which is a number) from @var{group} by calling @var{accept-form}. @@ -21303,6 +27447,9 @@ The function should return a cons where the @code{car} is the group name and the @code{cdr} is the article number that the article was entered as. +The group should exist before the back end is asked to accept the +article for that group. + There should be no data returned. @@ -21419,9 +27566,9 @@ This macro defines some common functions that almost all back ends should have. -@example +@lisp (nnoo-define-basics nndir) -@end example +@end lisp @item deffoo This macro is just like @code{defun} and takes the same parameters. In @@ -21432,11 +27579,11 @@ This macro allows mapping of functions from the current back end to functions from the parent back ends. -@example +@lisp (nnoo-map-functions nndir (nnml-retrieve-headers 0 nndir-current-group 0 0) (nnmh-request-article 0 nndir-current-group 0 0)) -@end example +@end lisp This means that when @code{nndir-retrieve-headers} is called, the first, third, and fourth parameters will be passed on to @@ -21448,13 +27595,13 @@ last thing in the source file, since it will only define functions that haven't already been defined. -@example +@lisp (nnoo-import nndir (nnmh nnmh-request-list nnmh-request-newgroups) (nnml)) -@end example +@end lisp This means that calls to @code{nndir-request-list} should just be passed on to @code{nnmh-request-list}, while all public functions from @@ -21466,10 +27613,10 @@ Below is a slightly shortened version of the @code{nndir} back end. @lisp -;;; nndir.el --- single directory newsgroup access for Gnus -;; Copyright (C) 1995,96 Free Software Foundation, Inc. - -;;; Code: +;;; @r{nndir.el --- single directory newsgroup access for Gnus} +;; @r{Copyright (C) 1995,96 Free Software Foundation, Inc.} + +;;; @r{Code:} (require 'nnheader) (require 'nnmh) @@ -21497,7 +27644,7 @@ (defvoo nndir-status-string "" nil nnmh-status-string) (defconst nndir-version "nndir 1.0") -;;; Interface functions. +;;; @r{Interface functions.} (nnoo-define-basics nndir) @@ -21536,6 +27683,7 @@ @subsubsection Hooking New Back Ends Into Gnus @vindex gnus-valid-select-methods +@findex gnus-declare-backend Having Gnus start using your new back end is rather easy---you just declare it with the @code{gnus-declare-backend} functions. This will enter the back end into the @code{gnus-valid-select-methods} variable. @@ -21549,6 +27697,8 @@ (gnus-declare-backend "nnchoke" 'mail 'respool 'address) @end lisp +The above line would then go in the @file{nnchoke.el} file. + The abilities can be: @table @code @@ -21578,9 +27728,9 @@ @subsubsection Mail-like Back Ends One of the things that separate the mail back ends from the rest of the -back ends is the heavy dependence by the mail back ends on common -functions in @file{nnmail.el}. For instance, here's the definition of -@code{nnml-request-scan}: +back ends is the heavy dependence by most of the mail back ends on +common functions in @file{nnmail.el}. For instance, here's the +definition of @code{nnml-request-scan}: @lisp (deffoo nnml-request-scan (&optional group server) @@ -21631,7 +27781,7 @@ @subsection Score File Syntax Score files are meant to be easily parseable, but yet extremely -mallable. It was decided that something that had the same read syntax +mallable. It was decided that something that had the same read syntax as an Emacs Lisp list would fit that spec. Here's a typical score file: @@ -21707,8 +27857,8 @@ @subsection Headers Internally Gnus uses a format for storing article headers that -corresponds to the @sc{nov} format in a mysterious fashion. One could -almost suspect that the author looked at the @sc{nov} specification and +corresponds to the @acronym{NOV} format in a mysterious fashion. One could +almost suspect that the author looked at the @acronym{NOV} specification and just shamelessly @emph{stole} the entire thing, and one would be right. @dfn{Header} is a severely overloaded term. ``Header'' is used in @@ -22029,8 +28179,8 @@ @subsection Various File Formats @menu -* Active File Format:: Information on articles and groups available. -* Newsgroups File Format:: Group descriptions. +* Active File Format:: Information on articles and groups available. +* Newsgroups File Format:: Group descriptions. @end menu @@ -22101,8 +28251,8 @@ cat instead. @menu -* Keystrokes:: Entering text and executing commands. -* Emacs Lisp:: The built-in Emacs programming language. +* Keystrokes:: Entering text and executing commands. +* Emacs Lisp:: The built-in Emacs programming language. @end menu @@ -22175,10 +28325,10 @@ This function (really ``special form'') @code{setq} is the one that can set a variable to some value. This is really all you need to know. Now -you can go and fill your @code{.emacs} file with lots of these to change +you can go and fill your @file{.emacs} file with lots of these to change how Gnus works. -If you have put that thing in your @code{.emacs} file, it will be read +If you have put that thing in your @file{.emacs} file, it will be read and @code{eval}ed (which is lisp-ese for ``run'') the next time you start Emacs. If you want to change the variable right away, simply say @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the @@ -22228,6 +28378,9 @@ @end iflatex @end iftex +@c Local Variables: +@c mode: texinfo +@c coding: iso-8859-1 @c End: @ignore diff -r b6e48fab7ff3 -r fd8097053f04 man/makefile.w32-in --- a/man/makefile.w32-in Mon Aug 02 13:28:45 2004 +0000 +++ b/man/makefile.w32-in Mon Aug 02 13:38:50 2004 +0000 @@ -46,14 +46,15 @@ $(infodir)/emacs-mime $(infodir)/eshell \ $(infodir)/speedbar $(infodir)/tramp \ $(infodir)/ses $(infodir)/smtpmail \ - $(infodir)/flymake $(infodir)/emacs-xtra + $(infodir)/flymake $(infodir)/emacs-xtra \ + $(infodir)/pgg $(infodir)/sieve DVI_TARGETS = emacs.dvi calc.dvi cc-mode.dvi cl.dvi dired-x.dvi \ ediff.dvi forms.dvi gnus.dvi message.dvi mh-e.dvi \ reftex.dvi sc.dvi vip.dvi viper.dvi widget.dvi faq.dvi \ ada-mode.dvi autotype.dvi idlwave.dvi eudc.dvi ebrowse.dvi \ pcl-cvs.dvi woman.dvi emacs-mime.dvi eshell.dvi \ speedbar.dvi tramp.dvi ses.dvi smtpmail.dvi flymake.dvi \ - emacs-xtra.dvi + emacs-xtra.dvi pgg.dvi sieve.dvi INFOSOURCES = info.texi # The following rule does not work with all versions of `make'. @@ -189,6 +190,7 @@ forms.dvi: forms.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/forms.texi +# gnus/message/emacs-mime/sieve/pgg are part of Gnus: $(infodir)/gnus: gnus.texi $(MAKEINFO) gnus.texi gnus.dvi: gnus.texi @@ -196,11 +198,22 @@ $(ENVADD) $(TEXI2DVI) gnustmp.texi cp gnustmp.dvi $*.dvi rm gnustmp.* - $(infodir)/message: message.texi $(MAKEINFO) message.texi message.dvi: message.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/message.texi +$(infodir)/emacs-mime: emacs-mime.texi + $(MAKEINFO) emacs-mime.texi +emacs-mime.dvi: emacs-mime.texi + $(ENVADD) $(TEXI2DVI) $(srcdir)/emacs-mime.texi +../info/sieve: sieve.texi + cd $(srcdir); $(MAKEINFO) sieve.texi +sieve.dvi: sieve.texi + $(ENVADD) $(TEXI2DVI) ${srcdir}/sieve.texi +../info/pgg: pgg.texi + cd $(srcdir); $(MAKEINFO) pgg.texi +pgg.dvi: pgg.texi + $(ENVADD) $(TEXI2DVI) ${srcdir}/pgg.texi $(infodir)/mh-e: mh-e.texi $(MAKEINFO) mh-e.texi @@ -278,11 +291,6 @@ speedbar.dvi: speedbar.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/speedbar.texi -$(infodir)/emacs-mime: emacs-mime.texi - $(MAKEINFO) emacs-mime.texi -emacs-mime.dvi: emacs-mime.texi - $(ENVADD) $(TEXI2DVI) $(srcdir)/emacs-mime.texi - $(infodir)/tramp: tramp.texi $(MAKEINFO) tramp.texi tramp.dvi: tramp.texi diff -r b6e48fab7ff3 -r fd8097053f04 man/message.texi --- a/man/message.texi Mon Aug 02 13:28:45 2004 +0000 +++ b/man/message.texi Mon Aug 02 13:38:50 2004 +0000 @@ -1,17 +1,26 @@ \input texinfo @c -*-texinfo-*- @setfilename ../info/message -@settitle Message 5.9.0 Manual +@settitle Message Manual @synindex fn cp @synindex vr cp @synindex pg cp -@copying +@dircategory Emacs +@direntry +* Message: (message). Mail and news composition mode that goes with Gnus. +@end direntry +@iftex +@finalout +@end iftex +@setchapternewpage odd + +@ifnottex + This file documents Message, the Emacs message composition mode. -Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002 Free Software -Foundation, Inc. - -@quotation +Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 +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 @@ -28,29 +37,41 @@ 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 quotation -@end copying - -@dircategory Emacs -@direntry -* Message: (message). Mail and news composition mode that goes with Gnus. -@end direntry -@iftex -@finalout -@end iftex -@setchapternewpage odd - +@end ifnottex + +@tex @titlepage -@title Message 5.9.0 Manual +@title Message Manual @author by Lars Magne Ingebrigtsen @page + @vskip 0pt plus 1filll -@insertcopying +Copyright @copyright{} 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003 + 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. @end titlepage @page +@end tex + @node Top @top Message @@ -67,8 +88,9 @@ * Key Index:: List of Message mode keys. @end menu -This manual corresponds to Message 5.9.0. Message is distributed with -the Gnus distribution bearing the same version number as this manual. +This manual corresponds to Message v5.10.6. Message is distributed +with the Gnus distribution bearing the same version number as this +manual. @node Interface @@ -92,6 +114,7 @@ * Forwarding:: Forwarding a message via news or mail. * Resending:: Resending a mail message. * Bouncing:: Bouncing a mail message. +* Mailing Lists:: Send mail to mailing lists. @end menu @@ -150,9 +173,9 @@ header will be used. This function can also return a list. In that case, each list element -should be a cons, where the car should be the name of an header -(eg. @code{Cc}) and the cdr should be the header value -(eg. @samp{larsi@@ifi.uio.no}). All these headers will be inserted into +should be a cons, where the @sc{car} should be the name of a header +(e.g. @code{Cc}) and the @sc{cdr} should be the header value +(e.g. @samp{larsi@@ifi.uio.no}). All these headers will be inserted into the head of the outgoing mail. @@ -171,10 +194,14 @@ @code{message-wide-reply-to-function}. It is used in the same way as @code{message-reply-to-function} (@pxref{Reply}). -@findex message-dont-reply-to-names +@vindex message-dont-reply-to-names Addresses that match the @code{message-dont-reply-to-names} regular expression will be removed from the @code{Cc} header. +@vindex message-wide-reply-confirm-recipients +If @code{message-wide-reply-confirm-recipients} is non-@code{nil} you +will be asked to confirm that you want to reply to multiple +recipients. The default is @code{nil}. @node Followup @section Followup @@ -204,6 +231,28 @@ The @code{message-cancel-news} command cancels the article in the current buffer. +@vindex message-cancel-message +The value of @code{message-cancel-message} is inserted in the body of +the cancel message. The default is @samp{I am canceling my own +article.}. + +@cindex Cancel Locks +@vindex message-insert-canlock +@cindex canlock +When Message posts news messages, it inserts @code{Cancel-Lock} +headers by default. This is a cryptographic header that ensures that +only you can cancel your own messages, which is nice. The downside +is that if you lose your @file{.emacs} file (which is where Gnus +stores the secret cancel lock password (which is generated +automatically the first time you use this feature)), you won't be +able to cancel your message. + +Whether to insert the header or not is controlled by the +@code{message-insert-canlock} variable. + +Not many news servers respect the @code{Cancel-Lock} header yet, but +this is expected to change in the future. + @node Superseding @section Superseding @@ -261,9 +310,14 @@ @item message-forward-as-mime @vindex message-forward-as-mime If this variable is @code{t} (the default), forwarded messages are -included as inline MIME RFC822 parts. If it's @code{nil}, forwarded +included as inline @acronym{MIME} RFC822 parts. If it's @code{nil}, forwarded messages will just be copied inline to the new message, like previous, -non MIME-savvy versions of gnus would do. +non @acronym{MIME}-savvy versions of Gnus would do. + +@item message-forward-before-signature +@vindex message-forward-before-signature +If non-@code{nil}, put forwarded message before signature, else after. + @end table @@ -296,15 +350,163 @@ @samp{^\\(Received\\|Return-Path\\):}. +@node Mailing Lists +@section Mailing Lists + +@cindex Mail-Followup-To +Sometimes while posting to mailing lists, the poster needs to direct +followups to the post to specific places. The Mail-Followup-To (MFT) +was created to enable just this. Two example scenarios where this is +useful: + +@itemize @bullet +@item +A mailing list poster can use MFT to express that responses should be +sent to just the list, and not the poster as well. This will happen +if the poster is already subscribed to the list. + +@item +A mailing list poster can use MFT to express that responses should be +sent to the list and the poster as well. This will happen if the poster +is not subscribed to the list. + +@item +If a message is posted to several mailing lists, MFT may also be used +to direct the following discussion to one list only, because +discussions that are spread over several lists tend to be fragmented +and very difficult to follow. + +@end itemize + +Gnus honors the MFT header in other's messages (i.e. while following +up to someone else's post) and also provides support for generating +sensible MFT headers for outgoing messages as well. + +@c @menu +@c * Honoring an MFT post:: What to do when one already exists +@c * Composing with a MFT header:: Creating one from scratch. +@c @end menu + +@c @node Composing with a MFT header +@subsection Composing a correct MFT header automagically + +The first step in getting Gnus to automagically generate a MFT header +in posts you make is to give Gnus a list of the mailing lists +addresses you are subscribed to. You can do this in more than one +way. The following variables would come in handy. + +@table @code + +@vindex message-subscribed-addresses +@item message-subscribed-addresses +This should be a list of addresses the user is subscribed to. Its +default value is @code{nil}. Example: +@lisp +(setq message-subscribed-addresses + '("ding@@gnus.org" "bing@@noose.org")) +@end lisp + +@vindex message-subscribed-regexps +@item message-subscribed-regexps +This should be a list of regexps denoting the addresses of mailing +lists subscribed to. Default value is @code{nil}. Example: If you +want to achieve the same result as above: +@lisp +(setq message-subscribed-regexps + '("\\(ding@@gnus\\)\\|\\(bing@@noose\\)\\.org") +@end lisp + +@vindex message-subscribed-address-functions +@item message-subscribed-address-functions +This can be a list of functions to be called (one at a time!!) to +determine the value of MFT headers. It is advisable that these +functions not take any arguments. Default value is @code{nil}. + +There is a pre-defined function in Gnus that is a good candidate for +this variable. @code{gnus-find-subscribed-addresses} is a function +that returns a list of addresses corresponding to the groups that have +the @code{subscribed} (@pxref{Group Parameters, ,Group Parameters, +gnus, The Gnus Manual}) group parameter set to a non-@code{nil} value. +This is how you would do it. + +@lisp +(setq message-subscribed-address-functions + '(gnus-find-subscribed-addresses)) +@end lisp + +@vindex message-subscribed-address-file +@item message-subscribed-address-file +You might be one organised human freak and have a list of addresses of +all subscribed mailing lists in a separate file! Then you can just +set this variable to the name of the file and life would be good. + +@end table + +You can use one or more of the above variables. All their values are +``added'' in some way that works :-) + +Now you are all set. Just start composing a message as you normally do. +And just send it; as always. Just before the message is sent out, Gnus' +MFT generation thingy kicks in and checks if the message already has a +MFT field. If there is one, it is left alone. (Except if it's empty - +in that case, the field is removed and is not replaced with an +automatically generated one. This lets you disable MFT generation on a +per-message basis.) If there is none, then the list of recipient +addresses (in the To: and Cc: headers) is checked to see if one of them +is a list address you are subscribed to. If none of them is a list +address, then no MFT is generated; otherwise, a MFT is added to the +other headers and set to the value of all addresses in To: and Cc: + +@kindex C-c C-f C-a +@findex message-generate-unsubscribed-mail-followup-to +@kindex C-c C-f C-m +@findex message-goto-mail-followup-to +Hm. ``So'', you ask, ``what if I send an email to a list I am not +subscribed to? I want my MFT to say that I want an extra copy.'' (This +is supposed to be interpreted by others the same way as if there were no +MFT, but you can use an explicit MFT to override someone else's +to-address group parameter.) The function +@code{message-generate-unsubscribed-mail-followup-to} might come in +handy. It is bound to @kbd{C-c C-f C-a} by default. In any case, you +can insert a MFT of your own choice; @kbd{C-c C-f C-m} +(@code{message-goto-mail-followup-to}) will help you get started. + +@c @node Honoring an MFT post +@subsection Honoring an MFT post + +@vindex message-use-mail-followup-to +When you followup to a post on a mailing list, and the post has a MFT +header, Gnus' action will depend on the value of the variable +@code{message-use-mail-followup-to}. This variable can be one of: + +@table @code +@item use + Always honor MFTs. The To: and Cc: headers in your followup will be + derived from the MFT header of the original post. This is the default. + +@item nil + Always dishonor MFTs (just ignore the darned thing) + +@item ask +Gnus will prompt you for an action. + +@end table + +It is considered good netiquette to honor MFT, as it is assumed the +fellow who posted a message knows where the followups need to go +better than you do. + @node Commands @chapter Commands @menu * Buffer Entry:: Commands after entering a Message buffer. -* Header Commands:: Commands for moving to headers. +* Header Commands:: Commands for moving headers or changing headers. * Movement:: Moving around in message buffers. * Insertion:: Inserting things into message buffers. -* MIME:: @sc{mime} considerations. +* MIME:: @acronym{MIME} considerations. +* IDNA:: Non-@acronym{ASCII} domain name considerations. +* Security:: Signing and encrypting messages. * Various Commands:: Various things. * Sending:: Actually sending the message. * Mail Aliases:: How to use mail aliases. @@ -330,14 +532,16 @@ @node Header Commands @section Header Commands -All these commands move to the header in question. If it doesn't exist, -it will be inserted. +@subsection Commands for moving to headers + +These following commands move to the header in question. If it doesn't +exist, it will be inserted. @table @kbd @item C-c ? @kindex C-c ? -@findex message-goto-to +@findex describe-mode Describe the message mode. @item C-c C-f C-t @@ -345,13 +549,19 @@ @findex message-goto-to Go to the @code{To} header (@code{message-goto-to}). +@item C-c C-f C-o +@kindex C-c C-f C-o +@findex message-goto-from +Go to the @code{From} header (@code{message-goto-from}). (The ``o'' +in the key binding is for Originator.) + @item C-c C-f C-b @kindex C-c C-f C-b @findex message-goto-bcc Go to the @code{Bcc} header (@code{message-goto-bcc}). -@item C-c C-f C-w -@kindex C-c C-f C-w +@item C-c C-f C-f +@kindex C-c C-f C-f @findex message-goto-fcc Go to the @code{Fcc} header (@code{message-goto-fcc}). @@ -380,8 +590,8 @@ @findex message-goto-distribution Go to the @code{Distribution} header (@code{message-goto-distribution}). -@item C-c C-f C-f -@kindex C-c C-f C-f +@item C-c C-f C-o +@kindex C-c C-f C-o @findex message-goto-followup-to Go to the @code{Followup-To} header (@code{message-goto-followup-to}). @@ -395,6 +605,133 @@ @findex message-goto-summary Go to the @code{Summary} header (@code{message-goto-summary}). +@item C-c C-f C-i +@kindex C-c C-f C-i +@findex message-insert-or-toggle-importance +This inserts the @samp{Importance:} header with a value of +@samp{high}. This header is used to signal the importance of the +message to the receiver. If the header is already present in the +buffer, it cycles between the three valid values according to RFC +1376: @samp{low}, @samp{normal} and @samp{high}. + +@item C-c C-f C-a +@kindex C-c C-f C-a +@findex message-generate-unsubscribed-mail-followup-to +Insert a reasonable @samp{Mail-Followup-To:} header +(@pxref{Mailing Lists}) in a post to an +unsubscribed list. When making original posts to a mailing list you are +not subscribed to, you have to type in a @samp{Mail-Followup-To:} header +by hand. The contents, usually, are the addresses of the list and your +own address. This function inserts such a header automatically. It +fetches the contents of the @samp{To:} header in the current mail +buffer, and appends the current @code{user-mail-address}. + +If the optional argument @code{include-cc} is non-@code{nil}, the +addresses in the @samp{Cc:} header are also put into the +@samp{Mail-Followup-To:} header. + +@end table + +@subsection Commands to change headers + +@table @kbd + +@item C-c C-o +@kindex C-c C-o +@findex message-sort-headers +@vindex message-header-format-alist +Sort headers according to @code{message-header-format-alist} +(@code{message-sort-headers}). + +@item C-c C-t +@kindex C-c C-t +@findex message-insert-to +Insert a @code{To} header that contains the @code{Reply-To} or +@code{From} header of the message you're following up +(@code{message-insert-to}). + +@item C-c C-n +@kindex C-c C-n +@findex message-insert-newsgroups +Insert a @code{Newsgroups} header that reflects the @code{Followup-To} +or @code{Newsgroups} header of the article you're replying to +(@code{message-insert-newsgroups}). + +@item C-c C-l +@kindex C-c C-l +@findex message-to-list-only +Send a message to the list only. Remove all addresses but the list +address from @code{To:} and @code{Cc:} headers. + +@item C-c M-n +@kindex C-c M-n +@findex message-insert-disposition-notification-to +Insert a request for a disposition +notification. (@code{message-insert-disposition-notification-to}). +This means that if the recipient support RFC 2298 she might send you a +notification that she received the message. + +@item M-x message-insert-importance-high +@kindex M-x message-insert-importance-high +@findex message-insert-importance-high +@cindex Importance +Insert an @samp{Importance} header with a value of @samp{high}, +deleting headers if necessary. + +@item M-x message-insert-importance-low +@kindex M-x message-insert-importance-low +@findex message-insert-importance-low +@cindex Importance +Insert an @samp{Importance} header with a value of @samp{low}, deleting +headers if necessary. + +@item C-c C-f s +@kindex C-c C-f s +@findex message-change-subject +@cindex Subject +Change the current @samp{Subject} header. Ask for new @samp{Subject} +header and append @samp{(was: )}. The old subject can be +stripped on replying, see @code{message-subject-trailing-was-query} +(@pxref{Message Headers}). + +@item C-c C-f x +@kindex C-c C-f x +@findex message-cross-post-followup-to +@vindex message-cross-post-default +@cindex X-Post +@cindex cross-post +Ask for an additional @samp{Newsgroups} and @samp{FollowUp-To} for a +cross-post. @code{message-cross-post-followup-to} mangles +@samp{FollowUp-To} and @samp{Newsgroups} header to point to group. +If @code{message-cross-post-default} is @code{nil} or if called with a +prefix-argument @samp{Follow-Up} is set, but the message is not +cross-posted. + +@item C-c C-f t +@kindex C-c C-f t +@findex message-reduce-to-to-cc +Replace contents of @samp{To} header with contents of @samp{Cc} or +@samp{Bcc} header. + +@item C-c C-f w +@kindex C-c C-f w +@findex message-insert-wide-reply +Insert @samp{To} and @samp{Cc} headers as if you were doing a wide +reply. + +@item C-c C-f a +@kindex C-c C-f a +@findex message-add-archive-header +@vindex message-archive-header +@vindex message-archive-note +@cindex X-No-Archive +Insert @samp{X-No-Archive: Yes} in the header and a note in the body. +The header and the note can be customized using +@code{message-archive-header} and @code{message-archive-note}. When +called with a prefix argument, ask for a text to insert. If you don't +want the note in the body, set @code{message-archive-note} to +@code{nil}. + @end table @@ -413,6 +750,15 @@ @findex message-goto-signature Move to the signature of the message (@code{message-goto-signature}). +@item C-a +@kindex C-a +@findex message-beginning-of-line +@vindex message-beginning-of-line +If at beginning of header value, go to beginning of line, else go to +beginning of header value. (The header value comes after the header +name and the colon.) This behaviour can be disabled by toggling +the variable @code{message-beginning-of-line}. + @end table @@ -453,87 +799,20 @@ @findex message-insert-headers Insert the message headers (@code{message-insert-headers}). -@end table - -@table @code -@item message-ignored-cited-headers -@vindex message-ignored-cited-headers -All headers that match this regexp will be removed from yanked -messages. The default is @samp{.}, which means that all headers will be -removed. - -@item message-citation-line-function -@vindex message-citation-line-function -Function called to insert the citation line. The default is -@code{message-insert-citation-line}, which will lead to citation lines -that look like: - -@example -Hallvard B Furuseth writes: -@end example - -Point will be at the beginning of the body of the message when this -function is called. - -@item message-yank-prefix -@vindex message-yank-prefix -@cindex yanking -@cindex quoting -When you are replying to or following up an article, you normally want -to quote the person you are answering. Inserting quoted text is done by -@dfn{yanking}, and each quoted line you yank will have -@code{message-yank-prefix} prepended to it. The default is @samp{> }. - -@item message-indentation-spaces -@vindex message-indentation-spaces -Number of spaces to indent yanked messages. - -@item message-cite-function -@vindex message-cite-function -@findex message-cite-original -@findex sc-cite-original -@findex message-cite-original-without-signature -@cindex Supercite -Function for citing an original message. The default is -@code{message-cite-original}, which simply inserts the original message -and prepends @samp{> } to each line. -@code{message-cite-original-without-signature} does the same, but elides -the signature. You can also set it to @code{sc-cite-original} to use -Supercite. - -@item message-indent-citation-function -@vindex message-indent-citation-function -Function for modifying a citation just inserted in the mail buffer. -This can also be a list of functions. Each function can find the -citation between @code{(point)} and @code{(mark t)}. And each function -should leave point and mark around the citation text as modified. - -@item message-signature -@vindex message-signature -String to be inserted at the end of the message buffer. If @code{t} -(which is the default), the @code{message-signature-file} file will be -inserted instead. If a function, the result from the function will be -used instead. If a form, the result from the form will be used instead. -If this variable is @code{nil}, no signature will be inserted at all. - -@item message-signature-file -@vindex message-signature-file -If non-@code{nil} the name of a file containing the signature to be -inserted at the end of the buffer. This is ignored if the file -doesn't exist. The default is @samp{~/.signature}. +@item C-c M-m +@kindex C-c M-m +@findex message-mark-inserted-region +Mark some region in the current article with enclosing tags. +See @code{message-mark-insert-begin} and @code{message-mark-insert-end}. + +@item C-c M-f +@kindex C-c M-f +@findex message-mark-insert-file +Insert a file in the current article with enclosing tags. +See @code{message-mark-insert-begin} and @code{message-mark-insert-end}. @end table -Note that RFC1036bis says that a signature should be preceded by the three -characters @samp{-- } on a line by themselves. This is to make it -easier for the recipient to automatically recognize and process the -signature. So don't remove those characters, even though you might feel -that they ruin your beautiful design, like, totally. - -Also note that no signature should be more than four lines long. -Including ASCII graphics is an efficient way to get everybody to believe -that you are silly and have nothing important to say. - @node MIME @section MIME @@ -542,20 +821,258 @@ @cindex multipart @cindex attachment -Message is a @sc{mime}-compliant posting agent. The user generally -doesn't have to do anything to make the @sc{mime} happen---Message will +Message is a @acronym{MIME}-compliant posting agent. The user generally +doesn't have to do anything to make the @acronym{MIME} happen---Message will automatically add the @code{Content-Type} and @code{Content-Transfer-Encoding} headers. The most typical thing users want to use the multipart things in -@sc{mime} for is to add ``attachments'' to mail they send out. This can -be done with the @code{C-c C-a} command, which will prompt for a file -name and a @sc{mime} type. - -You can also create arbitrarily complex multiparts using the MML +@acronym{MIME} for is to add ``attachments'' to mail they send out. This can +be done with the @kbd{C-c C-a} command, which will prompt for a file +name and a @acronym{MIME} type. + +You can also create arbitrarily complex multiparts using the @acronym{MML} language (@pxref{Composing, , Composing, emacs-mime, The Emacs MIME Manual}). +@node IDNA +@section IDNA +@cindex IDNA +@cindex internationalized domain names +@cindex non-ascii domain names + +Message is a @acronym{IDNA}-compliant posting agent. The user +generally doesn't have to do anything to make the @acronym{IDNA} +happen---Message will encode non-@acronym{ASCII} domain names in @code{From}, +@code{To}, and @code{Cc} headers automatically. + +Until @acronym{IDNA} becomes more well known, Message queries you +whether @acronym{IDNA} encoding of the domain name really should +occur. Some users might not be aware that domain names can contain +non-@acronym{ASCII} now, so this gives them a safety net if they accidently +typed a non-@acronym{ASCII} domain name. + +@vindex message-use-idna +The @code{message-use-idna} variable control whether @acronym{IDNA} is +used. If the variable is @code{nil} no @acronym{IDNA} encoding will +ever happen, if it is set to the symbol @code{ask} the user will be +queried (the default), and if set to @code{t} @acronym{IDNA} encoding +happens automatically. + +@findex message-idna-to-ascii-rhs +If you want to experiment with the @acronym{IDNA} encoding, you can +invoke @kbd{M-x message-idna-to-ascii-rhs RET} in the message buffer +to have the non-@acronym{ASCII} domain names encoded while you edit the message. + +Note that you must have @uref{http://www.gnu.org/software/libidn/, GNU +Libidn} installed in order to use this functionality. + +@node Security +@section Security +@cindex Security +@cindex S/MIME +@cindex PGP +@cindex PGP/MIME +@cindex sign +@cindex encrypt +@cindex secure + +Using the @acronym{MML} language, Message is able to create digitally +signed and digitally encrypted messages. Message (or rather +@acronym{MML}) currently support @acronym{PGP} (RFC 1991), +@acronym{PGP/MIME} (RFC 2015/3156) and @acronym{S/MIME}. Instructing +@acronym{MML} to perform security operations on a @acronym{MIME} part is +done using the @kbd{C-c C-m s} key map for signing and the @kbd{C-c C-m +c} key map for encryption, as follows. + +@table @kbd + +@item C-c C-m s s +@kindex C-c C-m s s +@findex mml-secure-message-sign-smime + +Digitally sign current message using @acronym{S/MIME}. + +@item C-c C-m s o +@kindex C-c C-m s o +@findex mml-secure-message-sign-pgp + +Digitally sign current message using @acronym{PGP}. + +@item C-c C-m s p +@kindex C-c C-m s p +@findex mml-secure-message-sign-pgpmime + +Digitally sign current message using @acronym{PGP/MIME}. + +@item C-c C-m c s +@kindex C-c C-m c s +@findex mml-secure-message-encrypt-smime + +Digitally encrypt current message using @acronym{S/MIME}. + +@item C-c C-m c o +@kindex C-c C-m c o +@findex mml-secure-message-encrypt-pgp + +Digitally encrypt current message using @acronym{PGP}. + +@item C-c C-m c p +@kindex C-c C-m c p +@findex mml-secure-message-encrypt-pgpmime + +Digitally encrypt current message using @acronym{PGP/MIME}. + +@item C-c C-m C-n +@kindex C-c C-m C-n +@findex mml-unsecure-message +Remove security related @acronym{MML} tags from message. + +@end table + +These commands do not immediately sign or encrypt the message, they +merely insert the proper @acronym{MML} secure tag to instruct the +@acronym{MML} engine to perform that operation when the message is +actually sent. They may perform other operations too, such as locating +and retrieving a @acronym{S/MIME} certificate of the person you wish to +send encrypted mail to. When the mml parsing engine converts your +@acronym{MML} into a properly encoded @acronym{MIME} message, the secure +tag will be replaced with either a part or a multipart tag. If your +message contains other mml parts, a multipart tag will be used; if no +other parts are present in your message a single part tag will be used. +This way, message mode will do the Right Thing (TM) with +signed/encrypted multipart messages. + +Since signing and especially encryption often is used when sensitive +information is sent, you may want to have some way to ensure that your +mail is actually signed or encrypted. After invoking the above +sign/encrypt commands, it is possible to preview the raw article by +using @kbd{C-u C-c RET P} (@code{mml-preview}). Then you can +verify that your long rant about what your ex-significant other or +whomever actually did with that funny looking person at that strange +party the other night, actually will be sent encrypted. + +@emph{Note!} Neither @acronym{PGP/MIME} nor @acronym{S/MIME} encrypt/signs +RFC822 headers. They only operate on the @acronym{MIME} object. Keep this +in mind before sending mail with a sensitive Subject line. + +By default, when encrypting a message, Gnus will use the +``signencrypt'' mode, which means the message is both signed and +encrypted. If you would like to disable this for a particular +message, give the @code{mml-secure-message-encrypt-*} command a prefix +argument, e.g., @kbd{C-u C-c C-m c p}. + +Actually using the security commands above is not very difficult. At +least not compared with making sure all involved programs talk with each +other properly. Thus, we now describe what external libraries or +programs are required to make things work, and some small general hints. + +@subsection Using S/MIME + +@emph{Note!} This section assume you have a basic familiarity with +modern cryptography, @acronym{S/MIME}, various PKCS standards, OpenSSL and +so on. + +The @acronym{S/MIME} support in Message (and @acronym{MML}) require +OpenSSL. OpenSSL performs the actual @acronym{S/MIME} sign/encrypt +operations. OpenSSL can be found at @uref{http://www.openssl.org/}. +OpenSSL 0.9.6 and later should work. Version 0.9.5a cannot extract mail +addresses from certificates, and it insert a spurious CR character into +@acronym{MIME} separators so you may wish to avoid it if you would like +to avoid being regarded as someone who send strange mail. (Although by +sending @acronym{S/MIME} messages you've probably already lost that +contest.) + +To be able to send encrypted mail, a personal certificate is not +required. Message (@acronym{MML}) need a certificate for the person to whom you +wish to communicate with though. You're asked for this when you type +@kbd{C-c C-m c s}. Currently there are two ways to retrieve this +certificate, from a local file or from DNS. If you chose a local +file, it need to contain a X.509 certificate in @acronym{PEM} format. +If you chose DNS, you're asked for the domain name where the +certificate is stored, the default is a good guess. To my belief, +Message (@acronym{MML}) is the first mail agent in the world to support +retrieving @acronym{S/MIME} certificates from DNS, so you're not +likely to find very many certificates out there. At least there +should be one, stored at the domain @code{simon.josefsson.org}. LDAP +is a more popular method of distributing certificates, support for it +is planned. (Meanwhile, you can use @code{ldapsearch} from the +command line to retrieve a certificate into a file and use it.) + +As for signing messages, OpenSSL can't perform signing operations +without some kind of configuration. Especially, you need to tell it +where your private key and your certificate is stored. @acronym{MML} +uses an Emacs interface to OpenSSL, aptly named @code{smime.el}, and it +contain a @code{custom} group used for this configuration. So, try +@kbd{M-x customize-group RET smime RET} and look around. + +Currently there is no support for talking to a CA (or RA) to create +your own certificate. None is planned either. You need to do this +manually with OpenSSL or using some other program. I used Netscape +and got a free @acronym{S/MIME} certificate from one of the big CA's on the +net. Netscape is able to export your private key and certificate in +PKCS #12 format. Use OpenSSL to convert this into a plain X.509 +certificate in PEM format as follows. + +@example +$ openssl pkcs12 -in ns.p12 -clcerts -nodes > key+cert.pem +@end example + +The @file{key+cert.pem} file should be pointed to from the +@code{smime-keys} variable. You should now be able to send signed mail. + +@emph{Note!} Your private key is now stored unencrypted in the file, +so take care in handling it. Storing encrypted keys on the disk are +supported, and Gnus will ask you for a passphrase before invoking +OpenSSL. Read the OpenSSL documentation for how to achieve this. If +you use unencrypted keys (e.g., if they are on a secure storage, or if +you are on a secure single user machine) simply press @code{RET} at +the passphrase prompt. + +@subsection Using PGP/MIME + +@acronym{PGP/MIME} requires an external OpenPGP implementation, such +as @uref{http://www.gnupg.org/, GNU Privacy Guard}. Pre-OpenPGP +implementations such as PGP 2.x and PGP 5.x are also supported. One +Emacs interface to the PGP implementations, PGG (@pxref{Top, ,PGG, +pgg, PGG Manual}), is included, but Mailcrypt and Florian Weimer's +@code{gpg.el} are also supported. + +@vindex gpg-temp-directory +Note, if you are using the @code{gpg.el} you must make sure that the +directory specified by @code{gpg-temp-directory} have permissions +0700. + +Creating your own key is described in detail in the documentation of +your PGP implementation, so we refer to it. + +If you have imported your old PGP 2.x key into GnuPG, and want to send +signed and encrypted messages to your fellow PGP 2.x users, you'll +discover that the receiver cannot understand what you send. One +solution is to use PGP 2.x instead (i.e., if you use @code{pgg}, set +@code{pgg-default-scheme} to @code{pgp}). If you do want to use +GnuPG, you can use a compatibility script called @code{gpg-2comp} +available from +@uref{http://muppet.faveve.uni-stuttgart.de/~gero/gpg-2comp/}. You +could also convince your fellow PGP 2.x users to convert to GnuPG. +@vindex mml-signencrypt-style-alist +As a final workaround, you can make the sign and encryption work in +two steps; separately sign, then encrypt a message. If you would like +to change this behavior you can customize the +@code{mml-signencrypt-style-alist} variable. For example: + +@lisp +(setq mml-signencrypt-style-alist '(("smime" separate) + ("pgp" separate) + ("pgpauto" separate) + ("pgpmime" separate))) +@end lisp + +This causes to sign and encrypt in two passes, thus generating a +message that can be understood by PGP version 2. + +(Refer to @uref{http://www.gnupg.org/gph/en/pgp2x.html} for more +information about the problem.) @node Various Commands @section Various Commands @@ -573,9 +1090,10 @@ @item C-c C-e @kindex C-c C-e @findex message-elide-region +@vindex message-elide-ellipsis Elide the text between point and mark (@code{message-elide-region}). The text is killed and replaced with the contents of the variable -@code{message-elide-ellipsis}. The default value is to use an ellipsis +@code{message-elide-ellipsis}. The default value is to use an ellipsis (@samp{[...]}). @item C-c C-z @@ -592,7 +1110,7 @@ @item M-RET @kindex M-RET -@kindex message-newline-and-reformat +@findex message-newline-and-reformat Insert four newlines, and then reformat if inside quoted text. Here's an example: @@ -613,26 +1131,20 @@ @samp{*} says where point will be placed. -@item C-c C-t -@kindex C-c C-t -@findex message-insert-to -Insert a @code{To} header that contains the @code{Reply-To} or -@code{From} header of the message you're following up -(@code{message-insert-to}). - -@item C-c C-n -@kindex C-c C-n -@findex message-insert-newsgroups -Insert a @code{Newsgroups} header that reflects the @code{Followup-To} -or @code{Newsgroups} header of the article you're replying to -(@code{message-insert-newsgroups}). - @item C-c M-r @kindex C-c M-r @findex message-rename-buffer Rename the buffer (@code{message-rename-buffer}). If given a prefix, prompt for a new buffer name. +@item TAB +@kindex TAB +@findex message-tab +@vindex message-tab-body-function +If non-@code{nil} execute the function specified in +@code{message-tab-body-function}. Otherwise use the function bound to +@kbd{TAB} in @code{text-mode-map} or @code{global-map}. + @end table @@ -715,7 +1227,7 @@ @lisp (setq ispell-message-dictionary-alist '(("^Newsgroups:.*\\bde\\." . "deutsch8") - (".*" . "default"))) + (".*" . "default"))) @end lisp @code{ispell} depends on having the external @samp{ispell} command @@ -747,6 +1259,7 @@ * Mail Variables:: Other mail variables. * News Headers:: Customizing news headers. * News Variables:: Other news variables. +* Insertion Variables:: Customizing how things are inserted. * Various Message Variables:: Other message variables. * Sending Variables:: Variables for sending. * Message Buffers:: How Message names its buffers. @@ -767,11 +1280,28 @@ @item message-generate-headers-first @vindex message-generate-headers-first -If non-@code{nil}, generate all required headers before starting to -compose the message. - -The variables @code{message-required-mail-headers} and -@code{message-required-news-headers} specify which headers are required. +If @code{t}, generate all required headers before starting to +compose the message. This can also be a list of headers to generate: + +@lisp +(setq message-generate-headers-first + '(References)) +@end lisp + +@vindex message-required-headers +The variables @code{message-required-headers}, +@code{message-required-mail-headers} and +@code{message-required-news-headers} specify which headers are +required. + +Note that some headers will be removed and re-generated before posting, +because of the variable @code{message-deletable-headers} (see below). + +@item message-draft-headers +@vindex message-draft-headers +When running Message from Gnus, the message buffers are associated +with a draft group. @code{message-draft-headers} says which headers +should be generated when a draft is written to the draft group. @item message-from-style @vindex message-from-style @@ -814,6 +1344,9 @@ @item message-subject-re-regexp @vindex message-subject-re-regexp +@cindex Aw +@cindex Sv +@cindex Re Responses to messages have subjects that start with @samp{Re: }. This is @emph{not} an abbreviation of the English word ``response'', but is Latin, and means ``in response to''. Some illiterate nincompoops have @@ -824,11 +1357,72 @@ set this variable to a regexp that matches these prefixes. Myself, I just throw away non-compliant mail. +Here's an example of a value to deal with these headers when +responding to a message: + +@lisp +(setq message-subject-re-regexp + (concat + "^[ \t]*" + "\\(" + "\\(" + "[Aa][Nn][Tt][Ww]\\.?\\|" ; antw + "[Aa][Ww]\\|" ; aw + "[Ff][Ww][Dd]?\\|" ; fwd + "[Oo][Dd][Pp]\\|" ; odp + "[Rr][Ee]\\|" ; re + "[Rr][\311\351][Ff]\\.?\\|" ; ref + "[Ss][Vv]" ; sv + "\\)" + "\\(\\[[0-9]*\\]\\)" + "*:[ \t]*" + "\\)" + "*[ \t]*" + )) +@end lisp + +@item message-subject-trailing-was-query +@vindex message-subject-trailing-was-query +@vindex message-subject-trailing-was-ask-regexp +@vindex message-subject-trailing-was-regexp +Controls what to do with trailing @samp{(was: )} in subject +lines. If @code{nil}, leave the subject unchanged. If it is the symbol +@code{ask}, query the user what do do. In this case, the subject is +matched against @code{message-subject-trailing-was-ask-regexp}. If +@code{message-subject-trailing-was-query} is t, always strip the +trailing old subject. In this case, +@code{message-subject-trailing-was-regexp} is used. + @item message-alternative-emails @vindex message-alternative-emails A regexp to match the alternative email addresses. The first matched address (not primary one) is used in the @code{From} field. +@item message-allow-no-recipients +@vindex message-allow-no-recipients +Specifies what to do when there are no recipients other than +@code{Gcc} or @code{Fcc}. If it is @code{always}, the posting is +allowed. If it is @code{never}, the posting is not allowed. If it is +@code{ask} (the default), you are prompted. + +@item message-hidden-headers +@vindex message-hidden-headers +A regexp, a list of regexps, or a list where the first element is +@code{not} and the rest are regexps. It says which headers to keep +hidden when composing a message. + +@lisp +(setq message-hidden-headers + '(not "From" "Subject" "To" "Cc" "Newsgroups")) +@end lisp + +@item message-header-synonyms +@vindex message-header-synonyms +A list of lists of header synonyms. E.g., if this list contains a +member list with elements @code{Cc} and @code{To}, then +@code{message-carefully-insert-headers} will not insert a @code{To} +header when the message is already @code{Cc}ed to the recipient. + @end table @@ -845,7 +1439,7 @@ @item message-ignored-mail-headers @vindex message-ignored-mail-headers Regexp of headers to be removed before mailing. The default is -@samp{^[GF]cc:\|^Resent-Fcc:\|^Xref:}. +@samp{^[GF]cc:\\|^Resent-Fcc:\\|^Xref:\\|^X-Draft-From:}. @item message-default-mail-headers @vindex message-default-mail-headers @@ -861,9 +1455,17 @@ @table @code @item message-send-mail-function @vindex message-send-mail-function +@findex message-send-mail-with-sendmail +@findex message-send-mail-with-mh +@findex message-send-mail-with-qmail +@findex message-smtpmail-send-it +@findex smtpmail-send-it +@findex feedmail-send-it Function used to send the current buffer as mail. The default is -@code{message-send-mail-with-sendmail}. If you prefer using MH -instead, set this variable to @code{message-send-mail-with-mh}. +@code{message-send-mail-with-sendmail}. Other valid values include +@code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail}, +@code{message-smtpmail-send-it}, @code{smtpmail-send-it} and +@code{feedmail-send-it}. @item message-mh-deletable-headers @vindex message-mh-deletable-headers @@ -873,12 +1475,47 @@ messages via MH. Set it to @code{nil} if your MH can handle these headers. +@item message-qmail-inject-program +@vindex message-qmail-inject-program +@cindex qmail +Location of the qmail-inject program. + +@item message-qmail-inject-args +@vindex message-qmail-inject-args +Arguments passed to qmail-inject programs. +This should be a list of strings, one string for each argument. It +may also be a function. + +For e.g., if you wish to set the envelope sender address so that bounces +go to the right place or to deal with listserv's usage of that address, you +might set this variable to @code{'("-f" "you@@some.where")}. + +@item message-sendmail-f-is-evil +@vindex message-sendmail-f-is-evil +@cindex sendmail +Non-@code{nil} means don't add @samp{-f username} to the sendmail +command line. Doing so would be even more evil than leaving it out. + +@item message-sendmail-envelope-from +@vindex message-sendmail-envelope-from +When @code{message-sendmail-f-is-evil} is @code{nil}, this specifies +the address to use in the @acronym{SMTP} envelope. If it is +@code{nil}, use @code{user-mail-address}. If it is the symbol +@code{header}, use the @samp{From} header of the message. + +@item message-mailer-swallows-blank-line +@vindex message-mailer-swallows-blank-line +Set this to non-@code{nil} if the system's mailer runs the header and +body together. (This problem exists on SunOS 4 when sendmail is run +in remote mode.) The value should be an expression to test whether +the problem will actually occur. + @item message-send-mail-partially-limit @vindex message-send-mail-partially-limit -The limit on the size of messages sent as @samp{message/partial}. -This is the minimum message size in characters beyond which the -message should be sent in several parts. If it is @code{nil}, the -size is unlimited. +@cindex split large message +The limitation of messages sent as message/partial. The lower bound +of message size in characters, beyond which the message should be sent +in several parts. If it is @code{nil}, the size is unlimited. @end table @@ -913,6 +1550,8 @@ @item Organization @cindex organization +@vindex message-user-organization +@vindex message-user-organization-file This optional header will be filled out depending on the @code{message-user-organization} variable. @code{message-user-organization-file} will be used if this variable is @@ -926,14 +1565,18 @@ @item Message-ID @cindex Message-ID +@vindex message-user-fqdn @vindex mail-host-address +@vindex user-mail-address @findex system-name @cindex Sun +@cindex i-did-not-set--mail-host-address--so-tickle-me This required header will be generated by Message. A unique ID will be -created based on the date, time, user name and system name. Message -will use @code{system-name} to determine the name of the system. If -this isn't a fully qualified domain name (FQDN), Message will use -@code{mail-host-address} as the FQDN of the machine. +created based on the date, time, user name and system name. For the +domain part, message will look (in this order) at +@code{message-user-fqdn}, @code{system-name}, @code{mail-host-address} +and @code{message-user-mail-address} (i.e. @code{user-mail-address}) +until a probably valid fully qualified domain name (FQDN) was found. @item User-Agent @cindex User-Agent @@ -946,18 +1589,21 @@ @item Expires @cindex Expires +@vindex message-expires This extremely optional header will be inserted according to the @code{message-expires} variable. It is highly deprecated and shouldn't be used unless you know what you're doing. @item Distribution @cindex Distribution +@vindex message-distribution-function This optional header is filled out according to the @code{message-distribution-function} variable. It is a deprecated and much misunderstood header. @item Path @cindex path +@vindex message-user-path This extremely optional header should probably never be used. However, some @emph{very} old servers require that this header is present. @code{message-user-path} further controls how this @@ -969,9 +1615,9 @@ @findex yow @cindex Mime-Version -In addition, you can enter conses into this list. The car of this cons +In addition, you can enter conses into this list. The @sc{car} of this cons should be a symbol. This symbol's name is the name of the header, and -the cdr can either be a string to be entered verbatim as the value of +the @sc{cdr} can either be a string to be entered verbatim as the value of this header, or it can be a function to be called. This function should return a string to be inserted. For instance, if you want to insert @code{Mime-Version: 1.0}, you should enter @code{(Mime-Version . "1.0")} @@ -979,10 +1625,19 @@ something like @code{(X-Yow . yow)} into the list. The function @code{yow} will then be called without any arguments. -If the list contains a cons where the car of the cons is -@code{optional}, the cdr of this cons will only be inserted if it is +If the list contains a cons where the @sc{car} of the cons is +@code{optional}, the @sc{cdr} of this cons will only be inserted if it is non-@code{nil}. +If you want to delete an entry from this list, the following Lisp +snippet might be useful. Adjust accordingly if you want to remove +another element. + +@lisp +(setq message-required-news-headers + (delq 'Message-ID message-required-news-headers)) +@end lisp + Other variables for customizing outgoing news articles: @table @code @@ -1055,7 +1710,7 @@ @item message-ignored-news-headers @vindex message-ignored-news-headers Regexp of headers to be removed before posting. The default is@* -@samp{^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:}. +@samp{^NNTP-Posting-Host:\\|^Xref:\\|^[BGF]cc:\\|^Resent-Fcc:\\|^X-Draft-From:}. @item message-default-news-headers @vindex message-default-news-headers @@ -1082,6 +1737,125 @@ @end table +@node Insertion Variables +@section Insertion Variables + +@table @code +@item message-ignored-cited-headers +@vindex message-ignored-cited-headers +All headers that match this regexp will be removed from yanked +messages. The default is @samp{.}, which means that all headers will be +removed. + +@item message-cite-prefix-regexp +@vindex message-cite-prefix-regexp +Regexp matching the longest possible citation prefix on a line. + +@item message-citation-line-function +@vindex message-citation-line-function +@cindex attribution line +Function called to insert the citation line. The default is +@code{message-insert-citation-line}, which will lead to citation lines +that look like: + +@example +Hallvard B Furuseth writes: +@end example + +Point will be at the beginning of the body of the message when this +function is called. + +Note that Gnus provides a feature where clicking on `writes:' hides the +cited text. If you change the citation line too much, readers of your +messages will have to adjust their Gnus, too. See the variable +@code{gnus-cite-attribution-suffix}. @xref{Article Highlighting, , +Article Highlighting, gnus, The Gnus Manual}, for details. + +@item message-yank-prefix +@vindex message-yank-prefix +@cindex yanking +@cindex quoting +When you are replying to or following up an article, you normally want +to quote the person you are answering. Inserting quoted text is done +by @dfn{yanking}, and each line you yank will have +@code{message-yank-prefix} prepended to it (except for quoted and +empty lines which uses @code{message-yank-cited-prefix}). The default +is @samp{> }. + +@item message-yank-cited-prefix +@vindex message-yank-cited-prefix +@cindex yanking +@cindex cited +@cindex quoting +When yanking text from an article which contains no text or already +cited text, each line will be prefixed with the contents of this +variable. The default is @samp{>}. See also +@code{message-yank-prefix}. + +@item message-indentation-spaces +@vindex message-indentation-spaces +Number of spaces to indent yanked messages. + +@item message-cite-function +@vindex message-cite-function +@findex message-cite-original +@findex sc-cite-original +@findex message-cite-original-without-signature +@cindex Supercite +Function for citing an original message. The default is +@code{message-cite-original}, which simply inserts the original message +and prepends @samp{> } to each line. +@code{message-cite-original-without-signature} does the same, but elides +the signature. You can also set it to @code{sc-cite-original} to use +Supercite. + +@item message-indent-citation-function +@vindex message-indent-citation-function +Function for modifying a citation just inserted in the mail buffer. +This can also be a list of functions. Each function can find the +citation between @code{(point)} and @code{(mark t)}. And each function +should leave point and mark around the citation text as modified. + +@item message-mark-insert-begin +@vindex message-mark-insert-begin +String to mark the beginning of some inserted text. + +@item message-mark-insert-end +@vindex message-mark-insert-end +String to mark the end of some inserted text. + +@item message-signature +@vindex message-signature +String to be inserted at the end of the message buffer. If @code{t} +(which is the default), the @code{message-signature-file} file will be +inserted instead. If a function, the result from the function will be +used instead. If a form, the result from the form will be used instead. +If this variable is @code{nil}, no signature will be inserted at all. + +@item message-signature-file +@vindex message-signature-file +File containing the signature to be inserted at the end of the buffer. +The default is @file{~/.signature}. + +@item message-signature-insert-empty-line +@vindex message-signature-insert-empty-line +If @code{t} (the default value) an empty line is inserted before the +signature separator. + +@end table + +Note that RFC1036bis says that a signature should be preceded by the three +characters @samp{-- } on a line by themselves. This is to make it +easier for the recipient to automatically recognize and process the +signature. So don't remove those characters, even though you might feel +that they ruin your beautiful design, like, totally. + +Also note that no signature should be more than four lines long. +Including @acronym{ASCII} graphics is an efficient way to get +everybody to believe that you are silly and have nothing important to +say. + + @node Various Message Variables @section Various Message Variables @@ -1089,13 +1863,12 @@ @item message-default-charset @vindex message-default-charset @cindex charset -Symbol naming a @sc{mime} charset. Non-ASCII characters in messages are -assumed to be encoded using this charset. The default is @code{nil}, -which means ask the user. (This variable is used only on non-@sc{mule} -Emacsen. -@xref{Charset Translation, , Charset Translation, emacs-mime, - Emacs MIME Manual}, for details on the @sc{mule}-to-@sc{mime} -translation process. +Symbol naming a @acronym{MIME} charset. Non-@acronym{ASCII} +characters in messages are assumed to be encoded using this charset. +The default is @code{nil}, which means ask the user. (This variable +is used only on non-@sc{mule} Emacsen. @xref{Charset Translation, , +Charset Translation, emacs-mime, Emacs MIME Manual}, for details on +the @sc{mule}-to-@acronym{MIME} translation process. @item message-signature-separator @vindex message-signature-separator @@ -1111,6 +1884,11 @@ @vindex message-directory Directory used by many mailey things. The default is @file{~/Mail/}. +@item message-auto-save-directory +@vindex message-auto-save-directory +Directory where Message auto-saves buffers if Gnus isn't running. If +@code{nil}, Message won't auto-save. The default is @file{~/Mail/drafts/}. + @item message-signature-setup-hook @vindex message-signature-setup-hook Hook run when initializing the message buffer. It is run after the @@ -1160,27 +1938,42 @@ @item message-send-mail-hook @vindex message-send-mail-hook -Hook run before sending mail messages. +Hook run before sending mail messages. This hook is run very late -- +just before the message is actually sent as mail. @item message-send-news-hook @vindex message-send-news-hook -Hook run before sending news messages. +Hook run before sending news messages. This hook is run very late -- +just before the message is actually sent as news. @item message-sent-hook @vindex message-sent-hook Hook run after sending messages. +@item message-cancel-hook +@vindex message-cancel-hook +Hook run when canceling news articles. + @item message-mode-syntax-table @vindex message-mode-syntax-table Syntax table used in message mode buffers. +@item message-strip-special-text-properties +@vindex message-strip-special-text-properties +Emacs has a number of special text properties which can break message +composing in various ways. If this option is set, message will strip +these properties from the message composition buffer. However, some +packages requires these properties to be present in order to work. If +you use one of these packages, turn this option off, and hope the +message composition doesn't break too bad. + @item message-send-method-alist @vindex message-send-method-alist Alist of ways to send outgoing messages. Each element has the form @lisp -(TYPE PREDICATE FUNCTION) +(@var{type} @var{predicate} @var{function}) @end lisp @table @var @@ -1216,7 +2009,7 @@ @vindex message-fcc-handler-function A function called to save outgoing articles. This function will be called with the name of the file to store the article in. The default -function is @code{message-output} which saves in inbox format. +function is @code{message-output} which saves in Unix mailbox format. @item message-courtesy-message @vindex message-courtesy-message @@ -1225,7 +2018,17 @@ newsgroups the article has been posted to will be inserted there. If this variable is @code{nil}, no such courtesy message will be added. The default value is @samp{"The following message is a courtesy copy of -an article\nthat has been posted to %s as well.\n\n"}. +an article\\nthat has been posted to %s as well.\\n\\n"}. + +@item message-fcc-externalize-attachments +@vindex message-fcc-externalize-attachments +If @code{nil}, attach files as normal parts in Fcc copies; if it is +non-@code{nil}, attach local files as external parts. + +@item message-interactive +@vindex message-interactive +If non-@code{nil} wait for and display errors when sending a message; +if @code{nil} let the mailer mail back a message to report errors. @end table @@ -1308,7 +2111,7 @@ killed, postponed or exited. An @dfn{action} can be either: a normal function, or a list where the -@code{car} is a function and the @code{cdr} is the list of arguments, or +@sc{car} is a function and the @sc{cdr} is the list of arguments, or a form to be @code{eval}ed. @@ -1318,7 +2121,7 @@ Message uses virtually only its own variables---older @code{mail-} variables aren't consulted. To force Message to take those variables -into account, you can put the following in your @code{.emacs} file: +into account, you can put the following in your @file{.emacs} file: @lisp (require 'messcompat)